-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* 🌱 Add chain utils * 🚧 Add chain constants file * 🚧 Add initial implementation to interact with contracts on chain * ♻️ Update interfaces and rename file * ♻️ Fix test and mocking * Update chainIds type * 🎨 Code cleanup * ✅ Add tests * 👌 Applied suggestions from code review * 👌 Applied suggestions * 👌 Applied suggestions * 👌 Applied suggestions from code review * 👌 Applied suggestions --------- Co-authored-by: Ishan <[email protected]>
- Loading branch information
1 parent
87774a9
commit 4dc7463
Showing
6 changed files
with
289 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| package chain | ||
|
|
||
| // L2ChainIDs manages L2 network chainIDs. | ||
| type L2ChainIDs struct { | ||
| optimism uint64 | ||
| optimismGoerli uint64 | ||
| optimismSepolia uint64 | ||
| optimismHardhatLocal uint64 | ||
| optimismHardhatDevnet uint64 | ||
| optimismBedrockAlphaTestnet uint64 | ||
| baseMainnet uint64 | ||
| baseGoerli uint64 | ||
| baseSepolia uint64 | ||
| zoraGoerli uint64 | ||
| zoraMainnet uint64 | ||
| liskSepolia uint64 | ||
| } | ||
|
|
||
| var l2NetworkChainIDs = L2ChainIDs{ | ||
| optimism: 10, | ||
| optimismGoerli: 420, | ||
| optimismSepolia: 11155420, | ||
| optimismHardhatLocal: 31337, | ||
| optimismHardhatDevnet: 17, | ||
| optimismBedrockAlphaTestnet: 28528, | ||
| baseGoerli: 84531, | ||
| baseSepolia: 84532, | ||
| baseMainnet: 8453, | ||
| zoraGoerli: 999, | ||
| zoraMainnet: 7777777, | ||
| liskSepolia: 4202, | ||
| } | ||
|
|
||
| type NetworkType = string | ||
|
|
||
| const ( | ||
| L1 = NetworkType("L1") | ||
| L2 = NetworkType("L2") | ||
| ) | ||
|
|
||
| // Contracts has information of the L1 & L2 contracts addresses. | ||
| type Contracts struct { | ||
| stateCommitmentChain string | ||
| optimismPortal string | ||
| l2OutputOracle string | ||
| networkType NetworkType | ||
| } | ||
|
|
||
| var contractAddresses map[uint64]Contracts | ||
|
|
||
| func init() { | ||
| contractAddresses = map[uint64]Contracts{ | ||
| l2NetworkChainIDs.optimism: { | ||
| stateCommitmentChain: "0xBe5dAb4A2e9cd0F27300dB4aB94BeE3A233AEB19", | ||
| optimismPortal: "0xbEb5Fc579115071764c7423A4f12eDde41f106Ed", | ||
| l2OutputOracle: "0xdfe97868233d1aa22e815a266982f2cf17685a27", | ||
| networkType: L1, | ||
| }, | ||
| l2NetworkChainIDs.optimismGoerli: { | ||
| stateCommitmentChain: "0x9c945aC97Baf48cB784AbBB61399beB71aF7A378", | ||
| optimismPortal: "0x5b47E1A08Ea6d985D6649300584e6722Ec4B1383", | ||
| l2OutputOracle: "0xE6Dfba0953616Bacab0c9A8ecb3a9BBa77FC15c0", | ||
| networkType: L1, | ||
| }, | ||
| l2NetworkChainIDs.optimismSepolia: { | ||
| stateCommitmentChain: "0x0000000000000000000000000000000000000000", | ||
| optimismPortal: "0x16Fc5058F25648194471939df75CF27A2fdC48BC", | ||
| l2OutputOracle: "0x90E9c4f8a994a250F6aEfd61CAFb4F2e895D458F", | ||
| networkType: L1, | ||
| }, | ||
| l2NetworkChainIDs.optimismHardhatLocal: { | ||
| stateCommitmentChain: "0xDc64a140Aa3E981100a9becA4E685f962f0cF6C9", | ||
| optimismPortal: "0x0000000000000000000000000000000000000000", | ||
| l2OutputOracle: "0x0000000000000000000000000000000000000000", | ||
| networkType: L1, | ||
| }, | ||
| l2NetworkChainIDs.optimismHardhatDevnet: { | ||
| stateCommitmentChain: "0xDc64a140Aa3E981100a9becA4E685f962f0cF6C9", | ||
| optimismPortal: "0x0000000000000000000000000000000000000000", | ||
| l2OutputOracle: "0x0000000000000000000000000000000000000000", | ||
| networkType: L1, | ||
| }, | ||
| l2NetworkChainIDs.optimismBedrockAlphaTestnet: { | ||
| stateCommitmentChain: "0x0000000000000000000000000000000000000000", | ||
| optimismPortal: "0xA581Ca3353DB73115C4625FFC7aDF5dB379434A8", | ||
| l2OutputOracle: "0x3A234299a14De50027eA65dCdf1c0DaC729e04A6", | ||
| networkType: L1, | ||
| }, | ||
| l2NetworkChainIDs.baseGoerli: { | ||
| stateCommitmentChain: "0x0000000000000000000000000000000000000000", | ||
| optimismPortal: "0xe93c8cD0D409341205A592f8c4Ac1A5fe5585cfA", | ||
| l2OutputOracle: "0x2A35891ff30313CcFa6CE88dcf3858bb075A2298", | ||
| networkType: L1, | ||
| }, | ||
| l2NetworkChainIDs.baseSepolia: { | ||
| stateCommitmentChain: "0x0000000000000000000000000000000000000000", | ||
| optimismPortal: "0x49f53e41452C74589E85cA1677426Ba426459e85", | ||
| l2OutputOracle: "0x84457ca9D0163FbC4bbfe4Dfbb20ba46e48DF254", | ||
| networkType: L1, | ||
| }, | ||
| l2NetworkChainIDs.baseMainnet: { | ||
| stateCommitmentChain: "0x0000000000000000000000000000000000000000", | ||
| optimismPortal: "0x49048044D57e1C92A77f79988d21Fa8fAF74E97e", | ||
| l2OutputOracle: "0x56315b90c40730925ec5485cf004d835058518A0", | ||
| networkType: L1, | ||
| }, | ||
| l2NetworkChainIDs.zoraGoerli: { | ||
| stateCommitmentChain: "0x0000000000000000000000000000000000000000", | ||
| optimismPortal: "0xDb9F51790365e7dc196e7D072728df39Be958ACe", | ||
| l2OutputOracle: "0xdD292C9eEd00f6A32Ff5245d0BCd7f2a15f24e00", | ||
| networkType: L1, | ||
| }, | ||
| l2NetworkChainIDs.zoraMainnet: { | ||
| stateCommitmentChain: "0x0000000000000000000000000000000000000000", | ||
| optimismPortal: "0x1a0ad011913A150f69f6A19DF447A0CfD9551054", | ||
| l2OutputOracle: "0x9E6204F750cD866b299594e2aC9eA824E2e5f95c", | ||
| networkType: L1, | ||
| }, | ||
| l2NetworkChainIDs.liskSepolia: { | ||
| optimismPortal: "0xe3d90F21490686Ec7eF37BE788E02dfC12787264", | ||
| l2OutputOracle: "0xA0E35F56C318DE1bD5D9ca6A94Fe7e37C5663348", | ||
| networkType: L1, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| // GetContractAddressesByChainID returns contract addresses by network chainID. | ||
| func GetContractAddressesByChainID(chainID uint64) (Contracts, bool) { | ||
| filteredContracts := contractAddresses[chainID] | ||
|
|
||
| if len(filteredContracts.l2OutputOracle) == 0 { | ||
| return filteredContracts, false | ||
| } | ||
|
|
||
| return filteredContracts, true | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| package chain | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestGetContractAddressesByChainID(t *testing.T) { | ||
| assert := assert.New(t) | ||
|
|
||
| const availableChainID uint64 = 10 | ||
| contractAddresses, areAddressesAvailable := GetContractAddressesByChainID(availableChainID) | ||
| contractAddressesExpected := Contracts{ | ||
| stateCommitmentChain: "0xBe5dAb4A2e9cd0F27300dB4aB94BeE3A233AEB19", | ||
| optimismPortal: "0xbEb5Fc579115071764c7423A4f12eDde41f106Ed", | ||
| l2OutputOracle: "0xdfe97868233d1aa22e815a266982f2cf17685a27", | ||
| networkType: "L1", | ||
| } | ||
| assert.Equal(true, areAddressesAvailable) | ||
| assert.Equal(contractAddressesExpected, contractAddresses) | ||
|
|
||
| const unavailableChainID uint64 = 5 | ||
| contractAddresses, areAddressesAvailable = GetContractAddressesByChainID(unavailableChainID) | ||
| assert.Equal(false, areAddressesAvailable) | ||
| assert.Equal(0, len(contractAddresses.l2OutputOracle)) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| package chain | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "math/big" | ||
|
|
||
| "github.com/ethereum/go-ethereum/accounts/abi/bind" | ||
| "github.com/ethereum/go-ethereum/common" | ||
| "github.com/ethereum/go-ethereum/ethclient" | ||
|
|
||
| "github.com/ethereum-optimism/optimism/op-bindings/bindings" | ||
| ) | ||
|
|
||
| // OracleAccessor binds oracle contract to an instance for querying data. | ||
| type OracleAccessor struct { | ||
| contractInstance *bindings.L2OutputOracle | ||
| } | ||
|
|
||
| // ConfigOptions are the options required to interact with the oracle contract. | ||
| type ConfigOptions struct { | ||
| L1RPCEndpoint string | ||
| ChainID uint64 | ||
| L2OutputOracleContractAddress string | ||
| } | ||
|
|
||
| func getL1OracleContractAddressByChainID(chainID uint64) (string, bool) { | ||
| cAddr, areAddressesAvailable := GetContractAddressesByChainID(chainID) | ||
| if !areAddressesAvailable { | ||
| return "", false | ||
| } | ||
|
|
||
| return cAddr.l2OutputOracle, true | ||
| } | ||
|
|
||
| // NewOracleAccessor returns [OracleAccessor] with contract instance. | ||
| func NewOracleAccessor(ctx context.Context, opts *ConfigOptions) (*OracleAccessor, error) { | ||
| client, err := ethclient.DialContext(ctx, opts.L1RPCEndpoint) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| oracleContractAddress, isAddressExists := getL1OracleContractAddressByChainID(opts.ChainID) | ||
|
|
||
| // Verify if oracle contract address is available in the chain constants | ||
| // If not available, use l2OutputContractAddress from the config options | ||
| if !isAddressExists { | ||
| if len(opts.L2OutputOracleContractAddress) == 0 { | ||
| return nil, fmt.Errorf("L2OutputOracleContractAddress is not available") | ||
| } | ||
| oracleContractAddress = opts.L2OutputOracleContractAddress | ||
| } | ||
|
|
||
| oracleContractInstance, err := bindings.NewL2OutputOracle(common.HexToAddress(oracleContractAddress), client) | ||
|
|
||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return &OracleAccessor{ | ||
| contractInstance: oracleContractInstance, | ||
| }, nil | ||
| } | ||
|
|
||
| // GetNextOutputIndex returns index of next output to be proposed. | ||
| func (oc *OracleAccessor) GetNextOutputIndex() (*big.Int, error) { | ||
| return oc.contractInstance.NextOutputIndex(&bind.CallOpts{}) | ||
| } | ||
|
|
||
| // GetL2Output returns L2 output at given index. | ||
| func (oc *OracleAccessor) GetL2Output(index *big.Int) (bindings.TypesOutputProposal, error) { | ||
| return oc.contractInstance.GetL2Output(&bind.CallOpts{}, index) | ||
| } |
Oops, something went wrong.