eos-common

eos-common

EOSIO Smart Contract common library used for Typescript

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
• symbol
  • Parameters
  • Examples
• constructor
  • Parameters
  • Examples
• asset
  • Parameters
  • Examples
• split
  • Parameters
  • Examples

constructor

Symbol Class

Parameters

• symbol string Symbol
• precision number Precision

Examples

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

Returns Symbol Symbol

symbol

Symbol

Parameters

• symbol string Symbol
• precision number Precision

Examples

const sym = symbol("EOS", 4);
sym.symbol //=> "EOS"
sym.precision //=> 4

Returns Symbol Symbol

constructor

Asset Class

Parameters

• amount number Amount (uint64_t)
• symbol Symbol Symbol

Examples

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

Returns Asset Asset

asset

Asset

Parameters

• amount number Amount (uint64_t)
• symbol Symbol Symbol

Examples

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

Returns Asset Asset

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.symbol() //=> "EOS"

Returns Asset