Class Portals

Index

Constructors

Properties

_outputCache bedrock contracts depositConfirmationBlocks estimateGas l1BlockTimeSeconds l1ChainId l1SignerOrProvider l2ChainId l2SignerOrProvider populateTransaction

Accessors

l1Provider l1Signer l2Provider l2Signer

Constructors

constructor

new Portals(opts): Portals
Creates a new CrossChainProvider instance.
Parameters
- opts: {
      bedrock?: boolean;
      contracts?: DeepPartial<OEContractsLike>;
      depositConfirmationBlocks?: NumberLike;
      l1BlockTimeSeconds?: NumberLike;
      l1ChainId: NumberLike;
      l1SignerOrProvider: SignerOrProviderLike;
      l2ChainId: NumberLike;
      l2SignerOrProvider: SignerOrProviderLike;
  }
  Options for the provider.
  - Optional bedrock?: boolean
    Whether or not to enable Bedrock compatibility.
  - Optional contracts?: DeepPartial<OEContractsLike>
    Optional contract address overrides.
  - Optional depositConfirmationBlocks?: NumberLike
    Optional number of blocks before a deposit is confirmed.
  - Optional l1BlockTimeSeconds?: NumberLike
    Optional estimated block time in seconds for the L1 chain.
  - l1ChainId: NumberLike
    Chain ID for the L1 chain.
  - l1SignerOrProvider: SignerOrProviderLike
    Signer or Provider for the L1 chain, or a JSON-RPC url.
  - l2ChainId: NumberLike
    Chain ID for the L2 chain.
  - l2SignerOrProvider: SignerOrProviderLike
    Signer or Provider for the L2 chain, or a JSON-RPC url.
Returns Portals
- Defined in packages/tokamak/sdk/src/portals.ts:107

Properties

`Private` _outputCache

_outputCache: {
root: string;
valid: boolean;
}[] = []

Cache for output root validation. Output roots are expensive to verify, so we cache them.

Type declaration

root: string
valid: boolean

bedrock

bedrock: boolean

Whether or not Bedrock compatibility is enabled.

contracts

contracts: OEContracts

Contract objects attached to their respective providers and addresses.

depositConfirmationBlocks

depositConfirmationBlocks: number

Number of blocks before a deposit is considered confirmed.

estimateGas

estimateGas: {
    depositTransaction: ((request) => Promise<BigNumber>);
    finalizeWithdrawalTransaction: ((message) => Promise<BigNumber>);
    initiateWithdrawal: ((request) => Promise<BigNumber>);
    proveWithdrawalTransaction: ((message, opts?) => Promise<BigNumber>);
} = ...

Object that holds the functions that estimates the gas required for a given transaction. Follows the pattern used by ethers.js.

Type declaration

depositTransaction: ((request) => Promise<BigNumber>)
- - (request): Promise<BigNumber>
  - Parameters
    - request: DepositTransactionRequest
    Returns Promise<BigNumber>
finalizeWithdrawalTransaction: ((message) => Promise<BigNumber>)
- - (message): Promise<BigNumber>
  - Parameters
    - message: WithdrawalMessageInfo
    Returns Promise<BigNumber>
initiateWithdrawal: ((request) => Promise<BigNumber>)
- - (request): Promise<BigNumber>
  - Parameters
    - request: WithdrawalTransactionRequest
    Returns Promise<BigNumber>
proveWithdrawalTransaction: ((message, opts?) => Promise<BigNumber>)
- - (message, opts?): Promise<BigNumber>
  - Parameters
    - message: WithdrawalMessageInfo
    - Optional opts: {
      overrides?: PayableOverrides;
      }
      Optional overrides?: PayableOverrides
    Returns Promise<BigNumber>

l1BlockTimeSeconds

l1BlockTimeSeconds: number

Estimated average L1 block time in seconds.

l1ChainId

l1ChainId: number

Chain ID for the L1 network.

l1SignerOrProvider

l1SignerOrProvider: Provider | Signer

Provider connected to the L1 chain.

l2ChainId

l2ChainId: number

Chain ID for the L2 network.

l2SignerOrProvider

l2SignerOrProvider: Provider | Signer

Provider connected to the L2 chain.

populateTransaction

populateTransaction: {
    depositTransaction: ((request) => Promise<TransactionRequest>);
    finalizeWithdrawalTransaction: ((message) => Promise<TransactionRequest>);
    initiateWithdrawal: ((request) => Promise<TransactionRequest>);
    proveWithdrawalTransaction: ((message, opts?) => Promise<TransactionRequest>);
} = ...

Type declaration

depositTransaction: ((request) => Promise<TransactionRequest>)
- - (request): Promise<TransactionRequest>
  - Parameters
    - request: DepositTransactionRequest
    Returns Promise<TransactionRequest>
finalizeWithdrawalTransaction: ((message) => Promise<TransactionRequest>)
- - (message): Promise<TransactionRequest>
  - Parameters
    - message: WithdrawalMessageInfo
    Returns Promise<TransactionRequest>
initiateWithdrawal: ((request) => Promise<TransactionRequest>)
- - (request): Promise<TransactionRequest>
  - Parameters
    - request: WithdrawalTransactionRequest
    Returns Promise<TransactionRequest>
proveWithdrawalTransaction: ((message, opts?) => Promise<TransactionRequest>)
- - (message, opts?): Promise<TransactionRequest>
  - Parameters
    - message: WithdrawalMessageInfo
    - Optional opts: {
      overrides?: PayableOverrides;
      }
      Optional overrides?: PayableOverrides
    Returns Promise<TransactionRequest>

Accessors

l1Provider

get l1Provider(): Provider
Provider connected to the L1 chain.

Returns Provider
- Defined in packages/tokamak/sdk/src/portals.ts:153

l1Signer

get l1Signer(): Signer
Signer connected to the L1 chain.

Returns Signer
- Defined in packages/tokamak/sdk/src/portals.ts:175

l2Provider

get l2Provider(): Provider
Provider connected to the L2 chain.

Returns Provider
- Defined in packages/tokamak/sdk/src/portals.ts:164

l2Signer

get l2Signer(): Signer
Signer connected to the L2 chain.

Returns Signer
- Defined in packages/tokamak/sdk/src/portals.ts:186

Methods

calculateRelayedDepositTxID

calculateRelayedDepositTxID(txReceipt): Promise<string>
Parameters
- txReceipt: TransactionReceipt
Returns Promise<string>
- Defined in packages/tokamak/sdk/src/portals.ts:604

calculateWithdrawalMessage

calculateWithdrawalMessage(txReceipt): Promise<WithdrawalMessageInfo>
Parameters
- txReceipt: TransactionReceipt
Returns Promise<WithdrawalMessageInfo>
- Defined in packages/tokamak/sdk/src/portals.ts:623

calculateWithdrawalMessageByL2TxHash

calculateWithdrawalMessageByL2TxHash(transactionHash): Promise<WithdrawalMessageInfo>
Parameters
- transactionHash: string
Returns Promise<WithdrawalMessageInfo>
- Defined in packages/tokamak/sdk/src/portals.ts:635

depositTransaction

depositTransaction(request, opts?): Promise<TransactionResponse>
Parameters
- request: DepositTransactionRequest
- Optional opts: {
  signer?: Signer;
  }
  - Optional signer?: Signer
Returns Promise<TransactionResponse>
- Defined in packages/tokamak/sdk/src/portals.ts:907

finalizeWithdrawalTransaction

finalizeWithdrawalTransaction(message, opts?): Promise<TransactionResponse>
Parameters
- message: WithdrawalMessageInfo
- Optional opts: {
  signer?: Signer;
  }
  - Optional signer?: Signer
Returns Promise<TransactionResponse>
- Defined in packages/tokamak/sdk/src/portals.ts:951

finalizeWithdrawalTransactionUsingL2Tx

finalizeWithdrawalTransactionUsingL2Tx(transactionHash, opts?): Promise<TransactionResponse>
Parameters
- transactionHash: string
- Optional opts: {
  signer?: Signer;
  }
  - Optional signer?: Signer
Returns Promise<TransactionResponse>
- Defined in packages/tokamak/sdk/src/portals.ts:963

fpac

fpac(): Promise<boolean>
Uses portal version to determine if the messenger is using fpac contracts. Better not to cache this value as it will change during the fpac upgrade and we want clients to automatically begin using the new logic without throwing any errors.

Returns Promise<boolean>
Whether or not the messenger is using fpac contracts.
- Defined in packages/tokamak/sdk/src/portals.ts:982

getBedrockMessageProof

getBedrockMessageProof(withdrawalMessageInfo): Promise<BedrockCrossChainMessageProof>
Generates the bedrock proof required to finalize an L2 to L1 message.
Parameters
- withdrawalMessageInfo: WithdrawalMessageInfo
Returns Promise<BedrockCrossChainMessageProof>
Proof that can be used to finalize the message.
- Defined in packages/tokamak/sdk/src/portals.ts:701

getChallengePeriodSeconds

getChallengePeriodSeconds(): Promise<number>
Queries the current challenge period in seconds from the StateCommitmentChain.

Returns Promise<number>
Current challenge period in seconds.
- Defined in packages/tokamak/sdk/src/portals.ts:672

getFinalizedWithdrawalStatus

getFinalizedWithdrawalStatus(withdrawalHash): Promise<boolean>
Parameters
- withdrawalHash: string
Returns Promise<boolean>
- Defined in packages/tokamak/sdk/src/portals.ts:901

getL1BlockNumber

getL1BlockNumber(): Promise<number>
Returns Promise<number>
- Defined in packages/tokamak/sdk/src/portals.ts:194

getL1ToL2MessageStatusByReceipt

getL1ToL2MessageStatusByReceipt(txReceipt): Promise<MessageStatus>
Parameters
- txReceipt: TransactionReceipt
Returns Promise<MessageStatus>
- Defined in packages/tokamak/sdk/src/portals.ts:206

getL2ToL1MessageStatusByReceipt

getL2ToL1MessageStatusByReceipt(txReceipt): Promise<MessageStatus>
Parameters
- txReceipt: TransactionReceipt
Returns Promise<MessageStatus>
- Defined in packages/tokamak/sdk/src/portals.ts:509

getMessageBedrockOutput

getMessageBedrockOutput(l2BlockNumber): Promise<BedrockOutputData>
Returns the Bedrock output root that corresponds to the given message.
Parameters
- l2BlockNumber: number
Returns Promise<BedrockOutputData>
Bedrock output root.
- Defined in packages/tokamak/sdk/src/portals.ts:403

getMessageStateRoot

getMessageStateRoot(transactionHash): Promise<StateRoot>
Returns the state root that corresponds to a given message. This is the state root for the block in which the transaction was included, as published to the StateCommitmentChain. If the state root for the given message has not been published yet, this function returns null.
Parameters
- transactionHash: string
Returns Promise<StateRoot>
State root for the block in which the message was created.
- Defined in packages/tokamak/sdk/src/portals.ts:352

getMessageStatus

getMessageStatus(txReceipt): Promise<MessageStatus>
Parameters
- txReceipt: TransactionReceipt
Returns Promise<MessageStatus>
- Defined in packages/tokamak/sdk/src/portals.ts:198

getProvenWithdrawal

getProvenWithdrawal(withdrawalHash): Promise<ProvenWithdrawal>
Queries the OptimismPortal contract's provenWithdrawals mapping for a ProvenWithdrawal that matches the passed withdrawalHash
Parameters
- withdrawalHash: string
Returns Promise<ProvenWithdrawal>
A ProvenWithdrawal object

Bedrock
Note: This function is bedrock-specific.
- Defined in packages/tokamak/sdk/src/portals.ts:749

getStateBatchAppendedEventByBatchIndex

getStateBatchAppendedEventByBatchIndex(batchIndex): Promise<Event>
Returns the StateBatchAppended event that was emitted when the batch with a given index was created. Returns null if no such event exists (the batch has not been submitted).
Parameters
- batchIndex: number
  Index of the batch to find an event for.
Returns Promise<Event>
StateBatchAppended event for the batch, or null if no such batch exists.
- Defined in packages/tokamak/sdk/src/portals.ts:222

getStateBatchAppendedEventByTransactionIndex

getStateBatchAppendedEventByTransactionIndex(transactionIndex): Promise<Event>
Returns the StateBatchAppended event for the batch that includes the transaction with the given index. Returns null if no such event exists.
Parameters
- transactionIndex: number
  Index of the L2 transaction to find an event for.
Returns Promise<Event>
StateBatchAppended event for the batch that includes the given transaction by index.
- Defined in packages/tokamak/sdk/src/portals.ts:248

getStateRootBatchByTransactionIndex

getStateRootBatchByTransactionIndex(transactionIndex): Promise<StateRootBatch>
Returns information about the state root batch that included the state root for the given transaction by index. Returns null if no such state root has been published yet.
Parameters
- transactionIndex: number
  Index of the L2 transaction to find a state root batch for.
Returns Promise<StateRootBatch>
State root batch for the given transaction index, or null if none exists yet.
- Defined in packages/tokamak/sdk/src/portals.ts:314

initiateWithdrawal

initiateWithdrawal(request, opts?): Promise<TransactionResponse>
Parameters
- request: WithdrawalTransactionRequest
- Optional opts: {
  signer?: Signer;
  }
  - Optional signer?: Signer
Returns Promise<TransactionResponse>
- Defined in packages/tokamak/sdk/src/portals.ts:917

isValidOutputRoot

isValidOutputRoot(outputRoot, l2BlockNumber): Promise<boolean>
Parameters
- outputRoot: string
- l2BlockNumber: number
Returns Promise<boolean>
- Defined in packages/tokamak/sdk/src/portals.ts:841

proveWithdrawalTransaction

proveWithdrawalTransaction(message, opts?): Promise<TransactionResponse>
Parameters
- message: WithdrawalMessageInfo
- Optional opts: {
  signer?: Signer;
  }
  - Optional signer?: Signer
Returns Promise<TransactionResponse>
- Defined in packages/tokamak/sdk/src/portals.ts:927

proveWithdrawalTransactionUsingL2Tx

proveWithdrawalTransactionUsingL2Tx(transactionHash, opts?): Promise<TransactionResponse>
Parameters
- transactionHash: string
- Optional opts: {
  signer?: Signer;
  }
  - Optional signer?: Signer
Returns Promise<TransactionResponse>
- Defined in packages/tokamak/sdk/src/portals.ts:939

waitForMessageStatus

waitForMessageStatus(txReceipt, status, opts?): Promise<void>
Parameters
- txReceipt: TransactionReceipt
- status: MessageStatus
- Optional opts: {
  pollIntervalMs?: number;
  timeoutMs?: number;
  }
  - Optional pollIntervalMs?: number
  - Optional timeoutMs?: number
Returns Promise<void>
- Defined in packages/tokamak/sdk/src/portals.ts:644

Class Portals

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

opts: { bedrock?: boolean; contracts?: DeepPartial<OEContractsLike>; depositConfirmationBlocks?: NumberLike; l1BlockTimeSeconds?: NumberLike; l1ChainId: NumberLike; l1SignerOrProvider: SignerOrProviderLike; l2ChainId: NumberLike; l2SignerOrProvider: SignerOrProviderLike; }

Optional bedrock?: boolean

Optional contracts?: DeepPartial<OEContractsLike>

Optional depositConfirmationBlocks?: NumberLike

Optional l1BlockTimeSeconds?: NumberLike

l1ChainId: NumberLike

l1SignerOrProvider: SignerOrProviderLike

l2ChainId: NumberLike

l2SignerOrProvider: SignerOrProviderLike

Returns Portals

Properties

Private _outputCache

Type declaration

root: string

valid: boolean

bedrock

contracts

depositConfirmationBlocks

estimateGas

Type declaration

depositTransaction: ((request) => Promise<BigNumber>)

Parameters

request: DepositTransactionRequest

Returns Promise<BigNumber>

finalizeWithdrawalTransaction: ((message) => Promise<BigNumber>)

Parameters

message: WithdrawalMessageInfo

Returns Promise<BigNumber>

initiateWithdrawal: ((request) => Promise<BigNumber>)

Parameters

request: WithdrawalTransactionRequest

Returns Promise<BigNumber>

proveWithdrawalTransaction: ((message, opts?) => Promise<BigNumber>)

Parameters

message: WithdrawalMessageInfo

Optional opts: { overrides?: PayableOverrides; }

Optional overrides?: PayableOverrides

Returns Promise<BigNumber>

l1BlockTimeSeconds

l1ChainId

l1SignerOrProvider

l2ChainId

l2SignerOrProvider

populateTransaction

Type declaration

depositTransaction: ((request) => Promise<TransactionRequest>)

Parameters

request: DepositTransactionRequest

Returns Promise<TransactionRequest>

finalizeWithdrawalTransaction: ((message) => Promise<TransactionRequest>)

Parameters

message: WithdrawalMessageInfo

Returns Promise<TransactionRequest>

initiateWithdrawal: ((request) => Promise<TransactionRequest>)

Parameters

request: WithdrawalTransactionRequest

Returns Promise<TransactionRequest>

proveWithdrawalTransaction: ((message, opts?) => Promise<TransactionRequest>)

Parameters

message: WithdrawalMessageInfo

Optional opts: { overrides?: PayableOverrides; }

Optional overrides?: PayableOverrides

Returns Promise<TransactionRequest>

Accessors

l1Provider

Returns Provider

l1Signer

Returns Signer

l2Provider

Returns Provider

l2Signer

opts: {
bedrock?: boolean;
contracts?: DeepPartial<OEContractsLike>;
depositConfirmationBlocks?: NumberLike;
l1BlockTimeSeconds?: NumberLike;
l1ChainId: NumberLike;
l1SignerOrProvider: SignerOrProviderLike;
l2ChainId: NumberLike;
l2SignerOrProvider: SignerOrProviderLike;
}

`Optional` bedrock?: boolean

`Optional` contracts?: DeepPartial<OEContractsLike>

`Optional` depositConfirmationBlocks?: NumberLike

`Optional` l1BlockTimeSeconds?: NumberLike

`Private` _outputCache

`Optional` opts: {
overrides?: PayableOverrides;
}

`Optional` overrides?: PayableOverrides

`Optional` opts: {
overrides?: PayableOverrides;
}

`Optional` overrides?: PayableOverrides

`Optional` opts: {
signer?: Signer;
}

`Optional` signer?: Signer

`Optional` opts: {
signer?: Signer;
}

`Optional` signer?: Signer

`Optional` opts: {
signer?: Signer;
}

`Optional` signer?: Signer