Integration Guides
Vault-by-vault guides for integrating Plume Vaults mint and redemption flows on EVM chains and Solana.
These guides are organized one vault per page. Use the Actions API path first for app, wallet, and backend transaction-builder integrations. Use the direct contract path only when your integration needs lower-level control over quoting, compliance, approvals, and redemption state.
Outline
Choose a vault guide
| Guide | Slug | Chains | Deposit |
|---|---|---|---|
| nTBILL Integration Plume Treasury Vault | nest-treasury-vault |    |    |
| nALPHA Integration Plume Alpha Vault | nest-alpha-vault | | |
| nBASIS Integration Plume Basis Vault | nest-basis-vault | | |
| nOPAL Integration Plume BlackOpal LiquidStone II Vault | nest-opal-vault | | |
| nCREDIT Integration Plume Credit Vault | nest-credit-vault | | |
| nWISDOM Integration Plume Wisdom Vault | nest-wisdom-vault | | |
| nACRDX Integration Plume ACRDX Vault | nest-acrdx-vault | | |
| nLCRD Integration Plume Liquid Credit Vault | nest-lcrd-vault | | |
| nFXCF Integration Plume FalconX CLO Vault | nest-falconx-clo | | |
| nCLO Integration Plume BlackRock iShares AAA CLO Active ETF Vault | nest-cloa-vault | | |
| nAXI Integration Plume AXI Vault | nest-axi-vault | | |
| FACTOR Integration Plume Factor Vault | plume-factor-vault | | |
| nONYC Integration Plume OnRe Vault | nest-onre-vault | | |
| nPRIME Integration Prime Vault | nprime | | |
Each vault guide includes Deposit, Deposit on behalf, and Redeem sections. The Deposit on behalf section explains the shared caller, original depositor, share receiver, attestation lifecycle and destination transaction for aggregators such as LI.FI.
Recommended integration paths
| Path | Best for | Primary interface | Notes |
|---|---|---|---|
| EVM Actions API | Apps, wallets, custodians, backend transaction builders | https://api.nest.credit/v1/actions | Builds same-chain EVM transaction bundles for supported vault, chain, and asset combinations. |
| Direct EVM contracts | Protocol integrations and advanced backend flows | ERC-20, ComplianceProxy (V2), NestVault | Requires the integrator to handle compliance, quoting, allowance, calldata, simulation, and redemption lifecycle. |
| Solana API (recommended) | Solana wallets and apps | https://api.nest.credit/v1/solana | Builds base64 transactions. Every mint includes keeper and ephemeral event-account signatures; user and applicable sponsor signatures remain. The browser example calls this API directly. |
| Solana Direct onchain | Local instruction construction | LayerZero OFT and Circle CCTP | The user funds event-account rent and signs locally. Keepers handle downstream settlement without a transaction-builder API request. |
The EVM Actions API OpenAPI JSON is available at https://api.nest.credit/v1/actions/docs.
Common implementation rules
- Treat every API amount as a raw integer amount, not a decimal UI amount.
- Use the decimals returned by the API when rendering user-facing amounts.
- Explicitly set
complianceVersion: "v2"on all Actions mint quotes and builds, including vaults with V1 defaults. Require an enabled V2 deployment for the route; never fall back to V1 for deposit on behalf. - Execute returned EVM transactions in order from the specified
sender. - Never assume an approval transaction is present. If allowance is already sufficient, the API can omit it.
- Re-quote close to the time the user signs.
- User-facing apps should keep API simulation enabled.
- For direct EVM integrations, validate the selected vault, chain, asset, and V2 compliance attestation before submitting transactions.
- For Solana, distinguish wallet addresses from token-account addresses, and convert share amounts using the vault's Solana and Plume decimals without silently discarding OFT dust.
- Finalize the Solana transaction message before collecting signatures. Changing its instructions, fee payer, or blockhash invalidates every existing signature, including the mint keeper signature.
- Keepers settle standard Solana redemptions and return USDC automatically. Status API polling is separate from transaction construction; users do not sign a later finish or claim transaction.