{"_id":"@elmntl/voltr-codama-sdk","_rev":"2-a388266b9106112157d3308e95599341","name":"@elmntl/voltr-codama-sdk","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@elmntl/voltr-codama-sdk","version":"1.0.0","keywords":["solana","voltr","vault","sdk","web3","blockchain","defi"],"author":{"name":"Elemental / Voltr"},"license":"MIT","_id":"@elmntl/voltr-codama-sdk@1.0.0","maintainers":[{"name":"capagris","email":"capagris@elemental.fund"}],"homepage":"https://github.com/elementalfund/voltr-codama-sdk#readme","bugs":{"url":"https://github.com/elementalfund/voltr-codama-sdk/issues"},"dist":{"shasum":"12155a1a177efc63009305dd441502f1b0b6bd3b","tarball":"https://registry.npmjs.org/@elmntl/voltr-codama-sdk/-/voltr-codama-sdk-1.0.0.tgz","fileCount":6,"integrity":"sha512-wmeOcwStWLAFCi9uhWGLOnZSdbV7WKKAO9Ibpi4mt+cnuVkhtsUxj15KUrR8gOFCEX7ucHjiJ6hXk+XgFoBT7g==","signatures":[{"sig":"MEUCIEON90a6NbCApQTOJO+mPEd7TDFgeDuZgX3FAXmZ8tBqAiEApjKLFQwETYvXTqWP5tP8xoP7O/rO1QEnhkItiDChaTw=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":1037778},"main":"dist/index.js","types":"dist/index.d.ts","module":"dist/index.mjs","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.js"}},"gitHead":"9c516ee3a9ae8ae263b5f6c1b09e06fa61c6ebe7","scripts":{"build":"tsup index.ts --format cjs,esm --dts --clean","generate":"codama run generate","prepublishOnly":"npm run build"},"_npmUser":{"name":"capagris","email":"capagris@elemental.fund"},"repository":{"url":"git+https://github.com/elementalfund/voltr-codama-sdk.git","type":"git"},"_npmVersion":"10.9.2","description":"TypeScript SDK for Voltr Protocol - Generated with Codama","directories":{},"_nodeVersion":"22.17.1","_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.0.0","codama":"^1.5.0","typescript":"^5.7.0","@solana/kit":"^2.1.0","@types/node":"^22.0.0","@codama/renderers-js":"^1.5.5","@codama/nodes-from-anchor":"^1.3.8"},"peerDependencies":{"@solana/kit":"^2.0.0"},"_npmOperationalInternal":{"tmp":"tmp/voltr-codama-sdk_1.0.0_1768000841662_0.35176110184585974","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2026-01-09T23:20:41.499Z","modified":"2026-01-31T13:52:30.982Z","1.0.0":"2026-01-09T23:20:41.847Z"},"bugs":{"url":"https://github.com/elementalfund/voltr-codama-sdk/issues"},"author":{"name":"Elemental / Voltr"},"license":"MIT","homepage":"https://github.com/elementalfund/voltr-codama-sdk#readme","keywords":["solana","voltr","vault","sdk","web3","blockchain","defi"],"repository":{"url":"git+https://github.com/elementalfund/voltr-codama-sdk.git","type":"git"},"description":"TypeScript SDK for Voltr Protocol - Generated with Codama","maintainers":[{"email":"w7017232@gmail.com","name":"noritake"},{"email":"capagris@elemental.fund","name":"capagris"}],"readme":"# @elmntl/voltr-codama-sdk\n\nTypeScript SDK for interacting with [Voltr Protocol](https://voltr.xyz) vaults on Solana.\n\n> **Note**: This SDK is generated using [Codama](https://github.com/codama-idl/codama) and uses the modern `@solana/kit` (web3.js 2.0) library.\n\n## Installation\n\n```bash\nnpm install @elmntl/voltr-codama-sdk @solana/kit\n```\n\n## Quick Start\n\n```typescript\nimport { createSolanaRpc, address, createKeyPairSignerFromBytes } from \"@solana/kit\";\nimport { getDepositVaultInstructionAsync, fetchVault, VOLTR_VAULT_PROGRAM_ADDRESS } from \"@elmntl/voltr-codama-sdk\";\n\n// Connect to Solana\nconst rpc = createSolanaRpc(\"https://api.mainnet-beta.solana.com\");\n\n// Fetch a vault\nconst vaultAddress = address(\"YOUR_VAULT_ADDRESS\");\nconst vault = await fetchVault(rpc, vaultAddress);\n\n// Create a deposit instruction\nconst depositIx = await getDepositVaultInstructionAsync({\n  userTransferAuthority: signer,\n  vault: vaultAddress,\n  vaultAssetMint: vault.data.asset.mint,\n  assetTokenProgram: vault.data.asset.tokenProgram,\n  amount: 1_000_000n, // Amount in base units\n});\n```\n\n## Available Instructions\n\n### User Instructions\n- `depositVault` - Deposit assets into a vault\n- `requestWithdrawVault` - Request withdrawal from a vault\n- `withdrawVault` - Complete a withdrawal\n- `cancelRequestWithdrawVault` - Cancel a pending withdrawal request\n\n### Admin Instructions\n- `initializeVault` - Initialize a new vault\n- `updateVault` - Update vault parameters\n- `updateVaultConfig` - Update vault configuration\n- `addAdaptor` - Add a strategy adaptor\n- `removeAdaptor` - Remove a strategy adaptor\n- `harvestFee` - Harvest protocol fees\n\n### Strategy Instructions\n- `initializeStrategy` - Initialize a strategy position\n- `depositStrategy` - Deposit into a strategy\n- `withdrawStrategy` - Withdraw from a strategy\n- `directWithdrawStrategy` - Direct withdrawal from strategy\n- `closeStrategy` - Close a strategy position\n\n## Account Types\n\n```typescript\nimport { fetchVault, fetchProtocol } from \"@elmntl/voltr-codama-sdk\";\n\n// Fetch and decode vault account\nconst vault = await fetchVault(rpc, vaultAddress);\nconsole.log(vault.data.asset.mint);\nconsole.log(vault.data.lp.supply);\n\n// Fetch protocol account\nconst protocol = await fetchProtocol(rpc);\n```\n\n## Type Definitions\n\nAll instruction arguments, account data, and custom types are fully typed:\n\n```typescript\nimport type {\n  Vault,\n  VaultConfiguration,\n  FeeConfiguration,\n  DepositVaultInstructionDataArgs,\n} from \"@elmntl/voltr-codama-sdk\";\n```\n\n## Program Address\n\n```typescript\nimport { VOLTR_VAULT_PROGRAM_ADDRESS } from \"@elmntl/voltr-codama-sdk\";\n// vVoLTRjQmtFpiYoegx285Ze4gsLJ8ZxgFKVcuvmG1a8\n```\n\n## Requirements\n\n- Node.js >= 18\n- `@solana/kit` >= 2.0.0\n\n## License\n\nMIT\n\n","readmeFilename":"README.md"}