Skip to content

feat(sdk): use clearer status enums #3070

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
smartcontracts wants to merge 1 commit into from
Closed

feat(sdk): use clearer status enums #3070

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/cyan-laws-glow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@eth-optimism/sdk': minor
---

Slightly modifies the MessageStatus enum to map to strings instead of integers
12 changes: 6 additions & 6 deletions packages/sdk/src/interfaces/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,34 +120,34 @@ export enum MessageStatus {
/**
* Message is an L1 to L2 message and has not been processed by the L2.
*/
UNCONFIRMED_L1_TO_L2_MESSAGE,
UNCONFIRMED_L1_TO_L2_MESSAGE = 'UNCONFIRMED_L1_TO_L2_MESSAGE',

/**
* Message is an L1 to L2 message and the transaction to execute the message failed.
* When this status is returned, you will need to resend the L1 to L2 message, probably with a
* higher gas limit.
*/
FAILED_L1_TO_L2_MESSAGE,
FAILED_L1_TO_L2_MESSAGE = 'FAILED_L1_TO_L2_MESSAGE',

/**
* Message is an L2 to L1 message and no state root has been published yet.
*/
STATE_ROOT_NOT_PUBLISHED,
STATE_ROOT_NOT_PUBLISHED = 'STATE_ROOT_NOT_PUBLISHED',

/**
* Message is an L2 to L1 message and awaiting the challenge period.
*/
IN_CHALLENGE_PERIOD,
IN_CHALLENGE_PERIOD = 'IN_CHALLENGE_PERIOD',

/**
* Message is ready to be relayed.
*/
READY_FOR_RELAY,
READY_FOR_RELAY = 'READY_FOR_RELAY',

/**
* Message has been relayed.
*/
RELAYED,
RELAYED = 'RELAYED',
}

/**
Expand Down