@d9-network/spec 0.0.3 → 0.0.4

package/docs/CONTRACTS.md

@@ -1,603 +0,0 @@
-# D9 Chain Smart Contracts Documentation
-
-This document describes all ink! smart contracts deployed on the D9 blockchain, including their messages (methods), storage, events, and error types.
-
-## Table of Contents
-
-1. [Token Contracts](#token-contracts)
-   - [USDT (PSP22 Token)](#usdt-psp22-token)
-2. [Mining Contracts](#mining-contracts)
-   - [Burn Manager](#burn-manager)
-   - [Burn Mining](#burn-mining)
-   - [Mining Pool](#mining-pool)
-   - [Node Reward](#node-reward)
-   - [Merchant Mining](#merchant-mining)
-3. [DeFi Contracts](#defi-contracts)
-   - [Market Maker (AMM)](#market-maker-amm)
-4. [Bridge Contracts](#bridge-contracts)
-   - [Cross-Chain Transfer](#cross-chain-transfer)
-
----
-
-## Token Contracts
-
-### USDT (PSP22 Token)
-
-PSP22-compliant USDT stablecoin token contract.
-
-#### Storage
-
-| Key | Type | Description |
-|-----|------|-------------|
-| `psp22.supply` | `bigint` | Total token supply |
-| `psp22.balances` | `Map<AccountId, bigint>` | Account balances |
-| `psp22.allowances` | `Map<(Owner, Spender), bigint>` | Transfer allowances |
-
-#### Messages
-
-| Name | Parameters | Returns | Mutates | Description |
-|------|------------|---------|---------|-------------|
-| `transfer` | `to: SS58String, value: bigint, _data: Binary` | `Result<(), PSP22Error>` | Yes | Transfer tokens to another account |
-| `transfer_from` | `from: SS58String, to: SS58String, value: bigint, _data: Binary` | `Result<(), PSP22Error>` | Yes | Transfer tokens on behalf of another account |
-| `PSP22::total_supply` | - | `bigint` | No | Get total token supply |
-| `PSP22::balance_of` | `owner: SS58String` | `bigint` | No | Get account balance |
-| `PSP22::allowance` | `owner: SS58String, spender: SS58String` | `bigint` | No | Get transfer allowance |
-| `PSP22::transfer` | `to: SS58String, value: bigint, data: Binary` | `Result<(), PSP22Error>` | Yes | PSP22 standard transfer |
-| `PSP22::transfer_from` | `from: SS58String, to: SS58String, value: bigint, data: Binary` | `Result<(), PSP22Error>` | Yes | PSP22 standard transfer_from |
-| `PSP22::approve` | `spender: SS58String, value: bigint` | `Result<(), PSP22Error>` | Yes | Approve transfer allowance |
-| `PSP22::increase_allowance` | `spender: SS58String, delta_value: bigint` | `Result<(), PSP22Error>` | Yes | Increase allowance |
-| `PSP22::decrease_allowance` | `spender: SS58String, delta_value: bigint` | `Result<(), PSP22Error>` | Yes | Decrease allowance |
-
-#### Constructor
-
-```typescript
-new(initial_supply: bigint): Result<(), Error>
-```
-
-#### Events
-
-| Name | Data | Description |
-|------|------|-------------|
-| `Approval` | `owner, spender, amount` | Approval was granted |
-| `Transfer` | `from?, to?, value` | Tokens were transferred |
-
-#### Errors
-
-| Name | Description |
-|------|-------------|
-| `Custom(string)` | Custom error message |
-| `InsufficientBalance` | Balance too low |
-| `InsufficientAllowance` | Allowance too low |
-| `ZeroRecipientAddress` | Zero recipient address |
-| `ZeroSenderAddress` | Zero sender address |
-| `SafeTransferCheckFailed(string)` | Safe transfer check failed |
-
----
-
-## Mining Contracts
-
-### Burn Manager
-
-Central contract that manages token burning across multiple burn mining contracts.
-
-#### Storage
-
-| Key | Type | Description |
-|-----|------|-------------|
-| `portfolios` | `Map<AccountId, Portfolio>` | User burn portfolios |
-| `admin` | `SS58String` | Contract admin |
-| `burn_contracts` | `Vec<SS58String>` | Registered burn contracts |
-| `total_amount_burned` | `bigint` | Total tokens burned globally |
-
-#### Portfolio Structure
-
-```typescript
-{
-  amount_burned: bigint;      // Total amount burned by user
-  balance_due: bigint;        // Balance due to user
-  balance_paid: bigint;       // Balance already paid
-  last_withdrawal?: {         // Last withdrawal info
-    time: bigint;
-    contract: SS58String;
-  };
-  last_burn: {                // Last burn info
-    time: bigint;
-    contract: SS58String;
-  };
-}
-```
-
-#### Messages
-
-| Name | Parameters | Returns | Mutates | Payable | Description |
-|------|------------|---------|---------|---------|-------------|
-| `burn` | `burn_beneficiary: SS58String, burn_contract: SS58String` | `Result<Portfolio, Error>` | Yes | Yes | Execute a burn via cross-contract call |
-| `withdraw` | `burn_contract: SS58String` | `Result<Portfolio, Error>` | Yes | No | Withdraw rewards from a burn contract |
-| `get_portfolio` | `account_id: SS58String` | `Portfolio?` | No | No | Get user's portfolio |
-| `get_ancestors` | `account_id: SS58String` | `Vec<SS58String>?` | No | No | Get referral ancestors |
-| `get_admin` | - | `SS58String` | No | No | Get admin address |
-| `get_total_burned` | - | `bigint` | No | No | Get total burned amount |
-| `add_burn_contract` | `burn_contract: SS58String` | `Result<(), Error>` | Yes | No | Add a burn contract |
-| `remove_burn_contract` | `burn_contract: SS58String` | `Result<(), Error>` | Yes | No | Remove a burn contract |
-
-#### Constructor
-
-```typescript
-new(admin: SS58String, burn_contracts: Vec<SS58String>): Result<(), Error>
-// Payable constructor
-```
-
-#### Events
-
-| Name | Data | Description |
-|------|------|-------------|
-| `WithdrawalExecuted` | `from, amount` | Withdrawal was executed |
-| `BurnExecuted` | `from, amount` | Burn was executed |
-
-#### Errors
-
-| Name | Description |
-|------|-------------|
-| `BurnAmountInsufficient` | Burn amount too low |
-| `NoAccountFound` | Account not found |
-| `EarlyWithdrawalAttempt` | Withdrawal attempted too early |
-| `ContractBalanceTooLow` | Contract has insufficient balance |
-| `RestrictedFunction` | Function access restricted |
-| `WithdrawalExceedsBalance` | Withdrawal exceeds balance |
-| `TransferFailed` | Transfer operation failed |
-| `InvalidCaller` | Invalid caller |
-| `InvalidBurnContract` | Invalid burn contract address |
-| `BurnContractAlreadyAdded` | Burn contract already registered |
-| `CrossContractCallFailed` | Cross-contract call failed |
-| `WithdrawalNotAllowed` | Withdrawal not allowed |
-| `NoAncestorsFound` | No referral ancestors found |
-
----
-
-### Burn Mining
-
-Individual burn mining contract for token burning rewards.
-
-#### Storage
-
-| Key | Type | Description |
-|-----|------|-------------|
-| `accounts` | `Map<AccountId, BurnAccount>` | User burn accounts |
-| `total_amount_burned` | `bigint` | Total burned in this contract |
-| `main_pool` | `SS58String` | Main mining pool address |
-| `burn_minimum` | `bigint` | Minimum burn amount |
-| `day_milliseconds` | `bigint` | Milliseconds per day (for calculations) |
-| `admin` | `SS58String` | Contract admin |
-
-#### Account Structure
-
-```typescript
-{
-  creation_timestamp: bigint;
-  amount_burned: bigint;
-  balance_due: bigint;
-  balance_paid: bigint;
-  last_withdrawal?: bigint;
-  last_burn: bigint;
-  referral_boost_coefficients: [bigint, bigint];
-  last_interaction: bigint;
-}
-```
-
-#### Messages
-
-| Name | Parameters | Returns | Mutates | Description |
-|------|------------|---------|---------|-------------|
-| `initiate_burn` | `account_id: SS58String, burn_amount: bigint` | `Result<bigint, Error>` | Yes | Initiate a burn (called by burn manager) |
-| `prepare_withdrawal` | `account_id: SS58String` | `Result<[bigint, bigint], Error>` | Yes | Prepare withdrawal amounts |
-| `get_account` | `account_id: SS58String` | `Account?` | No | Get account details |
-| `get_ancestors` | `account_id: SS58String` | `Vec<SS58String>?` | No | Get referral ancestors |
-| `update_data` | `user: SS58String, amount_burned: bigint` | `Result<(), Error>` | Yes | Update user data |
-| `change_main` | `new_main: SS58String` | `Result<(), Error>` | Yes | Change main pool address |
-| `set_day_milliseconds` | `new_day_milliseconds: bigint` | `Result<(), Error>` | Yes | Set day duration |
-| `set_code` | `code_hash: Hash` | `Result<(), Error>` | Yes | Upgrade contract code |
-
-#### Constructor
-
-```typescript
-new(main_pool: SS58String, burn_minimum: bigint): Result<(), Error>
-// Payable constructor
-```
-
----
-
-### Mining Pool
-
-Central mining pool contract managing rewards distribution.
-
-#### Storage
-
-| Key | Type | Description |
-|-----|------|-------------|
-| `admin` | `SS58String` | Contract admin |
-| `main_contract` | `SS58String` | Main contract address |
-| `merchant_contract` | `SS58String` | Merchant contract address |
-| `node_reward_contract` | `SS58String` | Node reward contract address |
-| `amm_contract` | `SS58String` | AMM contract address |
-| `merchant_volume` | `bigint` | Total merchant volume |
-| `last_session` | `number` | Last processed session |
-| `accumulative_reward_pool` | `bigint` | Accumulated rewards pool |
-| `volume_at_index` | `Map<number, bigint>` | Volume per session |
-
-#### Messages
-
-| Name | Parameters | Returns | Mutates | Payable | Description |
-|------|------------|---------|---------|---------|-------------|
-| `get_accumulative_reward_pool` | - | `bigint` | No | No | Get reward pool balance |
-| `pay_node_reward` | `account_id: SS58String, amount: bigint` | `Result<(), Error>` | Yes | No | Pay node reward |
-| `get_merchant_volume` | - | `bigint` | No | No | Get total merchant volume |
-| `get_session_volume` | `session_index: number` | `bigint` | No | No | Get session volume |
-| `get_total_volume` | - | `bigint` | No | No | Get total volume |
-| `update_pool_and_retrieve` | `session_index: number` | `Result<bigint, Error>` | Yes | No | Update pool and get amount |
-| `deduct_from_reward_pool` | `amount: bigint` | `Result<(), Error>` | Yes | No | Deduct from reward pool |
-| `process_merchant_payment` | - | `Result<(), Error>` | Yes | Yes | Process merchant payment |
-| `merchant_user_redeem_d9` | `user_account: SS58String, redeemable_usdt: bigint` | `Result<bigint, Error>` | No | No | Redeem D9 for user |
-| `change_merchant_contract` | `merchant_contract: SS58String` | `Result<(), Error>` | Yes | No | Change merchant contract |
-| `change_node_reward_contract` | `node_reward_contract: SS58String` | `Result<(), Error>` | Yes | No | Change node reward contract |
-| `change_amm_contract` | `amm_contract: SS58String` | `Result<(), Error>` | Yes | No | Change AMM contract |
-| `change_main_contract` | `main_contract: SS58String` | `Result<(), Error>` | Yes | No | Change main contract |
-| `send_to` | `to: SS58String, amount: bigint` | `Result<(), Error>` | Yes | No | Send D9 to address |
-| `set_code` | `code_hash: Hash` | `Result<(), Error>` | Yes | No | Upgrade contract code |
-
-#### Constructor
-
-```typescript
-new(
-  main_contract: SS58String,
-  merchant_contract: SS58String,
-  node_reward_contract: SS58String,
-  amm_contract: SS58String
-): Result<(), Error>
-```
-
-#### Errors
-
-| Name | Description |
-|------|-------------|
-| `OnlyCallableBy(SS58String)` | Function only callable by specific address |
-| `FailedToGetExchangeAmount` | Failed to get exchange amount |
-| `FailedToTransferD9ToUser` | Failed to transfer D9 to user |
-| `SessionPoolNotReady` | Session pool not ready |
-
----
-
-### Node Reward
-
-Contract for managing validator node rewards.
-
-#### Storage
-
-| Key | Type | Description |
-|-----|------|-------------|
-| `admin` | `SS58String` | Contract admin |
-| `new_admin` | `SS58String` | Pending new admin |
-| `mining_pool` | `SS58String` | Mining pool contract |
-| `rewards_pallet` | `SS58String` | Rewards pallet address |
-| `vote_limit` | `bigint` | Vote limit for rewards |
-| `session_rewards` | `Map<number, [bigint, bigint]>` | Session rewards data |
-| `node_reward` | `Map<SS58String, bigint>` | Pending node rewards |
-| `authorized_reward_receiver` | `Map<SS58String, SS58String>` | Authorized reward receivers |
-
-#### Messages
-
-| Name | Parameters | Returns | Mutates | Description |
-|------|------------|---------|---------|-------------|
-| `set_mining_pool` | `mining_pool: SS58String` | `Result<(), Error>` | Yes | Set mining pool address |
-| `set_rewards_pallet` | `rewards_pallet: SS58String` | `Result<(), Error>` | Yes | Set rewards pallet |
-| `relinquish_admin` | `new_admin: SS58String` | `Result<(), Error>` | Yes | Start admin transfer |
-| `accept_admin` | - | `Result<(), Error>` | Yes | Accept admin role |
-| `cancel_admin_relinquish` | - | `Result<(), Error>` | Yes | Cancel admin transfer |
-| `get_vote_limit` | - | `bigint` | No | Get vote limit |
-| `change_vote_limit` | `new_limit: bigint` | `Result<(), Error>` | Yes | Change vote limit |
-| `withdraw_reward` | `node_id: SS58String` | `Result<(), Error>` | Yes | Withdraw node reward |
-| `get_session_rewards_data` | `session_index: number` | `[bigint, bigint]?` | No | Get session rewards |
-| `get_node_reward_data` | `node_id: SS58String` | `bigint?` | No | Get node's pending reward |
-| `get_authorized_receiver` | `node_id: SS58String` | `SS58String` | No | Get authorized receiver |
-| `set_authorized_receiver` | `node_id: SS58String, receiver: SS58String` | `Result<(), Error>` | Yes | Set authorized receiver |
-| `remove_authorized_receiver` | `node_id: SS58String` | `Result<(), Error>` | Yes | Remove authorized receiver |
-| `update_rewards` | `last_session: number, sorted_nodes_and_votes: Vec<(SS58String, bigint)>` | `Result<(), Error>` | Yes | Update rewards (called by pallet) |
-| `set_code` | `code_hash: Hash` | `Result<(), Error>` | Yes | Upgrade contract code |
-
-#### Constructor
-
-```typescript
-new(mining_pool: SS58String, rewards_pallet: SS58String): Result<(), Error>
-```
-
-#### Events
-
-| Name | Data | Description |
-|------|------|-------------|
-| `NodeRewardPaid` | `node, receiver, amount` | Node reward was paid |
-
-#### Errors
-
-| Name | Description |
-|------|-------------|
-| `OnlyCallableBy(SS58String)` | Only callable by specific address |
-| `BeyondQualificationForNodeStatus` | Beyond qualification for node status |
-| `ErrorIssuingPayment` | Error issuing payment |
-| `ErrorGettingSessionPoolFromMiningPoolContract` | Failed to get session pool |
-| `NotAuthorizedToWithdraw` | Not authorized to withdraw |
-| `NothingToWithdraw` | Nothing to withdraw |
-| `ErrorGettingCurrentValidators` | Failed to get current validators |
-
----
-
-### Merchant Mining
-
-Contract for merchant-consumer green points and rewards system.
-
-#### Storage
-
-| Key | Type | Description |
-|-----|------|-------------|
-| `subscription_fee` | `bigint` | Merchant subscription fee |
-| `usdt_contract` | `SS58String` | USDT contract address |
-| `amm_contract` | `SS58String` | AMM contract address |
-| `mining_pool` | `SS58String` | Mining pool address |
-| `milliseconds_day` | `bigint` | Milliseconds per day |
-| `admin` | `SS58String` | Contract admin |
-| `merchant_expiry` | `Map<SS58String, bigint>` | Merchant subscription expiry |
-| `accounts` | `Map<SS58String, Account>` | User accounts |
-
-#### Account Structure
-
-```typescript
-{
-  green_points: bigint;
-  relationship_factors: [bigint, bigint];
-  last_conversion?: bigint;
-  redeemed_usdt: bigint;
-  redeemed_d9: bigint;
-  created_at: bigint;
-}
-```
-
-#### Messages
-
-| Name | Parameters | Returns | Mutates | Payable | Description |
-|------|------------|---------|---------|---------|-------------|
-| `subscribe` | `usdt_amount: bigint` | `Result<bigint, Error>` | Yes | No | Create/extend merchant subscription |
-| `redeem_d9` | - | `Result<bigint, Error>` | Yes | No | Redeem D9 from green points |
-| `give_green_points_d9` | `consumer_id: SS58String` | `Result<{merchant, consumer}, Error>` | Yes | Yes | Give green points (D9 payment) |
-| `give_green_points_usdt` | `consumer_id: SS58String, usdt_payment: bigint` | `Result<{merchant, consumer}, Error>` | Yes | No | Give green points (USDT payment) |
-| `send_usdt_payment_to_merchant` | `merchant_id: SS58String, usdt_amount: bigint` | `Result<{merchant, consumer}, Error>` | Yes | Yes | Send USDT payment to merchant |
-| `send_d9_payment_to_merchant` | `merchant_id: SS58String` | `Result<{merchant, consumer}, Error>` | Yes | Yes | Send D9 payment to merchant |
-| `get_expiry` | `account_id: SS58String` | `bigint` | No | No | Get merchant subscription expiry |
-| `get_account` | `account_id: SS58String` | `Account?` | No | No | Get account details |
-| `change_amm_contract` | `new_amm_contract: SS58String` | `Result<(), Error>` | Yes | No | Change AMM contract |
-| `change_mining_pool` | `new_mining_pool: SS58String` | `Result<(), Error>` | Yes | No | Change mining pool |
-| `change_admin` | `new_admin: SS58String` | `Result<(), Error>` | Yes | No | Change admin |
-| `set_code` | `code_hash: Hash` | `Result<(), Error>` | Yes | No | Upgrade contract code |
-
-#### Constructor
-
-```typescript
-new(
-  amm_contract: SS58String,
-  mining_pool: SS58String,
-  usdt_contract: SS58String
-): Result<(), Error>
-```
-
-#### Events
-
-| Name | Data | Description |
-|------|------|-------------|
-| `SubscriptionExtended` | `account_id, usdt, expiry` | Subscription extended |
-| `D9Redeemed` | `account_id, redeemed_d9` | D9 was redeemed |
-| `GreenPointsTransaction` | `{merchant: {account_id, green_points}, consumer: {account_id, green_points}}` | Green points awarded |
-| `D9MerchantPaymentSent` | `merchant, consumer, amount` | D9 payment sent |
-| `USDTMerchantPaymentSent` | `merchant, consumer, amount` | USDT payment sent |
-| `GivePointsUSDT` | `consumer, merchant, amount` | USDT green points given |
-
----
-
-## DeFi Contracts
-
-### Market Maker (AMM)
-
-Automated Market Maker for D9/USDT swaps and liquidity provision.
-
-#### Storage
-
-| Key | Type | Description |
-|-----|------|-------------|
-| `usdt_contract` | `SS58String` | USDT contract address |
-| `fee_percent` | `number` | Trading fee percentage |
-| `fee_total` | `bigint` | Total fees collected |
-| `liquidity_tolerance_percent` | `number` | Liquidity tolerance percentage |
-| `total_lp_tokens` | `bigint` | Total LP tokens minted |
-| `admin` | `SS58String` | Contract admin |
-| `liquidity_providers` | `Map<SS58String, bigint>` | LP token balances |
-
-#### Messages
-
-| Name | Parameters | Returns | Mutates | Payable | Description |
-|------|------------|---------|---------|---------|-------------|
-| `get_currency_reserves` | - | `[bigint, bigint]` | No | No | Get pool reserves (D9, USDT) |
-| `get_liquidity_provider` | `account_id: SS58String` | `bigint?` | No | No | Get LP token balance |
-| `add_liquidity` | `usdt_liquidity: bigint` | `Result<(), Error>` | Yes | Yes | Add liquidity (send D9) |
-| `remove_liquidity` | - | `Result<(), Error>` | Yes | No | Remove all liquidity |
-| `get_d9` | `usdt: bigint` | `Result<bigint, Error>` | Yes | No | Swap USDT for D9 |
-| `get_usdt` | - | `Result<bigint, Error>` | Yes | Yes | Swap D9 for USDT |
-| `calculate_exchange` | `direction: [Currency, Currency], amount_0: bigint` | `Result<bigint, Error>` | No | No | Calculate exchange amount |
-| `estimate_exchange` | `direction: [Currency, Currency], amount_0: bigint` | `Result<[bigint, bigint], Error>` | No | No | Estimate exchange with fees |
-| `check_new_liquidity` | `usdt_liquidity: bigint, d9_liquidity: bigint` | `Result<(), Error>` | No | No | Check if liquidity is valid |
-| `calc_new_lp_tokens` | `d9_liquidity: bigint, usdt_liquidity: bigint` | `bigint` | Yes | No | Calculate LP tokens for liquidity |
-| `check_usdt_balance` | `account_id: SS58String, amount: bigint` | `Result<(), Error>` | No | No | Check USDT balance |
-| `change_admin` | `new_admin: SS58String` | `Result<(), Error>` | Yes | No | Change admin |
-| `set_code` | `code_hash: Hash` | `Result<(), Error>` | Yes | No | Upgrade contract code |
-
-#### Constructor
-
-```typescript
-new(
-  usdt_contract: SS58String,
-  fee_percent: number,
-  liquidity_tolerance_percent: number
-): Result<(), Error>
-```
-
-#### Currency Type
-
-```typescript
-enum Currency {
-  D9,
-  USDT
-}
-```
-
-#### Events
-
-| Name | Data | Description |
-|------|------|-------------|
-| `LiquidityAdded` | `account_id, usdt, d9` | Liquidity added to pool |
-| `LiquidityRemoved` | `account_id, usdt, d9` | Liquidity removed from pool |
-| `D9ToUSDTConversion` | `account_id, usdt, d9` | D9 swapped for USDT |
-| `USDTToD9Conversion` | `account_id, usdt, d9` | USDT swapped for D9 |
-
-#### Errors
-
-| Name | Description |
-|------|-------------|
-| `D9orUSDTProvidedLiquidityAtZero` | Liquidity amount is zero |
-| `ConversionAmountTooLow` | Conversion amount too low |
-| `CouldntTransferUSDTFromUser` | Failed to transfer USDT |
-| `InsufficientLiquidity(Currency)` | Pool has insufficient liquidity |
-| `InsufficientAllowance` | Insufficient USDT allowance |
-| `MarketMakerHasInsufficientFunds(Currency)` | AMM has insufficient funds |
-| `InsufficientLiquidityProvided` | Insufficient liquidity provided |
-| `USDTBalanceInsufficient` | USDT balance insufficient |
-| `LiquidityProviderNotFound` | LP not found |
-| `LiquidityAddedBeyondTolerance([bigint, bigint])` | Liquidity ratio beyond tolerance |
-| `InsufficientLPTokens` | Insufficient LP tokens |
-| `InsufficientContractLPTokens` | Contract has insufficient LP tokens |
-| `DivisionByZero` | Division by zero |
-| `MultiplicationError` | Multiplication overflow |
-| `USDTTooSmall` | USDT amount too small |
-| `USDTTooMuch` | USDT amount too large |
-| `LiquidityTooLow` | Liquidity too low |
-
----
-
-## Bridge Contracts
-
-### Cross-Chain Transfer
-
-Contract for cross-chain USDT transfers between D9 and TRON.
-
-#### Storage
-
-| Key | Type | Description |
-|-----|------|-------------|
-| `super_admin` | `SS58String` | Super admin address |
-| `new_admin` | `SS58String` | Pending new admin |
-| `controller` | `SS58String` | Controller address |
-| `usdt_contract` | `SS58String` | USDT contract address |
-| `transaction_admins` | `Vec<SS58String>` | Transaction admin list |
-| `user_transaction_nonce` | `Map<SS58String, bigint>` | User transaction nonces |
-| `transactions` | `Map<String, Transaction>` | Transaction records |
-
-#### Transaction Structure
-
-```typescript
-{
-  transaction_id: string;
-  transaction_type: "Commit" | "Dispatch";
-  from_chain: "D9" | "TRON";
-  from_address: { Tron: FixedSizeBinary<21> } | { D9: SS58String };
-  to_address: { Tron: FixedSizeBinary<21> } | { D9: SS58String };
-  amount: bigint;
-  timestamp: bigint;
-}
-```
-
-#### Messages
-
-| Name | Parameters | Returns | Mutates | Description |
-|------|------------|---------|---------|-------------|
-| `asset_commit` | `transaction_id: string, from_address: SS58String, to_address: FixedSizeBinary<21>, amount: bigint` | `Result<string, Error>` | Yes | Commit assets for cross-chain transfer (D9 -> TRON) |
-| `asset_dispatch` | `from_address: FixedSizeBinary<21>, to_address: SS58String, amount: bigint` | `Result<string, Error>` | Yes | Dispatch assets from TRON (TRON -> D9) |
-| `get_transaction` | `tx_id: string` | `Transaction?` | No | Get transaction by ID |
-| `get_last_transaction` | `user_id: SS58String` | `Transaction?` | No | Get user's last transaction |
-| `get_current_nonce` | `user_id: SS58String` | `bigint` | No | Get user's current nonce |
-| `generate_tx_id` | `user_id: SS58String` | `string` | No | Generate new transaction ID |
-| `record_cancelled_tron_transfer` | `user_id: SS58String` | `Result<(), Error>` | Yes | Record cancelled TRON transfer |
-| `add_transaction_admin` | `admin: SS58String` | `Result<(), Error>` | Yes | Add transaction admin |
-| `remove_transaction_admin` | `admin: SS58String` | `Result<(), Error>` | Yes | Remove transaction admin |
-| `get_transaction_admins` | - | `Vec<SS58String>` | No | Get all transaction admins |
-| `is_transaction_admin` | `admin: SS58String` | `boolean` | No | Check if address is admin |
-| `change_controller` | `new_controller: SS58String` | `Result<(), Error>` | Yes | Change controller |
-| `relinquish_admin` | `new_admin: SS58String` | `Result<(), Error>` | Yes | Start admin transfer |
-| `claim_admin` | - | `Result<(), Error>` | Yes | Claim admin role |
-| `cancel_admin_transfer` | - | `Result<(), Error>` | Yes | Cancel admin transfer |
-| `set_code` | `code_hash: Hash` | `Result<(), Error>` | Yes | Upgrade contract code |
-
-#### Constructor
-
-```typescript
-new(usdt_contract: SS58String): Result<(), Error>
-```
-
-#### Events
-
-| Name | Data | Description |
-|------|------|-------------|
-| `CommitCreated` | `transaction_id, from_address, amount` | Cross-chain commit created |
-| `DispatchCompleted` | `tx_id, to_address, amount` | Cross-chain dispatch completed |
-
-#### Errors
-
-| Name | Description |
-|------|-------------|
-| `Restrictedto(SS58String)` | Restricted to specific address |
-| `AmountMustBeGreaterThanZero` | Amount must be greater than zero |
-| `TransactionAlreadyExists` | Transaction already exists |
-| `InvalidAddressLength(Chain)` | Invalid address length for chain |
-| `InvalidHexString` | Invalid hex string |
-| `DecodedHexLengthInvalid` | Decoded hex length invalid |
-| `TronAddressInvalidByteLength` | TRON address invalid byte length |
-| `InvalidTronAddress` | Invalid TRON address |
-| `TronDecodeError` | TRON decode error |
-| `UnableToSendUSDT` | Unable to send USDT |
-| `InsufficientAllowance` | Insufficient USDT allowance |
-| `UserUSDTBalanceInsufficient` | User USDT balance insufficient |
-| `AlreadyTransactionAdmin` | Already a transaction admin |
-
----
-
-## Common Contract Features
-
-### Upgradability
-
-All contracts support code upgrades via the `set_code` message:
-
-```typescript
-set_code(code_hash: FixedSizeBinary<32>): Result<(), Error>
-```
-
-This allows the contract logic to be updated while preserving storage and address.
-
-### Error Handling
-
-All contracts use Rust's `Result` type for error handling. Common error patterns:
-
-- `CouldNotReadInput` - Failed to decode input parameters
-- Cross-contract call errors (trapped, reverted)
-- Authorization errors (restricted functions)
-- Balance/allowance insufficient errors
-
-### Admin Patterns
-
-Most contracts follow a two-step admin transfer pattern:
-
-1. Current admin calls `relinquish_admin(new_admin)`
-2. New admin calls `accept_admin()` or `claim_admin()`
-3. Current admin can call `cancel_admin_transfer()` before acceptance