paritytech/js-abi

Moved to https://github.com/Parity-JS/abi

@parity/abi

A port of https://github.com/paritytech/ethabi to JavaScript

contributing

Clone the repo and install dependencies via npm install. Tests can be executed via npm run test

installation

Install the package with npm install --save @parity/abi from @parity/abi

implementation

approach

• this version tries to stay as close to the original Rust version in intent, function names & purpose
• it is a basic port of the Rust version, relying on effectively the same test-suite (expanded where deemed appropriate)
• it is meant as a library to be used in other projects, i.e. @parity/api

differences to original Rust version

• internally the library operates on string binary representations as opposed to Vector bytes, lengths are therefore 64 bytes as opposed to 32 bytes
• function names are adapted from the Rust standard snake_case to the JavaScript standard camelCase
• due to the initial library focus, the cli component (as implemented by the original) is not supported nor implemented

js-abi's Issues

Wrong encoded input with nested arrays

// -- Encoded input using js lib (incorrect)

secureApi.util.abiEncode('update',['uint256[][]', 'uint256[][]'],[ [[]], [[]] ])

"0000000000000000000000000000000000000000000000000000000000000040" +
"0000000000000000000000000000000000000000000000000000000000000080" +
"0000000000000000000000000000000000000000000000000000000000000001" +
"0000000000000000000000000000000000000000000000000000000000000080" +
"0000000000000000000000000000000000000000000000000000000000000000" +
"0000000000000000000000000000000000000000000000000000000000000001" +
"00000000000000000000000000000000000000000000000000000000000000c0" +
"0000000000000000000000000000000000000000000000000000000000000000"

// -- Encoded input using rust lib (correct)

encode(&vec![
    Token::Array(vec![Token::Array(vec![])]),
    Token::Array(vec![Token::Array(vec![])]),
]);

// offset of the 1st array
"0000000000000000000000000000000000000000000000000000000000000040" +
// offset of the 2nd array
"00000000000000000000000000000000000000000000000000000000000000a0" +
// 40 - 1st array (len)
"0000000000000000000000000000000000000000000000000000000000000001" +
// offset of array inside 1st array
"0000000000000000000000000000000000000000000000000000000000000080" +
// 80 - array inside 1st array (len)
"0000000000000000000000000000000000000000000000000000000000000000" +
// a0 - 2nd array (len)
"0000000000000000000000000000000000000000000000000000000000000001" +
// offset of array inside 2nd array
"00000000000000000000000000000000000000000000000000000000000000e0" +
// e0 - array inside 2nd array (len)
"0000000000000000000000000000000000000000000000000000000000000000"

cc thanks @debris for verifying

ABI tries to encode float values

Given input such as 1cdef.5cb34 the ABI will try to encode the float hex value - incorrectly. Options are -

1. Alert/throw when invalid floats are received
2. Truncate the value before encoding (possibly still warning?)