Quickstart (Stellar)

Prerequisites

Node.js 18+
A Stellar testnet account + secret key (S...)
Testnet XLM (for fees)

Never commit your secret key. Keep STELLAR_SECRET_KEY in .env only.

Step 1 — Install the SDK

npm install @ankarachain/sdk

Or use the CLI without installing:

npx ankara <command>

Step 2 — Initialise Your Project

Create a new config and pick Stellar Testnet (Soroban) when prompted:

npx ankara init my-stellar-rwa-project

This creates:

my-stellar-rwa-project/
├── ankara.config.json
└── .env

Your .env will include:

STELLAR_SECRET_KEY=your_stellar_secret_seed_here

Step 3 — Set the Token Factory Address

You need a deployed TokenFactory contract ID on Stellar.

Option A: Use the existing testnet deployment (recommended)

Use the TokenFactory address from the repo’s Stellar deployment list:

https://github.com/pauleke65/ankarachain/blob/main/packages/contracts-stellar/DEPLOYMENTS.md

Then set it in ankara.config.json:

{
  "version": "1.0",
  "network": "stellar-testnet",
  "factoryAddress": "CBMBI63UU6KJIZ5KUVP6A3FGMBMS4R3OXSY27NQNK5PPLCWJW7DPSEEF",
  "escrowFactoryAddress": "CDF5P3KOAU6RZGUSSA7KPNYEJMCBYAF5TVWELNFSVTM3TYP6EFUXRYVW",
  "deployments": []
}

Option B: Deploy your own factories

If you want your own factory addresses, deploy the Soroban contracts from:

cd packages/contracts-stellar
npm run build
./scripts/deploy-testnet.sh deployer

This uses stellar-cli identities (not STELLAR_SECRET_KEY) and prints the contract IDs you can paste into ankara.config.json.

Step 4 — Deploy a Token

Deploy a token using the same ankara deploy flow as EVM networks:

npx ankara deploy --template farmland

The wizard will prompt for the same metadata fields and will save the deployed contract ID into ankara.config.json.

Step 5 — Mint Tokens

npx ankara mint

Step 6 — Create a Milestone Escrow Deal

To deploy a MilestoneEscrow, you need an EscrowFactory address in ankara.config.json (already shown in Step 3 if you used the existing testnet deployment). Deploy an escrow:

npx ankara deploy-escrow

For a simple testnet demo, you can use the native XLM Stellar Asset Contract as the escrow token: CDLZFC3SYJYDZT7K67VZ75HPJVIEUVNIXF47ZG2FB2RMQQVU2HHGCYSC

XLM is not a stablecoin. Use it only for testnet demos, not real production flows.

Using the SDK Directly

For programmatic use in your app:

import { TokenFactory } from "@ankarachain/sdk";
import { ethers } from "ethers";

const factory = new TokenFactory({
  network: "stellar-testnet",
  stellarSecretKey: process.env.STELLAR_SECRET_KEY!,
  factoryAddress: "CBMBI63UU6KJIZ5KUVP6A3FGMBMS4R3OXSY27NQNK5PPLCWJW7DPSEEF",
});

const result = await factory.deployFarmland({
  name: "Kano Farmland Token",
  symbol: "KFT",
  assetId: "KANO-FARM-001",
  countryCode: "NG",
  metadata: {
    location: "12.0022, 8.5919",
    areaSqMeters: BigInt(10000),
    soilType: "loam",
    irrigationType: "rain-fed",
    cropHistory: "maize,sorghum,fallow",
    titleDocumentHash: ethers.ZeroHash,
    valuationUSD: ethers.parseEther("50000"),
    stateRegion: "Kano State",
    lastUpdated: BigInt(Math.floor(Date.now() / 1000)),
  },
});

console.log("Deployed:", result.tokenAddress);

Next Steps

Stellar Overview

How the Soroban contracts map to the same SDK API as EVM networks.

CLI Commands

Full reference for every ankara command.

Smart Contracts

Architecture, roles, and upgrade patterns.

Escrow

Milestone-based escrow deals for tranche-based payments.

Getting Started

Stellar

CLI

Asset Templates

Smart Contracts

MCP Server

Prerequisites

Step 1 — Install the SDK

Step 2 — Initialise Your Project

Step 3 — Set the Token Factory Address

Option A: Use the existing testnet deployment (recommended)

Option B: Deploy your own factories

Step 4 — Deploy a Token

Step 5 — Mint Tokens

Step 6 — Create a Milestone Escrow Deal

Using the SDK Directly

Next Steps

Stellar Overview

CLI Commands

Smart Contracts

Escrow

​Prerequisites

​Step 1 — Install the SDK

​Step 2 — Initialise Your Project

​Step 3 — Set the Token Factory Address

​Option A: Use the existing testnet deployment (recommended)

​Option B: Deploy your own factories

​Step 4 — Deploy a Token

​Step 5 — Mint Tokens

​Step 6 — Create a Milestone Escrow Deal

​Using the SDK Directly

​Next Steps

Stellar Overview

CLI Commands

Smart Contracts

Escrow

Prerequisites

Step 1 — Install the SDK

Step 2 — Initialise Your Project

Step 3 — Set the Token Factory Address

Option A: Use the existing testnet deployment (recommended)

Option B: Deploy your own factories

Step 4 — Deploy a Token

Step 5 — Mint Tokens

Step 6 — Create a Milestone Escrow Deal

Using the SDK Directly

Next Steps