💻 Digital USD SDK Specification – Heiro Ledger
This SDK provides programmatic access to the core functionality of the Direct Settlement Protocol on Heiro ledger.
🔧 Core Methods
| Method | Description |
|---|---|
transfer(from, to, amount) | Transfers tokens between wallets, enforcing KYC and sanctions checks |
createWallet(attestation) | Creates a new wallet, requires a valid attestation object |
getWallet(address) | Returns wallet metadata including balances and attached attestation |
createToken(params) | Creates a new token with metadata and token authority attestation |
mintTokens(token, amount) | Mints new tokens into the token authority’s wallet |
burnTokens(token, amount) | Burns a specified quantity of tokens from the caller’s wallet |
stake(token, amount) | Locks tokens to provide swap liquidity and earn fees or yield |
unstake(token, amount) | Begins the unlock process for staked tokens |
getStakingStatus(wallet) | Returns staked balances and unlock state for a wallet |
swap(tokenA, tokenB, amount) | Performs a currency swap using staked liquidity from providers |
getSwapQuote(tokenA, tokenB, amount) | Returns expected output and fee for a proposed token swap |
💡 Notes on Staking
- Staking is not tied to nodes; it is a protocol-wide liquidity signal.
- Tokens staked are used to provide liquidity for swaps and earn protocol-defined fees.
- Highly inflationary tokens may face low voluntary staking participation.
- Token authorities may mint and stake reserves to ensure minimum liquidity.
- Staking is also used as a monetary velocity throttle, replacing interest rate levers.
- Protocol enforces that staked funds cannot be transferred until unstaked.
🔐 Security and Enforcement
All methods automatically enforce:
- Attestation validity (
attestor_idwhitelisted) - Jurisdictional compliance
- Sanctions list checks against (
attestor_id,attestation_id)
Wallets without valid attestations cannot participate in transfers or staking.