npmpackage.info

eosjs

General purpose library for the EOSIO blockchain.

22.1.0

1,433

MIT

TypeScript

11,624,214 4.3

Installations

npm install eosjs

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

15.14.0

NPM Version

7.7.6 Score

98.6

Supply Chain

99.6

Quality

80.1

Maintenance

Vulnerability

99.6

License

Pull Requests

Open

27

Total

579

Closed

156

Merged

396

Issues

Open

26

Total

565

Closed

539

Releases

EOSJS v22.1.0 Release Notes

v22.1.0

Published on 13 Jul 2021

EOSJS v22.0.0 Release Notes

v22.0.0

Published on 20 May 2021

EOSJS v21.0.4 Release Notes

v21.0.4

Published on 19 Apr 2021

EOSJS v22.0.0-rc2 Release Notes

v22.0.0-rc2

Published on 17 Feb 2021

EOSJS v22.0.0-rc1 Release Notes

v22.0.0-rc1

Published on 15 Dec 2020

EOSJS v21.0.3 Release Notes

v21.0.3

Published on 12 Aug 2020

View all 32 releases

Contributors

Unable to fetch Contributors

View all 58 contributors

Languages

TypeScript

JavaScript

HTML

Shell

Dockerfile

CSS

C++

TypeScript (72.79%)

JavaScript (14.61%)

HTML (7.42%)

Shell (3.41%)

Dockerfile (1.13%)

CSS (0.42%)

C++ (0.22%)

Developer

EOSIO

Download Statistics

Total Downloads

11,624,214

Last Day

3,240

Last Week

31,912

Last Month

176,915

Last Year

1,791,788

GitHub Statistics

1,433 Stars

1,387 Commits

463 Forks

109 Watching

56 Branches

58 Contributors

Maintainers

Package Meta Information

Latest Version

22.1.0

Package Id

eosjs@22.1.0

Size

79.40 kB

NPM Version

7.7.6

Node Version

15.14.0

Publised On

13 Jul 2021

Total Downloads

Cumulative downloads

Total Downloads

11,624,214

Last day

-59.9%

3,240

Compared to previous day

Last week

-26.2%

31,912

Compared to previous week

Last month

-5.6%

176,915

Compared to previous month

Last year

7.6%

1,791,788

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

eosjs

npm

Javascript API for integration with EOSIO-based blockchains using EOSIO RPC API.

Documentation can be found here

Installation

NPM

The official distribution package can be found at npm.

Add dependency to your project

yarn add eosjs

Using with Typescript

In order to get access to the TextEncoding and TextDecoding types, you need to add @types/text-encoding as a dev dependency: yarn add --dev @types/text-encoding

If you're using Node (not a browser) then you'll also need to make sure the dom lib is referenced in your tsconfig.json:

{
	"compilerOptions": {
		"lib": [..., "dom"]
	}
}

Browser Distribution

Clone this repository locally then run yarn build-web. The browser distribution will be located in dist-web and can be directly copied into your project repository. The dist-web folder contains minified bundles ready for production, along with source mapped versions of the library for debugging. For full browser usage examples, see the documentation.

Import

ES Modules

Importing using ESM syntax is supported using TypeScript, webpack, or Node.js with --experimental-modules flag

1import { Api, JsonRpc, RpcError } from 'eosjs';
2import { JsSignatureProvider } from 'eosjs/dist/eosjs-jssig';           // development only

CommonJS

Importing using commonJS syntax is supported by Node.js out of the box.

1const { Api, JsonRpc, RpcError } = require('eosjs');
2const { JsSignatureProvider } = require('eosjs/dist/eosjs-jssig');      // development only
3const fetch = require('node-fetch');                                    // node only; not needed in browsers
4const { TextEncoder, TextDecoder } = require('util');                   // node only; native TextEncoder/Decoder

Basic Usage

Signature Provider

The Signature Provider holds private keys and is responsible for signing transactions.

Using the JsSignatureProvider in the browser is not secure and should only be used for development purposes. Use a secure vault outside of the context of the webpage to ensure security when signing transactions in production

1const defaultPrivateKey = "5JtUScZK2XEp3g9gh7F8bwtPTRAkASmNrrftmx4AxDKD5K4zDnr"; // bob
2const signatureProvider = new JsSignatureProvider([defaultPrivateKey]);

JSON-RPC

Open a connection to JSON-RPC, include fetch when on Node.js.

1const rpc = new JsonRpc('http://127.0.0.1:8888', { fetch });

API

Include textDecoder and textEncoder when using in Node. You may exclude these when running in a browser since most modern browsers now natively support these. If your browser does not support these (https://caniuse.com/#feat=textencoder), then you can import them as a dependency through the following deprecated npm package: https://www.npmjs.com/package/text-encoding

1const api = new Api({ rpc, signatureProvider, textDecoder: new TextDecoder(), textEncoder: new TextEncoder() });

Sending a transaction

transact() is used to sign and push transactions onto the blockchain with an optional configuration object parameter. This parameter can override the default value of broadcast: true, and can be used to fill TAPOS fields given expireSeconds and either blocksBehind or useLastIrreversible. Given no configuration options, transactions are expected to be unpacked with TAPOS fields (expiration, ref_block_num, ref_block_prefix) and will automatically be broadcast onto the chain.

1(async () => {
2  const result = await api.transact({
3    actions: [{
4      account: 'eosio.token',
5      name: 'transfer',
6      authorization: [{
7        actor: 'useraaaaaaaa',
8        permission: 'active',
9      }],
10      data: {
11        from: 'useraaaaaaaa',
12        to: 'useraaaaaaab',
13        quantity: '0.0001 SYS',
14        memo: '',
15      },
16    }]
17  }, {
18    blocksBehind: 3,
19    expireSeconds: 30,
20  });
21  console.dir(result);
22})();

Error handling

use RpcError for handling RPC Errors

1...
2try {
3  const result = await api.transact({
4  ...
5} catch (e) {
6  console.log('\nCaught exception: ' + e);
7  if (e instanceof RpcError)
8    console.log(JSON.stringify(e.json, null, 2));
9}
10...

Contributing

Contributing Guide

Code of Conduct

License

MIT

Important

See LICENSE for copyright and license terms.

All repositories and other materials are provided subject to the terms of this IMPORTANT notice and you must familiarize yourself with its terms. The notice contains important information, limitations and restrictions relating to our software, publications, trademarks, third-party resources, and forward-looking statements. By accessing any of our repositories and other materials, you accept and agree to the terms of the notice.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

8

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 8

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-docker-images.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/build-docker-images.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-docker-images.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/build-docker-images.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-docker-images.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/build-docker-images.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-docker-images.yml:99: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/build-docker-images.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-docker-images.yml:157: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/build-docker-images.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-docker-images.yml:215: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/build-docker-images.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/integration-tests.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/integration-tests.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/integration-tests.yml:110: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/integration-tests.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/integration-tests.yml:165: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/integration-tests.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/integration-tests.yml:275: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/integration-tests.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/integration-tests.yml:330: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/integration-tests.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/integration-tests.yml:389: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/integration-tests.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/integration-tests.yml:499: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/integration-tests.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/integration-tests.yml:668: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/integration-tests.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/integration-tests.yml:220: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/integration-tests.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/integration-tests.yml:444: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/integration-tests.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/integration-tests.yml:554: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/integration-tests.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/integration-tests.yml:609: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/integration-tests.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-edge.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/publish-edge.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-edge.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/publish-edge.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/publish-release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/EOSIO/eosjs/publish-release.yml/master?enable=pin
Warn: containerImage not pinned by hash: .github/eosjs-ci/Dockerfile:7
Warn: containerImage not pinned by hash: .github/eosjs-ci/Dockerfile:69
Info: 37 out of 59 GitHub-owned GitHubAction dependencies pinned
Info: 32 out of 32 third-party GitHubAction dependencies pinned
Info: 0 out of 2 containerImage dependencies pinned

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.3

/10

Last Scanned on 2024-12-23

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to eosjs

eosjs-ecc

4.0.7

Elliptic curve cryptography functions

eosjs-api

7.0.4

Application programming interface to EOS blockchain nodes.

eosjs-keygen

1.3.2

General purpose library for private key storage and key management.

eosjs-ecc-priveos

4.0.8

Elliptic curve cryptography functions

eosjs

Installations

Developer Guide

No

CommonJS

15.14.0

7.7.6

Score

Pull Requests

27

579

156

396

Issues

26

565

539

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

11,624,214

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

eosjs

Installation

NPM

Add dependency to your project

Using with Typescript

Browser Distribution

Import

ES Modules

CommonJS

Basic Usage

Signature Provider

JSON-RPC

API

Sending a transaction

Error handling

Contributing

License

Important

10

10

10

10

8

0

0

0

0

0

0

0

4.3

/10

Other packages similar to eosjs