Directory chain/token_chain

Module-level declarations

Types

bridge_configuration

struct bridge_configuration

struct minting_policy

minting_policy_history

entity minting_policy_history

struct module_args

struct network_bridge

pending_bridge_proposal

entity pending_bridge_proposal

pending_bridge_proposal_configuration

entity pending_bridge_proposal_configuration

pending_tc_constants

entity pending_tc_constants

pending_tc_constants_data

struct pending_tc_constants_data

pending_token_proposal

entity pending_token_proposal

pending_token_proposal_minting_policy

entity pending_token_proposal_minting_policy

object state

entity token

token_account_creation_brid

entity token_account_creation_brid

token_account_minting_policy

entity token_account_minting_policy

token_account_minting_policy_account

entity token_account_minting_policy_account

token_bridge_proposal_data

struct token_bridge_proposal_data

token_chain_constants

object token_chain_constants

struct token_data

token_proposal_data

struct token_proposal_data

Properties

pool_account_type

val pool_account_type: text = "TOKEN_CHAIN_POOL"

token_chain_account_creation_op_name

val token_chain_account_creation_op_name: text = "create_token_chain_account"

token_chain_governance_account_type

val token_chain_governance_account_type: text = "TOKEN_CHAIN_GOVERNANCE"

token_chain_governance_voter_set

val token_chain_governance_voter_set: text = "Token chain governance"

Functions

apply_ras_iccf_action

function apply_ras_iccf_action(account: account, strategy_params_gtv: gtv)

apply_tc_constants

function apply_tc_constants(proposal: common_proposal)

apply_token_bridge_create

function apply_token_bridge_create(proposal: common_proposal)

apply_token_create

function apply_token_create(proposal: common_proposal)

byte_array_to_hex

function byte_array_to_hex(ba: byte_array): text

cleanup_pending_tc_constants

function cleanup_pending_tc_constants(proposal: common_proposal)

cleanup_pending_token_bridge_create

function cleanup_pending_token_bridge_create(proposal: common_proposal)

cleanup_pending_token_create

function cleanup_pending_token_create(proposal: common_proposal)

common_voter_set_update_allowed_ec

@extend(validate_voter_set_proposal) function common_voter_set_update_allowed_ec(pending_proposal: pending_proposal)

create_governance_voter_set

function create_governance_voter_set()

create_pool_account

function create_pool_account(): account

create_token_chain_governance_account

function create_token_chain_governance_account(): account

@extend(strategy) function (): map<text, _strategy>

@extend(auth_handler) function (): map<text, _auth_handler>

@extend(delete_common_proposal_handlers) function (): map<text, (common_proposal) -> unit>

@extend(auth_handler) function (): map<text, _auth_handler>

@extend(auth_handler) function (): map<text, _auth_handler>

@extend(auth_handler) function (): map<text, _auth_handler>

@extend(apply_common_voting_result_handlers) function (): map<text, (common_proposal) -> unit>

@extend(delete_common_proposal_handlers) function (): map<text, (common_proposal) -> unit>

@extend(auth_handler) function (): map<text, _auth_handler>

@extend(auth_handler) function (): map<text, _auth_handler>

@extend(apply_common_voting_result_handlers) function (): map<text, (common_proposal) -> unit>

@extend(delete_common_proposal_handlers) function (): map<text, (common_proposal) -> unit>

@extend(apply_common_voting_result_handlers) function (): map<text, (common_proposal) -> unit>

function get_asset(): asset

function get_asset_id(): byte_array

get_pool_account

function get_pool_account(): account

get_pool_account_id

function get_pool_account_id(): byte_array

get_token_chain_governance_account

function get_token_chain_governance_account(): account

get_token_chain_governance_account_id

function get_token_chain_governance_account_id(): byte_array

iccf_account_details

function iccf_account_details(gtv: gtv): account_details

icmf_message_receive

@extend(receive_icmf_message) function icmf_message_receive(sender: byte_array, topic: text, body: gtv)

refund_proposal

function refund_proposal(account: account, amount: integer)

register_assets

function register_assets(): asset_origin

require_governance_voter_set

function require_governance_voter_set(): common_voter_set

require_initialized

function require_initialized()

require_is_governor

function require_is_governor(): byte_array

function require_token(asset: asset): token

tc_vault_dapp_details

@extend(vault_dapp_details) function tc_vault_dapp_details(): vault_dapp_details_data

validate_tc_proposal

function validate_tc_proposal(proposal_details: pending_tc_constants)

Queries

query api_version(): integer

get_constants_proposal

query get_constants_proposal(id: rowid): pending_tc_constants_data

Return details of a pending constants proposal.

get_token_bridge_proposal

query get_token_bridge_proposal(id: rowid): token_bridge_proposal_data

get_token_chain_constants

query get_token_chain_constants(): (listing_fee: integer, bridge_fee: integer)

query get_token_info(asset_id: byte_array): token_data

get_token_proposal

query get_token_proposal(id: rowid): token_proposal_data

Operations

init_token_chain

operation init_token_chain()

Initializes the token chain

operation mint_token(asset_id: byte_array, amount: big_integer)

Mints new tokens to account. Must be allowed by the token minting policy.

propose_constants

operation propose_constants(listing_fee: integer?, bridge_fee: integer?)

Propose a change Token chain values such as fees.

operation propose_token(name: text, symbol: text, decimals: integer, icon: text, minting_policy: list<minting_policy>, account_creation_brids: list<byte_array>)

Anyone can propose a new token on token chain. The listing fee will be deducted upon proposing the new token and refunded in case it is not accepted.

propose_token_bridge

operation propose_token_bridge(asset_id: byte_array, bridge_configurations: list<bridge_configuration>)

Token owner can propose bridge(s). When approved they will be added automatically to the token chain EVM event receiver and hbridge bridges.

operation ras_token_iccf(transaction: gtx_transaction, asset_id: byte_array)

Account creation strategy that utilizes ICCF to authorize account creation. Each token owner can register a list of authorized chains that can create new accounts on its behalf. The account creation fee will be subtracted from the token owner account which is acting as a pool.

The account creation requires a transaction that includes an operation with the following signature:

create_token_chain_account(main: ft4.accounts.auth_descriptor, disposable: ft4.accounts.auth_descriptor?, additional args...)

'disposable' can be omitted as argument in case no additional args are necessary.

remove_token_bridge

operation remove_token_bridge(asset_id: byte_array, bridges: list<network_bridge>)

Token owner can remove bridge(s). It will automatically remove the bridge contract from the token chain EVM event receiver.

revoke_token_bridge_proposal

operation revoke_token_bridge_proposal(proposal_id: rowid)

Revokes a token bridge proposal

revoke_token_proposal

operation revoke_token_proposal(proposal_id: rowid)

Revokes a token proposal