SolanaAdapter

Solana Adapter for August SDK

Example

To access the Solana adapter instance

const sdk = new AugustSDK()
sdk.solana.getVaultState()

Constructors

Constructor

new default(endpoint, network?, commitment?): default

Parameters

Returns

default

Accessors

connection

Get Signature

get connection(): Connection

Returns

Connection

endpoint

Get Signature

get endpoint(): `https://${string}`

Returns

`https://${string}`

network

Get Signature

get network(): ISolanaNetwork

Returns

ISolanaNetwork

provider

Get Signature

get provider(): AnchorProvider

Returns

AnchorProvider

Methods

fetchUserShareBalance()

fetchUserShareBalance(publicKey, shareMint): Promise<number>

Parameters

Returns

Promise<number>

fetchUserShareBalanceRaw()

fetchUserShareBalanceRaw(publicKey, shareMint): Promise<{ amount: string; decimals: number; }>

BigInt-safe variant of fetchUserShareBalance. Returns the raw u64 amount (as a base-units string) plus the mint's decimals (or null when the scale can't be determined — see Returns), so the caller can produce a correct INormalizedNumber without losing precision.

Prefer this anywhere the result feeds BigInt math — positions, max- actions, redemption sizing, allowance checks. fetchUserShareBalance returns a JS-number uiAmount which silently encodes against 18 decimals when passed through toNormalizedBn(value) without an explicit decimals argument; that's exactly how the jitoSOL "missing position" regression manifested.

RPC cost: 1 getParsedTokenAccountsByOwner call. Worst case ~150ms on a healthy mainnet endpoint.

Parameters

Returns

Promise<{ amount: string; decimals: number; }>

{ amount, decimals }. Three observable shapes:

• { amount: '<u64>', decimals: <number> } — token account exists.
• { amount: '0', decimals: null } — no token account for this mint under this wallet, OR tokenAmount was missing from the response, OR publicKey/shareMint was not supplied. Distinguishable from a genuine zero-balance account (decimals would be set there).
• { amount: '0', decimals: null } — RPC threw (error is logged).

decimals === null means "we could not determine the scale" — callers that need an INormalizedNumber must fall back to a known decimals value (typically the deposit mint's decimals from backend metadata) before normalizing. Never throws.

fetchUserTokenBalance()

fetchUserTokenBalance(publicKey, depositMint): Promise<string>

Parameters

Returns

Promise<string>

getProgram()

getProgram(programIdl?, programId?): Program<any>

Build an Anchor Program bound to this adapter's provider and network.

The program id is resolved as: explicit programId → the address carried by a custom programIdl → the canonical deployment for this adapter's network. A copy of the SDK's bundled vaultIdl defers to the network default (its embedded address is a build stamp, not network-aware), so forwarding it on devnet never silently targets the mainnet program.

An IDL whose metadata.name is august_withdrawal_queue resolves against the withdrawal queue program's network default instead of the vault's.

Parameters

Returns

Program<any>

An Anchor Program for the resolved program id. No RPC is made — construction is offline.

Throws

AugustValidationError if no program id can be resolved because the program has no canonical deployment on this adapter's network (neither program on testnet; the withdrawal queue not yet on mainnet-beta) and neither programId nor a custom IDL address was supplied.

Example

// canonical program on the adapter's network
const program = sdk.solana.getProgram();

// a different deployment, same interface
const legacy = sdk.solana.getProgram(vaultIdl, '7B8n9vL51b6ibqRAd1adZsi3x3kxtq5NZaondh22Vkyq');

getProgramId()

getProgramId(type): string

Canonical program id for a program type on this adapter's network.

Parameters

Returns

string

The base58 program id.

Throws

AugustValidationError if type is not one of the two program types, or the program is not deployed on this adapter's network: neither program on testnet, and 'withdrawalQueue' not yet on mainnet-beta.

Example

const queueProgram = adapter.getProgramId('withdrawalQueue');

getToken()

getToken(mintAddress): Promise<{ address: string; decimals: number; image: string; name: string; symbol: string; }>

Parameters

Returns

Promise<{ address: string; decimals: number; image: string; name: string; symbol: string; }>

getTokenSymbol()

getTokenSymbol(mintAddress): Promise<string>

Parameters

Returns

Promise<string>

getVaultState()

getVaultState(vaultProgramId, idl, vaultAddress?): Promise<{ depositMintDecimals: number; vaultState: unknown; }>

Parameters

Returns

Promise<{ depositMintDecimals: number; vaultState: unknown; }>

getVaultStateReadOnly()

getVaultStateReadOnly(vaultProgramId, idl, vaultAddress?): Promise<{ depositMintDecimals: number; vaultState: ISolanaVaultState; }>

Parameters

Returns

Promise<{ depositMintDecimals: number; vaultState: ISolanaVaultState; }>

setWalletProvider()

setWalletProvider(_publicKey, signTransaction): void

Parameters

Returns

void

vaultCancelRedeemRequest()

vaultCancelRedeemRequest(params): Promise<string>

Cancel a pending withdrawal request, returning its shares to the holder.

Allowed at any time while the request exists: during the cooldown, after it, past the fulfillment window, and while the vault is paused. Only the holder who made the request may cancel it. Signs through the provider's wallet; the request's rent is refunded to the holder.

RPC: three reads, then the send.

Parameters

Returns

Promise<string>

The confirmed transaction's signature.

Throws

AugustValidationError for a missing request, or one this wallet did not make, before signing.

Throws

AugustSDKError when the transaction fails.

Example

await sdk.solana.vaultCancelRedeemRequest({ wallet: wallet.publicKey, request });

vaultDeposit()

vaultDeposit(vaultProgramId, idl, publicKey, depositAmount, sendTransaction?, vaultAddress?, options?): Promise<any>

Deposit funds into a Solana August vault.

Parameters

Returns

Promise<any>

vaultRedeem()

vaultRedeem(vaultProgramId, idl, publicKey, redeemShares, sendTransaction?, vaultAddress?, options?): Promise<any>

Redeem vault shares from a Solana August vault.

Parameters

Returns

Promise<any>

The confirmed transaction's signature.

Throws

AugustValidationError for bad input, for a queued vault without options.request, or for a request the wallet cannot claim yet.

Example

// A vault with a withdrawal queue: claim a ready request.
const { pendingRedemptions } = await sdk.getVaultAvailableRedemptions({ vault, wallet });
await sdk.solana.vaultRedeem(programId, vaultIdl, wallet, 0n, undefined, undefined, {
  request: pendingRedemptions[0].id,
});

vaultRequestRedeem()

vaultRequestRedeem(params): Promise<ISolanaRequestRedeemResult>

Request a withdrawal from a Solana vault that has a withdrawal queue.

With a queue attached, a vault's shares cannot be redeemed directly: the holder escrows them in a request, waits out the queue's cooldown, then claims with SolanaAdapter.vaultRedeem and options.request, or anyone the request permits (a keeper, by default) claims for them. The payout is priced when the request is claimed, not now, but never below the floor set here: by default the current net quote lowered by 50 bps, so a fee rise or mark-down in between makes the claim fail rather than pay less. A pending request can be cancelled at any time with SolanaAdapter.vaultCancelRedeemRequest, which returns the shares.

Signs through the provider's wallet and submits one transaction, which also creates the recipient's deposit-token account when it has none. The holder pays the request account's rent, refunded when it is claimed or cancelled, plus rent for any account created. Use getVaultAvailableRedemptions to list requests and see when they can be claimed.

RPC: three to four reads, then the send.

Parameters

Returns

Promise<ISolanaRequestRedeemResult>

The signature, the request's address (pass it as request to claim or cancel) and its id.

Throws

AugustValidationError for bad input, a vault without an attached queue, a frozen account or too few shares, before signing.

Throws

AugustSDKError when the transaction fails.

Example

const { request } = await sdk.solana.vaultRequestRedeem({
  vault: vaultStateAddress,
  wallet: wallet.publicKey,
  amount: 10, // shares, UI units
});
// ...once the cooldown has run:
await sdk.solana.vaultRedeem(programId, vaultIdl, wallet.publicKey, 0n, undefined, undefined, { request });

Interfaces

ISolanaCancelRedeemRequestParams

Input to SolanaAdapter.vaultCancelRedeemRequest.

Properties

ISolanaDepositOptions

Slippage protection for SolanaAdapter.vaultDeposit.

The SDK quotes the shares a deposit should mint from the vault's current state and passes a floor to the program's deposit_checked instruction, which reverts with SlippageExceeded if the share price moves past it before execution.

Properties

ISolanaRedeemOptions

Slippage protection for SolanaAdapter.vaultRedeem.

The floor is measured net of the withdrawal fee, i.e. on what the wallet actually receives, matching the program's redeem_checked.

Properties

ISolanaRequestRedeemParams

Input to SolanaAdapter.vaultRequestRedeem.

Properties

ISolanaRequestRedeemResult

What SolanaAdapter.vaultRequestRedeem returns.

Properties

Variables

Solana

const Solana: object

Type Declaration