Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.meteora.ag/llms.txt

Use this file to discover all available pages before exploring further.

This guide provides instructions on how to get started with building on Meteora’s Dynamic Vault program using the Dynamic Vault TypeScript SDK. Before you begin, here are some important resources:

Typescript SDK

Meteora Dynamic Vault Typescript SDK

Dynamic Vault NPM Package

Meteora Dynamic Vault NPM Package

​
Installation

To use the SDK in your project, install it using your preferred package manager: 
npm install @meteora-ag/vault-sdk @solana/web3.js @solana/spl-token-registry

​
Initialization

Once installed, you can initialize the SDK in your TypeScript/JavaScript project like this: 
import { Connection } from "@solana/web3.js";
import VaultImpl from '@meteora-ag/vault-sdk';
import { StaticTokenListResolutionStrategy, TokenInfo } from "@solana/spl-token-registry";

// Initialize a connection to the Solana network (e.g., Mainnet)
const connection = new Connection("https://api.mainnet-beta.solana.com");

// Retrieve the token info for the vault (example: SOL)
const tokenMap = new StaticTokenListResolutionStrategy().resolve();
const SOL_TOKEN_INFO = tokenMap.find(token => token.symbol === 'SOL') as TokenInfo;

// Getting a Vault Implementation instance (SOL)
const vault: VaultImpl = await VaultImpl.create(
    connection,
    SOL_TOKEN_INFO,
    {
        cluster: 'mainnet-beta'
    }
);

​
Testing the SDK (for contributors)

If you have cloned the SDK repository and want to run the built-in tests: 
# Install dependencies
cd ts-client
bun install

# Run tests
bun test

​
Development Resources

​
Faucets

Devnet Faucet

When working on devnet, you might need test tokens. Here is a helpful faucet.