Socket
Socket
Sign inDemoInstall

rlp

Package Overview
Dependencies
1
Maintainers
2
Versions
33
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    rlp

Recursive Length Prefix Encoding Module


Version published
Weekly downloads
585K
increased by3.54%
Maintainers
2
Created
Weekly downloads
 

Package description

What is rlp?

The 'rlp' npm package is used for encoding and decoding data using the Recursive Length Prefix (RLP) encoding scheme, which is commonly used in Ethereum and other blockchain technologies. RLP is a method to encode arbitrarily nested arrays of binary data, and it is particularly useful for serializing data structures in a compact and efficient manner.

What are rlp's main functionalities?

Encoding Data

This feature allows you to encode an array of data into RLP format. In this example, the array ['cat', 'dog'] is encoded into its RLP representation.

const rlp = require('rlp');
const encoded = rlp.encode(['cat', 'dog']);
console.log(encoded);

Decoding Data

This feature allows you to decode RLP-encoded data back into its original form. In this example, the RLP-encoded buffer is decoded back into the array ['cat', 'dog'].

const rlp = require('rlp');
const encoded = Buffer.from('c88363617483646f67', 'hex');
const decoded = rlp.decode(encoded);
console.log(decoded);

Other packages similar to rlp

Readme

Source

SYNOPSIS

NPM Package Build Status Coverage Status Gitter or #ethereumjs on freenode

js-standard-style

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 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 <hex string>
rlp encode <json String>

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

Keywords

FAQs

Last updated on 28 Jun 2018

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc