eos-common

eos-common

EOSIO Smart Contract common library used for Typescript

Goal

To implement the most commonly used EOSIO C++ Classes into Typescript:

• Asset
• Symbol
• SymbolCode
• ExtendedAsset
• ExtendedSymbol

Installation

Using Yarn:

yarn add eos-common

or using NPM:

npm install --save eos-common

Quick Start

import { split } from "eos-common"

const { amount } = split("1.0000 EOS");
amount //=> 10000

API

Table of Contents

• constructor
  • Parameters
  • Examples
• amount
• is_amount_within_range
• is_valid
• max_amount
• split
  • Parameters
  • Examples
• check
  • Parameters
  • Examples
• SymbolCode
• constructor
  • Parameters
  • Examples

constructor

Asset Class

Parameters

• amount
• sym Symbol The name of the symbol
• a number The amount of the asset

Examples

const quantity = new Asset(10000, new Symbol("EOS", 4));
quantity.toString() //=> "1.0000 EOS";
quantity.symbol.code() //=> "EOS"
quantity.symbol.precision //=> 4

Returns Asset Asset

amount

{int64_t} The amount of the asset

is_amount_within_range

Check if the amount doesn't exceed the max amount

Returns any true - if the amount doesn't exceed the max amount

Returns any false - otherwise

is_valid

Check if the asset is valid. %A valid asset has its amount <= max_amount and its symbol name valid

Returns any true - if the asset is valid

Returns any false - otherwise

max_amount

{constexpr int64_t} Maximum amount possible for this asset. It's capped to 2^62 - 1

split

Split quantity string

Parameters

• quantity string Quantity string

Examples

const quantity = split("1.0000 EOS");
quantity.amount //=> 10000
quantity.symbol.precision //=> 4
quantity.symbol.code() //=> "EOS"

Returns Asset

check

Assert if the predicate fails and use the supplied message.

Parameters

• pred boolean Pre-condition
• msg string Error Message

Examples

check(a == b, "a does not equal b");

Returns void

SymbolCode

constructor

Symbol Class

Parameters

• code string Symbol Code
• precision number Precision

Examples

const sym = new Symbol("EOS", 4);
sym.code() //=> "EOS"
sym.precision //=> 4

Returns Symbol Symbol