1.0.1 • Published 5 years ago

rlp-browser v1.0.1

Weekly downloads
1,775
License
MPL-2.0
Repository
github
Last release
5 years ago

This is a fork of EthereumJS' rlp module, which allows browser support via the buffer module, which uses UInt8 arrays instead of the node.js Buffer module.

SYNOPSIS

js-standard-style Build Status Gitter or #ethereumjs on freenode

Recursive Length Prefix Encoding for node.js.

INSTALL

npm install rlp
install with -g if you want to use the cli.

USAGE

var RLP = require('rlp'); 

var nestedList = [ [], [[]], [ [], [[]] ] ];
var encoded = RLP.encode(nestedList);
var decoded = RLP.decode(encoded);
  assert.deepEqual(nestedList, decoded);
});

API

rlp.encode(plain) - RLP encodes an Array, Buffer or String and returns a Buffer.

rlp.decode(encoded, [skipRemainderCheck=false]) - Decodes a RLP encoded Buffer, Array or String and returns a Buffer or an Array of Buffers. If skipRemainderCheck is enabled rlp will just decode the first rlp sequence in the buffer. By default it would through an error if there is more bytes in Buffer than used by rlp sequence.

CLI

rlp decode <hex string>
rlp encode <json String>

TESTS

test uses mocha. To run
npm test