@kzen-networks/zilliqa v0.6.7

Zilliqa Threshold Signatures JavaScript Library

This project is a fork of Zilliqa JavaScript Library. It moves away the concept of a single private key system, and instead injects a two-party Schnorr signatures scheme: we introduce a server which acts as the co-signer, and the wallet functions as the client. The two parties hold independent shares which are both required in order to produce a signature and broadcast a valid transaction. At no moment the complete private key is constructed. The Quick Start example is updated to use the two-party scheme. Also, the Demo section demonstrates core functionality.

Introduction

zilliqa-js is structured as a Lerna monorepo. Each package roughly corresponds to a discrete ZilliqaModule, most of which can be used independently.

The only required package is @zilliqa-js/core, which contains the default HTTPProvider, and other core abstractions that are necessary for other modules to function.

The following table provides a description of each module and what you may want to use it for.

Installation

It is recommended that developers install the JavaScript client by making use of the umbrella package @kzen-networks/zilliqa. This takes care of bootstrapping the various modules, which are then accessible as members of the Zilliqa class.

yarn add @kzen-networks/zilliqa
# bn.js should be added with the above package. if it is not, install it manually.
yarn add bn.js

As this library is still in a relatively early stage of development, we recommend using the next tag to install it in NPM. This will ensure that you receive the latest published version, as it may not be ideal to wait for a semver bump before being able to take advantage of new features/bug fixes.

Quick Start

Launch server (acts as the co-signer in the two-party signing scheme):

const { Zilliqa } = require('@kzen-networks/zilliqa');
const zilliqa = new Zilliqa('https://dev-api.zilliqa.com');
zilliqa.server.launch();

Create a wallet:

const { Zilliqa } = require('@kzen-networks/zilliqa');
const zilliqa = new Zilliqa('https://dev-api.zilliqa.com');
const fs = require('fs');
const ENCRYPTED_SHARE_PATH = './enc-share.json';

async function createWallet() {
  await zilliqa.wallet.create();  // run two-party Schnorr key generation and store the share in default account
  const address = zilliqa.wallet.defaultAccount.address;
  fs.writeFileSync(ENCRYPTED_SHARE_PATH, await zilliqa.wallet.export(address, 'passphrase'));  // save encrypted share
  console.log(address);
  // 0x42dEa4002600642f2c564bBcfddb568Bcc9728B5
}

createWallet();

After sending some Zil to this address (e.g., by a faucet), sign and send a transaction:

const { BN, Long, bytes, units } = require('@zilliqa-js/util');
const CHAIN_ID = 333;
const MSG_VERSION = 1;
const VERSION = bytes.pack(CHAIN_ID, MSG_VERSION);

async function testBlockchain() {
  const address = await zilliqa.wallet.addByKeystore(fs.readFileSync(ENCRYPTED_SHARE_PATH), 'passphrase');  // load encrypted share

  const balanceResponse = await zilliqa.blockchain.getBalance(address);
  console.log(balanceResponse.result.balance);
  // 100508300000000

  const minGasPriceResponse = await zilliqa.blockchain.getMinimumGasPrice();
  const minGasPrice = new BN(minGasPriceResponse.result);
  const tx = await zilliqa.blockchain.createTransaction(
    zilliqa.transactions.new({
      version: VERSION,
      toAddr: 'zil1jp3mdjppv49aa8uuy0s354lqnxw85sk57jupp0',  // should be either a valid checksum or bech32 address
      amount: new BN(units.toQa(0.001, units.Units.Zil)),
      gasPrice: minGasPrice,
      gasLimit: Long.fromNumber(1)
    })
  );
  console.log(tx.id);
  // 0f9a2a0a10d94d71003fceba37bf47a9958f785a23f6cd85e6bdc62a0053458
}

testBlockchain();

Demo

You can also run the two-party signing protocol using a demo from the command line. Server:

$ demo/server

Client:

$ demo/client --help

Usage: client [options] [command]

Options:
  -h, --help                     output usage information

Commands:
  address
  balance <address>
  transfer <from> <to> <amount>

API Documentation and examples

Each package contains its own examples and API documentation. For convenience, these are links to the respective README documents.

• account
• blockchain
• contract
• core
• crypto
• proto
• util

Development

This repository makes use of several technologies to provide a better and faster development experience for contributors, and has to be bootstrapped before one can do productive work.

Bootstrapping

zilliqa-js leverages Project References, which is available in TypeScript from version 3.x. As such, the build process is slightly different.

# install all dependencies and shared devDependencies
yarn install

# symlink packages, compile TS source files, and generate protobuf files.
yarn bootstrap

# watch TS source files and recompile on change
yarn build:ts -w

Tests

Because of the two-party signing protocol, in order for the wallet to be able to generate accounts and sign transactions, the server needs to be up. So before running tests make sure you launch the server:

$ yarn run start-server

Tests for each package reside in packages/src/*/tests, and are run using jest. Files containing unit tests always have the prefix *.spec.ts, while integration/e2e tests have the prefix *.ispect.ts.

In order to run any tests, you must first make sure the source files are compiled and all dependencies are installed by running yarn bootstrap.

If you wish to run integration tests, you may do so agains a local or remote Zilliqa testnet. However, note that the public testnet may not always be caught up to the state-of-the-art, and, therefore, can cause zilliqa-js to behave in unexpected ways.

# run all unit tests
yarn test

# configure environment variables
# $GENESIS_PRIV_KEY - the private key used to run transaction-related tests
# $GENESIS_ADDRESS - the address for the private key
# HTTP_PROVIDER - the URL of the Zilliqa JSON-RPC server
# MNEMONIC - the seed words of the wallet account used to run transaction-related tests
# CHAIN_ID - the chain ID of the specified network
vim .env

# run all integration tests
yarn test:integration

Bundling

zilliqa-js is bundled using rollup. Unfortunately, because elliptic is a major dependency and contains a circular dependency that causes rollup to choke, we also make use of webpack to pre-process and thereby eliminate the problem.

To build the distributable bundles, simple run yarn bundle. This will output two bundles, *.umd.js and *.esm.js, to packages/*/dist. Node.js clients are pointed to the umd bundle, and bundlers are pointed to esm.

NOTE: these bundles are not minified.

Licence

You can view our licence here.