| Recursive Length Prefix encoding for Node.js and the browser. |
|---|
To obtain the latest version, simply require the project using npm:
npm install @ethereumjs/rlpInstall with -g if you want to use the CLI.
// ./examples/simple.ts
import { RLP } from '@ethereumjs/rlp'
import assert from 'assert'
const nestedList = [[], [[]], [[], [[]]]]
const encoded = RLP.encode(nestedList)
const decoded = RLP.decode(encoded)
assert.deepStrictEqual(decoded, nestedList, 'decoded output does not match original')
console.log('assert.deepStrictEqual would have thrown if the decoded output did not match')With the breaking release round in Summer 2023 we have added hybrid ESM/CJS builds for all our libraries (see section below) and have eliminated many of the caveats which had previously prevented a frictionless browser usage.
It is now easily possible to run a browser build of one of the EthereumJS libraries within a modern browser using the provided ESM build. For a setup example see ./examples/browser.html.
RLP.encode(plain) - RLP encodes an Array, Uint8Array or String and returns a Uint8Array.
RLP.decode(encoded, [stream=false]) - Decodes an RLP encoded Uint8Array, Array or String and returns a Uint8Array or NestedUint8Array. If stream is enabled, it will just decode the first rlp sequence in the Uint8Array. By default, it would throw an error if there are more bytes in Uint8Array than used by the rlp sequence.
rlp encode <JSON string>
rlp decode <0x-prefixed hex string>
rlp encode '5'->0x05rlp encode '[5]'->0xc105rlp encode '["cat", "dog"]'->0xc88363617483646f67rlp decode 0xc88363617483646f67->["cat","dog"]
See our organizational documentation for an introduction to EthereumJS as well as information on current standards and best practices. If you want to join for work or carry out improvements on the libraries, please review our contribution guidelines first.