ankara CLI Commands: Flags, Arguments, and Examples

Every ankara command reads ankara.config.json from your current working directory and signing credentials from .env. Run ankara init once in a new project before using any other command. Commands marked read-only do not require a private key — they query the chain directly.

Project Setup

`ankara init [project-name]`

Scaffolds a new Ankara Chain project in your current directory. The wizard prompts you for a network, an optional factory address, and an optional custom RPC URL, then writes ankara.config.json and a .env stub.

ankara init
ankara init my-rwa-project

Interactive prompts

Prompt	Default	Description
Project name	`my-ankara-project`	Human label stored in the config
Target network	`polygon-amoy`	One of: `polygon-amoy`, `localhost`, `polygon`, `celo`, `bnb`, `ethereum`, `stellar-testnet`, `stellar`
TokenFactory address	(blank)	Paste an existing address, or leave blank and run `deploy-factory` next
Custom RPC URL	(blank)	Overrides the SDK built-in endpoint for this network

Example output

  🌍  Ankara Chain SDK — Project Setup
  ────────────────────────────────────────

  ✔ Initialised: my-rwa-project
  Network:         polygon-amoy
  Factory address: (not set — deploy first)
  Config file:     ankara.config.json

  Next steps:
    1. Add your PRIVATE_KEY to .env
    2. Deploy the factory:  npx ankara deploy-factory
    3. Deploy a token:      npx ankara deploy --template farmland

If ankara.config.json already exists, the wizard asks whether to reinitialise. Your existing deployments array is preserved.

`ankara deploy-factory`

Prints the Hardhat (EVM) or Stellar CLI commands you need to run to deploy the full Ankara Chain contract suite — TokenFactory, NFTFactory, MultiTokenFactory, EscrowFactory, RampSettlementFactory, and FactoryRegistry — to the configured network.

ankara deploy-factory

This command prints deployment instructions rather than deploying directly. You will need a local copy of the ankara-core contracts repository to run the printed Hardhat or Stellar CLI commands. After deploying, paste the resulting TokenFactory address into ankara.config.json as "factoryAddress".

Example output (EVM)

  🏭  Deploy TokenFactory
  ────────────────────────────────────────

  Network:  polygon-amoy
  Deployer: 0xYourWalletAddress
  Balance:  0.42 MATIC

  ⚠ This command deploys the full Ankara Chain contract suite.
  ⚠ Make sure your wallet has enough gas.

  To deploy contracts, run the Hardhat deploy script from packages/contracts-evm:

    cd packages/contracts-evm
    npx hardhat run scripts/deploy.ts --network amoy

  Then paste the TokenFactory address back into ankara.config.json
  or re-run: npx ankara init

Token Deployment

`ankara deploy`

Interactive wizard that deploys an ERC-20 RWA token through your configured TokenFactory. Prompts you to choose a template and fill in all asset-specific metadata fields. The deployed address is saved automatically to ankara.config.json.

ankara deploy
ankara deploy --template farmland

string

Skip the template selection prompt. Accepted values: farmland, commodity, real-estate, invoice, carbon-credit, mining-rights.

Template-specific metadata fields

GPS location         e.g. 12.0022, 8.5919
Area (sq metres)
Soil type            e.g. loam, clay, sandy
Irrigation type      e.g. rain-fed, drip
Crop history         e.g. maize,sorghum,fallow
State / Region       e.g. Kano State
Valuation USD

Commodity type       e.g. maize, cocoa
Quantity (kg)
Grade classification e.g. Grade A
Warehouse ID
Warehouse location
Harvest season       e.g. 2025/2026
Valuation USD

Property ID
Property type        Residential | Commercial | Industrial | Land
Location address
Total area (sq m)
Occupancy status     Vacant | Owner-occupied | Tenanted
Rental yield (bps)   e.g. 600 = 6%
Valuation USD

Invoice number
Debtor reference
Face value USD
Discount rate (bps)  e.g. 200 = 2%
Days until due
Currency (ISO 4217)  e.g. USD, NGN

Credit type          REDD+ | VCS | Gold Standard | GS4GG | CDM
Verification body ref
Vintage year
Quantity CO2e (t)
Project location
Project type         Forestry | Agriculture | Energy | Waste

License number
Mineral type         Gold | Coltan | Copper | Diamond | Coal | Lithium
Concession area
Area (hectares)
License expiry (days from now)
Issuing authority
Royalty rate (bps)   e.g. 300 = 3%

Example output

  🚀  Deploy RWA Token
  ────────────────────────────────────────

  Template:  farmland
  Name:      Kano Farmland Token
  Symbol:    KFT
  Asset ID:  FARMLAND-001
  Country:   NG
  Network:   polygon-amoy

  ✔ Token deployed!

  Token address: 0xDeAdBeEf00000000000000000000000000000001
  Tx hash:       0xabc123def456...
  Network:       polygon-amoy

  View on explorer: https://amoy.polygonscan.com/address/0xDeAdBeEf...
  Saved to ankara.config.json

`ankara deploy-nft`

Deploys an ERC-721 NFT contract representing a single unique asset record. Use this alongside — or instead of — ERC-20 fungible tokens when your asset is a one-of-a-kind deed, title, or certificate.

ankara deploy-nft

Supported templates

Value	Description
`farmland-nft`	Unique land parcel deed
`real-estate-nft`	Unique property title
`mining-rights-nft`	Unique mining license
`commodity-vault-nft`	Certified warehouse receipt

Your ankara.config.json must contain an "nftFactoryAddress" field pointing to a deployed NFTFactory contract before you can use this command.

Example output

  🖼️  Deploy NFT Asset Record
  ────────────────────────────────────────

  Template    : farmland-nft
  Name        : Kano North Parcel
  Symbol      : KNP
  Asset ID    : FARMLAND-NFT-001
  Country     : NG
  Network     : polygon-amoy

  ✔ NFT contract deployed!
  NFT Address : 0xNftContractAddress...
  Tx Hash     : 0xabc123...

`ankara deploy-batch`

Deploys a CommodityBatchToken (ERC-1155) contract — a multi-token warehouse receipt where each token ID represents a distinct commodity batch stored in the same facility.

ankara deploy-batch

Interactive prompts

Prompt	Description
Warehouse name	Human-readable name for the warehouse contract
Country code	ISO 3166-1 alpha-2
Base IPFS URI	Metadata URI prefix, e.g. `ipfs://Qm.../`
Warehouse ID	Unique identifier for the storage facility
Warehouse location	Human-readable address

Requires a "multiTokenFactoryAddress" in ankara.config.json.

`ankara deploy-pool`

Deploys a PoolVault — an ERC-20 fund contract that accepts multiple underlying RWA token addresses as collateral and issues pool shares to depositors.

ankara deploy-pool

Interactive prompts

Prompt	Description
Pool name	ERC-20 name for the vault shares
Pool symbol	ERC-20 symbol for the vault shares
Asset ID	Unique string identifier
Country code	ISO 3166-1 alpha-2
Oracle address	Optional `ManualOracle` address for on-chain pricing
Management fee (bps)	Annual fee in basis points, e.g. `100` = 1% (default `50` = 0.5%/yr)

Token Operations

`ankara mint`

Mints ERC-20 tokens to a recipient address. If you have only one deployment in your config, the CLI uses it automatically; otherwise it presents a selection list.

ankara mint
ankara mint --contract 0xTokenAddress --to 0xRecipient --amount 5000

string

Token contract address. Skips the interactive selection prompt.

string

Recipient wallet address (EVM or Stellar, depending on configured network).

string

Number of tokens to mint, in whole units (e.g. "1000"). Default: "1000".

Example output

  🪙  Mint Tokens
  ────────────────────────────────────────

  Contract: 0xDeAdBeEf00000000000000000000000000000001
  To:       0xRecipient0000000000000000000000000000001
  Amount:   5000 tokens

  ✔ Minted!
  Tx hash: 0xabc123def456...
  Explorer: https://amoy.polygonscan.com/tx/0xabc123...

`ankara batch-mint`

Mints ERC-1155 commodity batch tokens to a single recipient. Use this to issue warehouse receipt shares for a specific batch ID on a deployed CommodityBatchToken contract.

ankara batch-mint

Interactive prompts

Prompt	Description
CommodityBatchToken address	The ERC-1155 contract to mint on
Batch ID	Token ID representing the commodity batch (integer)
Recipient address	Wallet that receives the tokens
Amount	Number of tokens to mint

Example output

  🪙  Mint Commodity Batch Tokens (ERC-1155)
  ────────────────────────────────────────

  ✔ Minted 500 tokens (batch 3) to 0xRecipient...
  Tx hash: 0xabc123...

`ankara transfer`

Transfers tokens from your deployer wallet to another address. The CLI auto-detects whether the contract is an ERC-20 fungible token or an ERC-721 NFT (via ERC-165) and adjusts the prompts accordingly. On Stellar networks, you choose the asset type manually.

ankara transfer

Interactive prompts: contract address; then recipient address and amount (fungible), or recipient address and token ID (NFT).

`ankara status`

Queries an Ankara Chain token contract and prints its on-chain metadata. If you omit the address, the command lists every deployment recorded in ankara.config.json. This command is read-only — no private key is needed.

ankara status
ankara status 0xTokenAddress

Example output

  📋  Asset Status
  ────────────────────────────────────────

  Name:             Kano Farmland Token
  Symbol:           KFT
  Address:          0xDeAdBeEf...
  Country:          NG
  Status:           ACTIVE
  Valuation USD:    50000.0
  Metadata version: 1

Asset lifecycle statuses: DRAFT → ACTIVE → SUSPENDED → REDEEMED / EXPIRED.

`ankara register-batch`

Registers a new commodity batch on an existing CommodityBatchToken (ERC-1155) contract, assigning it a token ID and storing its metadata on-chain.

ankara register-batch

Interactive prompts

Prompt	Description
CommodityBatchToken address	The ERC-1155 contract to register on
Batch ID	Integer token ID for this batch
Commodity type	e.g. `cocoa`, `maize`
Quantity (kg)	Weight of goods in this batch
Grade classification	e.g. `Grade A`
Harvest season	e.g. `2025-Q1`
Origin country code	ISO 3166-1 alpha-2, e.g. `NG`
Valuation USD	Estimated value in USD
Expiry unix timestamp	Unix timestamp when the batch expires

Escrow

Ankara Chain’s milestone escrow supports tranche-based payments — a common pattern for diaspora remittances and construction financing. Funds are held in a smart contract and released only when each milestone is marked delivered and approved.

`ankara deploy-escrow`

Deploys a MilestoneEscrow contract. You define the number of milestones and the token amount for each one at deploy time. The total amount (sum of all milestones) must later be deposited by the payer via ankara escrow-fund.

ankara deploy-escrow

Interactive prompts

Prompt	Description
Payer address	Diaspora buyer who funds the escrow
Payee address	Recipient of released milestone funds
Arbiter address	Optional neutral party for dispute resolution; leave blank for none
Stablecoin address	ERC-20 token used for payments (must be whitelisted on the `EscrowFactory`)
Timelock (days)	Days before a delivered milestone can be force-released if the payer is unresponsive. Default: `7`
Number of milestones	Integer
Per-milestone amount	Amount in whole token units, one prompt per milestone
Per-milestone description	Free-text label (hashed on-chain)

Example output

  🤝  Deploy Milestone Escrow
  ────────────────────────────────────────

  Payer       : 0xPayerAddress...
  Payee       : 0xPayeeAddress...
  Arbiter     : none
  Token       : 0xStablecoinAddress...
  Milestones  : 3 (total 300.0)
  Timelock    : 7 days
  Network     : polygon-amoy

  ✔ Escrow deployed: 0xEscrowAddress...
  Tx hash : 0xabc123...
  Saved to ankara.config.json

  Next: the payer approves the stablecoin and runs "ankara escrow-fund"

`ankara escrow-fund`

Approves the stablecoin allowance and deposits the full agreed amount into the escrow contract. Only the payer should run this command.

ankara escrow-fund

Prompt: Escrow contract address. Example output

  💰  Fund Milestone Escrow
  ────────────────────────────────────────

  ✔ Escrow funded with 300.0 tokens
  Tx hash: 0xabc123...

`ankara escrow-deliver`

Marks a milestone as delivered. Only the payee should run this command after completing the work for a given milestone.

ankara escrow-deliver

Prompts: escrow address, milestone ID (0-indexed). Example output

  📦  Mark Milestone Delivered
  ────────────────────────────────────────

  ✔ Milestone 0 marked delivered
  Tx hash: 0xabc123...
  The payer can now run "ankara escrow-approve" to release funds.

`ankara escrow-approve`

Approves a delivered milestone and releases its funds to the payee. Only the payer should run this command.

ankara escrow-approve

Prompts: escrow address, milestone ID (0-indexed). Example output

  ✅  Approve Milestone (releases funds)
  ────────────────────────────────────────

  ✔ Milestone 0 approved — funds released to payee
  Tx hash: 0xabc123...

`ankara escrow-dispute`

Raises a dispute on a delivered milestone, blocking the release of funds until the arbiter resolves it. Either the payer or the payee may raise a dispute.

ankara escrow-dispute

Prompts: escrow address, milestone ID.

`ankara escrow-resolve`

Resolves a disputed milestone. Only the arbiter designated at deployment can run this command. You choose whether to release the funds to the payee or refund them to the payer.

ankara escrow-resolve

Prompts: escrow address, milestone ID, release to payee (yes/no).

`ankara escrow-claim-timelock`

Force-releases a delivered milestone to the payee after the configured timelock period has elapsed with no dispute raised. This can be called by any address — it is a safety valve for unresponsive payers.

ankara escrow-claim-timelock

Prompts: escrow address, milestone ID.

`ankara escrow-status`

Reads the full state of an escrow contract — parties, balances, and per-milestone status — without requiring a private key.

ankara escrow-status

Prompts: escrow address. Milestone status values: PENDING → DELIVERED → RELEASED / DISPUTED → REFUNDED.

Fiat Ramp

All ramp commands use ManualRampProvider — a reference implementation that returns simulated data. For production, inject a real provider adapter (Yellow Card, Flutterwave, Transak, etc.) at the SDK level before running the CLI.

`ankara ramp-quote`

Gets a fiat-to-token or token-to-fiat exchange quote for a given currency pair and country.

ankara ramp-quote

Interactive prompts

Prompt	Example
Direction	`on-ramp` or `off-ramp`
Fiat currency	`NGN`, `KES`, `GHS`
Token symbol	`mUSD`
Country code	`NG`, `KE`, `GH`
Amount is in	`fiat` or `token`
Amount	`1500`

Example output

  💱  Ramp Quote
  ────────────────────────────────────────

  Direction     : on-ramp
  Fiat amount   : 1500 NGN
  Token amount  : 1.00 mUSD
  Exchange rate : 1500
  Fee (fiat)    : 15 NGN
  Expires at    : 2025-06-01T12:00:00.000Z

`ankara onramp-initiate`

Starts an on-ramp session (fiat → tokens) with the ramp provider. Returns a session ID and payment URL. This command does not mint tokens — you must mint them separately once your backend confirms the fiat payment via the provider webhook.

ankara onramp-initiate

Prompts: fiat amount, fiat currency, token symbol, recipient wallet address, country code. Example output

  🟢  Initiate On-Ramp (fiat → tokens)
  ────────────────────────────────────────

  Session ID   : sess_abc123
  Status       : pending
  Payment URL  : https://pay.provider.example/sess_abc123

  Next: once the payer completes the fiat payment, mint the recipient's tokens,
  then run: ankara onramp-record --reference sess_abc123

`ankara offramp-initiate`

Starts an off-ramp session (tokens → fiat). Approves the RampSettlement contract to spend the specified token amount, deposits the tokens into custody, and initiates a fiat payout session with the provider.

ankara offramp-initiate

Interactive prompts

Prompt	Description
RampSettlement contract address	Your deployed settlement contract
Token contract address	The ERC-20 token to sell
Amount	Whole token units to off-ramp
Fiat currency	e.g. `NGN`, `KES`
Payout account number	Bank account or mobile money number
Bank code	Leave blank for mobile money
Country code	ISO 3166-1 alpha-2

Example output

  🔴  Initiate Off-Ramp (tokens → fiat)
  ────────────────────────────────────────

  ✔ Off-ramp initiated — 100.0 tokens deposited in custody
  Reference : sess_def456
  Tx hash   : 0xabc123...
  Next: once the fiat payout completes, run "ankara offramp-confirm" (SETTLER_ROLE).
  If the payout fails instead, run "ankara offramp-refund" (MANAGER_ROLE).

`ankara offramp-confirm`

Confirms that the fiat payout was successfully delivered to the recipient, releasing the custodied tokens to the settlement treasury. Requires SETTLER_ROLE on the RampSettlement contract.

ankara offramp-confirm

Prompts: settlement contract address, session reference ID.

`ankara offramp-refund`

Refunds custodied tokens back to the original depositor when a fiat payout fails. Requires MANAGER_ROLE on the RampSettlement contract.

ankara offramp-refund

Prompts: settlement contract address, session reference ID.

`ankara ramp-status`

Reads the on-chain record for an off-ramp deposit or on-ramp attestation by reference ID. Read-only — no private key required.

ankara ramp-status

Prompts: settlement contract address, reference ID.

`ankara deploy-ramp-settlement`

Deploys a RampSettlement contract — the on-chain custody component of the fiat off-ramp flow. The treasury address you provide receives settled tokens after each confirmed payout.

ankara deploy-ramp-settlement

Prompts: treasury address.

`ankara onramp-record`

Records an on-chain attestation that an on-ramp mint has occurred, linking the mint to a provider session reference. This does not move funds — mint the recipient’s tokens first, then call this command.

ankara onramp-record

Prompts: settlement contract address, reference string, recipient address, token address, amount minted.

Payments

These commands are Stellar-only. See Payments.

`ankara batch-pay`

Pays every recipient in a CSV file through a deployed batch-disburser contract, with up to 100 recipients per transaction.

ankara batch-pay [--contract <address>] [--token <address>] [--file payouts.csv] [--reference <text>] [-y]

Flag	Description
`--contract`	`batch-disburser` contract address
`--token`	Token to pay in, for example the USDC SAC
`--file`	CSV file with one `recipient,amount` row per line
`--reference`	Text emitted in the on-chain event, for example `Payroll Sept 2026`
`-y, --yes`	Skip the confirmation prompt for unattended runs, such as a monthly cron job

Amounts are integers in the token’s smallest unit. A header row and # comment lines are allowed:

recipient,amount
GA...WORKER1,1500000000
GB...WORKER2,2200000000

Each transaction is atomic. If any recipient in a batch fails, for example because the token’s identity verifier hasn’t approved them, that whole batch reverts.

Oracle & Collateral

`ankara oracle-set`

Pushes a new price value to your deployed ManualOracle contract. Use this in development and testing; production deployments should use an automated price feed.

ankara oracle-set

Prompts: oracle contract address, token address to price, price in USD (e.g. 1.50).

`ankara deposit`

Deposits tokens into a PoolVault as collateral, receiving vault shares in return.

ankara deposit

Prompts: pool vault address, token address to deposit, amount.

`ankara pool-status`

Reads the current state of a PoolVault — total assets, share price, management fee accrual, and collateral breakdown. Read-only.

ankara pool-status

Prompts: pool vault address.

​Project Setup

​ankara init [project-name]

​ankara deploy-factory

​Token Deployment

​ankara deploy

​ankara deploy-nft

​ankara deploy-batch

​ankara deploy-pool

​Token Operations

​ankara mint

​ankara batch-mint

​ankara transfer

​ankara status

​ankara register-batch

​Escrow

​ankara deploy-escrow

​ankara escrow-fund

​ankara escrow-deliver

​ankara escrow-approve

​ankara escrow-dispute

​ankara escrow-resolve

​ankara escrow-claim-timelock

​ankara escrow-status

​Fiat Ramp

​ankara ramp-quote

​ankara onramp-initiate

​ankara offramp-initiate

​ankara offramp-confirm

​ankara offramp-refund

​ankara ramp-status

​ankara deploy-ramp-settlement

​ankara onramp-record

​Payments

​ankara batch-pay

​Oracle & Collateral

​ankara oracle-set

​ankara deposit

​ankara pool-status

Project Setup

`ankara init [project-name]`

`ankara deploy-factory`

Token Deployment

`ankara deploy`

`ankara deploy-nft`

`ankara deploy-batch`

`ankara deploy-pool`

Token Operations

`ankara mint`

`ankara batch-mint`

`ankara transfer`

`ankara status`

`ankara register-batch`

Escrow

`ankara deploy-escrow`

`ankara escrow-fund`

`ankara escrow-deliver`

`ankara escrow-approve`

`ankara escrow-dispute`

`ankara escrow-resolve`

`ankara escrow-claim-timelock`

`ankara escrow-status`

Fiat Ramp

`ankara ramp-quote`

`ankara onramp-initiate`

`ankara offramp-initiate`

`ankara offramp-confirm`

`ankara offramp-refund`

`ankara ramp-status`

`ankara deploy-ramp-settlement`

`ankara onramp-record`

Payments

`ankara batch-pay`

Oracle & Collateral

`ankara oracle-set`

`ankara deposit`

`ankara pool-status`