feat: abi encoder by 2-towns · Pull Request #216 · status-im/nim-web3

2-towns · 2025-07-21T10:10:35Z

Add ABI encoder / decoder from https://github.com/codex-storage/nim-contract-abi.

Fixes #213, #215 and #45

tests/test_contracts.nim

web3/encoding.nim

web3/decoding.nim

2-towns · 2025-08-01T11:37:44Z

I did a benchmark that shows the current implementation outperforms contractabi, especially with objects and large data.
It is slower for small primitives, short strings, and small arrays.

arnetheduck · 2025-08-05T07:00:06Z

It is slower for small primitives, short strings, and small arrays.

oh - that's interesting - if I were two guess, there's an extra allocation somewhere, probably made by faststreams ..

web3/abi_serialization.nim

emizzle

Really nice effort, Arnaud! 👏 I'll have to come back around to reviewing the encoding side of things in another review round as it's quite a lot to review in one sitting.

tests/test_decoding.nim

tests/test_encoding.nim

web3/decoding.nim

arnetheduck · 2025-08-15T10:30:23Z

web3/encoding.nim

+    var data: seq[seq[byte]] = @[]
+    var offset = totalSerializedFields(T) * abiSlotSize
+
+    value.enumInstanceSerializedFields(_, fieldValue):


since we know the size of the non-dynamic part of the encoding, we can use https://github.com/status-im/nim-faststreams/blob/a9c6b884b0971c03e2251094ac88d1ecbc2c20bb/faststreams/outputs.nim#L380 to reserve a write area for it and write the data directly to the stream, avoiding the need for var data

See https://github.com/status-im/nim-faststreams/blob/master/tests/test_outputs.nim#L474 for an example

Okay done in my last commit 763a399

nice! I'm curious if it helped the benchmark

web3/encoding.nim

arnetheduck · 2025-08-15T10:36:21Z

lgtm and certainly a big improvement over the status quo!

there's a few efficiency improvements that can be made
int/uint - ie architecture-specific integers should not be allowed anywhere
range support is problematic for the same reason, ie range[0..10] is I think architecture-specific since the range bounds are int - one would have to disallow that explicitly with something like when range.low is int|uint: error...

Fine with merging and opening issues for the above, or fixing them in this PR directly

2-towns · 2025-08-15T17:37:47Z

lgtm and certainly a big improvement over the status quo!

there's a few efficiency improvements that can be made

int/uint - ie architecture-specific integers should not be allowed anywhere

range support is problematic for the same reason, ie range[0..10] is I think architecture-specific since the range bounds are int - one would have to disallow that explicitly with something like when range.low is int|uint: error...

Fine with merging and opening issues for the above, or fixing them in this PR directly

I prefer to fix them in the PR directly

2-towns · 2025-08-22T15:15:00Z

Okay I fixed everything except the delayFixedSizeWrite which is a bit more complicated to implement. I suggest to open an issue for that as you suggested @arnetheduck . Waiting for your validation.

arnetheduck · 2025-08-27T10:27:23Z

web3/decoding.nim

@@ -0,0 +1,437 @@
+import
+    std/typetraits,


arnetheduck · 2025-08-27T10:28:29Z

web3/decoding.nim

+        decoder.input.advance(offsets[i].int - pos)
+      result[i] = decoder.decode(T)
+
+    return result


if result is used, we should not use return - alternatively, use a separate variable and expression return

arnetheduck · 2025-08-27T10:30:31Z

web3/decoding.nim

+    resultObj = decoder.decode(T)
+
+  decoder.finish()
+  result = resultObj


Suggested change

result = resultObj

resultObj

broadly, we encourage expression return: https://status-im.github.io/nim-style-guide/language.result.html

arnetheduck · 2025-08-27T10:34:21Z

LGTM! Let's get status-im/nimbus-eth2#7376 bumped to these latest changes with the delayed writes and merge as soon as that is green.

2-towns · 2025-08-28T10:38:01Z

LGTM! Let's get status-im/nimbus-eth2#7376 bumped to these latest changes with the delayed writes and merge as soon as that is green.

Okay I am gonna to merge it, nimbus PR is green (except Lint because this PR is not on master yet) https://github.com/status-im/nimbus-eth2/actions/runs/17289414384/job/49073028914.

* Updates to support the new json_serialization streaming * New ABI encoder/decoder (#216)

* Updates to support the new json_serialization streaming * New ABI encoder/decoder (status-im/nim-web3#216)

arnetheduck reviewed Jul 22, 2025

View reviewed changes

tests/test_contracts.nim Outdated Show resolved Hide resolved

arnetheduck reviewed Jul 22, 2025

View reviewed changes

web3/encoding.nim Outdated Show resolved Hide resolved

arnetheduck reviewed Jul 24, 2025

View reviewed changes

web3/encoding.nim Show resolved Hide resolved

arnetheduck reviewed Jul 24, 2025

View reviewed changes

web3/encoding.nim Show resolved Hide resolved

2-towns force-pushed the feat/abi-encoder branch 2 times, most recently from 7a165a6 to 5580e75 Compare July 31, 2025 07:19

arnetheduck reviewed Jul 31, 2025

View reviewed changes

web3/decoding.nim Outdated Show resolved Hide resolved

arnetheduck reviewed Jul 31, 2025

View reviewed changes

web3/decoding.nim Outdated Show resolved Hide resolved

2-towns marked this pull request as ready for review July 31, 2025 14:06

arnetheduck reviewed Aug 5, 2025

View reviewed changes

web3/abi_serialization.nim Outdated Show resolved Hide resolved

arnetheduck approved these changes Aug 5, 2025

View reviewed changes

emizzle reviewed Aug 5, 2025

View reviewed changes

2-towns added 16 commits August 8, 2025 12:28

Add nimbledeps to gitignore

5ecd053

Add abi encoder

3cfe5a7

Add encoding tests

5565dbc

Add AbiEncoder

f9991ab

Add encoding tests

ec1ae61

Fix async signature

85e34d9

Add encoding tests to all tests

0e56f72

Do not bubble the exception

f1e58ba

Add proper error handling

303757e

Use faststream to simplify internal logic

0b17d13

Partial implementation of the decoding

b39d301

Fix tuple encoding and try to provide better docs / tests

07e5222

Update abi util to to take tuple in consideration

75d3f34

Add deprecation notice

c0725cc

Refactor the dynamic array / seq decoding

5f761c4

Add decoding

cb0cdc8

arnetheduck reviewed Aug 15, 2025

View reviewed changes

web3/decoding.nim Outdated Show resolved Hide resolved

arnetheduck reviewed Aug 15, 2025

View reviewed changes

web3/encoding.nim Outdated Show resolved Hide resolved

2-towns added 6 commits August 22, 2025 12:57

Remove int / uint support

b75ec43

Use toOpenArray method and replace StUint usage by uint.

5480654

Use used pragma

d2bba2c

Reject range with int / uint value

13553f4

Apply toOpenArray function

0dd3c4d

Remove unused function

f9355a6

2-towns added 5 commits August 25, 2025 10:37

Check hardhat version on ci

2ee569f

Update ci with hardhat 3

565c359

Remove the intermediate data seq

763a399

Remove comment

7ccd836

Remove comment

4d44970

arnetheduck reviewed Aug 27, 2025

View reviewed changes

web3/decoding.nim

@@ -0,0 +1,437 @@

import

std/typetraits,

Copy link
Copy Markdown

Member

arnetheduck Aug 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

odd indent

arnetheduck reviewed Aug 27, 2025

View reviewed changes

Use explicit return

e86e830

2-towns merged commit 48fb2d4 into master Aug 28, 2025
20 checks passed

2-towns deleted the feat/abi-encoder branch August 28, 2025 12:51

arnetheduck mentioned this pull request Sep 5, 2025

Adapt encoding to ethereum #186

Closed

arnetheduck added a commit that referenced this pull request Sep 25, 2025

v0.8.0

ce882a5

* Updates to support the new json_serialization streaming * New ABI encoder/decoder (#216)

arnetheduck mentioned this pull request Sep 25, 2025

v0.8.0 #226

Merged

arnetheduck added a commit that referenced this pull request Sep 25, 2025

v0.8.0 (#226)

cdfe560

* Updates to support the new json_serialization streaming * New ABI encoder/decoder (#216)

git-ravenbin added a commit to git-ravenbin/nim-web3 that referenced this pull request Oct 26, 2025

v0.8.0 (#226)

add3168

* Updates to support the new json_serialization streaming * New ABI encoder/decoder (status-im/nim-web3#216)

Conversation

2-towns commented Jul 21, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

2-towns commented Aug 1, 2025

Uh oh!

arnetheduck commented Aug 5, 2025

Uh oh!

Uh oh!

emizzle left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

arnetheduck Aug 15, 2025

Choose a reason for hiding this comment

Uh oh!

2-towns Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

arnetheduck Aug 27, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

arnetheduck commented Aug 15, 2025

Uh oh!

2-towns commented Aug 15, 2025

Uh oh!

2-towns commented Aug 22, 2025

Uh oh!

arnetheduck Aug 27, 2025

Choose a reason for hiding this comment

Uh oh!

arnetheduck Aug 27, 2025

Choose a reason for hiding this comment

Uh oh!

arnetheduck Aug 27, 2025

Choose a reason for hiding this comment

Uh oh!

arnetheduck commented Aug 27, 2025

Uh oh!

2-towns commented Aug 28, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants