app

README

What is it

A stable coin issuance platform on top of Cosmos. A new Cosmos chain that can Issue, Mint, Burn and Transfer custom tokens like Binance Asset Management https://docs.binance.org/tokens.html

Intro

Assets are stored as tokens on Chain, and the below management actions are available.

Issue

Issue is a transaction used to create a new asset. Anyone can issue a new token with fee paid. After issuing, the token would appear in the issuer's account as free balance.

An issuance transaction contains:

• Source Address: the sender address of the transaction and it will become the owner of the token, all created tokens will be in this account.

• Token Name: it is the long official name, such as "Fantom Coin". It is limited to 32 characters.

• Symbol: identifier of the token, limited to 8 alphanumeric characters and is case insensitive, for example, "FTM".

  "F" suffixed symbol is also allowed for migrating tokens that already exist on other chains.

  The symbol doesn't have to be unique, "-" followed by random 3 letters will be appended to the provided symbol to avoid uniqueness constraint.

  Those 3 letters are the first three letters of tx hash of the issue transaction.

  For example, "NNF-F90". Only FTM does not have this suffix.

• Total Supply: an int64. The max total supply is 90 billion.

• Mintable: that means whether this token can be minted in the future. To set the tokens to be mintable, you need to add --mintable, otherwise just omit this field to set this token to be non-mintable.

Example on mainnet:

 # To issue a NNB mintable token with total-supply 1 billion on mainnet
 ./famcli tx token issue --token-name "new token" --total-supply 100000000000000000 --symbol NNF --mintable --from alice --chain-id Fantom-Chain-Alpha  --node  https://data.mainnet.io:443 --trust-node

# To issue a NNB non-mintable token with total-supply 1 billion on mainnet
./famcli tx token issue --token-name "new token" --total-supply 100000000000000000 --symbol NNF --from alice  --chain-id Fantom-Chain-Alpha   --node  https://data.mainnet.io:443 --trust-node

Example on testnet:

 # To issue a NNB mintable token with total-supply 1 billion on testnet
 ./tfamcli tx token issue --token-name "new token" --total-supply 100000000000000000 --symbol NNF --mintable --from alice --chain-id Fantom-Chain-Alpha  --node  https://data.testnet.io:80 --trust-node
 
 # Output:  Committed at block 1887 (tx hash: F77A055DDD570AE42A7050182993A0B4DBC81A0D, ... Issued NNF-F77...)

# To issue a NNB non-mintable token with total-supply 1 billion on testnet
./tfamcli tx token issue --token-name "new token" --total-supply 100000000000000000 --symbol NNF --from alice  --chain-id Fantom-Chain-Omega   --node  https://data.testnet.io:80 --trust-node

# Output: Committed at block 1887 (tx hash: F77A055DDD570AE42A7050182993A0B4DBC81A0D, ... Issued NNF-F77...)

Mint

Tokens that is "mintable" (specified when issued) can use this function. The total supply after mint is still restricted by 90 billion.

Note only the owner of the token can use this transaction.

Example on mainnet:

./famcli tx token mint --amount 100000000000000000 --symbol NNF-F77 --from alice --chain-id Fantom-Chain-Alpha --node https://data.defibit.io:443 --trust-node

Example on testnet:

./tfamcli tx token mint --amount 100000000000000000 --symbol NNF-F77 --from alice --chain-id Fantom-Chain-Omega --node https://data.testnet.io:80 --trust-node

Burn

Burn is to destroy certain amount of token, after which that amount of tokens will be subtracted from the operator's balance. The total supply will be updated at the same time.

Notice that only the owner of the token has the permission to burn token.

Example on mainnet:

./famcli tx token burn --amount 100000000000000000 --symbol NNF-F77 --from alice --chain-id Fantom-Chain-Alpha --node https://data.mainnet.io:443 --trust-node

Example on testnet:

./tfamcli tx token burn --amount 100000000000000000 --symbol NNF-F77 --from alice --chain-id Fantom-Chain-Omega --node https://data.testnet.io:443 --trust-node

Freeze & Unfreeze

Freeze would move the specified amount of token into "frozen" status, so that these tokens can not transferred, spent in orders or any other transaction until they are unfreezed.

Anyone can (only) freeze or unfreeze tokens on their account with status in "free".

Example on mainnet:

./famcli tx token freeze --amount 2000000 --symbol NNF-F77 --from alice --chain-id Fantom-Chain-Alpha --node https://data.mainnet.io:443 --trust-node

./famcli tx token unfreeze --amount 2000000 --symbol NNF-F77 --from alice --chain-id Fantom-Chain-Alpha --node https://data.mainnet.io:443 --trust-node

Example on testnet:

./famcli tx token freeze --amount 2000000 --symbol NNF-F77 --from alice --chain-id Fantom-Chain-Omega --node https://data.testnet.io:443 --trust-node

./tfamcli tx token unfreeze --amount 2000000 --symbol NNF-F77 --from alice --chain-id Fantom-Chain-Omega --node https://data.testnet.io:443 --trust-node

Querying the Chain

To find more information on transactions or blocks, eg after issuing a new token, you can do any of the following

Query transaction example

command line:

famcli query txs --tags 'tx.hash:DA6DFD4662B340B42EC42AE167E54FD7108CBB90E69506F663112395D7BEF6F0' --page 1 --limit 10

REST server:

https://127.0.0.1:1317/txs?tx.hash=DA6DFD4662B340B42EC42AE167E54FD7108CBB90E69506F663112395D7BEF6F0&page=1&limit=10

Query block example (command line):

famcli query txs --tags 'tx.height:1081' --page 1 --limit 10

REST server:

https://127.0.0.1:1317/txs?tx.height=1081&page=1&limit=10

Documentation

Index

• Variables
• func MakeCodec() *codec.Codec
• func NewFantomAssetManagementApp(logger log.Logger, db dbm.DB, baseAppOptions ...func(*bam.BaseApp)) *fantomAssetManagementApp
• type GenesisState
  • func NewDefaultGenesisState() GenesisState

Variables

var (
	// default home directories for the application CLI
	DefaultCLIHome = os.ExpandEnv("$HOME/.famcli")

	// DefaultNodeHome sets the folder where the application data and configuration will be stored
	DefaultNodeHome = os.ExpandEnv("$HOME/.famd")

	// NewBasicManager is in charge of setting up basic module elements
	ModuleBasics = module.NewBasicManager(
		genaccounts.AppModuleBasic{},
		genutil.AppModuleBasic{},
		auth.AppModuleBasic{},
		bank.AppModuleBasic{},
		staking.AppModuleBasic{},
		distr.AppModuleBasic{},
		params.AppModuleBasic{},
		slashing.AppModuleBasic{},
		supply.AppModuleBasic{},

		assetmanagement.AppModule{},
	)
)

Functions

func MakeCodec

func MakeCodec() *codec.Codec

MakeCodec generates the necessary codecs for Amino

func NewFantomAssetManagementApp

func NewFantomAssetManagementApp(logger log.Logger, db dbm.DB, baseAppOptions ...func(*bam.BaseApp),
) *fantomAssetManagementApp

Types

type GenesisState

type GenesisState map[string]json.RawMessage

GenesisState represents chain state at the start of the chain. Any initial state (account balances) are stored here.

func NewDefaultGenesisState

func NewDefaultGenesisState() GenesisState