mirror of
https://github.com/status-im/nim-contract-abi.git
synced 2025-02-21 06:58:33 +00:00
49 lines
1.0 KiB
Markdown
49 lines
1.0 KiB
Markdown
Contract ABI
|
|
============
|
|
|
|
Implements encoding of parameters according to the Ethereum
|
|
[Contract ABI Specification][1].
|
|
|
|
Installation
|
|
------------
|
|
|
|
Use the [Nimble][2] package manager to add `contractabi` to an existing project.
|
|
Add the following to its .nimble file:
|
|
|
|
```nim
|
|
requires "https://github.com/status-im/nim-contract-abi >= 0.1.0 & < 0.2.0"
|
|
```
|
|
|
|
Usage
|
|
-----
|
|
|
|
```nim
|
|
import contractabi
|
|
import stint
|
|
|
|
# encode unsigned integers, booleans, enums
|
|
AbiEncoder.encode(42'u8)
|
|
|
|
# encode uint256
|
|
AbiEncoder.encode(42.u256)
|
|
|
|
# encode byte arrays and sequences
|
|
AbiEncoder.encode([1'u8, 2'u8, 3'u8])
|
|
AbiEncoder.encode(@[1'u8, 2'u8, 3'u8])
|
|
|
|
# encode tuples
|
|
AbiEncoder.encode( (42'u8, @[1'u8, 2'u8, 3'u8], true) )
|
|
|
|
# decode values of different types
|
|
AbiDecoder.decode(bytes, uint8)
|
|
AbiDecoder.decode(bytes, UInt256)
|
|
AbiDecoder.decode(bytes, array[3, uint8])
|
|
AbiDecoder.decode(bytes, seq[uint8])
|
|
|
|
# decode tuples
|
|
AbiDecoder.decode(bytes, (uint32, bool, seq[byte]) )
|
|
```
|
|
|
|
[1]: https://docs.soliditylang.org/en/latest/abi-spec.html
|
|
[2]: https://github.com/nim-lang/nimble
|