eos-common
Advanced tools
eos-common
EOSIO Smart Contract common library used for Typescript
Implements most commonly used EOSIO C++ Classes into Typescript:
Using Yarn:
yarn add eos-common
or using NPM:
npm install --save eos-common
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
Asset
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
{int64_t} The amount of the asset
{symbol} The symbol name of the asset
The typeof operator returns a string indicating the type of the unevaluated operand.
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
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 the amount of the asset
amounta New amount for the assetSubtraction assignment operator
a Another asset to subtract this asset withReturns any asset& - Reference to this asset
Addition Assignment operator
a Another asset to subtract this asset withReturns any asset& - Reference to this asset
Multiplication assignment operator, with a number
a The multiplier for the asset's amountReturns any asset - Reference to this asset
a The divisor for the asset's amountReturns any asset - Reference to this asset
The toString() method returns the string representation of the object.
The isinstance() function returns True if the specified object is of the specified type, otherwise False.
objAddition operator
a The first asset to be addedb The second asset to be addedReturns any asset - New asset as the result of addition
Subtraction operator
a The asset to be subtractedb The asset used to subtractReturns any asset - New asset as the result of subtraction of a with b
Multiplication operator, with a number proceeding
a The asset to be multipliedb The multiplier for the asset's amountReturns any asset - New asset as the result of multiplication
Division operator, with a number proceeding
a The asset to be dividedb The divisor for the asset's amountReturns any asset - New asset as the result of division
Equality operator
a The first asset to be comparedb The second asset to be comparedReturns any true - if both asset has the same amount
Returns any false - otherwise
Inequality operator
a The first asset to be comparedb The second asset to be comparedReturns any true - if both asset doesn't have the same amount
Returns any false - otherwise
Less than operator
a The first asset to be comparedb The second asset to be comparedReturns any true - if the first asset's amount is less than the second asset amount
Returns any false - otherwise
Less or equal to operator
a The first asset to be comparedb The second asset to be comparedReturns any true - if the first asset's amount is less or equal to the second asset amount
Returns any false - otherwise
Greater than operator
a The first asset to be comparedb The second asset to be comparedReturns any true - if the first asset's amount is greater than the second asset amount
Returns any false - otherwise
Greater or equal to operator
a The first asset to be comparedb The second asset to be comparedReturns any true - if the first asset's amount is greater or equal to the second asset amount
Returns any false - otherwise
{constexpr int64_t} Maximum amount possible for this asset. It's capped to 2^62 - 1
Assert if the predicate fails and use the supplied message.
check(a == b, "a does not equal b");
Returns void
Writes a number as a string
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.obj1obj2The asset
The owner of the asset
The typeof operator returns a string indicating the type of the unevaluated operand.
Get the extended symbol of the asset
Returns any extended_symbol - The extended symbol of the asset
The toString() method returns the string representation of the object.
Multiplication assignment operator
aDivision operator
aSubtraction operator
aAddition operator
aLess than operator
aComparison operator
aComparison operator
aComparison operator
aComparison operator
aThe isinstance() function returns True if the specified object is of the specified type, otherwise False.
objsym The symbolcontractcon The name of the contractThe typeof operator returns a string indicating the type of the unevaluated operand.
Returns the symbol in the extended_contract
Returns any symbol
Returns the name of the contract in the extended_symbol
Returns any name
The toString() method returns the string representation of the object.
show_precision (optional, default true)The isinstance() function returns True if the specified object is of the specified type, otherwise False.
objEquivalency operator. Returns true if a == b (are the same)
abReturns any boolean - true if both provided name are the same
Inverted equivalency operator. Returns true if a != b (are different)
abReturns any boolean - true if both provided name are not the same
Less than operator. Returns true if a < b.
abReturns any boolean - true if name a is less than b
Extended Symbol
symcontractextended_symbol( symbol("4,EOS"), name("eosio.token") )
strThe typeof operator returns a string indicating the type of the unevaluated operand.
Returns the length of the %name
Returns the suffix of the %name
Returns uint64_t repreresentation of the name
Explicit cast to bool of the name
Returns any Returns true if the name is set to the default value of 0 else true.
The toString() method returns the string representation of the object.
The isinstance() function returns True if the specified object is of the specified type, otherwise False.
objConverts a %name Base32 symbol into its corresponding value
c Character to be convertedReturns any constexpr char - Converted value
Equivalency operator. Returns true if a == b (are the same)
abReturns any boolean - true if both provided name are the same
Inverted equivalency operator. Returns true if a != b (are different)
abReturns any boolean - true if both provided name are not the same
Less than operator. Returns true if a < b.
abReturns any boolean - true if name a is less than b
strThe typeof operator returns a string indicating the type of the unevaluated operand.
The toString() method returns the string representation of the object.
Equivalency operator. Returns true if a == b (are the same)
comparisonReturns any boolean - true if both provided symbol_codes are the same
Inverted equivalency operator. Returns true if a != b (are different)
comparisonReturns any boolean - true if both provided symbol_codes are not the same
Less than operator. Returns true if a < b.
comparisonReturns any boolean - true if symbol_code a is less than b
The isinstance() function returns True if the specified object is of the specified type, otherwise False.
objSymbol
const sym = new Symbol("EOS", 4);
sym.code() //=> "EOS"
sym.precision //=> 4
Returns Symbol Symbol
The typeof operator returns a string indicating the type of the unevaluated operand.
Is this symbol valid
This symbol's precision
Returns representation of symbol name
Returns uint64_t repreresentation of the symbol
Explicit cast to bool of the symbol
Returns any Returns true if the symbol is set to the default value of 0 else true.
The toString() method returns the string representation of the object.
show_precision (optional, default true)The isinstance() function returns True if the specified object is of the specified type, otherwise False.
objEquivalency operator. Returns true if a == b (are the same)
abReturns any boolean - true if both provided symbol_codes are the same
Inverted equivalency operator. Returns true if a != b (are different)
abReturns any boolean - true if both provided symbol_codes are not the same
Less than operator. Returns true if a < b.
abReturns any boolean - true if symbol_code a is less than b
voteWeightToday computes the stake2vote weight for EOS, in order to compute the decaying value.
Convert EOS stake into decaying value
stakedvote number voteConvert vote decay value into EOS stake
votestaked number stakedCalculate producer vpay
total_votespervote_buckettotal_producer_vote_weightReturns bigint producer pay as int64t
FAQs
EOSIO Smart Contract common library used for Typescript
The npm package eos-common receives a total of 106 weekly downloads. As such, eos-common popularity was classified as not popular.
We found that eos-common demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."