UpshiftDocs
SDKAPI Reference

SuiAdapter

Sui adapter for the Upshift SDK — read-only Ember vault data, TVL, and transforms into the shared IVault shape.

Generated from @augustdigital/sdk 9.3.0

This page is produced from the SDK's TSDoc on every release. To correct it, edit the TSDoc in the SDK repository — an edit here is overwritten by the next release.

Sui Adapter for August SDK

Example

To access the Sui adapter instance

const sdk = new AugustSDK()
sdk.sui.getEmberVaults()

Constructors

Constructor

new default(apiBaseUrl, chainId): default

Parameters

ParameterTypeDefault value
apiBaseUrlstringSuiConstants.EMBER_API_BASE_URL
chainIdnumberSuiConstants.SUI_CHAIN_ID

Returns

default

Accessors

apiBaseUrl

Get Signature

get apiBaseUrl(): string

Returns

string

chainId

Get Signature

get chainId(): number

Returns

number

Methods

calculateUtilization()

calculateUtilization(current, maximum): number

Parameters

ParameterType
currentstring | number
maximumstring | number

Returns

number

convertFromE9()

convertFromE9(value): number

Parameters

ParameterType
valuestring | number

Returns

number

getEmberTVL()

getEmberTVL(limit): Promise<number>

Parameters

ParameterTypeDefault value
limitnumber1

Returns

Promise<number>

getEmberVaults()

getEmberVaults(options?): Promise<IEmberVault[]>

Parameters

ParameterType
options?IFetchEmberVaultsOptions

Returns

Promise<IEmberVault[]>

isSuiAddress()

isSuiAddress(address): boolean

Parameters

ParameterType
addressstring

Returns

boolean

isSuiVault()

isSuiVault(chainId): boolean

Parameters

ParameterType
chainIdnumber

Returns

boolean

transformEmberVaultsToIVaults()

transformEmberVaultsToIVaults(emberVaults): IVault[]

Parameters

ParameterType
emberVaultsIEmberVault[]

Returns

IVault[]

transformEmberVaultToIVault()

transformEmberVaultToIVault(emberVault): IVault

Parameters

ParameterType
emberVaultIEmberVault

Returns

IVault

Variables

Sui

const Sui: object

Type Declaration

NameTypeDefault value
constants__moduleSuiConstants
getters__moduleSuiGetters
transformerobject-
transformer.transformEmberVaultsToIVaults()(emberVaults) => IVault[]-
transformer.transformEmberVaultToIVault()(emberVault) => IVault-
utils__moduleSuiUtils

SolanaAdapter

Solana adapter for the Upshift SDK — Anchor-based vault deposits, redemptions, and balance/state reads over a configurable RPC connection.

StellarAdapter

Stellar adapter for the Upshift SDK — Soroban vault deposits, redemptions, position queries, and signed-transaction submission.

On this page

ConstructorsConstructorAccessorsapiBaseUrlchainIdMethodscalculateUtilization()convertFromE9()getEmberTVL()getEmberVaults()isSuiAddress()isSuiVault()transformEmberVaultsToIVaults()transformEmberVaultToIVault()VariablesSui