Struct sov_bank::Bank

pub struct Bank<C: Context> { /* private fields */ }

The sov-bank module manages user balances. It provides functionality for:

• Token creation.
• Token transfers.
• Token burn.

Implementations

impl<C: Context> Bank<C>

pub fn create_token( &self, token_name: String, salt: u64, initial_balance: Amount, minter_address: C::Address, authorized_minters: Vec<C::Address>, context: &C, working_set: &mut WorkingSet<C::Storage> ) -> Result<C::Address>

Creates a token from a set of configuration parameters. Checks if a token already exists at that address. If so return an error.

pub fn transfer( &self, to: C::Address, coins: Coins<C>, context: &C, working_set: &mut WorkingSet<C::Storage> ) -> Result<CallResponse>

Transfers the set of coins to the address specified by to.

pub fn burn( &self, coins: Coins<C>, owner: &C::Address, working_set: &mut WorkingSet<C::Storage> ) -> Result<()>

Burns the set of coins.

If there is no token at the address specified in the Coins structure, return an error; on success it updates the total supply of tokens.

pub fn mint_from_eoa( &self, coins: &Coins<C>, mint_to_address: &C::Address, context: &C, working_set: &mut WorkingSet<C::Storage> ) -> Result<()>

Mints the coinsto the address mint_to_address using the externally owned account (“EOA”) supplied by context.sender() as the authorizer. Returns an error if the token address doesn’t exist or context.sender() is not authorized to mint tokens.

On success, it updates the self.tokens set to store the new balance.

pub fn mint( &self, coins: &Coins<C>, mint_to_address: &C::Address, authorizer: &C::Address, working_set: &mut WorkingSet<C::Storage> ) -> Result<()>

Mints the coins to the address mint_to_address if authorizer is an allowed minter. Returns an error if the token address doesn’t exist or context.sender() is not authorized to mint tokens.

On success, it updates the self.tokens set to store the new minted address.

impl<C: Context> Bank<C>

pub fn transfer_from( &self, from: &C::Address, to: &C::Address, coins: Coins<C>, working_set: &mut WorkingSet<C::Storage> ) -> Result<CallResponse>

Transfers the set of coins from the address from to the address to.

Returns an error if the token address doesn’t exist.

pub fn get_balance_of( &self, user_address: C::Address, token_address: C::Address, working_set: &mut WorkingSet<C::Storage> ) -> Option<u64>

Helper function used by the rpc method balance_of to return the balance of the token stored at token_address for the user having the address user_address from the underlying storage. If the token address doesn’t exist, or if the user doesn’t have tokens of that type, return None. Otherwise, wrap the resulting balance in Some.

pub fn get_token_name( &self, token_address: &C::Address, working_set: &mut WorkingSet<C::Storage> ) -> Option<String>

Get the name of a token by address

Trait Implementations

impl<C: Clone + Context> Clone for Bank<C>where C::Address: Clone,

fn clone(&self) -> Bank<C>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Context> Default for Bank<C>

fn default() -> Self

Returns the “default value” for a type.

impl<C: Context> Module for Bank<C>

type Context = C

Execution context.

type Config = BankConfig<C>

Configuration for the genesis method.

type CallMessage = CallMessage<C>

Module defined argument to the call method.

fn genesis( &self, config: &Self::Config, working_set: &mut WorkingSet<C::Storage> ) -> Result<(), Error>

Genesis is called when a rollup is deployed and can be used to set initial state values in the module.

fn call( &self, msg: Self::CallMessage, context: &Self::Context, working_set: &mut WorkingSet<C::Storage> ) -> Result<CallResponse, Error>

Call allows interaction with the module and invokes state changes. It takes a module defined type and a context as parameters.

impl<C: Context> ModuleInfo for Bank<C>

type Context = C

fn prefix(&self) -> Prefix

Returns the prefix of the module.

fn address(&self) -> &<Self::Context as Spec>::Address

Returns address of the module.

fn dependencies(&self) -> Vec<&<Self::Context as Spec>::Address>

Returns addresses of all the other modules this module is dependent on