taurus-js

taurus-js

Streamlined version of eosjs that contains just elliptic curve cryptography, serialize, and numeric methods.

Installation

NPM

The private NPM package can be found at npm.

Add dependency to your project

yarn add @blockone/taurus-js

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.

Import

ES Modules

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

import { PrivateKey, PublicKey, Signature } from '@blockone/taurus-js'

CommonJS

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

const { PrivateKey, PublicKey, Signature } = require('@blockone/taurus-js')
const { TextEncoder, TextDecoder } = require('util') // node only; native TextEncoder/Decoder

Full Documentation of Codebase

The documentation specific to the code in this repository can be found here

If you also need information from code that was removed from this repository, the full eosjs documentation can be found here

Lastly, there are a few examples and installation/usage guides available in the third-party perspective documentation for eosjs here

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.