0.1.537 • Published 9 months ago

@drift-labs/vaults-sdk v0.1.537

Weekly downloads
-
License
-
Repository
-
Last release
9 months ago

CLI Usage

This repo has a simple CLI for interacting with the vault (run from this package.json):

This CLI utility requires an RPC node and keypair to sign transactions (similar to solana cli). You can either provide these as environment variables or in a .env file, or use the --keypair and --url flags.

Required Environment Variables or Flags:

Environment Variablecommand line flagDescription
RPC_URL--urlThe RPC node to connect to for transactions
KEYPAIR_PATH--keypairPath to keypair to sign transactions

View available commands, run with --help in nested commands to get available options for each command

yarn cli --help

Init a new vault. This will initialize a new vault and update you (the manager) as the delegate, unless --delegate is specified.

$ yarn cli init-vault --help
Usage: cli init-vault [options]

Initialize a new vault

Options:
  -n, --name <string>               Name of the vault to create
  -i, --market-index <number>       Spot market index to accept for deposits (default 0 == USDC) (default: "0")
  -r, --redeem-period <number>      The period (in seconds) depositors must wait after requesting a withdraw (default: 7 days) (default: "604800")
  -x, --max-tokens <number>         The max number of spot marketIndex tokens the vault can accept (default 0 == unlimited) (default: "0")
  -m, --management-fee <percent>    The annualized management fee to charge depositors (default: "0")
  -s, --profit-share <percent>      The percentage of profits charged by manager (default: "0")
  -p, --permissioned                Provide this flag to make the vault permissioned, vault-depositors will need to be initialized by the manager
                                    (default: false)
  -a, --min-deposit-amount <number  The minimum token amount allowed to deposit (default: "0")
  -d, --delegate <publicKey>        The address to make the delegate of the vault
  -h, --help                        display help for command

To update params in a vault:

$ yarn cli manager-update-vault --help
Usage: cli manager-update-vault [options]

Update vault params for a manager

Options:
  --vault-address <address>         Address of the vault to update
  -r, --redeem-period <number>      The new redeem period (can only be lowered)
  -x, --max-tokens <number>         The max tokens the vault can accept
  -a, --min-deposit-amount <number  The minimum token amount allowed to deposit
  -m, --management-fee <percent>    The new management fee (can only be lowered)
  -s, --profit-share <percent>      The new profit share percentage (can only be lowered)
  -p, --permissioned <boolean>      Set the vault as permissioned (true) or open (false) (default: false)
  -h, --help                        display help for command

Make a deposit into a vault (as a manager, DEPOSIT_AMOUNT in human precision):

yarn cli manager-deposit --vault-address=<VAULT_ADDRESS> --amount=<DEPOSIT_AMOUNT>

Make a withdraw request from a vault (as a manager, SHARES in raw precision):

yarn cli manager-request-withdraw --vault-address=<VAULT_ADDRESS> --amount=<SHARES>

Manager can trigger a profit share calculation (this looks up all VaultDepositors for a vault eligible for profit share and batch processes them):

yarn cli apply-profit-share-all --vault-address=<VAULT_ADDRESS>

For permissioned vaults, initialize a VaultDepositor for someone to deposit.

yarn cli init-vault-depositor --vault-address=<VAULT_ADDRESS> --deposit-authority=<AUTHORITY_TO_ALLOW_DEPOSIT>

Then send them the VAULT_DEPOSITOR_ADDRESS

Make a deposit into a vault (as a non-manager, DEPOSIT_AMOUNT in human precision):

yarn cli deposit --vault-depositor-address=<VAULT_DEPOSITOR_ADDRESS> --amount=<DEPOSIT_AMOUNT>

To print out the current state of a Vault or VaultDepositor:

yarn cli view-vault --vault-address=<VAULT_ADDRESS>

yarn cli view-vault-depositor --vault-depositor-address=<VAULT_DEPOSITOR_ADDRESS>
0.1.536

9 months ago

0.1.537

9 months ago

0.1.535

9 months ago

0.1.529

9 months ago

0.1.532

9 months ago

0.1.531

9 months ago

0.1.534

9 months ago

0.1.533

9 months ago

0.1.530

9 months ago

0.1.525

9 months ago

0.1.524

9 months ago

0.1.527

9 months ago

0.1.526

9 months ago

0.1.523

9 months ago

0.1.522

9 months ago

0.1.528

9 months ago

0.1.521

9 months ago

0.1.518

9 months ago

0.1.519

9 months ago

0.1.520

9 months ago

0.1.514

9 months ago

0.1.513

9 months ago

0.1.516

9 months ago

0.1.515

9 months ago

0.1.512

9 months ago

0.1.517

9 months ago

0.1.507

9 months ago

0.1.506

9 months ago

0.1.509

9 months ago

0.1.508

9 months ago

0.1.510

9 months ago

0.1.511

9 months ago

0.1.499

9 months ago

0.1.503

9 months ago

0.1.502

9 months ago

0.1.505

9 months ago

0.1.504

9 months ago

0.1.501

9 months ago

0.1.500

9 months ago

0.1.359

1 year ago

0.1.477

10 months ago

0.1.356

1 year ago

0.1.476

10 months ago

0.1.355

1 year ago

0.1.479

10 months ago

0.1.358

1 year ago

0.1.478

10 months ago

0.1.357

1 year ago

0.1.473

10 months ago

0.1.352

1 year ago

0.1.472

10 months ago

0.1.351

1 year ago

0.1.475

10 months ago

0.1.354

1 year ago

0.1.474

10 months ago

0.1.353

1 year ago

0.1.471

10 months ago

0.1.350

1 year ago

0.1.470

10 months ago

0.1.488

10 months ago

0.1.367

1 year ago

0.1.487

10 months ago

0.1.366

1 year ago

0.1.369

1 year ago

0.1.489

10 months ago

0.1.368

1 year ago

0.1.484

10 months ago

0.1.363

1 year ago

0.1.483

10 months ago

0.1.362

1 year ago

0.1.486

10 months ago

0.1.365

1 year ago

0.1.485

10 months ago

0.1.364

1 year ago

0.1.480

10 months ago

0.1.482

10 months ago

0.1.361

1 year ago

0.1.481

10 months ago

0.1.360

1 year ago

0.1.378

12 months ago

0.1.498

9 months ago

0.1.377

1 year ago

0.1.379

12 months ago

0.1.495

10 months ago

0.1.374

1 year ago

0.1.494

10 months ago

0.1.373

1 year ago

0.1.497

10 months ago

0.1.376

1 year ago

0.1.496

10 months ago

0.1.375

1 year ago

0.1.491

10 months ago

0.1.370

1 year ago

0.1.490

10 months ago

0.1.493

10 months ago

0.1.372

1 year ago

0.1.492

10 months ago

0.1.371

1 year ago

0.1.389

12 months ago

0.1.388

12 months ago

0.1.385

12 months ago

0.1.384

12 months ago

0.1.387

12 months ago

0.1.386

12 months ago

0.1.381

12 months ago

0.1.380

12 months ago

0.1.383

12 months ago

0.1.382

12 months ago

0.1.309

1 year ago

0.1.429

11 months ago

0.1.308

1 year ago

0.1.437

11 months ago

0.1.316

1 year ago

0.1.436

11 months ago

0.1.315

1 year ago

0.1.439

11 months ago

0.1.318

1 year ago

0.1.438

11 months ago

0.1.317

1 year ago

0.1.433

11 months ago

0.1.312

1 year ago

0.1.432

11 months ago

0.1.311

1 year ago

0.1.435

11 months ago

0.1.314

1 year ago

0.1.434

11 months ago

0.1.313

1 year ago

0.1.431

11 months ago

0.1.310

1 year ago

0.1.430

11 months ago

0.1.319

1 year ago

0.1.448

11 months ago

0.1.327

1 year ago

0.1.447

11 months ago

0.1.326

1 year ago

0.1.329

1 year ago

0.1.449

11 months ago

0.1.328

1 year ago

0.1.444

11 months ago

0.1.323

1 year ago

0.1.443

11 months ago

0.1.322

1 year ago

0.1.446

11 months ago

0.1.325

1 year ago

0.1.445

11 months ago

0.1.324

1 year ago

0.1.440

11 months ago

0.1.442

11 months ago

0.1.321

1 year ago

0.1.441

11 months ago

0.1.320

1 year ago

0.1.459

10 months ago

0.1.338

1 year ago

0.1.458

10 months ago

0.1.337

1 year ago

0.1.339

1 year ago

0.1.455

10 months ago

0.1.334

1 year ago

0.1.454

10 months ago

0.1.333

1 year ago

0.1.457

10 months ago

0.1.336

1 year ago

0.1.456

10 months ago

0.1.335

1 year ago

0.1.451

10 months ago

0.1.330

1 year ago

0.1.450

10 months ago

0.1.453

10 months ago

0.1.332

1 year ago

0.1.452

10 months ago

0.1.331

1 year ago

0.1.349

1 year ago

0.1.469

10 months ago

0.1.348

1 year ago

0.1.466

10 months ago

0.1.345

1 year ago

0.1.465

10 months ago

0.1.344

1 year ago

0.1.468

10 months ago

0.1.347

1 year ago

0.1.467

10 months ago

0.1.346

1 year ago

0.1.462

10 months ago

0.1.341

1 year ago

0.1.461

10 months ago

0.1.340

1 year ago

0.1.464

10 months ago

0.1.343

1 year ago

0.1.463

10 months ago

0.1.342

1 year ago

0.1.460

10 months ago

0.1.404

12 months ago

0.1.403

12 months ago

0.1.406

12 months ago

0.1.405

12 months ago

0.1.400

12 months ago

0.1.402

12 months ago

0.1.401

12 months ago

0.1.408

12 months ago

0.1.407

12 months ago

0.1.409

12 months ago

0.1.415

11 months ago

0.1.414

11 months ago

0.1.417

11 months ago

0.1.416

11 months ago

0.1.411

12 months ago

0.1.410

12 months ago

0.1.413

11 months ago

0.1.412

11 months ago

0.1.419

11 months ago

0.1.418

11 months ago

0.1.426

11 months ago

0.1.305

1 year ago

0.1.425

11 months ago

0.1.304

1 year ago

0.1.428

11 months ago

0.1.307

1 year ago

0.1.427

11 months ago

0.1.306

1 year ago

0.1.422

11 months ago

0.1.301

1 year ago

0.1.421

11 months ago

0.1.300

1 year ago

0.1.424

11 months ago

0.1.303

1 year ago

0.1.423

11 months ago

0.1.302

1 year ago

0.1.420

11 months ago

0.1.390

12 months ago

0.1.399

12 months ago

0.1.396

12 months ago

0.1.395

12 months ago

0.1.398

12 months ago

0.1.397

12 months ago

0.1.392

12 months ago

0.1.391

12 months ago

0.1.394

12 months ago

0.1.393

12 months ago

0.1.297

1 year ago

0.1.299

1 year ago

0.1.298

1 year ago

0.1.296

1 year ago

0.1.295

1 year ago

0.1.291

1 year ago

0.1.293

1 year ago

0.1.292

1 year ago

0.1.294

1 year ago

0.1.290

1 year ago

0.1.289

1 year ago

0.1.286

1 year ago

0.1.288

1 year ago

0.1.287

1 year ago

0.1.285

1 year ago

0.1.284

1 year ago

0.1.283

1 year ago

0.1.282

1 year ago

0.1.279

1 year ago

0.1.278

1 year ago

0.1.280

1 year ago

0.1.281

1 year ago

0.1.275

1 year ago

0.1.277

1 year ago

0.1.276

1 year ago

0.1.274

1 year ago

0.1.273

1 year ago

0.1.272

1 year ago

0.1.269

1 year ago

0.1.271

1 year ago

0.1.270

1 year ago

0.1.268

1 year ago

0.1.267

1 year ago

0.1.264

1 year ago

0.1.263

1 year ago

0.1.266

1 year ago

0.1.265

1 year ago

0.1.260

1 year ago

0.1.262

1 year ago

0.1.261

1 year ago

0.1.257

1 year ago

0.1.259

1 year ago

0.1.258

1 year ago

0.1.256

1 year ago

0.1.255

1 year ago

0.1.254

1 year ago

0.1.249

1 year ago

0.1.253

1 year ago

0.1.252

1 year ago

0.1.251

1 year ago

0.1.250

1 year ago

0.1.248

1 year ago

0.1.247

1 year ago

0.1.246

1 year ago

0.1.245

1 year ago

0.1.244

1 year ago

0.1.239

1 year ago

0.1.238

1 year ago

0.1.242

1 year ago

0.1.241

1 year ago

0.1.243

1 year ago

0.1.240

1 year ago

0.1.237

1 year ago

0.1.236

1 year ago

0.1.235

1 year ago

0.1.234

1 year ago

0.1.231

1 year ago

0.1.233

1 year ago

0.1.232

1 year ago

0.1.230

1 year ago

0.1.228

1 year ago

0.1.229

1 year ago

0.1.227

1 year ago

0.1.226

1 year ago

0.1.225

1 year ago

0.1.224

1 year ago

0.1.223

1 year ago

0.1.222

1 year ago

0.1.221

1 year ago

0.1.217

1 year ago

0.1.216

1 year ago

0.1.219

1 year ago

0.1.218

1 year ago

0.1.213

1 year ago

0.1.212

1 year ago

0.1.215

1 year ago

0.1.214

1 year ago

0.1.220

1 year ago

0.1.209

1 year ago

0.1.211

1 year ago

0.1.210

1 year ago

0.1.206

1 year ago

0.1.208

1 year ago

0.1.207

1 year ago

0.1.205

1 year ago

0.1.204

1 year ago

0.1.202

1 year ago

0.1.201

1 year ago

0.1.203

1 year ago

0.1.200

1 year ago

0.1.199

1 year ago

0.1.198

1 year ago

0.1.197

1 year ago

0.1.194

1 year ago

0.1.196

1 year ago

0.1.195

1 year ago

0.1.190

1 year ago

0.1.192

1 year ago

0.1.191

1 year ago

0.1.193

1 year ago

0.1.187

1 year ago

0.1.186

1 year ago

0.1.189

1 year ago

0.1.188

1 year ago

0.1.183

1 year ago

0.1.185

1 year ago

0.1.184

1 year ago

0.1.179

1 year ago

0.1.181

1 year ago

0.1.180

1 year ago

0.1.182

1 year ago

0.1.176

1 year ago

0.1.175

1 year ago

0.1.178

1 year ago

0.1.177

1 year ago

0.1.172

1 year ago

0.1.174

1 year ago

0.1.173

1 year ago

0.1.169

1 year ago

0.1.170

1 year ago

0.1.171

1 year ago

0.1.168

1 year ago

0.1.167

1 year ago

0.1.166

1 year ago

0.1.165

1 year ago

0.1.164

1 year ago

0.1.161

1 year ago

0.1.160

1 year ago

0.1.163

1 year ago

0.1.162

1 year ago

0.1.159

1 year ago

0.1.158

1 year ago

0.1.157

1 year ago

0.1.156

1 year ago

0.1.155

1 year ago

0.1.154

1 year ago

0.1.149

1 year ago

0.1.148

1 year ago

0.1.153

1 year ago

0.1.150

1 year ago

0.1.152

1 year ago

0.1.151

1 year ago

0.1.147

1 year ago

0.1.146

1 year ago

0.1.143

1 year ago

0.1.145

1 year ago

0.1.144

1 year ago

0.1.142

1 year ago

0.1.141

1 year ago

0.1.140

1 year ago

0.1.139

1 year ago

0.1.136

1 year ago

0.1.138

1 year ago

0.1.137

1 year ago

0.1.129

1 year ago

0.1.135

1 year ago

0.1.132

1 year ago

0.1.131

1 year ago

0.1.134

1 year ago

0.1.133

1 year ago

0.1.130

1 year ago

0.1.128

1 year ago

0.1.127

1 year ago

0.1.126

1 year ago

0.1.125

1 year ago

0.1.118

1 year ago

0.1.117

2 years ago

0.1.119

1 year ago

0.1.116

2 years ago

0.1.124

1 year ago

0.1.121

1 year ago

0.1.120

1 year ago

0.1.122

1 year ago

0.1.114

2 years ago

0.1.115

2 years ago

0.1.113

2 years ago

0.1.112

2 years ago

0.1.111

2 years ago

0.1.110

2 years ago

0.1.109

2 years ago

0.1.108

2 years ago

0.1.107

2 years ago

0.1.106

2 years ago

0.1.105

2 years ago

0.1.104

2 years ago

0.1.103

2 years ago

0.1.102

2 years ago

0.1.101

2 years ago

0.1.98

2 years ago

0.1.99

2 years ago

0.1.100

2 years ago

0.1.96

2 years ago

0.1.97

2 years ago

0.1.94

2 years ago

0.1.95

2 years ago

0.1.90

2 years ago

0.1.91

2 years ago

0.1.92

2 years ago

0.1.93

2 years ago

0.1.89

2 years ago

0.1.88

2 years ago

0.1.85

2 years ago

0.1.86

2 years ago

0.1.87

2 years ago

0.1.81

2 years ago

0.1.82

2 years ago

0.1.83

2 years ago

0.1.84

2 years ago

0.1.80

2 years ago

0.1.75

2 years ago

0.1.76

2 years ago

0.1.77

2 years ago

0.1.78

2 years ago

0.1.79

2 years ago

0.1.74

2 years ago

0.1.72

2 years ago

0.1.73

2 years ago

0.1.70

2 years ago

0.1.71

2 years ago

0.1.63

2 years ago

0.1.64

2 years ago

0.1.65

2 years ago

0.1.66

2 years ago

0.1.67

2 years ago

0.1.68

2 years ago

0.1.69

2 years ago

0.1.61

2 years ago

0.1.62

2 years ago

0.1.58

2 years ago

0.1.59

2 years ago

0.1.60

2 years ago

0.1.54

2 years ago

0.1.55

2 years ago

0.1.56

2 years ago

0.1.57

2 years ago

0.1.52

2 years ago

0.1.53

2 years ago

0.1.50

2 years ago

0.1.51

2 years ago

0.1.49

2 years ago

0.1.48

2 years ago

0.1.47

2 years ago

0.1.46

2 years ago

0.1.45

2 years ago

0.1.44

2 years ago

0.1.43

2 years ago

0.1.42

2 years ago

0.1.41

2 years ago

0.1.40

2 years ago

0.1.39

2 years ago

0.1.38

2 years ago

0.1.37

2 years ago

0.1.36

2 years ago

0.1.35

2 years ago

0.1.34

2 years ago

0.1.33

2 years ago

0.1.32

2 years ago

0.1.31

2 years ago

0.1.30

2 years ago

0.1.29

2 years ago

0.1.28

2 years ago

0.1.27

2 years ago

0.1.26

2 years ago

0.1.25

2 years ago

0.1.24

2 years ago

0.1.23

2 years ago

0.1.22

2 years ago

0.1.21

2 years ago

0.1.20

2 years ago

0.1.19

2 years ago

0.1.18

2 years ago

0.1.17

2 years ago

0.1.16

2 years ago

0.1.15

2 years ago

0.1.14

2 years ago

0.1.13

2 years ago

0.1.12

2 years ago

0.1.11

2 years ago

0.1.10

2 years ago

0.1.9

2 years ago

0.1.8

2 years ago

0.1.7

2 years ago

0.1.6

2 years ago

0.1.5

2 years ago

0.1.4

2 years ago

0.1.3

2 years ago

0.1.2

2 years ago

0.1.1

2 years ago

0.1.0

2 years ago