Soroban quickstart

Create a lending account by supplying collateral through the controller. For the lending app, use the getting started guide. For a wallet or portfolio integration, use the wallet integration guide for SDK transaction preparation, signing, API positions, prices, and token metadata.

Prepare the inputs

Use the Stellar CLI and a funded signing account. Select the network and check its contract addresses. The example requires:

Input	Requirement
Caller	A Stellar account with XLM for fees and tokens to supply.
Controller	The controller contract for the selected network.
Spoke id	The risk configuration for the account; this cannot change after creation.
Hub and asset	An existing market listed as collateralizable on that spoke.
Amount	A positive integer in token base units. For 7 decimals, `10000000` represents one token.

A market key is { hub_id, asset }. The same token in two hubs represents two independent markets. See Markets for the model.

Supply collateral

Set CONTROLLER to the selected controller address. Set IDENTITY to your configured CLI signing identity and CALLER_ADDRESS to its Stellar G... address. Replace the token and amount placeholders. Pass account_id = 0 to create a lending account.

stellar contract invoke \
  --id "$CONTROLLER" \
  --source-account "$IDENTITY" \
  --network testnet \
  -- supply \
  --caller "$CALLER_ADDRESS" \
  --account_id 0 \
  --spoke_id 1 \
  --assets '[[{"hub_id":1,"asset":"<asset-address>"}, "<amount>"]]'

The call returns the account id. Store it for subsequent actions. Creation mints a position NFT to the caller; transferring that NFT transfers control of its collateral and debt together. The caller authorizes the controller invocation and the nested token transfer to the pool. The CLI simulates the invocation before submission. In a wallet integration, build the transaction, prepare it through Soroban RPC, sign the prepared transaction, then submit it. Preparation supplies the footprint, authorization entries, and resource fees. For contract callers, use the vault supply authorization recipe.

Verify the position

Set ACCOUNT_ID to the returned lending account id. Read its supplied amount without sending a transaction:

stellar contract invoke --id "$CONTROLLER" \
  --source-account "$IDENTITY" --network testnet --send=no \
  -- get_collateral_amount \
  --account_id "$ACCOUNT_ID" \
  --hub_asset '{"hub_id":1,"asset":"<asset-address>"}'

The result is in token base units and includes accrued interest. The account has no debt until a borrow succeeds.

stellar contract invoke --id "$CONTROLLER" \
  --source-account "$IDENTITY" --network testnet --send=no \
  -- get_health_factor --account_id "$ACCOUNT_ID"

Health factor uses WAD (1e18); values below 1e18 permit liquidation. i128::MAX can mean no debt, a saturated ratio, or a missing account. Check account_exists and debt positions before displaying it as debt-free. Continue with Supply for supply constraints, Borrow to add debt, or System architecture for contract responsibilities.

Start here

Core concepts

Lending actions

Strategies and integrations

System behavior

Reference

Operations

Prepare the inputs

Supply collateral

Verify the position

​Prepare the inputs

​Supply collateral

​Verify the position

Prepare the inputs

Supply collateral

Verify the position