https://github.com/vaporyjs/rlp

Vapory Style Recursive Length Prefix Encoding for node.js
https://github.com/vaporyjs/rlp

cli decodes rlp-sequence

Last synced: 9 months ago
JSON representation

Vapory Style Recursive Length Prefix Encoding for node.js

• Host: GitHub
• URL: https://github.com/vaporyjs/rlp
• Owner: vaporyjs
• Created: 2018-03-04T04:43:08.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-01-12T23:42:22.000Z (over 5 years ago)
• Last Synced: 2025-08-08T23:51:22.039Z (10 months ago)
• Topics: cli, decodes, rlp-sequence
• Language: JavaScript
• Homepage: https://vapory.org
• Size: 80.1 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
SYNOPSIS

=====

[![NPM Package](https://img.shields.io/npm/v/rlp.svg?style=flat-square)](https://www.npmjs.org/package/rlp)

[![Build Status](https://img.shields.io/travis/vaporyjs/rlp.svg?branch=master&style=flat-square)](https://travis-ci.org/vaporyjs/rlp)

[![Coverage Status](https://img.shields.io/coveralls/vaporyjs/rlp.svg?style=flat-square)](https://coveralls.io/r/vaporyjs/rlp)

[![Gitter](https://img.shields.io/gitter/room/vapory/vaporyjs-lib.svg?style=flat-square)](https://gitter.im/vapory/vaporyjs-lib) or #vaporyjs on freenode

[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)

[Recursive Length](https://github.com/vaporyco/wiki/wiki/RLP) Prefix Encoding for node.js.

INSTALL

======

`npm install rlp`   

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

USAGE

=======

```javascript

var RLP = require('rlp');

var assert = require('assert');

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 an 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 throw an error if there are more bytes in Buffer than used by rlp sequence.

CLI

===

`rlp decode `   

`rlp encode `  

TESTS

=====

Test uses mocha. To run `npm test`

CODE COVERAGE

=============

Install dev dependencies

`npm install`

Run

`npm run coverage`

The results are at

`coverage/lcov-report/index.html`