0.1.537 • Published 10 months ago

@drift-labs/vaults-sdk v0.1.537

Weekly downloads
-
License
-
Repository
-
Last release
10 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

10 months ago

0.1.537

10 months ago

0.1.535

10 months ago

0.1.529

10 months ago

0.1.532

10 months ago

0.1.531

10 months ago

0.1.534

10 months ago

0.1.533

10 months ago

0.1.530

10 months ago

0.1.525

11 months ago

0.1.524

11 months ago

0.1.527

11 months ago

0.1.526

11 months ago

0.1.523

11 months ago

0.1.522

11 months ago

0.1.528

11 months ago

0.1.521

11 months ago

0.1.518

11 months ago

0.1.519

11 months ago

0.1.520

11 months ago

0.1.514

11 months ago

0.1.513

11 months ago

0.1.516

11 months ago

0.1.515

11 months ago

0.1.512

11 months ago

0.1.517

11 months ago

0.1.507

11 months ago

0.1.506

11 months ago

0.1.509

11 months ago

0.1.508

11 months ago

0.1.510

11 months ago

0.1.511

11 months ago

0.1.499

11 months ago

0.1.503

11 months ago

0.1.502

11 months ago

0.1.505

11 months ago

0.1.504

11 months ago

0.1.501

11 months ago

0.1.500

11 months ago

0.1.359

1 year ago

0.1.477

11 months ago

0.1.356

1 year ago

0.1.476

11 months ago

0.1.355

1 year ago

0.1.479

11 months ago

0.1.358

1 year ago

0.1.478

11 months ago

0.1.357

1 year ago

0.1.473

11 months ago

0.1.352

1 year ago

0.1.472

11 months ago

0.1.351

1 year ago

0.1.475

11 months ago

0.1.354

1 year ago

0.1.474

11 months ago

0.1.353

1 year ago

0.1.471

11 months ago

0.1.350

1 year ago

0.1.470

11 months ago

0.1.488

11 months ago

0.1.367

1 year ago

0.1.487

11 months ago

0.1.366

1 year ago

0.1.369

1 year ago

0.1.489

11 months ago

0.1.368

1 year ago

0.1.484

11 months ago

0.1.363

1 year ago

0.1.483

11 months ago

0.1.362

1 year ago

0.1.486

11 months ago

0.1.365

1 year ago

0.1.485

11 months ago

0.1.364

1 year ago

0.1.480

11 months ago

0.1.482

11 months ago

0.1.361

1 year ago

0.1.481

11 months ago

0.1.360

1 year ago

0.1.378

1 year ago

0.1.498

11 months ago

0.1.377

1 year ago

0.1.379

1 year ago

0.1.495

11 months ago

0.1.374

1 year ago

0.1.494

11 months ago

0.1.373

1 year ago

0.1.497

11 months ago

0.1.376

1 year ago

0.1.496

11 months ago

0.1.375

1 year ago

0.1.491

11 months ago

0.1.370

1 year ago

0.1.490

11 months ago

0.1.493

11 months ago

0.1.372

1 year ago

0.1.492

11 months ago

0.1.371

1 year ago

0.1.389

1 year ago

0.1.388

1 year ago

0.1.385

1 year ago

0.1.384

1 year ago

0.1.387

1 year ago

0.1.386

1 year ago

0.1.381

1 year ago

0.1.380

1 year ago

0.1.383

1 year ago

0.1.382

1 year ago

0.1.309

1 year ago

0.1.429

1 year ago

0.1.308

1 year ago

0.1.437

12 months ago

0.1.316

1 year ago

0.1.436

1 year ago

0.1.315

1 year ago

0.1.439

12 months ago

0.1.318

1 year ago

0.1.438

12 months ago

0.1.317

1 year ago

0.1.433

1 year ago

0.1.312

1 year ago

0.1.432

1 year ago

0.1.311

1 year ago

0.1.435

1 year ago

0.1.314

1 year ago

0.1.434

1 year ago

0.1.313

1 year ago

0.1.431

1 year ago

0.1.310

1 year ago

0.1.430

1 year ago

0.1.319

1 year ago

0.1.448

12 months ago

0.1.327

1 year ago

0.1.447

12 months ago

0.1.326

1 year ago

0.1.329

1 year ago

0.1.449

12 months ago

0.1.328

1 year ago

0.1.444

12 months ago

0.1.323

1 year ago

0.1.443

12 months ago

0.1.322

1 year ago

0.1.446

12 months ago

0.1.325

1 year ago

0.1.445

12 months ago

0.1.324

1 year ago

0.1.440

12 months ago

0.1.442

12 months ago

0.1.321

1 year ago

0.1.441

12 months ago

0.1.320

1 year ago

0.1.459

12 months ago

0.1.338

1 year ago

0.1.458

12 months ago

0.1.337

1 year ago

0.1.339

1 year ago

0.1.455

12 months ago

0.1.334

1 year ago

0.1.454

12 months ago

0.1.333

1 year ago

0.1.457

12 months ago

0.1.336

1 year ago

0.1.456

12 months ago

0.1.335

1 year ago

0.1.451

12 months ago

0.1.330

1 year ago

0.1.450

12 months ago

0.1.453

12 months ago

0.1.332

1 year ago

0.1.452

12 months ago

0.1.331

1 year ago

0.1.349

1 year ago

0.1.469

11 months ago

0.1.348

1 year ago

0.1.466

11 months ago

0.1.345

1 year ago

0.1.465

11 months ago

0.1.344

1 year ago

0.1.468

11 months ago

0.1.347

1 year ago

0.1.467

11 months ago

0.1.346

1 year ago

0.1.462

12 months ago

0.1.341

1 year ago

0.1.461

12 months ago

0.1.340

1 year ago

0.1.464

11 months ago

0.1.343

1 year ago

0.1.463

12 months ago

0.1.342

1 year ago

0.1.460

12 months ago

0.1.404

1 year ago

0.1.403

1 year ago

0.1.406

1 year ago

0.1.405

1 year ago

0.1.400

1 year ago

0.1.402

1 year ago

0.1.401

1 year ago

0.1.408

1 year ago

0.1.407

1 year ago

0.1.409

1 year ago

0.1.415

1 year ago

0.1.414

1 year ago

0.1.417

1 year ago

0.1.416

1 year ago

0.1.411

1 year ago

0.1.410

1 year ago

0.1.413

1 year ago

0.1.412

1 year ago

0.1.419

1 year ago

0.1.418

1 year ago

0.1.426

1 year ago

0.1.305

1 year ago

0.1.425

1 year ago

0.1.304

1 year ago

0.1.428

1 year ago

0.1.307

1 year ago

0.1.427

1 year ago

0.1.306

1 year ago

0.1.422

1 year ago

0.1.301

1 year ago

0.1.421

1 year ago

0.1.300

1 year ago

0.1.424

1 year ago

0.1.303

1 year ago

0.1.423

1 year ago

0.1.302

1 year ago

0.1.420

1 year ago

0.1.390

1 year ago

0.1.399

1 year ago

0.1.396

1 year ago

0.1.395

1 year ago

0.1.398

1 year ago

0.1.397

1 year ago

0.1.392

1 year ago

0.1.391

1 year ago

0.1.394

1 year ago

0.1.393

1 year 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

2 years ago

0.1.201

2 years ago

0.1.203

2 years ago

0.1.200

2 years ago

0.1.199

2 years ago

0.1.198

2 years ago

0.1.197

2 years ago

0.1.194

2 years ago

0.1.196

2 years ago

0.1.195

2 years ago

0.1.190

2 years ago

0.1.192

2 years ago

0.1.191

2 years ago

0.1.193

2 years ago

0.1.187

2 years ago

0.1.186

2 years ago

0.1.189

2 years ago

0.1.188

2 years ago

0.1.183

2 years ago

0.1.185

2 years ago

0.1.184

2 years ago

0.1.179

2 years ago

0.1.181

2 years ago

0.1.180

2 years ago

0.1.182

2 years ago

0.1.176

2 years ago

0.1.175

2 years ago

0.1.178

2 years ago

0.1.177

2 years ago

0.1.172

2 years ago

0.1.174

2 years ago

0.1.173

2 years ago

0.1.169

2 years ago

0.1.170

2 years ago

0.1.171

2 years ago

0.1.168

2 years ago

0.1.167

2 years ago

0.1.166

2 years ago

0.1.165

2 years ago

0.1.164

2 years ago

0.1.161

2 years ago

0.1.160

2 years ago

0.1.163

2 years ago

0.1.162

2 years ago

0.1.159

2 years ago

0.1.158

2 years ago

0.1.157

2 years ago

0.1.156

2 years ago

0.1.155

2 years ago

0.1.154

2 years ago

0.1.149

2 years ago

0.1.148

2 years ago

0.1.153

2 years ago

0.1.150

2 years ago

0.1.152

2 years ago

0.1.151

2 years ago

0.1.147

2 years ago

0.1.146

2 years ago

0.1.143

2 years ago

0.1.145

2 years ago

0.1.144

2 years ago

0.1.142

2 years ago

0.1.141

2 years ago

0.1.140

2 years ago

0.1.139

2 years ago

0.1.136

2 years ago

0.1.138

2 years ago

0.1.137

2 years ago

0.1.129

2 years ago

0.1.135

2 years ago

0.1.132

2 years ago

0.1.131

2 years ago

0.1.134

2 years ago

0.1.133

2 years ago

0.1.130

2 years ago

0.1.128

2 years ago

0.1.127

2 years ago

0.1.126

2 years ago

0.1.125

2 years ago

0.1.118

2 years ago

0.1.117

2 years ago

0.1.119

2 years ago

0.1.116

2 years ago

0.1.124

2 years ago

0.1.121

2 years ago

0.1.120

2 years ago

0.1.122

2 years 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