Merge branch 'develop' into aj/deploy-dispute-game-e2e

.changeset/config.json

@@ -3,7 +3,7 @@
   "changelog": ["@changesets/changelog-github", { "repo": "ethereum-optimism/optimism" }],
   "commit": false,
   "fixed": [],
-  "linked": [["contracts-bedrock", "contracts-ts"]],
+  "linked": [["@eth-optimism/contracts-bedrock", "@eth-optimism/contracts-ts"]],
   "access": "public",
   "baseBranch": "develop",
   "updateInternalDependencies": "patch",

.changeset/violet-pants-dress.md

+---
+'@eth-optimism/sdk': minor
+---
+
+Added to and from block filters to several methods in CrossChainMessenger

.circleci/config.yml

@@ -197,7 +197,7 @@ jobs:
             fi
             IMAGE_BASE="<<parameters.registry>>/<<parameters.repo>>/<<parameters.docker_name>>"
             DOCKER_TAGS=$(echo -ne <<parameters.docker_tags>> | sed "s/,/\n/g" | sed "s/[^a-zA-Z0-9\n]/-/g" | sed -e "s|^|-t ${IMAGE_BASE}:|")
-            docker build \
+            docker build --progress plain \
             $(echo -ne $DOCKER_TAGS | tr '\n' ' ') \
             -f <<parameters.docker_file>> \
             <<parameters.docker_context>>
@@ -266,7 +266,7 @@ jobs:
             DOCKER_TAGS=$(echo -ne <<parameters.docker_tags>> | sed "s/,/\n/g" | sed "s/[^a-zA-Z0-9\n]/-/g" | sed -e "s|^|-t ${IMAGE_BASE}:|")
             docker context create buildx-build
             docker buildx create --use buildx-build
-            docker buildx build --platform=<<parameters.platforms>> --target "<<parameters.docker_target>>" --push \
+            docker buildx build --progress plain --platform=<<parameters.platforms>> --target "<<parameters.docker_target>>" --push \
               $(echo -ne $DOCKER_TAGS | tr '\n' ' ') \
               -f <<parameters.docker_file>> \
               <<parameters.docker_context>>
@@ -321,7 +321,7 @@ jobs:
             DOCKER_TAGS=$(echo -ne <<parameters.docker_tags>> | sed "s/,/\n/g" | sed "s/[^a-zA-Z0-9\n]/-/g" | sed -e "s|^|-t ${IMAGE_BASE}:|")
             docker context create buildx-build
             docker buildx create --use buildx-build
-            docker buildx build --platform=<<parameters.platforms>> --target "<<parameters.docker_target>>" --push \
+            docker buildx build --progress plain --platform=<<parameters.platforms>> --target "<<parameters.docker_target>>" --push \
               $(echo -ne $DOCKER_TAGS | tr '\n' ' ') \
               -f <<parameters.docker_file>> \
               <<parameters.docker_context>>
@@ -1745,6 +1745,21 @@ workflows:
             - oplabs-gcr-release
           requires:
             - hold
+      - docker-release:
+          name: op-ufm-docker-release
+          filters:
+            tags:
+              only: /^op-ufm\/v.*/
+            branches:
+              ignore: /.*/
+          docker_file: op-ufm/Dockerfile
+          docker_name: op-ufm
+          docker_tags: <<pipeline.git.revision>>,<<pipeline.git.branch>>
+          docker_context: .
+          context:
+            - oplabs-gcr-release
+          requires:
+            - hold
       - docker-release:
           name: proxyd-docker-release
           filters:

.github/workflows/tag-service.yml

@@ -18,13 +18,14 @@ on:
         required: true
         type: choice
         options:
+          - ci-builder
+          - fault-detector
+          - indexer
           - op-node
           - op-batcher
           - op-proposer
+          - op-ufm
           - proxyd
-          - indexer
-          - fault-detector
-          - ci-builder
       prerelease:
         description: Increment major/minor/patch as prerelease?
         required: false

docs/op-stack/src/docs/build/sdk.md

 ---
-title: Using the SDK with OP Stack
+title: Using the OP Stack Client SDK
 lang: en-US
 ---
 
-When building applications for use with your OP Stack, you can continue to use [the Optimism JavaScript SDK](https://sdk.optimism.io/).
-The main difference is you need to provide some contract addresses to the `CrossDomainMessenger` because they aren't preconfigured.
 
+## Natively supported chains
 
-## Contract addresses
+[The OP Stack Client SDK](https://sdk.optimism.io/) natively supports multiple OP Chains: OP, Base, etc.
+To see whether a specific OP Chain is supported directly, [see the documentation](https://sdk.optimism.io/enums/l2chainid).
 
-### L1 contract addresses
+## Not natively supported chains
 
-The contract addresses are in `.../optimism/packages/contracts-bedrock/deployments/getting-started`, which you created when you deployed the L1 contracts.
+If you are using a chain that is *not* natively supported, for example an OP Stack chain [you just created](./getting-started.md), you can continue to use [the OP Stack Client SDK](https://sdk.optimism.io/). 
+You just need to provide some contract addresses to the `CrossDomainMessenger` because they aren't preconfigured.
+
+### Getting contract addresses
+
+#### L1 contract addresses
+
+If you followed the directions in [Getting Started](./getting-started.md), the contract addresses are in `.../optimism/packages/contracts-bedrock/deployments/getting-started`, which you created when you deployed the L1 contracts.
 
 | Contract name when creating `CrossDomainMessenger` | File with address |
 | - | - |
@@ -22,9 +29,9 @@ The contract addresses are in `.../optimism/packages/contracts-bedrock/deploymen
 | `L2OutputOracle`         | `L2OutputOracleProxy.json`
 
 
-### Unneeded contract addresses
+#### Unneeded contract addresses
 
-Some contracts are required by the SDK, but not actually used.
+Some contracts are required by the SDK as a sanity check, but are not actually used.
 For these contracts you can just specify the zero address:
 
 - `StateCommitmentChain`
@@ -33,7 +40,7 @@ For these contracts you can just specify the zero address:
 
 In JavaScript you can create the zero address using the expression `"0x".padEnd(42, "0")`.
 
-## The CrossChainMessenger object
+### The CrossChainMessenger object
 
 These directions assume you are inside the [Hardhat console](https://hardhat.org/hardhat-runner/docs/guides/hardhat-console).
 They further assume that your project already includes the Optimism SDK [`@eth-optimism/sdk`](https://www.npmjs.com/package/@eth-optimism/sdk).
@@ -113,7 +120,7 @@ They further assume that your project already includes the Optimism SDK [`@eth-o
    })
    ```
 
-## Verify SDK functionality
+### Verify SDK functionality
 
 To verify the SDK's functionality, transfer some ETH from L1 to L2.
 

op-challenger/fault/alphabet_provider.go

@@ -49,7 +49,7 @@ func (ap *AlphabetProvider) Get(i uint64) (common.Hash, error) {
 
 func (ap *AlphabetProvider) AbsolutePreState() []byte {
 	out := make([]byte, 32)
-	out[31] = 140 // ascii character 140 is "`"
+	out[31] = 96 // ascii character 96 is "`"
 	return out
 }
 

op-challenger/fault/responder_test.go

@@ -10,6 +10,7 @@ import (
 	"github.com/ethereum-optimism/optimism/op-node/testlog"
 	"github.com/ethereum-optimism/optimism/op-service/txmgr"
 
+	"github.com/ethereum/go-ethereum"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/log"
@@ -40,6 +41,10 @@ func (m *mockTxManager) Send(ctx context.Context, candidate txmgr.TxCandidate) (
 	), nil
 }
 
+func (m *mockTxManager) Call(_ context.Context, _ ethereum.CallMsg, _ *big.Int) ([]byte, error) {
+	panic("unimplemented")
+}
+
 func (m *mockTxManager) BlockNumber(ctx context.Context) (uint64, error) {
 	panic("not implemented")
 }

op-e2e/actions/l2_proposer.go

@@ -44,6 +44,9 @@ type fakeTxMgr struct {
 func (f fakeTxMgr) From() common.Address {
 	return f.from
 }
+func (f fakeTxMgr) Call(_ context.Context, _ ethereum.CallMsg, _ *big.Int) ([]byte, error) {
+	panic("unimplemented")
+}
 func (f fakeTxMgr) BlockNumber(_ context.Context) (uint64, error) {
 	panic("unimplemented")
 }

op-service/txmgr/mocks/TxManager.go

@@ -4,9 +4,12 @@ package mocks
 
 import (
 	context "context"
+	big "math/big"
 
 	common "github.com/ethereum/go-ethereum/common"
 
+	ethereum "github.com/ethereum/go-ethereum"
+
 	mock "github.com/stretchr/testify/mock"
 
 	txmgr "github.com/ethereum-optimism/optimism/op-service/txmgr"
@@ -43,6 +46,32 @@ func (_m *TxManager) BlockNumber(ctx context.Context) (uint64, error) {
 	return r0, r1
 }
 
+// Call provides a mock function with given fields: ctx, msg, blockNumber
+func (_m *TxManager) Call(ctx context.Context, msg ethereum.CallMsg, blockNumber *big.Int) ([]byte, error) {
+	ret := _m.Called(ctx, msg, blockNumber)
+
+	var r0 []byte
+	var r1 error
+	if rf, ok := ret.Get(0).(func(context.Context, ethereum.CallMsg, *big.Int) ([]byte, error)); ok {
+		return rf(ctx, msg, blockNumber)
+	}
+	if rf, ok := ret.Get(0).(func(context.Context, ethereum.CallMsg, *big.Int) []byte); ok {
+		r0 = rf(ctx, msg, blockNumber)
+	} else {
+		if ret.Get(0) != nil {
+			r0 = ret.Get(0).([]byte)
+		}
+	}
+
+	if rf, ok := ret.Get(1).(func(context.Context, ethereum.CallMsg, *big.Int) error); ok {
+		r1 = rf(ctx, msg, blockNumber)
+	} else {
+		r1 = ret.Error(1)
+	}
+
+	return r0, r1
+}
+
 // From provides a mock function with given fields:
 func (_m *TxManager) From() common.Address {
 	ret := _m.Called()

op-service/txmgr/txmgr.go

@@ -45,6 +45,10 @@ type TxManager interface {
 	// NOTE: Send can be called concurrently, the nonce will be managed internally.
 	Send(ctx context.Context, candidate TxCandidate) (*types.Receipt, error)
 
+	// Call is used to call a contract.
+	// Internally, it uses the [ethclient.Client.CallContract] method.
+	Call(ctx context.Context, msg ethereum.CallMsg, blockNumber *big.Int) ([]byte, error)
+
 	// From returns the sending address associated with the instance of the transaction manager.
 	// It is static for a single instance of a TxManager.
 	From() common.Address
@@ -59,6 +63,9 @@ type ETHBackend interface {
 	// BlockNumber returns the most recent block number.
 	BlockNumber(ctx context.Context) (uint64, error)
 
+	// CallContract executes an eth_call against the provided contract.
+	CallContract(ctx context.Context, msg ethereum.CallMsg, blockNumber *big.Int) ([]byte, error)
+
 	// TransactionReceipt queries the backend for a receipt associated with
 	// txHash. If lookup does not fail, but the transaction is not found,
 	// nil should be returned for both values.
@@ -155,6 +162,12 @@ func (m *SimpleTxManager) Send(ctx context.Context, candidate TxCandidate) (*typ
 	return receipt, err
 }
 
+// Call is used to call a contract.
+// Internally, it uses the [ethclient.Client.CallContract] method.
+func (m *SimpleTxManager) Call(ctx context.Context, msg ethereum.CallMsg, blockNumber *big.Int) ([]byte, error) {
+	return m.backend.CallContract(ctx, msg, blockNumber)
+}
+
 // send performs the actual transaction creation and sending.
 func (m *SimpleTxManager) send(ctx context.Context, candidate TxCandidate) (*types.Receipt, error) {
 	if m.cfg.TxSendTimeout != 0 {

op-service/txmgr/txmgr_test.go

@@ -194,6 +194,11 @@ func (b *mockBackend) BlockNumber(ctx context.Context) (uint64, error) {
 	return b.blockHeight, nil
 }
 
+// Call mocks a call to the EVM.
+func (b *mockBackend) CallContract(ctx context.Context, call ethereum.CallMsg, blockNumber *big.Int) ([]byte, error) {
+	return nil, nil
+}
+
 func (b *mockBackend) HeaderByNumber(ctx context.Context, number *big.Int) (*types.Header, error) {
 	return &types.Header{
 		BaseFee: b.g.basefee(),
@@ -649,6 +654,10 @@ func (b *failingBackend) HeaderByNumber(_ context.Context, _ *big.Int) (*types.H
 	}, nil
 }
 
+func (b *failingBackend) CallContract(_ context.Context, _ ethereum.CallMsg, _ *big.Int) ([]byte, error) {
+	return nil, errors.New("unimplemented")
+}
+
 func (b *failingBackend) SendTransaction(_ context.Context, _ *types.Transaction) error {
 	return errors.New("unimplemented")
 }

packages/contracts-bedrock/deploy-config/devnetL1.json

@@ -44,7 +44,7 @@
   "l1GenesisBlockTimestamp": "0x64935846",
   "l1StartingBlockTag": "earliest",
   "l2GenesisRegolithTimeOffset": "0x0",
-  "faultGameAbsolutePrestate": 140,
+  "faultGameAbsolutePrestate": 96,
   "faultGameMaxDepth": 4,
   "faultGameMaxDuration": 604800
-}
+}
\ No newline at end of file

packages/sdk/example.env

+// public rpcs are heavily throttled/rate limited so replace these with rpcs with apikeys. These are meant to be testnet rpcs
+// in future these will get renamed to VITE_E2E_RPC_URL_GOERLI etc.
+VITE_E2E_RPC_URL_L1=https://ethereum-goerli.publicnode.com
+VITE_E2E_RPC_URL_L2=https://goerli.optimism.io
\ No newline at end of file

packages/sdk/src/cross-chain-messenger.ts

@@ -326,13 +326,11 @@ export class CrossChainMessenger {
    * Transforms a legacy message into its corresponding Bedrock representation.
    *
    * @param message Legacy message to transform.
+   * @param messageIndex The index of the message, if multiple exist from multicall
    * @returns Bedrock representation of the message.
    */
   public async toBedrockCrossChainMessage(
     message: MessageLike,
-    /**
-     * The index of the withdrawal if multiple are made with multicall
-     */
     messageIndex = 0
   ): Promise<CrossChainMessage> {
     const resolved = await this.toCrossChainMessage(message, messageIndex)
@@ -376,13 +374,11 @@ export class CrossChainMessenger {
    * L2ToL1MessagePasser contract on L2.
    *
    * @param message Message to transform.
+   * @param messageIndex The index of the message, if multiple exist from multicall
    * @return Transformed message.
    */
   public async toLowLevelMessage(
     message: MessageLike,
-    /**
-     * The index of the withdrawal if multiple are made with multicall
-     */
     messageIndex = 0
   ): Promise<LowLevelMessage> {
     const resolved = await this.toCrossChainMessage(message, messageIndex)
@@ -586,13 +582,11 @@ export class CrossChainMessenger {
    * create an entire CrossChainProvider object.
    *
    * @param message MessageLike to resolve into a CrossChainMessage.
+   * @param messageIndex The index of the message, if multiple exist from multicall
    * @returns Message coerced into a CrossChainMessage.
    */
   public async toCrossChainMessage(
     message: MessageLike,
-    /**
-     * The index of the withdrawal if multiple are made with multicall
-     */
     messageIndex = 0
   ): Promise<CrossChainMessage> {
     if (!message) {
@@ -651,18 +645,25 @@ export class CrossChainMessenger {
    * Retrieves the status of a particular message as an enum.
    *
    * @param message Cross chain message to check the status of.
+   * @param messageIndex The index of the message, if multiple exist from multicall
+   * @param fromBlockOrBlockHash The start block to use for the query filter on the RECEIVING chain
+   * @param toBlockOrBlockHash The end block to use for the query filter on the RECEIVING chain
    * @returns Status of the message.
    */
   public async getMessageStatus(
     message: MessageLike,
-
-    /**
-     * The index of the withdrawal if multiple are made with multicall
-     */
-    messageIndex = 0
+    // consider making this an options object next breaking release
+    messageIndex = 0,
+    fromBlockOrBlockHash?: BlockTag,
+    toBlockOrBlockHash?: BlockTag
   ): Promise<MessageStatus> {
     const resolved = await this.toCrossChainMessage(message, messageIndex)
-    const receipt = await this.getMessageReceipt(resolved, messageIndex)
+    const receipt = await this.getMessageReceipt(
+      resolved,
+      messageIndex,
+      fromBlockOrBlockHash,
+      toBlockOrBlockHash
+    )
 
     if (resolved.direction === MessageDirection.L1_TO_L2) {
       if (receipt === null) {
@@ -697,7 +698,6 @@ export class CrossChainMessenger {
             await this.contracts.l1.OptimismPortal.provenWithdrawals(
               hashLowLevelMessage(withdrawal)
             )
-
           // If the withdrawal hash has not been proven on L1,
           // return `READY_TO_PROVE`
           if (provenWithdrawal.timestamp.eq(BigNumber.from(0))) {
@@ -742,16 +742,17 @@ export class CrossChainMessenger {
    * Finds the receipt of the transaction that executed a particular cross chain message.
    *
    * @param message Message to find the receipt of.
+   * @param messageIndex The index of the message, if multiple exist from multicall
+   * @param fromBlockOrBlockHash The start block to use for the query filter on the RECEIVING chain
+   * @param toBlockOrBlockHash The end block to use for the query filter on the RECEIVING chain
    * @returns CrossChainMessage receipt including receipt of the transaction that relayed the
    * given message.
    */
   public async getMessageReceipt(
     message: MessageLike,
-
-    /**
-     * The index of the withdrawal if multiple are made with multicall
-     */
-    messageIndex = 0
+    messageIndex = 0,
+    fromBlockOrBlockHash?: BlockTag,
+    toBlockOrHash?: BlockTag
   ): Promise<MessageReceipt> {
     const resolved = await this.toCrossChainMessage(message, messageIndex)
     // legacy withdrawals relayed prebedrock are v1
@@ -783,10 +784,14 @@ export class CrossChainMessenger {
     // this is safe because we can guarantee only one of these filters max will return something
     const relayedMessageEvents = [
       ...(await messenger.queryFilter(
-        messenger.filters.RelayedMessage(messageHashV0)
+        messenger.filters.RelayedMessage(messageHashV0),
+        fromBlockOrBlockHash,
+        toBlockOrHash
       )),
       ...(await messenger.queryFilter(
-        messenger.filters.RelayedMessage(messageHashV1)
+        messenger.filters.RelayedMessage(messageHashV1),
+        fromBlockOrBlockHash,
+        toBlockOrHash
       )),
     ]
 
@@ -806,10 +811,14 @@ export class CrossChainMessenger {
     // FailedRelayedMessage events instead.
     const failedRelayedMessageEvents = [
       ...(await messenger.queryFilter(
-        messenger.filters.FailedRelayedMessage(messageHashV0)
+        messenger.filters.FailedRelayedMessage(messageHashV0),
+        fromBlockOrBlockHash,
+        toBlockOrHash
       )),
       ...(await messenger.queryFilter(
-        messenger.filters.FailedRelayedMessage(messageHashV1)
+        messenger.filters.FailedRelayedMessage(messageHashV1),
+        fromBlockOrBlockHash,
+        toBlockOrHash
       )),
     ]
 
@@ -846,12 +855,17 @@ export class CrossChainMessenger {
    * @param opts.confirmations Number of transaction confirmations to wait for before returning.
    * @param opts.pollIntervalMs Number of milliseconds to wait between polling for the receipt.
    * @param opts.timeoutMs Milliseconds to wait before timing out.
+   * @param opts.fromBlockOrBlockHash The start block to use for the query filter on the RECEIVING chain
+   * @param opts.toBlockOrBlockHash The end block to use for the query filter on the RECEIVING chain
+   * @param messageIndex The index of the message, if multiple exist from multicall
    * @returns CrossChainMessage receipt including receipt of the transaction that relayed the
    * given message.
    */
   public async waitForMessageReceipt(
     message: MessageLike,
     opts: {
+      fromBlockOrBlockHash?: BlockTag
+      toBlockOrHash?: BlockTag
       confirmations?: number
       pollIntervalMs?: number
       timeoutMs?: number
@@ -868,7 +882,12 @@ export class CrossChainMessenger {
     let totalTimeMs = 0
     while (totalTimeMs < (opts.timeoutMs || Infinity)) {
       const tick = Date.now()
-      const receipt = await this.getMessageReceipt(resolved, messageIndex)
+      const receipt = await this.getMessageReceipt(
+        resolved,
+        messageIndex,
+        opts.fromBlockOrBlockHash,
+        opts.toBlockOrHash
+      )
       if (receipt !== null) {
         return receipt
       } else {
@@ -891,18 +910,19 @@ export class CrossChainMessenger {
    * @param opts Options to pass to the waiting function.
    * @param opts.pollIntervalMs Number of milliseconds to wait when polling.
    * @param opts.timeoutMs Milliseconds to wait before timing out.
+   * @param opts.fromBlockOrBlockHash The start block to use for the query filter on the RECEIVING chain
+   * @param opts.toBlockOrBlockHash The end block to use for the query filter on the RECEIVING chain
+   * @param messageIndex The index of the message, if multiple exist from multicall
    */
   public async waitForMessageStatus(
     message: MessageLike,
     status: MessageStatus,
     opts: {
+      fromBlockOrBlockHash?: BlockTag
+      toBlockOrBlockHash?: BlockTag
       pollIntervalMs?: number
       timeoutMs?: number
     } = {},
-
-    /**
-     * The index of the withdrawal if multiple are made with multicall
-     */
     messageIndex = 0
   ): Promise<void> {
     // Resolving once up-front is slightly more efficient.
@@ -911,7 +931,12 @@ export class CrossChainMessenger {
     let totalTimeMs = 0
     while (totalTimeMs < (opts.timeoutMs || Infinity)) {
       const tick = Date.now()
-      const currentStatus = await this.getMessageStatus(resolved, messageIndex)
+      const currentStatus = await this.getMessageStatus(
+        resolved,
+        messageIndex,
+        opts.fromBlockOrBlockHash,
+        opts.toBlockOrBlockHash
+      )
 
       // Handle special cases for L1 to L2 messages.
       if (resolved.direction === MessageDirection.L1_TO_L2) {
@@ -1018,18 +1043,25 @@ export class CrossChainMessenger {
    * amount of time until the message will be picked up and executed on L2.
    *
    * @param message Message to estimate the time remaining for.
+   * @param messageIndex The index of the message, if multiple exist from multicall
+   * @param opts.fromBlockOrBlockHash The start block to use for the query filter on the RECEIVING chain
+   * @param opts.toBlockOrBlockHash The end block to use for the query filter on the RECEIVING chain
    * @returns Estimated amount of time remaining (in seconds) before the message can be executed.
    */
   public async estimateMessageWaitTimeSeconds(
     message: MessageLike,
-
-    /**
-     * The index of the withdrawal if multiple are made with multicall
-     */
-    messageIndex = 0
+    // consider making this an options object next breaking release
+    messageIndex = 0,
+    fromBlockOrBlockHash?: BlockTag,
+    toBlockOrBlockHash?: BlockTag
   ): Promise<number> {
     const resolved = await this.toCrossChainMessage(message, messageIndex)
-    const status = await this.getMessageStatus(resolved, messageIndex)
+    const status = await this.getMessageStatus(
+      resolved,
+      messageIndex,
+      fromBlockOrBlockHash,
+      toBlockOrBlockHash
+    )
     if (resolved.direction === MessageDirection.L1_TO_L2) {
       if (
         status === MessageStatus.RELAYED ||
@@ -1134,14 +1166,11 @@ export class CrossChainMessenger {
    * Returns the Bedrock output root that corresponds to the given message.
    *
    * @param message Message to get the Bedrock output root for.
+   * @param messageIndex The index of the message, if multiple exist from multicall
    * @returns Bedrock output root.
    */
   public async getMessageBedrockOutput(
     message: MessageLike,
-
-    /**
-     * The index of the withdrawal if multiple are made with multicall
-     */
     messageIndex = 0
   ): Promise<BedrockOutputData | null> {
     const resolved = await this.toCrossChainMessage(message, messageIndex)
@@ -1190,14 +1219,11 @@ export class CrossChainMessenger {
    * state root for the given message has not been published yet, this function returns null.
    *
    * @param message Message to find a state root for.
+   * @param messageIndex The index of the message, if multiple exist from multicall
    * @returns State root for the block in which the message was created.
    */
   public async getMessageStateRoot(
     message: MessageLike,
-
-    /**
-     * The index of the withdrawal if multiple are made with multicall
-     */
     messageIndex = 0
   ): Promise<StateRoot | null> {
     const resolved = await this.toCrossChainMessage(message, messageIndex)
@@ -1380,14 +1406,11 @@ export class CrossChainMessenger {
    * Generates the proof required to finalize an L2 to L1 message.
    *
    * @param message Message to generate a proof for.
+   * @param messageIndex The index of the message, if multiple exist from multicall
    * @returns Proof that can be used to finalize the message.
    */
   public async getMessageProof(
     message: MessageLike,
-
-    /**
-     * The index of the withdrawal if multiple are made with multicall
-     */
     messageIndex = 0
   ): Promise<CrossChainMessageProof> {
     const resolved = await this.toCrossChainMessage(message, messageIndex)
@@ -1443,14 +1466,11 @@ export class CrossChainMessenger {
    * Generates the bedrock proof required to finalize an L2 to L1 message.
    *
    * @param message Message to generate a proof for.
+   * @param messageIndex The index of the message, if multiple exist from multicall
    * @returns Proof that can be used to finalize the message.
    */
   public async getBedrockMessageProof(
     message: MessageLike,
-
-    /**
-     * The index of the withdrawal if multiple are made with multicall
-     */
     messageIndex = 0
   ): Promise<BedrockCrossChainMessageProof> {
     const resolved = await this.toCrossChainMessage(message, messageIndex)
@@ -1585,6 +1605,7 @@ export class CrossChainMessenger {
    * @param opts Additional options.
    * @param opts.signer Optional signer to use to send the transaction.
    * @param opts.overrides Optional transaction overrides.
+   * @param messageIndex The index of the message, if multiple exist from multicall
    * @returns Transaction response for the finalization transaction.
    */
   public async finalizeMessage(
@@ -1593,9 +1614,6 @@ export class CrossChainMessenger {
       signer?: Signer
       overrides?: PayableOverrides
     },
-    /**
-     * The index of the withdrawal if multiple are made with multicall
-     */
     messageIndex = 0
   ): Promise<TransactionResponse> {
     return (opts?.signer || this.l1Signer).sendTransaction(
@@ -1873,6 +1891,7 @@ export class CrossChainMessenger {
      * @param message Message to generate the proving transaction for.
      * @param opts Additional options.
      * @param opts.overrides Optional transaction overrides.
+     * @param messageIndex The index of the message, if multiple exist from multicall
      * @returns Transaction that can be signed and executed to prove the message.
      */
     proveMessage: async (
@@ -1880,9 +1899,6 @@ export class CrossChainMessenger {
       opts?: {
         overrides?: PayableOverrides
       },
-      /**
-       * The index of the withdrawal if multiple are made with multicall
-       */
       messageIndex = 0
     ): Promise<TransactionRequest> => {
       const resolved = await this.toCrossChainMessage(message, messageIndex)
@@ -1932,6 +1948,7 @@ export class CrossChainMessenger {
      * @param message Message to generate the finalization transaction for.
      * @param opts Additional options.
      * @param opts.overrides Optional transaction overrides.
+     * @param messageIndex The index of the message, if multiple exist from multicall
      * @returns Transaction that can be signed and executed to finalize the message.
      */
     finalizeMessage: async (
@@ -1939,9 +1956,6 @@ export class CrossChainMessenger {
       opts?: {
         overrides?: PayableOverrides
       },
-      /**
-       * The index of the withdrawal if multiple are made with multicall
-       */
       messageIndex = 0
     ): Promise<TransactionRequest> => {
       const resolved = await this.toCrossChainMessage(message, messageIndex)
@@ -2217,6 +2231,7 @@ export class CrossChainMessenger {
      * @param message Message to generate the proving transaction for.
      * @param opts Additional options.
      * @param opts.overrides Optional transaction overrides.
+     * @param messageIndex The index of the message, if multiple exist from multicall
      * @returns Gas estimate for the transaction.
      */
     proveMessage: async (
@@ -2224,9 +2239,6 @@ export class CrossChainMessenger {
       opts?: {
         overrides?: CallOverrides
       },
-      /**
-       * The index of the withdrawal if multiple are made with multicall
-       */
       messageIndex = 0
     ): Promise<BigNumber> => {
       return this.l1Provider.estimateGas(
@@ -2240,6 +2252,7 @@ export class CrossChainMessenger {
      * @param message Message to generate the finalization transaction for.
      * @param opts Additional options.
      * @param opts.overrides Optional transaction overrides.
+     * @param messageIndex The index of the message, if multiple exist from multicall
      * @returns Gas estimate for the transaction.
      */
     finalizeMessage: async (
@@ -2247,9 +2260,6 @@ export class CrossChainMessenger {
       opts?: {
         overrides?: CallOverrides
       },
-      /**
-       * The index of the withdrawal if multiple are made with multicall
-       */
       messageIndex = 0
     ): Promise<BigNumber> => {
       return this.l1Provider.estimateGas(

packages/sdk/test-next/README.md

@@ -2,3 +2,4 @@
 
 - The new tests for the next version of sdk will use vitest
 - The vitest tests are kept here seperated from mocha tests for now
+- Can find values needed in a `.env` file in `example.env`

packages/sdk/test-next/messageStatus.ts → packages/sdk/test-next/messageStatus.spec.ts

@@ -11,22 +11,40 @@ const crossChainMessenger = new CrossChainMessenger({
   bedrock: true,
 })
 
-describe('prove message', () => {
+describe('getMessageStatus', () => {
   it(`should be able to correctly find a finalized withdrawal`, async () => {
     /**
-     * Tx hash of legacy withdrawal that was claimed
+     * Tx hash of a withdrawal
      *
-     * @see https://goerli-optimism.etherscan.io/tx/0xda9e9c8dfc7718bc1499e1e64d8df6cddbabc46e819475a6c755db286a41b9fa
+     * @see https://goerli-optimism.etherscan.io/tx/0x8fb235a61079f3fa87da66e78c9da075281bc4ba5f1af4b95197dd9480e03bb5
      */
     const txWithdrawalHash =
-      '0xda9e9c8dfc7718bc1499e1e64d8df6cddbabc46e819475a6c755db286a41b9fa'
+      '0x8fb235a61079f3fa87da66e78c9da075281bc4ba5f1af4b95197dd9480e03bb5'
 
     const txReceipt = await l2Provider.getTransactionReceipt(txWithdrawalHash)
 
     expect(txReceipt).toBeDefined()
 
-    expect(await crossChainMessenger.getMessageStatus(txWithdrawalHash)).toBe(
-      MessageStatus.RELAYED
-    )
+    expect(
+      await crossChainMessenger.getMessageStatus(
+        txWithdrawalHash,
+        0,
+        9370789 - 1000,
+        9370789
+      )
+    ).toBe(MessageStatus.RELAYED)
+  }, 20_000)
+
+  it(`should return READY_FOR_RELAY if not in block range`, async () => {
+    const txWithdrawalHash =
+      '0x8fb235a61079f3fa87da66e78c9da075281bc4ba5f1af4b95197dd9480e03bb5'
+
+    const txReceipt = await l2Provider.getTransactionReceipt(txWithdrawalHash)
+
+    expect(txReceipt).toBeDefined()
+
+    expect(
+      await crossChainMessenger.getMessageStatus(txWithdrawalHash, 0, 0, 0)
+    ).toBe(MessageStatus.READY_FOR_RELAY)
   }, 20_000)
 })