Skip to content

Latest commit

 

History

History
98 lines (70 loc) · 4.33 KB

CLI0.md

File metadata and controls

98 lines (70 loc) · 4.33 KB

CLI0 ⇐ BaseTokenCLI

The FAT-0 CLI access object. Used to request data about a FAT-0 token

Kind: global class
Extends: BaseTokenCLI
Access: protected

clI0.getIssuance() ⇒ Promise

Get the issuance for the FAT-0 token, returns a typed FAT-0 Issuance object

Kind: instance method of CLI0
Overrides: getIssuance

clI0.getTransaction(entryhash) ⇒ Promise

Get a FAT-0 transaction for the token by entryhash

Kind: instance method of CLI0
Overrides: getTransaction

Param Type Description
entryhash string The Factom entryhash of the transaction to get. Resolves to a FAT-0 Transaction object

clI0.getTransactions(params) ⇒ Promise

Get a set of FAT-1 transactions for the token. Adjust results by parameters. Resolves to an of array FAT-0 Transaction objects

Kind: instance method of CLI0
Overrides: getTransactions

Param Type Default Description
params object Get transaction request parameters
[params.addresses] Array.<string> The list of public Factoid addresses to retrieve transactions for (Address appearing in inputs or outputs)
[params.entryhash] string The Factom entryhash of the transaction to start the result set at
[params.limit] number 25 The integer limit of number of transactions returned
[params.page] number 0 The page count of the results returned
[params.order] string "asc" The time based sort order of transactions returned. Must be either "asc" or "desc"

clI0.getType() ⇒ string

Get the type constant string of this CLI object. In this case, "FAT-0"

Kind: instance method of CLI0

clI0.getCLI() ⇒ CLI

Get the CLI object that was used to originally construct the BaseTokenCLI

Kind: instance method of CLI0

clI0.getChainId() ⇒ string

Get the Factom token chain ID used to originally construct the BaseTokenCLI

Kind: instance method of CLI0

clI0.getBalance(address) ⇒ Promise

Get the numeric balance of a Factoid address on the token. Returned as type BigNumber(https://www.npmjs.com/package/bignumber.js)

Kind: instance method of CLI0

Param Type Description
address string The public Factoid address to get the balance for

clI0.getStats() ⇒ Promise

Get statistics for the token. stats.circulating, stats.burned and stats.transactions are all of type BigNumber(https://www.npmjs.com/package/bignumber.js)

Kind: instance method of CLI0

clI0.sendTransaction() ⇒ Promise

Submit a signed FAT-0/1 Transaction

Kind: instance method of CLI0