SolanaAdapter

Solana Adapter for the Upshift SDK.

Classes

default

Solana Adapter for the Upshift SDK

Example

To access the Solana adapter instance

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

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.

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 this adapter's network has no canonical deployment (e.g. testnet) 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 the canonical program is not deployed on this adapter's network (e.g. testnet). Previously an unmapped network threw a bare TypeError.

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

vaultDeposit()

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

Deposit funds into a Solana Upshift vault.

Parameters

Returns

Promise<any>

vaultRedeem()

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

Redeem vault shares from a Solana Upshift vault.

Parameters

Returns

Promise<any>

Variables

Solana

const Solana: object

Type Declaration