UpshiftDocs

SDK API Reference

Generated API reference for @augustdigital/sdk — the SDK entry point, vault and subaccount modules, chain adapters, and contract ABIs.

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.

For a guided introduction, start with the Quick Start, Vault Actions, and Error Handling guides.

Modules

ModuleDescription
AugustSDKThe main August SDK class.
AugustVaultsThe August Vaults Module.
AugustSubAccountsThe August Sub Accounts Module.
AugustApiThe August backend API Module — read-only client for public backend endpoints (transparency dashboard, unrealized PnL) and authenticated loan-book / risk / OTC reads. Accessible as sdk.apiModule.
EVMAdapterEVM Adapter for August SDK
SolanaAdapterSolana Adapter for August SDK
SuiAdapterSui Adapter for August SDK
StellarAdapterStellar Adapter for August SDK
ABIsContract ABI definitions for interacting with August/Upshift smart contracts.

On this page