Crate sov_bank

sov-bank module

The sov-bank module is responsible for managing tokens on the rollup.

The sov-bank module offers the following functionality:

Calls:

1. The CallMessage::CreateToken message creates a new token with an initial balance allocated to the minter. Conceptually a token is a mapping from users addresses to balances. Each token has a name and a unique address created automatically by the sov-bank module during the creation phase.

2. The CallMessage::Transfer message facilitates the transfer of tokens between two accounts. To initiate the transfer, the sender must provide the beneficiary’s account, the amount of tokens to be transferred, and the token address. It is important to note that the sender’s account balance must be greater than the amount being transferred.

3. The CallMessage::Burn message burns the specified amount of tokens.

Re-exports

• pub use utils::get_genesis_token_address;
• pub use utils::get_token_address;

Modules

• utils
  Util functions for bank

Structs

• Bank
  The sov-bank module manages user balances. It provides functionality for:
• BankConfig
  Initial configuration for sov-bank module.
• Coins
  Specifies an interface to interact with tokens. Structure that stores information specifying a given amount (type Amount) of coins stored at a token_address (type sov_modules_api::Spec::Address).
• TokenConfig
  TokenConfig specifies a configuration used when generating a token for the bank module.

Enums

• CallMessage
  Specifies the call methods using in that module. This enumeration represents the available call messages for interacting with the sov-bank module.

Type Aliases

• Amount
  Specifies an interface to interact with tokens. Type alias to store an amount of token.