Arbitrum SDK

.gitmodules

@@ -11,6 +11,9 @@
 [submodule "services/cctp-relayer/external/synapse-contracts"]
 	path = services/cctp-relayer/external/synapse-contracts
 	url = https://github.com/synapsecns/synapse-contracts
+[submodule "ethergo/internal/nitro-contracts"]
+	path = ethergo/internal/nitro-contracts
+	url = https://github.com/OffchainLabs/nitro-contracts
 [submodule "packages/contracts-core/lib/create3-factory"]
 	path = packages/contracts-core/lib/create3-factory
 	url = https://github.com/zeframlou/create3-factory

ethergo/chain/README.md

@@ -0,0 +1,5 @@
+# Chain
+
+The chain module contains deprecated implementations of many commom utilities for interacting with the chain. While this module will be excised in due course from internal libs, it should not be used in any new code.
+
+Feel free to duplicate any functionality from this module on the assumption it will be deleted.

ethergo/parser/abiutil/selector.go

@@ -2,6 +2,7 @@ package abiutil
 
 import (
 	"fmt"
+	"github.com/ethereum/go-ethereum/accounts/abi"
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/ethereum/go-ethereum/common"
 	"strings"
@@ -59,3 +60,18 @@ func GetStringSelectorByName(name string, metadata *bind.MetaData) (string, erro
 	// extract the function selector bytes from the only matching testContract
 	return matchingSigs[0], nil
 }
+
+// MustGetMethodByName gets all the method metadata.
+func MustGetMethodByName(name string, metadata *bind.MetaData) abi.Method {
+	cabi, err := metadata.GetAbi()
+	if err != nil {
+		panic(err)
+	}
+
+	method, ok := cabi.Methods[name]
+	if !ok {
+		panic(fmt.Errorf("no method with name %s", name))
+	}
+
+	return method
+}

ethergo/parser/abiutil/selector_test.go

@@ -27,6 +27,10 @@ func (a *AbiSuite) getSelectorSuccesful(name string, metadata *bind.MetaData) [4
 	selector2 := abiutil.MustGetSelectorByName(name, metadata)
 	a.Require().Equal(selector, selector2)
 
+	realMethod := abiutil.MustGetMethodByName(name, metadata)
+	a.Require().NoError(err)
+	a.Require().Equal(realMethod.ID, selector2[:])
+
 	return selector
 }
 

ethergo/sdks/arbitrum/contracts/arbgasinfo/doc.go

@@ -0,0 +1,5 @@
+// Package arbgasinfo contains the interface to the pre-compiled gas price contract  for the Arbitrum chain.
+//
+// ArbGasInfo contains the interface for a pre-compile used by arbitrum for l2 gas estimation. Documentation is here: https://developer.arbitrum.io/devs-how-tos/how-to-estimate-gas#an-example-of-how-to-apply-this-formula-in-your-code
+// therefore: this cannot be deployed w/ deployers, but merely mocked or called via rpc. For this same reason, we do not need to return Filterers. As this contract does not actually exist.
+package arbgasinfo

ethergo/sdks/arbitrum/contracts/arbgasinfo/generate.go

@@ -0,0 +1,6 @@
+package arbgasinfo
+
+//go:generate go run github.com/synapsecns/sanguine/tools/abigen generate --sol  ../../../../internal/nitro-contracts/src/precompiles/ArbGasInfo.sol --pkg arbgasinfo --sol-version 0.8.17 --filename arbgasinfo
+// here we generate some interfaces we use in for our mocks. TODO this should be automated in abigen for all contracts + be condensed
+//go:generate go run github.com/vburenin/ifacemaker -f arbgasinfo.abigen.go -s ArbGasInfoCaller -i IArbGasInfoCaller -p arbgasinfo -o icaller_generated.go -c "autogenerated file"
+//go:generate go run github.com/vektra/mockery/v2 --name IArbGasInfoCaller --output ./mocks --case=underscore

ethergo/sdks/arbitrum/contracts/arbgasinfo/helpers.go

@@ -0,0 +1,38 @@
+package arbgasinfo
+
+import (
+	"fmt"
+	"github.com/ethereum/go-ethereum/accounts/abi/bind"
+	"github.com/ethereum/go-ethereum/common"
+)
+
+// ArbGasInfoRef is a reference to a ArbGasInfo contract.
+//
+// nolint: golint
+type ArbGasInfoRef struct {
+	*ArbGasInfo
+	address common.Address
+}
+
+// Address gets the address of the contract.
+func (a ArbGasInfoRef) Address() common.Address {
+	return a.address
+}
+
+// NewArbGasInfoRef creates a new ArbGasInfoRef bound to a contract.
+func NewArbGasInfoRef(address common.Address, backend bind.ContractBackend) (IArbGasInfo, error) {
+	gasInfo, err := NewArbGasInfo(address, backend)
+	if err != nil {
+		return nil, fmt.Errorf("failed to instantiate ArbGasInfo contract: %w", err)
+	}
+
+	return &ArbGasInfoRef{
+		ArbGasInfo: gasInfo,
+		address:    address,
+	}, nil
+}
+
+// IArbGasInfo is a thin wrapper around ArbGasInfoCaller that allows interfacing with the contract.
+type IArbGasInfo interface {
+	IArbGasInfoCaller
+}