EVMAdapter

SDK Reference / EVMAdapter

EVMAdapter

EVM Adapter for August SDK

Classes

default

EVM Adapter for August SDK Supports both ethers Signer/Wallet and wagmi/viem WalletClient

Example

To access the EVM adapter instance

const sdk = new AugustSDK()
sdk.evm.vaultRedeem()

Constructors

Constructor

new default(signer?): default

Parameters

Parameter	Type
signer?	any

Returns

default

Methods

depositNative()

depositNative(options): Promise<string>

Parameters

Parameter	Type
options	INativeDepositOptions

Returns

Promise<string>

getDeposited()

getDeposited(options): Promise<INormalizedNumber>

Parameters

Parameter	Type
options	{ vault: `0x${string}`; wallet: `0x${string}`; whitelist: `0x${string}`; }
options.vault	`0x${string}`
options.wallet	`0x${string}`
options.whitelist	`0x${string}`

Returns

Promise<INormalizedNumber>

getRemainingAllocations()

getRemainingAllocations(options): Promise<INormalizedNumber>

Parameters

Parameter	Type
options	{ depositCapAmount?: bigint; vault: `0x${string}`; wallet: `0x${string}`; whitelist: `0x${string}`; }
options.depositCapAmount?	bigint
options.vault	`0x${string}`
options.wallet	`0x${string}`
options.whitelist	`0x${string}`

Returns

Promise<INormalizedNumber>

isWhitelisted()

isWhitelisted(options): Promise<boolean>

Parameters

Parameter	Type
options	{ wallet: `0x${string}`; whitelist: `0x${string}`; }
options.wallet	`0x${string}`
options.whitelist	`0x${string}`

Returns

Promise<boolean>

sendersWhitelistAddress()

sendersWhitelistAddress(options): Promise<`0x${string}`>

Parameters

Parameter	Type
options	{ vault: `0x${string}`; }
options.vault	`0x${string}`

Returns

Promise<`0x${string}`>

setSigner()

setSigner(signer): void

Set a new signer (supports both ethers and viem/wagmi)

Parameters

Parameter	Type	Description
signer	any	Either an ethers Signer/Wallet or viem WalletClient

Returns

void

vaultAllowance()

vaultAllowance(options): Promise<INormalizedNumber>

Parameters

Parameter	Type
options	IContractWriteOptions

Returns

Promise<INormalizedNumber>

vaultApprove()

vaultApprove(options): Promise<string>

Parameters

Parameter	Type
options	IContractWriteOptions

Returns

Promise<string>

vaultDeposit()

vaultDeposit(options): Promise<string>

Parameters

Parameter	Type
options	IContractWriteOptions

Returns

Promise<string>

vaultRedeem()

vaultRedeem(options): Promise<string>

Parameters

Parameter	Type
options	IContractWriteOptions & object

Returns

Promise<string>

vaultRequestRedeem()

vaultRequestRedeem(options): Promise<string>

Parameters

Parameter	Type
options	IContractWriteOptions

Returns

Promise<string>

Functions

getEvmVaultV1()

getEvmVaultV1(tokenizedVault, options): Promise<IVault>

Fetch EVM vault data for v1 vault contracts (legacy format). Queries on-chain state and combines with backend metadata.

Parameters

Parameter	Type	Description
tokenizedVault	ITokenizedVault	Vault metadata from backend
options	IVaultBaseOptions	RPC configuration and chain details

Returns

Promise<IVault>

Formatted vault object or null if closed/invisible

---

getEvmVaultV2()

getEvmVaultV2(tokenizedVault, options): Promise<IVault>

Fetch EVM vault data for v2 vault contracts (current format). V2 vaults use separate contracts for vault, receipt token, and whitelist. Queries all three contracts and combines results.

Parameters

Parameter	Type	Description
tokenizedVault	ITokenizedVault	Vault metadata from backend
options	IVaultBaseOptions	RPC configuration and chain details

Returns

Promise<IVault>

Formatted vault object or null if closed/invisible