!build
!gh-pages docs


A NodeJS library to facilitate interaction with the Topl blockchain network. This server-side SDK is compliant with the Dion version of the Topl protocol as defined by the reference implementation, Bifrost client.

Requirements

You need Python 2.7 installed to be able to install BramblJS using npm. You can have multiple Python versions (2.x and 3.x) installed on the same system without problems.

In Ubuntu, Mint, and Debian you can install python 2.7 like this:

* You must have installed the following prerequisites on your system. Execute the following commands on your system to install all required dependencies to build Python 2.7
`` sudo apt-get update
sudo apt-get install build-essential checkinstall
sudo apt-get install libreadline-gplv2-dev libncursesw5-dev libssl-dev libsqlite3-dev tk-dev libgdbm-dev libc6-dev libbz2-dev
* Download Python using the following command from the official Python site: `cd /usr/src | wget https://www.python.org/ftp/python/2.7.18/Python-2.7.18.tgz`
* Note that you can replace python/2.7.18 with the latest version that has been released by Python
* Now extract the downloaded package
`sudo tar xzf Python-2.7.18.tgz`
* After extracting the downloaded package, compile the python source using the following command `cd Python-2.7.18
sudo ./configure --enable-optimizations
sudo make altinstall`
* Finally, check the python version to make sure the install was successful python2.7 -V

For other Linux flavors, macOS, and Windows, packages are available at

https://www.python.org/getit/

Installation

Note: BramblJS is only compatible with stable and maintained versions of Node mainly (12, 14, 16). If you are using a legacy version of node, please upgrade your node installation in order to use the BramblJS library.

First, configure your npm to point towards the python install that you have completed in the prerequisites section

npm config set python /path/to/python_dir

where /path/to/python_dir is the path to your python install

To install from npm run npm install --save brambljs in your project directory.


To install from source:
- Git clone using git clone https://github.com/topl/BramblJS

- Run npm install within the cloned repo to install all dependencies

$3

In order to build a multi-container application, also providing the linking between containers, is through the Docker Compose.

Run the following command to get up and running quickly, with no hassle from the docker/compose directory
docker-compose up

$3

- BramblJS has been tested on Bifrost 1.3.x+

Usage

BramblJS Library

A helper library for interacting with the Topl protocol. Requests to the API layer of a chain provider conform to JSON-RPC standards and are managed by the Requests module. Key Management conforms to the Dion specification of the Topl protocol as implemented in the reference client Bifrost v1.7.1.

$3

* Brambl - primary module that provides high-level capabilities and access to Requests, KeyManager, Hash and Address.
* Requests - sub-module for sending json-rpc requests to a specified chain provider.
* KeyManager - sub-module that provides functions for creating, importing, and exporting Bifrost compatible keyfiles.
* Hash - utility to recreates hashes calculated in Bifrost
* Address - utility to validate Addresses

A brief overview of each module is given below but for a detailed descriptions of all available methods, please visit https://brambljs.docs.topl.co

Brambl Module

$3

`
const BramblJS = require('brambljs');
const brambl = new BramblJS('YOUR_PASS')
`
This will create a new Requests instance targetting a private node running at http://localhost:9085, default api-key topl_the_world! and generate a new KeyManager instance for signing transactions, using Curve25519 and encrypted with YOUR_PASS

$3

_Required: networkPrefix, password, url, apiKey_
`
const BramblJS = require('brambljs');
const brambl = new BramblJS({
networkPrefix: "private", // applies to Requests and KeyManager
password: "topl_the_world!",
Requests: {
url: "http://localhost:9085", // set url
apiKey: "YOUR_API_KEY" // set api key for network
}
});
`

$3

_Required: networkPrefix, password, url, apiKey_
`
const BramblJS = require('brambljs');
const keyManager = BramblJS.KeyManager({
networkPrefix: "private", // network prefix is required
password: "topl_the_world!"
});
const requests = BramblJS.Requests("private", "http://localhost:9085", "YOUR_API_KEY");

// network prefix is required and must match the networkPrefix for requests and keyManager
const brambl = new BramblJS({
networkPrefix: "private",
KeyManager: keyManager,
Requests: requests
});
`

Requests Module

The Requests module is compliant with Bifrost's JSON-RPC interface documented at https://topl-rpc.docs.topl.co

A new JSON-RPC interface class may be instantiated by:

`
const requests = new BramblJS.Requests("private", "http://localhost:9085", "YOUR_API_KEY");
`
Update the 'url' for requests instance:
`
requests.setUrl("http://test.url.net:7091");
`
Update the 'api-key' for requests instance
`
requests.setApiKey("YOUR_NEW_KEY");
`
Making Requests using this module directly:
`
requests.getLatestBlock().then(console.log).catch(console.error)
`
Requests can also be done through Brambl module:
`
brambl.requests.getLatestBlock().then(console.log).catch(console.error)
`
By default, requests will be sent to http://localhost:9085 unless a new URL was provided.This is the standard address and API port that Bifrost listens on when launched locally. All of the methods available in this module are asynchronous and will return Promises that must be handled using async/await structures or .then().


_Note: All Requests can be called directly using this module or Brambl Module. Details for every request can be found here: https://brambljs.docs.topl.co/Requests.html_

$3

By default, Bifrost uses an API key of topl_the_world! to validate requests on locally running test nets. If you are planning to use the Topl Torus service for servicing API requests, you will need to register for an API key from Torus and subsequently use this value in the constructor of the Brambl layer object. Standard best practices for protecting API keys should be followed in this case (i.e. saving variables in .ENV or config files that are not shared with version control).

KeyManager

The KeyManager module is compliant with Bifrost's Gjallarhorn Key Manager service and provides an straightforward interface for creating new keyfiles as well as creating and verifying signatures on transactions. New encrypted keyfiles are generated using Curve25519 key pairs and are encrypted using an AES-256 cipher with a user-specified password. All data within the keyfile is encoded using Base58.

$3

`
const keyManager = new BramblJS.KeyManager("PASSWORD");
`
_Note: 'PASSWORD' is the user provided encryption password for the keyfile._

$3

`
const keyManager = new BramblJS.KeyManager({ password: "PASSWORD", networkPrefix: "private"});
`

$3

`
const myKeyManager = new BramblJS('YOUR_PASS').keyManager;
const myKeyFile = myKeyManager.getKeyStorage();
const keyManager = BramblJS.KeyManager.importKeyFile(myKeyFile, password);
`

Alternatively, if you have a json object already in memory, you can import it directly.

`
const myKeyFile = {"publicKeyId":"DPbxHQKbwGrpEaPdYoTRdMQBPwH67RH2dSCdREmWt8aa","crypto":{"cipher":"aes-256-ctr","cipherText":"2gq6UoPzgYd3wTo5r98ra21SNQC4vDTWgsZFwD2VuU5W","cipherParams":{"iv":"fjLbN5ecnsBW1HR6Zxz44"},"mac":"4MubsJSf98v9J4jr9e91Nd88MjzUNWrx473Z3tjfHvDC","kdf":"scrypt","kdfSalt":"8tQPvqQ8QEBTRYwaxUUvmMH76GKiYdtUyj2QvrXdPQ8X"}};
const keyManager = BramblJS.KeyManager.importKeyFile(myKeyFile, password);
`

Note that we do not recommend hard coding the encrypted keyfile in the source code, this is simply for demonstration purposes. The password will also have to be known in order to import the encrypted keyfile.

$3

`
const myKeyPath = "keyfiles/my-keyfile.json";
const keyManager = BramblJS.KeyManager.importKeyFileFromDisk(myKeyPath, password);
`
_Note: The network prefix will be determined from the address of the keyfile._

$3

`

//check whether a private key was used to generate the signature for a message.
//Note that this method is static so that it may be used without generating a keyfile.

BramblJS.KeyManager.verify(publicKey, message, signature);

// get key storage
keyMan.getKeyStorage();

// export to file
let dirPath = "../keyfiles-sample-dir"
keyMan.exportToFile(dirPath); // defaults to ./.keyfiles

// check if key is locked
const isLocked = keyMan.isLocked;

// lock key
keyMan.lockKey();

// unlock key
keyMan.unlockKey("PASSWORD");

// retrieve public key
const pk = keyMan.pk;

// retrieve address
const address = keyMan.address;

// retrieve networkPrefix
const networkPrefix = keyMan.networkPrefix;

// sign
let signedKey = keyMan.sign("TOPL_VALID_MSG");
console.log(signedKey);
`

Address Utils Module

The Address Utilities are functions used in BramblJS to validate addresses, create asset codes, validate an address network etc. For all available methods see address-utils.js.

$3

`
const BramblJS = require('brambljs');
console.log("Valid Networks: " + BramblJS.utils.getValidNetworksList());
`
_Note: Upon importing brambljs module, the utilities functions can be used without having to create a new instance of Brambl module which generates a new Keyfile (this is an expensive operation)._

$3

`
const BramblJS = require('brambljs');
const brambl = new BramblJS('YOUR_PASS')

// utils are also accesible through brambljs module
console.log("Valid Networks: " + brambl.utils.getValidNetworksList());
`
_Note: If a new instance of BramblJS has been created, the utils can be access through this module._

Examples

$3

In summary, a transaction is implemented by:
1. Requesting a prototype transaction from a specified network provider (i.e Topl Torus service or local private testnet)
2. Signing the raw transaction bytes using the keyfile in the KeyManager instance.
3. Sending the fully formed transaction to the broadcastTx method available in the Requests module.

After issuance, the pollTx method may be used to begin polling the chain provider to determine the status of the newly issued transaction.

Below are examples for using the BramblJS library with a private testnet running on your localhost. Please consult the Bifrost documentation for further instructions on deploying a local private testnet.

$3

`
const BramblJS = require('brambljs');
const brambl = new BramblJS('YOUR_PASS')
`

$3

`
brambl.requests.getLatestBlock().then(res => {
const timestamp = new Date(res.result.bestBlock.header.timestamp);
const blockHeight = res.result.bestBlock.header.height;
console.log('Block #' + blockHeight + ' forged ' + timestamp);
})
`

$3

`
// short name must be latin1 enconded, up to 8 chars long.
// the key and the network prefix used to instantiate brambl will be used.
const assetCode = brambl.createAssetCode("name1234");
`
`
// The following can be used to access the utility function directly, this is independent to Brambl instance.
const assetCode = brambl.utils.Address.createAssetCode(networkPrefix, address, shortName);
`

$3

`
// Create Raw Asset Transfer and sign Tx
const address = brambl.keyManager.address;

const rawAssetParams = {
"propositionType": "PublicKeyCurve25519",
"recipients": [
// basic: [address, quantity]
// advance: [address, quantity, securityRoot, metadata]
[address, 4],
[address, 2],
],
"assetCode": assetCode,
"sender": [address],
"changeAddress": address,
"minting": true,
"fee": 1
};

brambl.transaction('createRawAssetTransfer', rawAssetParams)
.then(res => { console.log('Unconfirmed transaction'); console.log(res); return res })
.then(res => brambl.pollTx(res.result.txHash))
.then(res => { console.log('\nConfirmed transaction'); console.log(res) })
.catch(console.log)
`

$3

`
// Create Raw Arbit Transfer and sign Tx
const address = brambl.keyManager.address;

const rawAssetParams = {
"propositionType": "PublicKeyCurve25519",
"recipients": [
[address, 2]
],
"sender": [address],
"changeAddress": address,
"consolidationAddress": address,
"fee": 1,
"data": "",
};

brambl.transaction('createRawArbitTransfer', rawAssetParams)
.then(res => { console.log('Unconfirmed transaction'); console.log(res); return res })
.then(res => brambl.pollTx(res.result.txHash))
.then(res => { console.log('\nConfirmed transaction'); console.log(res) })
.catch(console.log)
`

$3

`
// Create Raw Poly Transfer and sign Tx
const address = brambl.keyManager.address;

const rawAssetParams = {
"propositionType": "PublicKeyCurve25519",
"recipients": [
[address, 2]
],
"sender": [address],
"changeAddress": address,
"fee": 1,
"data": "",
};

brambl.transaction('createRawPolyTransfer', rawAssetParams)
.then(res => { console.log('Unconfirmed transaction'); console.log(res); return res })
.then(res => brambl.pollTx(res.result.txHash))
.then(res => { console.log('\nConfirmed transaction'); console.log(res) })
.catch(console.log)
`

$3

`
const addresses = ["AUAftQsaga8DjVfVvq7DK14fm5HvGEDdVLZwexZZvoP7oWkWCLos", "AUAftQsaga8DjVfVvq7DK14fm5HvGEDdVLZwexZZvoP7oWkWCLos"];
brambl.requests.lookupBalancesByAddresses({addresses: addresses})
.then((res) => console.log(res))
.catch((e) => console.error(e));
`

$3

`
brambl.requests.getMempool()
.then((res) => console.log(res))
.catch((e) => console.error(e));
`

$3

`
brambl.requests.getTransactionById({transactionId: "me5cR4imXjssQsB47sKfaAgciYvYrHZCF6J"})
.then((res) => console.log(res))
.catch((e) => console.error(e));
`

$3

`
brambl.requests.getTransactionFromMempool({transactionId: "me5cR4imXjssQsB47sKfaAgciYvYrHZCF6J"})
.then((res) => console.log(res))
.catch((e) => console.error(e));
`

$3

`
brambl.requests.getBlockById({blockId: "wL12me5cR4imXjssQsB47sKfaAgciYvYrHZCF6JN8v1o"})
.then((res) => console.log(res))
.catch((e) => console.error(e));
`

$3

`
brambl.requests.getBlockByHeight({"height": 3})
.then((res) => console.log(res))
.catch((e) => console.error(e));
`

Testing

* Run linter before committing any code or creating a PR: npm run lint
* You can easily apply some fixes (make sure you review them after): npm run lint:fix
* Run only unit tests (uses mocha, chai and sinon): npm run test:ut
* Run only end to end (e2e) tests (uses mocha, chai): npm run test:e2e
* Run both unit testing and linter: npm run test
* Run all tests: npm run test:all`

License

BramblJS is licensed under the Mozilla Public License version 2.0 (MPL 2.0). A copy of this license may be found here