JavaScript SDK helpers for common tasks - Stellar Developer Docs

Before you write a helper

The JavaScript SDK, @stellar/stellar-sdk, has built-in helpers for many tasks that apps often code by hand. Check this table before you write your own. Every helper here is in version 17.x of the SDK, and each name links to its entry in the SDK reference. The call forms below use these imports and an RPC client for testnet:

import {
  Address,
  Asset,
  Soroban,
  checkAuthEntryReadiness,
  contract,
  inspectAuthEntry,
  rpc,
} from "@stellar/stellar-sdk";

const server = new rpc.Server("https://soroban-testnet.stellar.org");

Helpers by task

Task	Helper	Notes
Fund a testnet account or contract	`server.fundAddress(address)`	Takes a `G...` or `C...` address. Calls Friendbot and checks that the funding transaction succeeded. Works only on networks that run Friendbot.
Make a read-only contract call	`server.queryContract(contractId, method, args)`	Simulates the call and returns `{ result, isReadCall }`. It never signs or sends a transaction. Pass `args` as an object keyed by parameter name.
Read the token balance of an account or contract	`server.getAssetBalance(address, asset)`	Takes an `Asset`. For a `G...` address it reads the trustline. For a `C...` address it reads the balance from the asset’s Stellar Asset Contract. For the XLM balance of a `G...` address, use `server.getAccountEntry`.
Wait for a transaction result	`server.pollTransaction(hash, opts)`	Returns the first `SUCCESS` or `FAILED` response. If the transaction is still not found after the last attempt (by default 30 attempts, one second apart), it returns the `NOT_FOUND` response.
Display and parse token amounts	`Soroban.formatTokenAmount(amount, decimals)` and `Soroban.parseTokenAmount(value, decimals)`	Both take and return strings, so there is no floating-point rounding. `Soroban.formatTokenAmount("123000", 4)` returns `"12.3"`.
Call a contract without generated bindings	`contract.Client.from(options)`	Takes `{ contractId, rpcUrl, networkPassphrase }`. Reads the contract’s spec from the network and returns a client with one method for each contract function. Also works for Stellar Asset Contracts.
Inspect the credentials of an auth entry	`inspectAuthEntry(entry)`	Returns the credential type, address, nonce, expiration ledger, and whether the entry is signed. To check that an entry is ready to submit, use `checkAuthEntryReadiness(entry, currentLedgerSeq)`.
Tell account, contract, and muxed addresses apart	`Address.fromString(address).type`	Returns `"account"`, `"contract"`, `"muxedAccount"`, `"muxedContract"`, `"claimableBalance"`, or `"liquidityPool"`.