feat: use go-abi to replace go-ethereum abi library #788

yihuang · 2025-11-01T10:06:14Z

Description

use go-abi for much better efficiency and error handling

Closes: #789

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

tackled an existing issue or discussed with a team member
left instructions on how to review the changes
targeted the main branch

precompiles/bech32/bech32.abi.go

+	dynamicSize := 0
+	dynamicSize += abi.SizeString(t.Bech32Address)
+
+	return Bech32ToHexCallStaticSize + dynamicSize


precompiles/bech32/bech32.abi.go

+// EncodeTo encodes Bech32ToHexCall to ABI bytes in the provided buffer
+func (value Bech32ToHexCall) EncodeTo(buf []byte) (int, error) {
+	// Encode tuple fields
+	dynamicOffset := Bech32ToHexCallStaticSize // Start dynamic data after static section


precompiles/bech32/bech32.abi.go

+func (t Bech32ToHexReturn) EncodedSize() int {
+	dynamicSize := 0
+
+	return Bech32ToHexReturnStaticSize + dynamicSize


precompiles/bech32/bech32.abi.go

+// EncodeTo encodes Bech32ToHexReturn to ABI bytes in the provided buffer
+func (value Bech32ToHexReturn) EncodeTo(buf []byte) (int, error) {
+	// Encode tuple fields
+	dynamicOffset := Bech32ToHexReturnStaticSize // Start dynamic data after static section


precompiles/bech32/bech32.go

+			return nil, err
+		}
+		bz, err = result.Encode()
+	case Bech32ToHexID:


precompiles/bech32/bech32.go

yihuang · 2025-11-01T10:13:46Z

evmd/go.mod

 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
 	github.com/tyler-smith/go-bip39 v1.1.0 // indirect
 	github.com/ulikunitz/xz v0.5.15 // indirect
+	github.com/yihuang/go-abi v0.0.0-20251031110513-0571d8dc7aa0 // indirect


TODO, make a release before mark this PR as ready for review.

precompiles/bech32/bech32.abi.go

+
+// Big endian integer versions of function selectors
+const (
+	Bech32ToHexID = 3873392158


precompiles/bech32/bech32.abi.go

+
+var _ abi.Method = (*Bech32ToHexCall)(nil)
+
+const Bech32ToHexCallStaticSize = 32


precompiles/bech32/bech32.abi.go

+	return result, nil
+}
+
+const Bech32ToHexReturnStaticSize = 32


precompiles/bech32/bech32.abi.go

Solution: - use go-abi for much better efficiency and error handling update go-abi stdlib support fix: convert interface{} to generated statically typed structs in precompile tests Refactored test files to use generated statically typed structs from go-abi instead of interface{}: - gov/types_test.go: Updated 5 test functions * TestNewMsgDeposit → DepositCall * TestNewMsgCancelProposal → CancelProposalCall * TestNewMsgVote → VoteCall * TestParseVoteArgs → GetVoteCall * TestParseDepositArgs → GetDepositCall - distribution/types_test.go: Updated 8 test functions * TestNewMsgSetWithdrawAddress → SetWithdrawAddressCall * TestNewMsgWithdrawDelegatorReward → WithdrawDelegatorRewardsCall * TestNewMsgFundCommunityPool → FundCommunityPoolCall * TestNewMsgDepositValidatorRewardsPool → DepositValidatorRewardsPoolCall * TestNewDelegationRewardsRequest → DelegationRewardsCall * TestNewDelegationTotalRewardsRequest → DelegationTotalRewardsCall * TestNewDelegatorValidatorsRequest → DelegatorValidatorsCall * TestNewDelegatorWithdrawAddressRequest → DelegatorWithdrawAddressCall - slashing/types_test.go: Updated 1 test function * TestParseSigningInfoArgs: Simplified to remove unnecessary type checks Removed type validation test cases (now handled by Go's type system) and kept only business logic tests. Removed unused fmt imports where applicable. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> Co-Authored-By: Happy <[email protected]> fix test fix: convert interface{} to generated statically typed structs in precompile tests Convert all precompile test files to use generated statically typed structs instead of []interface{}, providing better type safety and developer experience. Changes: - distribution/types_test.go: Convert test arguments from []interface{} to generated structs - staking/types_test.go: Convert all test cases to use generated statically typed structs: * CreateValidatorCall, DelegateCall, UndelegateCall, RedelegateCall * CancelUnbondingDelegationCall, DelegationCall, UnbondingDelegationCall * Updated struct field names to match generated types (Commission → CommissionRates) * Removed unused imports - slashing/types_test.go: Convert test arguments from []interface{} to GetSigningInfoCall - slashing/query.go: Updated query functions to use generated struct types - slashing/tx.go: Updated transaction functions to use generated struct types - slashing/types.go: Updated ParseSigningInfoArgs and ParseSigningInfosArgs - slashing/slashing.go: Added PageRequest mapping to go:generate directive - slashing/slashing.abi.go: Regenerated to use cmn.PageRequest instead of duplicate type Results: - All tests pass successfully - 517 lines of code removed - Type safety improved with compile-time checking - Better IDE autocomplete and type hints 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> Co-Authored-By: Happy <[email protected]> perf: remove redundant *Output structs and move FromResponse to *Return structs Refactor precompile code to remove redundant *Output structs (SigningInfoOutput, SigningInfosOutput, ParamsOutput) and their corresponding custom types. The FromResponse methods now directly populate the generated *Return structs. Benefits: - Removed 78 lines of redundant code - Eliminated type duplication between *Output and *Return structs - Simplified query functions by removing unnecessary conversions - Direct use of generated statically typed structs Changes in slashing precompile: - Deleted SlashingSigningInfo, SigningInfoOutput, SigningInfosOutput structs - Deleted SlashingParams, ParamsOutput structs - Moved FromResponse method receivers to *GetSigningInfoReturn, *GetSigningInfosReturn, *GetParamsReturn - Simplified query.go functions to directly use *Return structs - All tests pass successfully 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> Co-Authored-By: Happy <[email protected]> feat: migrate remaining precompiles to use generated statically typed structs Convert bank, bech32, erc20, and werc20 precompiles to use generated statically typed structs instead of []interface{}, following the pattern established in staking, distribution, and slashing precompiles. Changes: - bank/types.go: Removed unused ParseBalancesArgs and ParseSupplyOfArgs functions - bech32/methods.go: Updated HexToBech32 and Bech32ToHex to use generated Call/Return structs - bech32/bech32.go: Updated Run function to decode args directly using generated structs - erc20/approve.go: Updated Approve to use ApproveCall and ApproveReturn - erc20/erc20.go: Updated Execute to use cmn.Run and cmn.RunWithStateDB with ID constants - erc20/query.go: Converted all query functions to use generated return types - erc20/tx.go: Updated Transfer/TransferFrom to use generated Call/Return structs - erc20/types.go: Removed all Parse*Args functions (replaced by generated structs) - werc20/tx.go: Updated Withdraw to use WithdrawCall and WithdrawReturn - werc20/werc20.go: Updated Execute and IsTransaction to use ID constants Benefits: - ~500+ lines of code removed across all precompiles - Type safety improved with compile-time checking - Better IDE autocomplete and type hints - Consistent patterns across all precompiles Build Status: ✅ All migrated precompiles build successfully ✅ All tests pass (staking, distribution, slashing) Note: ics20 precompile deferred (already builds successfully but uses old pattern) 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> Co-Authored-By: Happy <[email protected]> update go-abi cleanup changelog fix build feat: migrate bank precompile integration tests to go-abi Migrate bank precompile tests from go-ethereum ABI to custom go-abi library: - Updated ContractData struct to remove precompileABI field - Replaced UnpackIntoInterface/Unpack calls with manual decoding helpers - Updated getTxAndCallArgs to use EncodeWithSelector() for direct precompile calls - Rewrote test_query.go unit tests to use typed call structs (BalancesCall, SupplyOfCall, TotalSupplyCall) - Created decoder helper functions for type-safe result decoding - Tests now use fully type-safe generated types instead of reflection Created comprehensive MIGRATION_GUIDE.md with step-by-step instructions for migrating other precompile tests to go-abi. Co-Authored-By: Claude <[email protected]> Co-Authored-By: Happy <[email protected]> feat: migrate bech32 and slashing precompile integration tests to go-abi Migrated bech32 and slashing precompile tests from go-ethereum ABI to custom go-abi library: Bech32 precompile (tests/integration/precompiles/bech32/): - Updated all test cases to use typed call structs (HexToBech32Call, Bech32ToHexCall) - Replaced Pack() calls with EncodeWithSelector() for input encoding - Replaced Unpack() calls with direct Decode() on result types - Rewrote unit tests to use direct precompile methods instead of generic interface Slashing precompile (tests/integration/precompiles/slashing/): - Updated TestGetSigningInfo to use GetSigningInfoCall with ConsAddress field - Updated TestGetSigningInfos to use GetSigningInfosCall with Pagination field - Updated TestGetParams to use GetParamsCall with EmptyTuple - Replaced all UnpackIntoInterface calls with direct result type decoding - Tests now use fully type-safe generated types instead of reflection Co-Authored-By: Claude <[email protected]> Co-Authored-By: Happy <[email protected]> cleanup bank test refactor tests fix tests fix: update factory to use abi.Method from CallArgs Update ExecuteContractCall and QueryContract to use callArgs.Method instead of callArgs directly to match the new GenerateContractCallArgs signature that expects abi.Method interface. Co-Authored-By: Claude <[email protected]> Co-Authored-By: Happy <[email protected]> docs: update MIGRATION_GUIDE.md with status and troubleshooting - Added migration status table for all 10 precompiles - Updated decode examples to show recommended approach (direct Decode) - Added troubleshooting section with common issues and solutions: * s.precompile.Methods undefined * s.precompile.ABI undefined * Too many arguments in calls * Factory calls with CallArgs - Added references to Bech32 and Slashing migrations - Updated examples to be more comprehensive Co-Authored-By: Claude <[email protected]> Co-Authored-By: Happy <[email protected]> fix: variable declarations in BeforeEach blocks - Use short declaration operator (:=) in BeforeEach blocks instead of separate var declarations - Fix DepositEvent and WithdrawalEvent to use pointers: &werc20.DepositEvent{} - Fix ERC20 return type field access (Field1 instead of Balance, Name, Symbol, Decimals) - Remove unused crypto import from test_events.go 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]> Co-Authored-By: Happy <[email protected]> fix gov tests fix gov events test fix gov test build remove unused methods fix build bank tests fix: migrate distribution and erc20 precompiles to go-abi Migrate precompile tests from go-ethereum to go-abi following the gov precompile pattern. Changes: - Distribution precompile: Regenerated ABI and updated test files to use new go-abi encoding pattern - ERC20 precompile: Updated test files to use new call struct pattern and method interface - Updated imports from ethereum/accounts/abi to yihuang/go-abi - Replaced precompile.Methods[] and Pack() with call structs and EncodeWithSelector() - Updated IsTransaction() calls to use method.GetMethodID() This enables the precompiles to build successfully with the new go-abi framework. 🤖 Generated with [Claude Code](https://claude.ai/claude-code) Co-Authored-By: Claude <[email protected]> fix: migrate slashing precompile to go-abi Migrate slashing precompile tests from go-ethereum to go-abi following the established pattern. Changes: - test_tx.go: Updated to use new call struct pattern (UnjailCall) instead of Methods[] and Pack() - test_query.go: Updated to use common.PageRequest and slashing.PageResponse types - Fixed method signatures to use pointer receivers for call structs - Removed unused imports (fmt, testutil) This enables the slashing precompile main test files to build successfully with the new go-abi framework. 🤖 Generated with [Claude Code](https://claude.ai/claude-code) Co-Authored-By: Claude <[email protected]> temp fix erc20 tests temp

precompiles/erc20/erc20.go

precompiles/bech32/bech32.abi.go

+
+// GetMethodID returns the function id
+func (t Bech32ToHexCall) GetMethodID() uint32 {
+	return Bech32ToHexID


precompiles/cmd/main.go

+		for k, v := range generator.ParseExternalTuples(*extTuplesFlag) {
+			extTuples[k] = v
+		}


github-advanced-security bot found potential problems Nov 1, 2025

View reviewed changes

yihuang commented Nov 1, 2025

View reviewed changes

github-advanced-security bot found potential problems Nov 2, 2025

View reviewed changes

precompiles/bech32/bech32.abi.go Fixed Show fixed Hide fixed

yihuang added 2 commits November 3, 2025 10:11

migrate ics02

fe28bfe

yihuang force-pushed the go-abi branch from f1a59f5 to fe28bfe Compare November 3, 2025 02:51

yihuang added 5 commits November 3, 2025 10:51

remove unneeded doc

c06a5fd

cleanup

667466c

cleanup

fbf7d21

fix abi.Decoder pointer receiver

ffb0614

cleanup required gas

6e98340

github-advanced-security bot found potential problems Nov 3, 2025

View reviewed changes

precompiles/erc20/erc20.go Fixed Show fixed Hide fixed

yihuang added 8 commits November 3, 2025 12:02

reuse PageResponse

bdfeaef

revert change

1682e96

generate constructors for positional arguments

c46fd70

temp

fa8e23e

use custom cmd to share customizations

2bce5c4

fix staking tests build

b2ebdf7

fix tests build

177ee83

Merge branch 'main' into go-abi

83d2155

github-advanced-security bot found potential problems Nov 3, 2025

View reviewed changes

yihuang added 5 commits November 4, 2025 05:17

fix build

89ec9ce

fix staking tests build

def4705

fix distribution test build

e0aa260

fix slashing test build

d74d36e

fix ics20 precompiles

fae584f

yihuang changed the title ~~Problem: geth abi library is not suitable for precompile~~ feat: use go-abi to replace go-ethereum abi library Nov 4, 2025

fix tests build

d5efc2c

yihuang marked this pull request as ready for review November 4, 2025 05:17

fix build

e8236e4

yihuang marked this pull request as draft November 4, 2025 06:11

yihuang added 5 commits November 4, 2025 16:31

fix lint

95c77ba

fix method parse

2638064

fix ibc callback tests

5e754e3

fix tests

71fbdaf

fix tests

832dfcc

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: use go-abi to replace go-ethereum abi library #788

feat: use go-abi to replace go-ethereum abi library #788

Uh oh!

yihuang commented Nov 1, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Check warning

Check warning

Uh oh!

Check warning

Check warning

Uh oh!

Check warning

Uh oh!

yihuang Nov 1, 2025 •

edited

Loading

Uh oh!

Check warning

Check warning

Check warning

Uh oh!

Uh oh!

Check warning

Check warning

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant


		var _ abi.Method = (*Bech32ToHexCall)(nil)

		const Bech32ToHexCallStaticSize = 32

feat: use go-abi to replace go-ethereum abi library #788

Are you sure you want to change the base?

feat: use go-abi to replace go-ethereum abi library #788

Uh oh!

Conversation

yihuang commented Nov 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Author Checklist

Uh oh!

Uh oh!

Uh oh!

Check warning

Check warning

Uh oh!

Check warning

Check warning

Uh oh!

Check warning

Uh oh!

yihuang Nov 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Check warning

Check warning

Check warning

Uh oh!

Uh oh!

Check warning

Check warning

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

yihuang commented Nov 1, 2025 •

edited

Loading

yihuang Nov 1, 2025 •

edited

Loading