SuiAdapter

SDK Reference / SuiAdapter

SuiAdapter

Sui Adapter for August SDK

Classes

default

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

Parameter	Type	Default value
apiBaseUrl	string	SuiConstants.EMBER_API_BASE_URL
chainId	number	SuiConstants.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

Parameter	Type
current	string | number
maximum	string | number

Returns

number

convertFromE9()

convertFromE9(value): number

Parameters

Parameter	Type
value	string | number

Returns

number

getEmberTVL()

getEmberTVL(limit): Promise<number>

Parameters

Parameter	Type	Default value
limit	number	1

Returns

Promise<number>

getEmberVaults()

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

Parameters

Parameter	Type
options?	IFetchEmberVaultsOptions

Returns

Promise<IEmberVault[]>

isSuiAddress()

isSuiAddress(address): boolean

Parameters

Parameter	Type
address	string

Returns

boolean

isSuiVault()

isSuiVault(chainId): boolean

Parameters

Parameter	Type
chainId	number

Returns

boolean

transformEmberVaultsToIVaults()

transformEmberVaultsToIVaults(emberVaults): IVault[]

Parameters

Parameter	Type
emberVaults	IEmberVault[]

Returns

IVault[]

transformEmberVaultToIVault()

transformEmberVaultToIVault(emberVault): IVault

Parameters

Parameter	Type
emberVault	IEmberVault

Returns

IVault

Variables

Sui

const Sui: object

Type Declaration

Name	Type	Default value
constants	__module	SuiConstants
getters	__module	SuiGetters
transformer	object	-
transformer.transformEmberVaultsToIVaults()	(emberVaults) => IVault[]	-
transformer.transformEmberVaultToIVault()	(emberVault) => IVault	-
utils	__module	SuiUtils