StellarAdapter

Stellar Adapter for August SDK

Provides Stellar vault operations: deposit, redeem, position queries, and on-chain data fetching via Soroban RPC.

Stellar Adapter for August SDK

Example

const adapter = new StellarAdapter('testnet');
const xdr = await adapter.vaultDeposit({
  contractId: 'CBGWW5...',
  amount: '1000000',
  senderAddress: 'GDLZ...',
});
// Sign xdr with wallet (e.g. Freighter), then submit via adapter.submitTransaction()

Constructors

Constructor

new StellarAdapter(network, options?): StellarAdapter

Parameters

Returns

StellarAdapter

Accessors

network

Get Signature

get network(): IStellarNetwork

Returns

IStellarNetwork

Methods

convertToShares()

convertToShares(vaultAddress, rawAmount): Promise<string>

Preview how many vault shares a deposit amount would yield.

Parameters

Returns

Promise<string>

Raw share amount as a string, or null if query fails.

getExplorerLink()

getExplorerLink(id, type?): string

Parameters

Returns

string

getUserPosition()

getUserPosition(vaultAddress, walletAddress): Promise<IStellarUserPosition>

Get user's vault share balance.

Parameters

Returns

Promise<IStellarUserPosition>

The position { shares, decimals, decimalsFromFallback }, or null if the balance read fails. When decimalsFromFallback is true the decimals() read failed and decimals is the fallback (7) — callers sizing a redeem MUST refuse rather than trust it.

isStellarAddress()

isStellarAddress(address): boolean

Parameters

Returns

boolean

submitTransaction()

submitTransaction(signedXdr): Promise<string>

Side effect: a submitted transaction that the network reports as a failed redeem operation is reported to that vault's curator, on the same fire-and-forget terms as StellarAdapter.vaultRedeem.

Submit a signed Soroban transaction and poll until the network confirms it.

Submits on the network this adapter was constructed with, so signedXdr must be signed for that same network.

Parameters

Returns

Promise<string>

The transaction hash once the network confirms it as successful.

Throws

AugustTimeoutError when the transaction is not confirmed within the poll budget (MAX_POLL_ATTEMPTS).

Throws

AugustSDKError when the RPC rejects the submission or the transaction confirms as failed. Its context carries { network, status } plus, when the result XDR decodes, a resultCode string holding the transaction-level reason (e.g. "txBadSeq", "txTooLate"); resultCode is undefined when the code cannot be decoded.

Example

try {
  const hash = await adapter.submitTransaction(signedXdr);
} catch (err) {
  if (err instanceof AugustSDKError && err.context?.resultCode === 'txBadSeq') {
    // stale sequence number — rebuild the transaction and resubmit
  }
}

vaultDeposit()

vaultDeposit(params): Promise<string>

Build an unsigned deposit transaction for a Stellar vault.

Parameters

Returns

Promise<string>

Base64-encoded XDR of the unsigned transaction.

vaultRedeem()

vaultRedeem(params): Promise<string>

Build an unsigned redeem transaction for a Stellar vault.

Side effect on failure: a redemption the vault cannot serve is reported to that vault's curator, since Stellar vaults are instant-redeem only and this is the curator's only signal. Fire-and-forget — it never delays or alters the error you receive. On by default in production; see monitoring.curatorAlerts and the Curator Notifications section of the Stellar Actions guide for exactly what is sent and how to opt out.

Parameters

Returns

Promise<string>

Base64-encoded XDR of the unsigned transaction.

Variables

Stellar

const Stellar: object

Type Declaration

References

default

Renames and re-exports StellarAdapter