Contract ABI Encoding
Go to file
Mark Spanbroek c82a70b353 Fix warnings 2023-06-29 11:07:00 +02:00
.github/workflows Add CI 2021-11-25 09:33:40 +01:00
contractabi Fixes after breaking changes in stew and stint 2023-06-29 11:07:00 +02:00
tests Fix warnings 2023-06-29 11:07:00 +02:00
.editorconfig ABI Encoder extracted from nim-nitro module 2021-11-25 09:33:32 +01:00
.gitignore Add setup files 2022-07-13 09:14:54 +02:00
License.md Add license 2022-01-10 11:17:48 +01:00
Readme.md version 0.4.6 2022-09-14 09:16:12 +02:00
config.nims Add setup files 2022-07-13 09:14:54 +02:00
contractabi.nim Support calculation of solidity function selectors 2022-01-19 09:18:46 +01:00
contractabi.nimble version 0.4.6 2022-09-14 09:16:12 +02:00
nim.cfg ABI Encoder extracted from nim-nitro module 2021-11-25 09:33:32 +01:00
nimble.lock Add setup files 2022-07-13 09:14:54 +02:00

Readme.md

Contract ABI

Implements encoding of parameters according to the Ethereum Contract ABI Specification.

Installation

Use the Nimble package manager to add contractabi to an existing project. Add the following to its .nimble file:

requires "contractabi >= 0.4.6 & < 0.5.0"

Usage

import contractabi

# encode unsigned integers, booleans, enums
AbiEncoder.encode(42'u8)

# encode uint256
import stint
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]) )

# add support for encoding of custom types
import questionable/results

type CustomType = object
  a: uint16
  b: string

func encode(encoder: var AbiEncoder, custom: CustomType) =
  encoder.write( (custom.a, custom.b) )

func decode(decoder: var AbiDecoder, T: type CustomType): ?!T =
  let (a, b) = ?decoder.read( (uint16, string) )
  success CustomType(a: a, b: b)