Skip to content

README.md

Latest commit

 

History

History
361 lines (310 loc) · 11.7 KB

README.md

File metadata and controls

361 lines (310 loc) · 11.7 KB

MultiAsset Contract

MultiAsset is a temporary asset contract developed by the Composability Labs team for smoother testing of the Spark Orderbook on the testnet. It allows users to mint a specified amount of tokens. Please note, the asset standard for the mainnet is still under consideration.

Features

  • SRC20 Compatible: The MultiAsset contract is designed to be SRC20-compatible, enabling flexible token minting.
  • Rust SDK: Provides an SDK with transactional and informational methods for interacting with the MultiAsset contract.

MultiAsset Rust SDK

Transactional Methods

Deploy a New Contract

pub async fn deploy(wallet: &WalletUnlocked) -> anyhow::Result<Self>

Deploys a new MultiAsset contract and returns a MultiAssetContract object.

Create a New Asset

pub async fn asset_new(
    &self,
    name: &String,
    symbol: &String,
    decimals: u8,
) -> anyhow::Result<CallResponse<AssetId>>

Creates a new asset with name, symbol, and decimals. Returns the AssetId.

Mint Asset Amount

pub async fn mint(
    &self,
    recipient: Identity,
    asset: &AssetId,
    amount: u64,
) -> anyhow::Result<CallResponse<()>> {

Mints the specified amount of asset to the recipient.

Read Methods

Total Assets

pub async fn total_assets(&self) -> anyhow::Result<CallResponse<u64>>

Returns the total number of assets deployed.

Total Supply

pub async fn total_supply(&self, asset: &AssetId) -> anyhow::Result<CallResponse<Option<u64>>>

Returns the total minted supply of the specified asset.

Name

pub async fn name(&self, asset: &AssetId) -> anyhow::Result<CallResponse<Option<String>>>

Returns the name of the specified asset.

Decimals

pub async fn decimals(&self, asset: &AssetId) -> anyhow::Result<CallResponse<Option<u8>>>

Returns the number of decimals for the specified asset.

Get Asset by Name

pub async fn asset_get(&self, name: &String) -> anyhow::Result<CallResponse<Option<AssetId>>>

Returns the AssetId of an asset based on its name.

CLI Core Functions

These contract calls change the state of the market contract and require a funded wallet.

Deploy

To deploy the MultiAsset contract, run the following command from the project root:

./target/release/multiasset_sdk core deploy --rpc "testnet.fuel.network"

Example output:

MultiAsset contract deployed to: 0xdc527289bdef8ec452f350c9b2d36d464a9ebed88eb389615e512a78e26e3509
Deployment cost: 24112
Deployer: 0xf47e0ef744ac8c993550e03d17f1c4844494553a12cac11ab8c568c8999fdbbf

./target/release/multiasset_sdk core deploy --rpc "mainnet.fuel.network"

Example output:

MultiAsset contract deployed to: 0x8672a6eedf79ac029f6ae37a5138bc2542c332b008ca786c80b0de9513395f8a
Deployment cost: 2269
Deployer: 0x1ef9ec55122609502d923f8a7831f50ac05e02bdd640522a2ef18fd0f26d5fc7

Update

MultiAsset contract deployed to: 0xe957f456070eccec99ad0378bafb13c7c019d4a3299589f7fc059c2564a0d60c
Deployment cost: 2554
Deployer: 0x1ef9ec55122609502d923f8a7831f50ac05e02bdd640522a2ef18fd0f26d5fc7

Create a New Asset

./target/release/multiasset_sdk core asset-new \
    --name USDC \
    --symbol USDC \
    --decimals 6 \
    --restricted-mint \
    --contract-id 0x1ef9ec55122609502d923f8a7831f50ac05e02bdd640522a2ef18fd0f26d5fc7 \
    --rpc "testnet.fuel.network"

Example output:

A new asset created with id: 0x336b7c06352a4b736ff6f688ba6885788b3df16e136e95310ade51aa32dc6f05
Transaction cost: 5216
Creator: 0xf47e0ef744ac8c993550e03d17f1c4844494553a12cac11ab8c568c8999fdbbf

./target/release/multiasset_sdk core asset-new \
    --name TESTUSDC \
    --symbol tUSDC \
    --decimals 6 \
    --restricted-mint \
    --contract-id 0x8672a6eedf79ac029f6ae37a5138bc2542c332b008ca786c80b0de9513395f8a \
    --rpc "mainnet.fuel.network"

Example output:

A new asset created with id: 0x22dfb618b9fc621a7d53f0f599dd427fb5688e280062a8de8883a27819d3f276
Transaction cost: 225
Creator: 0x1ef9ec55122609502d923f8a7831f50ac05e02bdd640522a2ef18fd0f26d5fc7

./target/release/multiasset_sdk core asset-new \
    --name TESTBTC \
    --symbol tBTC \
    --decimals 8 \
    --contract-id 0x8672a6eedf79ac029f6ae37a5138bc2542c332b008ca786c80b0de9513395f8a \
    --rpc "mainnet.fuel.network"

Example output:

A new asset created with id: 0x0dc8cdbe2798cb45ebc99180afc0bc514ffb505a80f122004378955c1d23892c
Transaction cost: 225
Creator: 0x1ef9ec55122609502d923f8a7831f50ac05e02bdd640522a2ef18fd0f26d5fc7

./target/release/multiasset_sdk core asset-new \
    --name TESTETH \
    --symbol tETH \
    --decimals 9 \
    --contract-id 0x8672a6eedf79ac029f6ae37a5138bc2542c332b008ca786c80b0de9513395f8a \
    --rpc "mainnet.fuel.network"

Example output:

A new asset created with id: 0xf169e13e98ae8908199148380684894458b7916f074b85ebad2aaad489ce0d54
Transaction cost: 225
Creator: 0x1ef9ec55122609502d923f8a7831f50ac05e02bdd640522a2ef18fd0f26d5fc7

./target/release/multiasset_sdk core asset-new \
    --name Trump \
    --symbol TRMP \
    --decimals 9 \
    --restricted-mint \
    --contract-id 0xe957f456070eccec99ad0378bafb13c7c019d4a3299589f7fc059c2564a0d60c \
    --rpc "mainnet.fuel.network"

A new asset created with id: 0x0b2d808a898cdae8b8661d398a98f8ff45e1e0f536ba2e498f6c7e53a71932cd Transaction cost: 245 Creator: 0x1ef9ec55122609502d923f8a7831f50ac05e02bdd640522a2ef18fd0f26d5fc7

./target/release/multiasset_sdk core asset-new \
    --name Kamala \
    --symbol KMLA \
    --decimals 9 \
    --restricted-mint \
    --contract-id 0xe957f456070eccec99ad0378bafb13c7c019d4a3299589f7fc059c2564a0d60c \
    --rpc "mainnet.fuel.network"

A new asset created with id: 0x368f9275e7d072794527b57d5b54688300008a400f41d926a013195e7074029c Transaction cost: 245 Creator: 0x1ef9ec55122609502d923f8a7831f50ac05e02bdd640522a2ef18fd0f26d5fc7

Mint Tokens

./target/release/multiasset_sdk core mint \
    --recipient-id 0xf47e0ef744ac8c993550e03d17f1c4844494553a12cac11ab8c568c8999fdbbf \
    --recipient-type address \
    --asset 0x336b7c06352a4b736ff6f688ba6885788b3df16e136e95310ade51aa32dc6f05 \
    --amount 200000000 \
    --contract-id 0xdc527289bdef8ec452f350c9b2d36d464a9ebed88eb389615e512a78e26e3509 \
    --rpc "testnet.fuel.network"

Example output:

An asset 0x336b7c06352a4b736ff6f688ba6885788b3df16e136e95310ade51aa32dc6f05 amount minted 200000000 to: 0xf47e0ef744ac8c993550e03d17f1c4844494553a12cac11ab8c568c8999fdbbf
Transaction cost: 2164
Minter: 0xf47e0ef744ac8c993550e03d17f1c4844494553a12cac11ab8c568c8999fdbbf

./target/release/multiasset_sdk core mint \
    --recipient-id 0x1ef9ec55122609502d923f8a7831f50ac05e02bdd640522a2ef18fd0f26d5fc7 \
    --recipient-type address \
    --asset 0xf169e13e98ae8908199148380684894458b7916f074b85ebad2aaad489ce0d54 \
    --amount 1000000000000000 \
    --contract-id 0x8672a6eedf79ac029f6ae37a5138bc2542c332b008ca786c80b0de9513395f8a \
    --rpc "mainnet.fuel.network"

Example output:

An asset 0xf169e13e98ae8908199148380684894458b7916f074b85ebad2aaad489ce0d54 amount minted 200000000 to: 0x1ef9ec55122609502d923f8a7831f50ac05e02bdd640522a2ef18fd0f26d5fc7
Transaction cost: 111
Minter: 0x1ef9ec55122609502d923f8a7831f50ac05e02bdd640522a2ef18fd0f26d5fc7

./target/release/multiasset_sdk core mint \
    --recipient-id 0x1ef9ec55122609502d923f8a7831f50ac05e02bdd640522a2ef18fd0f26d5fc7 \
    --recipient-type address \
    --asset 0x22dfb618b9fc621a7d53f0f599dd427fb5688e280062a8de8883a27819d3f276 \
    --amount 1000000000000 \
    --contract-id 0x8672a6eedf79ac029f6ae37a5138bc2542c332b008ca786c80b0de9513395f8a \
    --rpc "mainnet.fuel.network"
./target/release/multiasset_sdk core mint \
    --recipient-id 0x1ef9ec55122609502d923f8a7831f50ac05e02bdd640522a2ef18fd0f26d5fc7 \
    --recipient-type address \
    --asset 0x0dc8cdbe2798cb45ebc99180afc0bc514ffb505a80f122004378955c1d23892c \
    --amount 100000000000000 \
    --contract-id 0x8672a6eedf79ac029f6ae37a5138bc2542c332b008ca786c80b0de9513395f8a \
    --rpc "mainnet.fuel.network"
./target/release/multiasset_sdk core mint \
    --recipient-id 0x1ef9ec55122609502d923f8a7831f50ac05e02bdd640522a2ef18fd0f26d5fc7 \
    --recipient-type address \
    --asset 0x0b2d808a898cdae8b8661d398a98f8ff45e1e0f536ba2e498f6c7e53a71932cd \
    --amount 10000000000000 \
    --contract-id 0xe957f456070eccec99ad0378bafb13c7c019d4a3299589f7fc059c2564a0d60c \
    --rpc "mainnet.fuel.network"
./target/release/multiasset_sdk core mint \
    --recipient-id 0x1ef9ec55122609502d923f8a7831f50ac05e02bdd640522a2ef18fd0f26d5fc7 \
    --recipient-type address \
    --asset 0x368f9275e7d072794527b57d5b54688300008a400f41d926a013195e7074029c \
    --amount 10000000000000 \
    --contract-id 0xe957f456070eccec99ad0378bafb13c7c019d4a3299589f7fc059c2564a0d60c \
    --rpc "mainnet.fuel.network"
./target/release/multiasset_sdk core mint-many \
    --recipient-id 0x1ef9ec55122609502d923f8a7831f50ac05e02bdd640522a2ef18fd0f26d5fc7 \
   --recipient-type address \
    --asset 0x0b2d808a898cdae8b8661d398a98f8ff45e1e0f536ba2e498f6c7e53a71932cd \
    --amount 10000000000000 \
    --contract-id 0xe957f456070eccec99ad0378bafb13c7c019d4a3299589f7fc059c2564a0d60c \
    --rpc "mainnet.fuel.network"

CLI Info Commands

Retrieve Asset number

./target/release/multiasset_sdk info total-assets \
    --contract-id 0xe957f456070eccec99ad0378bafb13c7c019d4a3299589f7fc059c2564a0d60c \
    --rpc "mainnet.fuel.network"

Retrieve Asset Name

./target/release/multiasset_sdk info name \
    --asset 0x336b7c06352a4b736ff6f688ba6885788b3df16e136e95310ade51aa32dc6f05 \
    --contract-id 0xdc527289bdef8ec452f350c9b2d36d464a9ebed88eb389615e512a78e26e3509 \
    --rpc "testnet.fuel.network"
./target/release/multiasset_sdk info name \
    --asset 0x22dfb618b9fc621a7d53f0f599dd427fb5688e280062a8de8883a27819d3f276 \
    --contract-id 0x8672a6eedf79ac029f6ae37a5138bc2542c332b008ca786c80b0de9513395f8a \
    --rpc "mainnet.fuel.network"

Retrieve Asset Symbol

./target/release/multiasset_sdk info symbol \
    --asset 0x336b7c06352a4b736ff6f688ba6885788b3df16e136e95310ade51aa32dc6f05 \
    --contract-id 0xdc527289bdef8ec452f350c9b2d36d464a9ebed88eb389615e512a78e26e3509 \
    --rpc "testnet.fuel.network"
./target/release/multiasset_sdk info symbol \
    --asset 0x22dfb618b9fc621a7d53f0f599dd427fb5688e280062a8de8883a27819d3f276 \
    --contract-id 0x8672a6eedf79ac029f6ae37a5138bc2542c332b008ca786c80b0de9513395f8a \
    --rpc "mainnet.fuel.network"

Retrieve Asset Decimals

./target/release/multiasset_sdk info decimals \
    --asset 0x336b7c06352a4b736ff6f688ba6885788b3df16e136e95310ade51aa32dc6f05 \
    --contract-id 0xdc527289bdef8ec452f350c9b2d36d464a9ebed88eb389615e512a78e26e3509 \
    --rpc "testnet.fuel.network"
./target/release/multiasset_sdk info decimals \
    --asset 0x22dfb618b9fc621a7d53f0f599dd427fb5688e280062a8de8883a27819d3f276 \
    --contract-id 0x8672a6eedf79ac029f6ae37a5138bc2542c332b008ca786c80b0de9513395f8a \
    --rpc "mainnet.fuel.network"

Retrieve Asset Total Supply

./target/release/multiasset_sdk info total-supply \
    --asset 0x368f9275e7d072794527b57d5b54688300008a400f41d926a013195e7074029c \
    --contract-id 0xe957f456070eccec99ad0378bafb13c7c019d4a3299589f7fc059c2564a0d60c \
    --rpc "mainnet.fuel.network"

4340000

Retrieve Restrcited Mint

./target/release/multiasset_sdk info restricted-mint \
    --asset 0x368f9275e7d072794527b57d5b54688300008a400f41d926a013195e7074029c \
    --contract-id 0xe957f456070eccec99ad0378bafb13c7c019d4a3299589f7fc059c2564a0d60c \
    --rpc "mainnet.fuel.network"