Contract ABI (v2) and Recursive Length Prefix made easy for the JVM. Everything heavily optimized for maximum throughput (ABI function call encoding up to 500x faster than a popular competitor. One function init plus one encode up to 50x faster (run benchmarks with gradle jmh
or run the maven-generated benchmarks jar)).
ABI spec: https://solidity.readthedocs.io/en/latest/abi-spec.html
RLP spec: https://github.com/ethereum/wiki/wiki/RLP
SHA-256 (headlong-5.7.0.jar): 846c2562c10e0bc1f3d488d45d84d2e7ca9ec6ffcfab71c02d5cf770b879a042
Function f = new Function("baz(uint32,bool)"); // canonicalizes and parses any signature
// or
Function f2 = Function.fromJson("{\"type\":\"function\",\"name\":\"foo\",\"inputs\":[{\"name\":\"complex_nums\",\"type\":\"tuple[]\",\"components\":[{\"name\":\"real\",\"type\":\"decimal\"},{\"name\":\"imaginary\",\"type\":\"decimal\"}]}]}");
Tuple args = new Tuple(69L, true);
// Two equivalent styles:
ByteBuffer one = f.encodeCall(args);
ByteBuffer two = f.encodeCallWithArgs(69L, true);
System.out.println(Function.formatCall(one.array())); // a multi-line hex representation
System.out.println(f.decodeCall(two).equals(args));
Function foo = new Function("foo((fixed[],int8)[1][][5])", "(ufixed,string)");
// decode return type (ufixed,string)
Tuple decoded = foo.decodeReturn(
FastHex.decode(
"0000000000000000000000000000000000000000000000000000000000000045"
+ "0000000000000000000000000000000000000000000000000000000000000040"
+ "000000000000000000000000000000000000000000000000000000000000000e"
+ "59616f62616e6745696768747939000000000000000000000000000000000000"
)
);
System.out.println(decoded.equals(new Tuple(new BigDecimal(BigInteger.valueOf(69L), 18), "YaobangEighty9")));
Function fooTwo = new Function("fooTwo()", "(uint8)");
int returned = fooTwo.decodeSingletonReturn(FastHex.decode("00000000000000000000000000000000000000000000000000000000000000FF"));
BooleanType bool = TypeFactory.create("bool");
IntType uint24 = TypeFactory.create("uint24");
// for an example class Student
public Student(byte[] rlp) {
Iterator<RLPItem> iter = RLP_STRICT.sequenceIterator(rlp);
this.name = iter.next().asString(UTF_8);
this.gpa = iter.next().asFloat();
this.publicKey = iter.next().asBytes();
this.balance = new BigDecimal(iter.next().asBigInt(), iter.next().asInt());
}
@Override
public Object[] toObjectArray() {
return new Object[] {
// instances of byte[]
Strings.decode(name, UTF_8),
FloatingPoint.toBytes(gpa),
publicKey,
balance.unscaledValue().toByteArray(),
Integers.toBytes(balance.scale())
// include an Object[] or Iterable and its elements will be encoded as an RLP list (which may include other lists)
};
}
@Override
public byte[] toRLP() {
return RLPEncoder.encodeSequentially(toObjectArray());
}
Now available in Maven Central Repository.
Or build locally:
Clone the project and install to your local maven repository using gradle publishToMavenLocal
or mvn install
, then declare it as a dependency:
implementation("com.esaulpaugh:headlong:6.0.0-SNAPSHOT")
<dependency>
<groupId>com.esaulpaugh</groupId>
<artifactId>headlong</artifactId>
<version>6.0.0-SNAPSHOT</version>
</dependency>
Alternatively:
- Run
gradle build
orgradle jar
which output tobuild/libs
- Use
mvn package
which outputs totarget
- Execute
ant all build-jar
which outputs tobuild/lib
- Add headlong as a project dependency
https://github.com/esaulpaugh/headlong-cli
https://github.com/esaulpaugh/headlong-android
Also includes optimized implementations of:
- EIP-778 Ethereum Node Records
- EIP-55 Mixed-case checksum address encoding
- Keccak
- hexadecimal
headlong depends on gson v2.8.9. Test suite should take less than one minute to run. Test packages require junit. Jar size is ~116 KiB. Java 8+.
See the wiki for more, such as TupleTypes, packed encoding (and decoding), and RLP Object Notation: https://github.com/esaulpaugh/headlong/wiki
Licensed under Apache 2.0 terms