eos-common

EOSIO Smart Contract common library used for Typescript

Implements most commonly used EOSIO C++ Classes into Typescript:

• asset
• symbol
• symbol_code
• name
• extended_asset
• extended_symbol

Installation

Using Yarn:

yarn add eos-common

or using NPM:

npm install --save eos-common

Quick Start

import { asset, symbol } from "eos-common"

const quantity = asset("1.0000 EOS");
// or
const quantity = asset(10000, symbol("EOS", 4));
quantity.to_string() //=> "1.0000 EOS";
quantity.symbol.code().to_string() //=> "EOS"
quantity.symbol.precision() //=> 4

API

Table of Contents

• Asset
  • Parameters
  • Examples
  • amount
  • symbol
  • typeof
  • is_amount_within_range
  • is_valid
  • set_amount
    • Parameters
  • minus
    • Parameters
  • plus
    • Parameters
  • times
    • Parameters
  • div
    • Parameters
  • toString
  • isInstance
    • Parameters
  • plus
    • Parameters
  • minus
    • Parameters
  • times
    • Parameters
  • div
    • Parameters
  • isEqual
    • Parameters
  • isNotEqual
    • Parameters
  • isLessThan
    • Parameters
  • isLessThanOrEqual
    • Parameters
  • isGreaterThan
    • Parameters
  • isGreaterThanOrEqual
    • Parameters
  • max_amount
• check
  • Parameters
  • Examples
• write_decimal
  • Parameters
• ExtendedAsset
  • Parameters
  • quantity
  • contract
  • typeof
  • get_extended_symbol
  • toString
  • toJSON
  • times
    • Parameters
  • div
    • Parameters
  • minus
    • Parameters
  • plus
    • Parameters
  • isLessThan
    • Parameters
  • isEqual
    • Parameters
  • isNotEqual
    • Parameters
  • isLessThanOrEqual
    • Parameters
  • isGreaterThanOrEqual
    • Parameters
  • isInstance
    • Parameters
• extended_asset
  • Parameters
  • Examples
• ExtendedSymbol
  • Parameters
  • typeof
  • get_symbol
  • get_contract
  • toString
    • Parameters
  • toJSON
    • Parameters
  • raw
  • isInstance
    • Parameters
  • isEqual
    • Parameters
  • isNotEqual
    • Parameters
  • isLessThan
    • Parameters
• extended_symbol
  • Parameters
  • Examples
• Name
  • Parameters
  • typeof
  • length
  • suffix
  • raw
  • bool
  • toString
  • isInstance
    • Parameters
  • char_to_value
    • Parameters
  • isEqual
    • Parameters
  • isNotEqual
    • Parameters
  • isLessThan
    • Parameters
• SymbolCode
  • Parameters
  • typeof
  • toString
  • isEqual
    • Parameters
  • isNotEqual
    • Parameters
  • isLessThan
    • Parameters
  • isInstance
    • Parameters
• Symbol
  • Parameters
  • Examples
• typeof
• is_valid
• precision
• code
• raw
• bool
• toString
  • Parameters
• isInstance
  • Parameters
• isEqual
  • Parameters
• isNotEqual
  • Parameters
• isLessThan
  • Parameters
• voteWeightToday
• stake2vote
  • Parameters
• vote2stake
  • Parameters
• calculate_producer_per_vote_pay
  • Parameters

Asset

Asset

Parameters

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

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

symbol

{symbol} The symbol name of the asset

typeof

The typeof operator returns a string indicating the type of the unevaluated operand.

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

set_amount

Set the amount of the asset

Parameters

• amount
• a New amount for the asset

minus

Subtraction assignment operator

Parameters

• a Another asset to subtract this asset with

Returns any asset& - Reference to this asset

plus

Addition Assignment operator

Parameters

• a Another asset to subtract this asset with

Returns any asset& - Reference to this asset

times

Multiplication assignment operator, with a number

Parameters

• a The multiplier for the asset's amount

Returns any asset - Reference to this asset

div

Parameters

• a The divisor for the asset's amount

Returns any asset - Reference to this asset

toString

The toString() method returns the string representation of the object.

isInstance

The isinstance() function returns True if the specified object is of the specified type, otherwise False.

Parameters

• obj

plus

Addition operator

Parameters

• a The first asset to be added
• b The second asset to be added

Returns any asset - New asset as the result of addition

minus

Subtraction operator

Parameters

• a The asset to be subtracted
• b The asset used to subtract

Returns any asset - New asset as the result of subtraction of a with b

times

Multiplication operator, with a number proceeding

Parameters

• a The asset to be multiplied
• b The multiplier for the asset's amount

Returns any asset - New asset as the result of multiplication

div

Division operator, with a number proceeding

Parameters

• a The asset to be divided
• b The divisor for the asset's amount

Returns any asset - New asset as the result of division

isEqual

Equality operator

Parameters

• a The first asset to be compared
• b The second asset to be compared

Returns any true - if both asset has the same amount

Returns any false - otherwise

isNotEqual

Inequality operator

Parameters

• a The first asset to be compared
• b The second asset to be compared

Returns any true - if both asset doesn't have the same amount

Returns any false - otherwise

isLessThan

Less than operator

Parameters

• a The first asset to be compared
• b The second asset to be compared

Returns any true - if the first asset's amount is less than the second asset amount

Returns any false - otherwise

isLessThanOrEqual

Less or equal to operator

Parameters

• a The first asset to be compared
• b The second asset to be compared

Returns any true - if the first asset's amount is less or equal to the second asset amount

Returns any false - otherwise

isGreaterThan

Greater than operator

Parameters

• a The first asset to be compared
• b The second asset to be compared

Returns any true - if the first asset's amount is greater than the second asset amount

Returns any false - otherwise

isGreaterThanOrEqual

Greater or equal to operator

Parameters

• a The first asset to be compared
• b The second asset to be compared

Returns any true - if the first asset's amount is greater or equal to the second asset amount

Returns any false - otherwise

max_amount

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

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

write_decimal

Writes a number as a string

Parameters

• number The number to print before shifting the decimal point to the left by num_decimal_places.
• num_decimal_places The number of decimal places to shift the decimal point.
• negative Whether to print a minus sign in the front.

ExtendedAsset

Parameters

• obj1
• obj2

quantity

The asset

contract

The owner of the asset

typeof

The typeof operator returns a string indicating the type of the unevaluated operand.

get_extended_symbol

Get the extended symbol of the asset

Returns any extended_symbol - The extended symbol of the asset

toString

The toString() method returns the string representation of the object.

toJSON

The toJSON() method returns the JSON representation of the object.

times

Multiplication assignment operator

Parameters

• a

div

Division operator

Parameters

• a

minus

Subtraction operator

Parameters

• a

plus

Addition operator

Parameters

• a

isLessThan

Less than operator

Parameters

• a

isEqual

Comparison operator

Parameters

• a

isNotEqual

Comparison operator

Parameters

• a

isLessThanOrEqual

Comparison operator

Parameters

• a

isGreaterThanOrEqual

Comparison operator

Parameters

• a

isInstance

The isinstance() function returns True if the specified object is of the specified type, otherwise False.

Parameters

• obj

extended_asset

Extended Asset

Parameters

• obj1
• obj2

Examples

extended_asset( asset("1.0000 EOS"), name("eosio.token"))

ExtendedSymbol

Parameters

• obj1
• obj2

typeof

The typeof operator returns a string indicating the type of the unevaluated operand.

get_symbol

Returns the symbol in the extended_contract

Returns any symbol

get_contract

Returns the name of the contract in the extended_symbol

Returns any name

toString

The toString() method returns the string representation of the object.

Parameters

• show_precision (optional, default true)

toJSON

The toJSON() method returns the JSON representation of the object.

Parameters

• show_precision (optional, default true)

raw

Returns uint128_t repreresentation of the extended symbol

isInstance

The isinstance() function returns True if the specified object is of the specified type, otherwise False.

Parameters

• obj

isEqual

Equivalency operator. Returns true if a == b (are the same)

Parameters

• a
• b

Returns any boolean - true if both provided name are the same

isNotEqual

Inverted equivalency operator. Returns true if a != b (are different)

Parameters

• a
• b

Returns any boolean - true if both provided name are not the same

isLessThan

Less than operator. Returns true if a < b.

Parameters

• a
• b

Returns any boolean - true if name a is less than b

extended_symbol

Extended Symbol

Parameters

• obj1
• obj2

Examples

extended_symbol( symbol("4,EOS"), name("eosio.token") )

Name

Parameters

• str

typeof

The typeof operator returns a string indicating the type of the unevaluated operand.

length

Returns the length of the %name

suffix

Returns the suffix of the %name

raw

Returns uint64_t repreresentation of the name

bool

Explicit cast to bool of the name

Returns any Returns true if the name is set to the default value of 0 else true.

toString

The toString() method returns the string representation of the object.

isInstance

The isinstance() function returns True if the specified object is of the specified type, otherwise False.

Parameters

• obj

char_to_value

Converts a %name Base32 symbol into its corresponding value

Parameters

• c Character to be converted

Returns any constexpr char - Converted value

isEqual

Equivalency operator. Returns true if a == b (are the same)

Parameters

• a
• b

Returns any boolean - true if both provided name are the same

isNotEqual

Inverted equivalency operator. Returns true if a != b (are different)

Parameters

• a
• b

Returns any boolean - true if both provided name are not the same

isLessThan

Less than operator. Returns true if a < b.

Parameters

• a
• b

Returns any boolean - true if name a is less than b

SymbolCode

Parameters

• obj

typeof

The typeof operator returns a string indicating the type of the unevaluated operand.

toString

The toString() method returns the string representation of the object.

isEqual

Equivalency operator. Returns true if a == b (are the same)

Parameters

• comparison

Returns any boolean - true if both provided symbol_codes are the same

isNotEqual

Inverted equivalency operator. Returns true if a != b (are different)

Parameters

• comparison

Returns any boolean - true if both provided symbol_codes are not the same

isLessThan

Less than operator. Returns true if a < b.

Parameters

• comparison

Returns any boolean - true if symbol_code a is less than b

isInstance

The isinstance() function returns True if the specified object is of the specified type, otherwise False.

Parameters

• obj

Symbol

Symbol

Parameters

• code string Symbol Code
• precision number Precision

Examples

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

Returns Symbol Symbol

typeof

The typeof operator returns a string indicating the type of the unevaluated operand.

is_valid

Is this symbol valid

precision

This symbol's precision

code

Returns representation of symbol name

raw

Returns uint64_t repreresentation of the symbol

bool

Explicit cast to bool of the symbol

Returns any Returns true if the symbol is set to the default value of 0 else true.

toString

The toString() method returns the string representation of the object.

Parameters

• show_precision (optional, default true)

isInstance

The isinstance() function returns True if the specified object is of the specified type, otherwise False.

Parameters

• obj

isEqual

Equivalency operator. Returns true if a == b (are the same)

Parameters

• a
• b

Returns any boolean - true if both provided symbol_codes are the same

isNotEqual

Inverted equivalency operator. Returns true if a != b (are different)

Parameters

• a
• b

Returns any boolean - true if both provided symbol_codes are not the same

isLessThan

Less than operator. Returns true if a < b.

Parameters

• a
• b

Returns any boolean - true if symbol_code a is less than b

voteWeightToday

voteWeightToday computes the stake2vote weight for EOS, in order to compute the decaying value.

stake2vote

Convert EOS stake into decaying value

Parameters

• staked
• vote number vote

vote2stake

Convert vote decay value into EOS stake

Parameters

• vote
• staked number staked

calculate_producer_per_vote_pay

Calculate producer vpay

Parameters

• total_votes
• pervote_bucket
• total_producer_vote_weight

Returns bigint producer pay as int64t