CLI 使用量
此 repo 具有简单的 CLI ,用于与金库交互( 从此运行) package.json:
这种 CLI 工具需要一个 RPC 节点和 keypair 来签名交易 。 您可以在 .env 文件,或使用 cli 标记( 如 --keypair 财务报告和审定财务报表 --url) (中文(简体) ).
需要的环境变量或标记 :
| 环境变量 | 命令行旗 | 说明 |
|---|---|---|
| 缩写:RPC URL | - url (英语) | 要连接的 RPC 交易节点 |
| 关键部分 | 键盘 | 用于签名交易的 keypair( 文件或 base58) 路径 。 这也可能是分类账文件路径(例如:. usb://ledger/<wallet_id>?key=0/0(中文(简体) ) |
| ENV 主题 | --env 数据 | “ devnet” 或“ mainnet”( 默认为“ minnet ”) |
查看可用命令, 以 --help 在嵌入命令中获取每个命令可用的选项
yarn cli --help
管理器命令
以下命令由Vault Manageers管理. KEYPAIR_PATH 应该是经理的钥匙.
初始化新金库
进入一个新的金库。 这将初始化一个新的金库,并更新你(经理)作为代表,除非 --delegate 已指定.
$ 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
更新默认参数
要更新金库中的段落 :
$ 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
更新边距交易已启用
如果您想用金库的现货差额进行交易, 您必须允许差额交易 :
yarn cli manager-update-margin-trading-enabled --vault-address=<VAULT_ADDRESS> --enabled=<true|false>
经理存款
以经理身份存入金库(DEPOSIT_AMOUNT 在人精度方面,例如5比5 USDC:
yarn cli manager-deposit --vault-address=<VAULT_ADDRESS> --amount=<DEPOSIT_AMOUNT>
管理器退出
作为管理者从金库中撤回请求( E)SHARES 原始精确度:
yarn cli manager-request-withdraw --vault-address=<VAULT_ADDRESS> --amount=<SHARES>
赎回期过后,经理可以完成取出: 1
yarn cli manager-withdraw --vault-address=<VAULT_ADDRESS>
应用利润份额
管理器可以触发利润份额的计算( 这查看所有 VaultDepositors 符合利润份额条件的金库及其分批处理:
yarn cli apply-profit-share-all --vault-address=<VAULT_ADDRESS>
保存者命令
存入金库
允许的跳过
允许的金库需要 管理器 初始化 VaultDepositor 在存款人存款之前的账户.
初始化 a VaultDepositor 账户 AUTHORITY_TO_ALLOW_DEPOSIT 存款:
yarn cli init-vault-depositor --vault-address=<VAULT_ADDRESS> --deposit-authority=<AUTHORITY_TO_ALLOW_DEPOSIT>
无权限的断层
无人允许的金库允许任何人存款. 这个 deposit 指令将初始化 a VaultDepositor 如果不存在的话.
DEPOSIT_AMOUNT (e) 保证金的精度(例如5美元兑5美元).
yarn cli deposit --vault-address=<VAULT_ADDRESS> --deposit-authority=<DEPOSIT_AUTHORITY> --amount=<DEPOSIT_AMOUNT>
或者,你可以通过在 VaultDepositor 直接地址:
yarn cli deposit --vault-depositor-address=<VAULT_DEPOSITOR_ADDRESS> --amount=<DEPOSIT_AMOUNT>
退出金库
请求退出金库 :
yarn cli request-withdraw --vault-address=<VAULT_ADDRESS> --authority=<AUTHORITY> --amount=<WITHDRAW_AMOUNT>
赎回期过后,储户可以完成提款: 1
yarn cli withdraw --vault-address=<VAULT_ADDRESS> --authority=<AUTHORITY>
只查看命令
打印当前状态 Vault数字 :
yarn cli view-vault --vault-address=<VAULT_ADDRESS>
打印当前状态 VaultDepositor数字 :
yarn cli view-vault-depositor --vault-depositor-address=<VAULT_DEPOSITOR_ADDRESS>