SolanaAdapter

SDK Reference / SolanaAdapter

SolanaAdapter

Solana Adapter for August SDK

Classes

default

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): default

Parameters

Parameter	Type	Default value
endpoint	`https://${string}`	undefined
network	ISolanaNetwork	SolanaUtils.fallbackNetwork

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

Parameter	Type
publicKey	string | PublicKey
shareMint	string | PublicKey

Returns

Promise<number>

fetchUserTokenBalance()

fetchUserTokenBalance(publicKey, depositMint): Promise<any>

Parameters

Parameter	Type
publicKey	string | PublicKey
depositMint	string | PublicKey

Returns

Promise<any>

getProgram()

getProgram(programIdl): Program<any>

Parameters

Parameter	Type
programIdl	any

Returns

Program<any>

getProgramId()

getProgramId(type): string

Parameters

Parameter	Type
type	"vault"

Returns

string

getToken()

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

Parameters

Parameter	Type
mintAddress	string | PublicKey

Returns

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

getTokenSymbol()

getTokenSymbol(mintAddress): Promise<string>

Parameters

Parameter	Type
mintAddress	string | PublicKey

Returns

Promise<string>

getVaultState()

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

Parameters

Parameter	Type
vaultProgramId	string | PublicKey
idl	any

Returns

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

getVaultStateReadOnly()

getVaultStateReadOnly(vaultProgramId, idl): Promise<{ depositMintDecimals: number; vaultState: unknown; vaultToken: ISolanaTokenBalance; }>

Parameters

Parameter	Type
vaultProgramId	string | PublicKey
idl	any

Returns

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

setWalletProvider()

setWalletProvider(_publicKey, signTransaction): void

Parameters

Parameter	Type
_publicKey	string | PublicKey
signTransaction	<T>(transaction) => Promise<T>

Returns

void

vaultDeposit()

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

Parameters

Parameter	Type
vaultProgramId	string | PublicKey
idl	any
publicKey	string | PublicKey
depositAmount	number
sendTransaction	(transaction, connection, options?) => Promise<string>

Returns

Promise<any>

vaultRedeem()

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

Parameters

Parameter	Type
vaultProgramId	string | PublicKey
idl	any
publicKey	string | PublicKey
redeemShares	number
sendTransaction	(transaction, connection, options?) => Promise<string>

Returns

Promise<any>

Variables

Solana

const Solana: object

Type Declaration

Name	Type	Default value
actions	__module	SolanaActions
constants	__module	SolanaConstants
getters	__module	SolanaGetters
utils	object	SolanaUtils
utils.deriveShareMintPda()	(vaultProgramId) => PublicKey	-
utils.deriveVaultStatePda()	(vaultProgramId) => PublicKey	-
utils.deriveVaultTokenAtaPda()	(vaultProgramId, depositMint) => PublicKey	-
utils.fallbackDecimals	number	-
utils.fallbackNetwork	ISolanaNetwork	-
utils.fetchUserShareBalance()	(__namedParameters) => Promise<number>	-
utils.fetchUserTokenBalance()	(__namedParameters) => Promise<any>	-
utils.getBestRpcEndpoint()	(__namedParameters) => Promise<"http://127.0.0.1:8899" | `https://${string}`>	-
utils.getExplorerLink()	(__namedParameters) => string	-
utils.getProgram()	(__namedParameters) => Program<any>	-
utils.getProvider()	(__namedParameters) => AnchorProvider	-
utils.getReadOnlyProvider()	(__namedParameters) => AnchorProvider	-
utils.getToken()	(__namedParameters) => Promise<{ address: string; decimals: number; image: string; name: string; symbol: string; }>	-
utils.getTokenSymbol()	(__namedParameters) => Promise<string>	-
utils.getVaultMints()	(__namedParameters) => Promise<{ depositMint: string; shareMint: string; }>	-
utils.getVaultState()	(__namedParameters) => Promise<{ depositMintDecimals: number; vaultState: unknown; vaultToken: ISolanaTokenBalance; }>	-
utils.getVaultStateReadOnly()	(__namedParameters) => Promise<{ depositMintDecimals: number; vaultState: unknown; vaultToken: ISolanaTokenBalance; }>	-
utils.isSolana()	(signature) => boolean	-
utils.isSolanaAddress()	(address) => boolean	-
utils.programIds	object	-
utils.programIds.devnet	object	-
utils.programIds.devnet.vault	string	'7B8n9vL51b6ibqRAd1adZsi3x3kxtq5NZaondh22Vkyq'
utils.programIds.localnet	object	-
utils.programIds.localnet.vault	string	'7B8n9vL51b6ibqRAd1adZsi3x3kxtq5NZaondh22Vkyq'
utils.programIds.mainnet-beta	object	-
utils.programIds.mainnet-beta.vault	string	'7B8n9vL51b6ibqRAd1adZsi3x3kxtq5NZaondh22Vkyq'
utils.programIds.testnet	object	-
utils.programIds.testnet.vault	string	'7B8n9vL51b6ibqRAd1adZsi3x3kxtq5NZaondh22Vkyq'