{"_id":"@cosmic-lab/phoenix-vaults-sdk","_rev":"7-bddb24cbbf1faa811428686a6bfa5b3e","name":"@cosmic-lab/phoenix-vaults-sdk","dist-tags":{"@cosmic-lab/phoenix-vaults-sdk@0.1.0":"0.1.0","latest":"0.1.7"},"versions":{"0.1.0":{"name":"@cosmic-lab/phoenix-vaults-sdk","version":"0.1.0","_id":"@cosmic-lab/phoenix-vaults-sdk@0.1.0","maintainers":[{"name":"epochsolana","email":"epochsolana@gmail.com"}],"dist":{"shasum":"518608ba4f45eaba0499ba863f0b6aa49122a194","tarball":"https://registry.npmjs.org/@cosmic-lab/phoenix-vaults-sdk/-/phoenix-vaults-sdk-0.1.0.tgz","fileCount":30,"integrity":"sha512-bAhAPiGAPlarP7a5wNIMVPTyaESXff+SgsC6NG+SGDFy+54CRmKEyQXBdHIAVQdp0gbKuDyEFFqzQeK1RX/XLA==","signatures":[{"sig":"MEUCIQDUd0/gl5wxRThS4MEfAlmk2iPj32zvdh3dNEpQiSwPsgIgSjVF3okr1sYqFSvFZDcnWrPbXSRfyJdTIKY+gp3axms=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":224800},"main":"lib/index.js","types":"lib/index.d.ts","engines":{"node":">=16"},"gitHead":"821dfafb4a7f903e32daa97f569ac569d9943765","scripts":{"build":"rm -rf lib && tsc","clean":"rm -rf lib && rm -rf node_modules"},"_npmUser":{"name":"epochsolana","email":"epochsolana@gmail.com"},"_npmVersion":"9.2.0","description":"This repo has a simple CLI for interacting with the vault (run from this `package.json`):","directories":{"lib":"lib"},"resolutions":{"rpc-websockets":"7.10.0","@solana/web3.js":"1.91.6"},"_nodeVersion":"18.8.0","dependencies":{"dotenv":"^16.3.1","commander":"^11.0.0","@solana/web3.js":"1.91.6","@coral-xyz/anchor":"0.28.0","@solana/spl-token":"0.4.8","@cosmic-lab/data-source":"^0.7.4","strict-event-emitter-types":"^2.0.0"},"_hasShrinkwrap":false,"devDependencies":{"ts-node":"^10.9.1","typescript":"^5.1.6","rpc-websockets":"7.10.0"},"_npmOperationalInternal":{"tmp":"tmp/phoenix-vaults-sdk_0.1.0_1726659997186_0.23377684562003465","host":"s3://npm-registry-packages"}},"0.1.1":{"name":"@cosmic-lab/phoenix-vaults-sdk","version":"0.1.1","_id":"@cosmic-lab/phoenix-vaults-sdk@0.1.1","maintainers":[{"name":"epochsolana","email":"epochsolana@gmail.com"}],"dist":{"shasum":"12bafd29898461d5696a3c3a7e9afaa7df6966e9","tarball":"https://registry.npmjs.org/@cosmic-lab/phoenix-vaults-sdk/-/phoenix-vaults-sdk-0.1.1.tgz","fileCount":27,"integrity":"sha512-LihzxhSIkfDtMdbt6JPHZ3s1kr/ik3UkYF2C3/klOTIg2QHE2OyX0gnpeSKit/zOFvyuE4S7+pAbKsODfukvsw==","signatures":[{"sig":"MEQCIAQSDvg/PohtcY4CFLKpM8CjEXLGA2fWtnTPfXsjbXSvAiBcFU7AkD87y00NbFX1vaj5oktG47I8Fg4HcZoKdPW2Eg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":218388},"main":"lib/index.js","types":"lib/index.d.ts","engines":{"node":">=16"},"gitHead":"821dfafb4a7f903e32daa97f569ac569d9943765","scripts":{"build":"rm -rf lib && tsc","clean":"rm -rf lib && rm -rf node_modules"},"_npmUser":{"name":"epochsolana","email":"epochsolana@gmail.com"},"_npmVersion":"9.2.0","description":"This repo has a simple CLI for interacting with the vault (run from this `package.json`):","directories":{"lib":"lib"},"resolutions":{"rpc-websockets":"7.10.0","@solana/web3.js":"1.91.6"},"_nodeVersion":"18.8.0","dependencies":{"dotenv":"^16.3.1","commander":"^11.0.0","@solana/web3.js":"1.91.6","@coral-xyz/anchor":"0.28.0","@solana/spl-token":"0.4.8","strict-event-emitter-types":"^2.0.0"},"_hasShrinkwrap":false,"devDependencies":{"ts-node":"^10.9.1","typescript":"^5.1.6","rpc-websockets":"7.10.0"},"_npmOperationalInternal":{"tmp":"tmp/phoenix-vaults-sdk_0.1.1_1726660876283_0.5679724871083371","host":"s3://npm-registry-packages"}},"0.1.2":{"name":"@cosmic-lab/phoenix-vaults-sdk","version":"0.1.2","_id":"@cosmic-lab/phoenix-vaults-sdk@0.1.2","maintainers":[{"name":"epochsolana","email":"epochsolana@gmail.com"}],"dist":{"shasum":"150673a6b10f8e91a28b8bf6a7052ac595613150","tarball":"https://registry.npmjs.org/@cosmic-lab/phoenix-vaults-sdk/-/phoenix-vaults-sdk-0.1.2.tgz","fileCount":27,"integrity":"sha512-80sxFnQQZsvDiqpLTQ2jLSEp/k1XjEePoqL4nm0JxynSGBIcbmbyw0H++WKKRTkHtJcTGQiO7AtFbkE3nkVP3Q==","signatures":[{"sig":"MEYCIQD6Gwn76Tfu+a0RvtRrhFd1yhxhhh/uxjo7hLxNFwL/AQIhAO/QGqAtYpeGvKgIefkTlePCHWck9K/AZ/bE3rVnTPgt","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":221227},"main":"lib/index.js","types":"lib/index.d.ts","engines":{"node":">=16"},"gitHead":"19a4cbf0e8e3ba154afae0f8312c3f8c68f90245","scripts":{"build":"rm -rf lib && tsc","clean":"rm -rf lib && rm -rf node_modules"},"_npmUser":{"name":"epochsolana","email":"epochsolana@gmail.com"},"_npmVersion":"9.2.0","description":"This repo has a simple CLI for interacting with the vault (run from this `package.json`):","directories":{"lib":"lib"},"resolutions":{"rpc-websockets":"7.10.0","@solana/web3.js":"1.91.6"},"_nodeVersion":"18.8.0","dependencies":{"dotenv":"^16.3.1","commander":"^11.0.0","@solana/web3.js":"1.91.6","@coral-xyz/anchor":"0.28.0","@solana/spl-token":"0.4.8","strict-event-emitter-types":"^2.0.0"},"_hasShrinkwrap":false,"devDependencies":{"ts-node":"^10.9.1","typescript":"^5.1.6","rpc-websockets":"7.10.0"},"_npmOperationalInternal":{"tmp":"tmp/phoenix-vaults-sdk_0.1.2_1726784198125_0.7280604331305327","host":"s3://npm-registry-packages"}},"0.1.3":{"name":"@cosmic-lab/phoenix-vaults-sdk","version":"0.1.3","_id":"@cosmic-lab/phoenix-vaults-sdk@0.1.3","maintainers":[{"name":"epochsolana","email":"epochsolana@gmail.com"}],"dist":{"shasum":"c5a59b5144456bb90b22475e655ba208ffc6ada7","tarball":"https://registry.npmjs.org/@cosmic-lab/phoenix-vaults-sdk/-/phoenix-vaults-sdk-0.1.3.tgz","fileCount":27,"integrity":"sha512-onq2lLafj01r6lUt3jiGqmmRJ8qSCO4o7cjIYlK705qim/Ny0K6QwqhE3+zsgKTqpLdxME+Sn+63V8xWxUjwEg==","signatures":[{"sig":"MEUCIQDcwKtUPR7AhoesBP8fHFtzNWDuhgxeYK4HK2Uv5OR58gIgN4MKae3SLJbXEUBGpklJD83LUZrcvp/OYWBOcFp8hwA=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":222454},"main":"lib/index.js","types":"lib/index.d.ts","engines":{"node":">=16"},"gitHead":"20e561d873b0b23deb517b1df60b25e7a0acef18","scripts":{"build":"rm -rf lib && tsc","clean":"rm -rf lib && rm -rf node_modules"},"_npmUser":{"name":"epochsolana","email":"epochsolana@gmail.com"},"_npmVersion":"9.2.0","description":"This repo has a simple CLI for interacting with the vault (run from this `package.json`):","directories":{"lib":"lib"},"resolutions":{"rpc-websockets":"7.10.0","@solana/web3.js":"1.91.6"},"_nodeVersion":"18.8.0","dependencies":{"dotenv":"^16.3.1","commander":"^11.0.0","@solana/web3.js":"1.91.6","@coral-xyz/anchor":"0.28.0","@solana/spl-token":"0.4.8","strict-event-emitter-types":"^2.0.0"},"_hasShrinkwrap":false,"devDependencies":{"ts-node":"^10.9.1","typescript":"^5.1.6","rpc-websockets":"7.10.0"},"_npmOperationalInternal":{"tmp":"tmp/phoenix-vaults-sdk_0.1.3_1726930847251_0.7330291007305934","host":"s3://npm-registry-packages"}},"0.1.4":{"name":"@cosmic-lab/phoenix-vaults-sdk","version":"0.1.4","_id":"@cosmic-lab/phoenix-vaults-sdk@0.1.4","maintainers":[{"name":"epochsolana","email":"epochsolana@gmail.com"}],"dist":{"shasum":"fff026504e27b86c2c8b6c88003317bbc5e4f390","tarball":"https://registry.npmjs.org/@cosmic-lab/phoenix-vaults-sdk/-/phoenix-vaults-sdk-0.1.4.tgz","fileCount":27,"integrity":"sha512-Frqzwu1GIv38sj7beL3eqVBvWhLnwq7wNUJWszdUrvt4ofo2Nr7XHLYOpu6l4rPKnyG1jJARGxoaR86twPWxuA==","signatures":[{"sig":"MEUCIQCBFHWlZj/ecqeqPsrySTQEqbGknP0Qi4XpLt+tIaFpHwIgVtlCNlJmryaFVhIIFgqOjoo40zJVtQAC6gKHJ008Rdo=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":238245},"main":"lib/index.js","types":"lib/index.d.ts","engines":{"node":">=16"},"gitHead":"f3f80a934f67d565c0ddf3b90de5c60975c28476","scripts":{"build":"rm -rf lib && tsc","clean":"rm -rf lib && rm -rf node_modules"},"_npmUser":{"name":"epochsolana","email":"epochsolana@gmail.com"},"_npmVersion":"9.2.0","description":"This repo has a simple CLI for interacting with the vault (run from this `package.json`):","directories":{"lib":"lib"},"resolutions":{"rpc-websockets":"7.10.0","@solana/web3.js":"1.91.6"},"_nodeVersion":"18.8.0","dependencies":{"dotenv":"^16.3.1","commander":"^11.0.0","@solana/web3.js":"1.91.6","@coral-xyz/anchor":"0.28.0","@solana/spl-token":"0.4.8","strict-event-emitter-types":"^2.0.0"},"_hasShrinkwrap":false,"devDependencies":{"ts-node":"^10.9.1","typescript":"^5.1.6","rpc-websockets":"7.10.0"},"_npmOperationalInternal":{"tmp":"tmp/phoenix-vaults-sdk_0.1.4_1727820041076_0.6731800578250908","host":"s3://npm-registry-packages"}},"0.1.5":{"name":"@cosmic-lab/phoenix-vaults-sdk","version":"0.1.5","_id":"@cosmic-lab/phoenix-vaults-sdk@0.1.5","maintainers":[{"name":"epochsolana","email":"epochsolana@gmail.com"}],"dist":{"shasum":"40351b97056f21c4ada29af602fe27b4c3bfc04b","tarball":"https://registry.npmjs.org/@cosmic-lab/phoenix-vaults-sdk/-/phoenix-vaults-sdk-0.1.5.tgz","fileCount":27,"integrity":"sha512-8t7kZ/9iAnE/guqkaG96hTVOF9+WKPWFHtThSWpXxYyoXjfGf8JgOGr60h4zfd+WhF3V7QSmdGHhShGZNedwhQ==","signatures":[{"sig":"MEUCIQD6D0YAd6WtFntkz1p9lVQDkgg4N5SCkMIBGeGtFDDopQIgGc+3YWMcAp9V3hY1QlYPfYyfjakfveiTuTNjlj7yXyc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":238245},"main":"lib/index.js","types":"lib/index.d.ts","engines":{"node":">=16"},"gitHead":"ff5042be6998823b04e6e84c97a2367e5f5cd354","scripts":{"build":"rm -rf lib && tsc","clean":"rm -rf lib && rm -rf node_modules"},"_npmUser":{"name":"epochsolana","email":"epochsolana@gmail.com"},"_npmVersion":"9.2.0","description":"This repo has a simple CLI for interacting with the vault (run from this `package.json`):","directories":{"lib":"lib"},"resolutions":{"rpc-websockets":"7.10.0","@solana/web3.js":"1.91.6"},"_nodeVersion":"18.8.0","dependencies":{"dotenv":"^16.3.1","commander":"^11.0.0","@solana/web3.js":"1.91.6","@coral-xyz/anchor":"0.28.0","@solana/spl-token":"0.4.8","strict-event-emitter-types":"^2.0.0"},"_hasShrinkwrap":false,"devDependencies":{"ts-node":"^10.9.1","typescript":"^5.1.6","rpc-websockets":"7.10.0"},"_npmOperationalInternal":{"tmp":"tmp/phoenix-vaults-sdk_0.1.5_1727821756531_0.5677222795473187","host":"s3://npm-registry-packages"}},"0.1.6":{"name":"@cosmic-lab/phoenix-vaults-sdk","version":"0.1.6","_id":"@cosmic-lab/phoenix-vaults-sdk@0.1.6","maintainers":[{"name":"epochsolana","email":"epochsolana@gmail.com"}],"dist":{"shasum":"97a0f969a0bca899295ef6c04cdb76b945e2ab2f","tarball":"https://registry.npmjs.org/@cosmic-lab/phoenix-vaults-sdk/-/phoenix-vaults-sdk-0.1.6.tgz","fileCount":27,"integrity":"sha512-CaXYkMNVuiypNXQ6pL9prtba4AIiGAIvPwcX9hJ2HEKkjUvJZ5B4YDmw6Rn65BxRojkcHqlbxHMUIa+Jo3CCiw==","signatures":[{"sig":"MEUCIDpUZNQTvJAq6BBAqf9c9duWX2dE91GowwULWACS3qrfAiEA+dFuGi3V2vWFu76wJuH+06JehX4Bjug8rgmr+HDyo6Q=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":238245},"main":"lib/index.js","types":"lib/index.d.ts","engines":{"node":">=16"},"gitHead":"635d39927fdb206e5bf302e9735fe91ec58d8e41","scripts":{"build":"rm -rf lib && tsc","clean":"rm -rf lib && rm -rf node_modules"},"_npmUser":{"name":"epochsolana","email":"epochsolana@gmail.com"},"_npmVersion":"10.8.3","description":"This repo has a simple CLI for interacting with the vault (run from this `package.json`):","directories":{"lib":"lib"},"resolutions":{"rpc-websockets":"7.10.0","@solana/web3.js":"1.91.6"},"_nodeVersion":"22.9.0","dependencies":{"dotenv":"^16.3.1","commander":"^11.0.0","@solana/web3.js":"1.91.6","@coral-xyz/anchor":"0.28.0","@solana/spl-token":"0.4.8","strict-event-emitter-types":"^2.0.0"},"_hasShrinkwrap":false,"devDependencies":{"ts-node":"^10.9.1","typescript":"^5.1.6","rpc-websockets":"7.10.0"},"_npmOperationalInternal":{"tmp":"tmp/phoenix-vaults-sdk_0.1.6_1727894904691_0.2989652712375288","host":"s3://npm-registry-packages"}},"0.1.7":{"name":"@cosmic-lab/phoenix-vaults-sdk","version":"0.1.7","main":"lib/index.js","types":"lib/index.d.ts","directories":{"lib":"lib"},"scripts":{"clean":"rm -rf lib && rm -rf node_modules","build":"rm -rf lib && tsc"},"dependencies":{"@coral-xyz/anchor":"0.28.0","@solana/spl-token":"0.4.8","@solana/web3.js":"1.91.6","commander":"^11.0.0","dotenv":"^16.3.1","strict-event-emitter-types":"^2.0.0"},"devDependencies":{"rpc-websockets":"7.10.0","ts-node":"^10.9.1","typescript":"^5.1.6"},"resolutions":{"rpc-websockets":"7.10.0","@solana/web3.js":"1.91.6"},"engines":{"node":">=16"},"_id":"@cosmic-lab/phoenix-vaults-sdk@0.1.7","gitHead":"e2105fad289901e78ab4840623a948b4a925038e","description":"This repo has a simple CLI for interacting with the vault (run from this `package.json`):","_nodeVersion":"22.9.0","_npmVersion":"10.8.3","dist":{"integrity":"sha512-+ANofwdRemoupMhdg/BBqI4AmPasnqO+vzLBf8XgB9sZAksVpcJFjH7ME56QqL2Pj3wrggNlLfNLfTSmeQ4+zw==","shasum":"616829b0b88c86bba578a49464617c990b1bc15f","tarball":"https://registry.npmjs.org/@cosmic-lab/phoenix-vaults-sdk/-/phoenix-vaults-sdk-0.1.7.tgz","fileCount":27,"unpackedSize":325446,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCXe0HbzAopsf4w4YL+CqMkb0fb/ww0q+tHdvp1DSjr+gIhAPQlpAoNcgkYHgnjw5lpGtiWEhSnbGkcMdTPO/Z8nn+E"}]},"_npmUser":{"name":"epochsolana","email":"epochsolana@gmail.com"},"maintainers":[{"name":"epochsolana","email":"epochsolana@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/phoenix-vaults-sdk_0.1.7_1729804607851_0.5999973588050331"},"_hasShrinkwrap":false}},"time":{"created":"2024-09-18T11:46:37.089Z","modified":"2024-10-24T21:16:48.241Z","0.1.0":"2024-09-18T11:46:37.326Z","0.1.1":"2024-09-18T12:01:16.525Z","0.1.2":"2024-09-19T22:16:38.319Z","0.1.3":"2024-09-21T15:00:47.490Z","0.1.4":"2024-10-01T22:00:41.274Z","0.1.5":"2024-10-01T22:29:16.743Z","0.1.6":"2024-10-02T18:48:24.913Z","0.1.7":"2024-10-24T21:16:48.051Z"},"description":"This repo has a simple CLI for interacting with the vault (run from this `package.json`):","maintainers":[{"name":"epochsolana","email":"epochsolana@gmail.com"}],"readme":"# CLI Usage\n\nThis repo has a simple CLI for interacting with the vault (run from this `package.json`):\n\nThis 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.\n\nRequired Environment Variables or Flags:\n\nEnvironment Variable| command line flag | Description\n--------------------|-------------------|------------\nRPC_URL             | --url             | The RPC node to connect to for transactions\nKEYPAIR_PATH        | --keypair         | Path to keypair to sign transactions\n\n\nView available commands, run with `--help` in nested commands to get available options for each command\n```\nyarn cli --help\n```\n\n\nInit a new vault. This will initialize a new vault and update you (the manager) as the delegate, unless `--delegate` is specified.\n```\n$ yarn cli init-vault --help\nUsage: cli init-vault [options]\n\nInitialize a new vault\n\nOptions:\n  -n, --name <string>               Name of the vault to create\n  -i, --market-index <number>       Spot market index to accept for deposits (default 0 == USDC) (default: \"0\")\n  -r, --redeem-period <number>      The period (in seconds) depositors must wait after requesting a withdraw (default: 7 days) (default: \"604800\")\n  -x, --max-tokens <number>         The max number of spot marketIndex tokens the vault can accept (default 0 == unlimited) (default: \"0\")\n  -m, --management-fee <percent>    The annualized management fee to charge depositors (default: \"0\")\n  -s, --profit-share <percent>      The percentage of profits charged by manager (default: \"0\")\n  -p, --permissioned                Provide this flag to make the vault permissioned, vault-depositors will need to be initialized by the manager\n                                    (default: false)\n  -a, --min-deposit-amount <number  The minimum token amount allowed to deposit (default: \"0\")\n  -d, --delegate <publicKey>        The address to make the delegate of the vault\n  -h, --help                        display help for command\n```\n\nTo update params in a vault:\n```\n$ yarn cli manager-update-vault --help\nUsage: cli manager-update-vault [options]\n\nUpdate vault params for a manager\n\nOptions:\n  --vault-address <address>         Address of the vault to update\n  -r, --redeem-period <number>      The new redeem period (can only be lowered)\n  -x, --max-tokens <number>         The max tokens the vault can accept\n  -a, --min-deposit-amount <number  The minimum token amount allowed to deposit\n  -m, --management-fee <percent>    The new management fee (can only be lowered)\n  -s, --profit-share <percent>      The new profit share percentage (can only be lowered)\n  -p, --permissioned <boolean>      Set the vault as permissioned (true) or open (false) (default: false)\n  -h, --help                        display help for command\n```\n\nMake a deposit into a vault (as a manager, `DEPOSIT_AMOUNT` in human precision):\n```\nyarn cli manager-deposit --vault-address=<VAULT_ADDRESS> --amount=<DEPOSIT_AMOUNT>\n```\n\nMake a withdraw request from a vault (as a manager, `SHARES` in raw precision):\n```\nyarn cli manager-request-withdraw --vault-address=<VAULT_ADDRESS> --amount=<SHARES>\n```\n\nManager can trigger a profit share calculation (this looks up all `VaultDepositors` for a vault eligible for profit share and batch processes them):\n```\nyarn cli apply-profit-share-all --vault-address=<VAULT_ADDRESS>\n```\n\n\nFor permissioned vaults, initialize a `VaultDepositor` for someone to deposit.\n```\nyarn cli init-vault-depositor --vault-address=<VAULT_ADDRESS> --deposit-authority=<AUTHORITY_TO_ALLOW_DEPOSIT>\n```\nThen send them the `VAULT_DEPOSITOR_ADDRESS`\n\n\nMake a deposit into a vault (as a non-manager, `DEPOSIT_AMOUNT` in human precision):\n```\nyarn cli deposit --vault-depositor-address=<VAULT_DEPOSITOR_ADDRESS> --amount=<DEPOSIT_AMOUNT>\n```\n\n\nTo print out the current state of a `Vault` or `VaultDepositor`:\n```\nyarn cli view-vault --vault-address=<VAULT_ADDRESS>\n\nyarn cli view-vault-depositor --vault-depositor-address=<VAULT_DEPOSITOR_ADDRESS>\n```\n","readmeFilename":"README.md"}