Skip to content
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

Fix Typo and Update References in Withdrawal Documentation #187

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix Typo and Update References in Withdrawal Documentation #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
72553e7
Update readFinalizedWithdrawals.md
Bilogweb3 Dec 10, 2024
9bd9b8b
Update writeProveWithdrawalTransaction.md
Bilogweb3 Dec 10, 2024
642b605
Update writeContractDeposit.md
Bilogweb3 Dec 17, 2024
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
2 changes: 1 addition & 1 deletion site/docs/actions/public/L1/readFinalizedWithdrawals.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# readFinalizedWithdrawals

Returns a boolean for whether the withdrawal of a given withdrawl hash has been finalized.
Returns a boolean for whether the withdrawal of a given withdrawal hash has been finalized.

```ts [example.ts]
import { publicL1Actions } from 'op-viem'
Expand Down
2 changes: 1 addition & 1 deletion site/docs/actions/wallet/L1/writeContractDeposit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ The `OptimismPortal` contract, or equivalent, facilitating the L1 to L2 transiti

## Notes

- The function will throw an error if `strict` is `true` and the `account` is a smart contract. This is to mitigate unexpected behavior due to [address aliasing](https://github.com/ethereum-optimism/optimism/blob/develop/specs/deposits.md#address-aliasing).
- The function will throw an error if `strict` is `true` and the `account` is a smart contract. This is to mitigate unexpected behavior due to [address aliasing](https://github.com/ethereum-optimism/optimism/blob/master/specs/deposits.md#address-aliasing).

- The function uses `encodeFunctionData` to create calldata for the L2 transaction, thus requiring ABI, function name, and args.

Expand Down
4 changes: 2 additions & 2 deletions site/docs/actions/wallet/L1/writeProveWithdrawalTransaction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# writeProveWithdrawalTransaction

Excutes a [proveWithdrawalTransaction](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L1/OptimismPortal.sol#L208) call to the `OptimismPortal` contract.
Executes a [proveWithdrawalTransaction](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L1/OptimismPortal.sol#L208) call to the `OptimismPortal` contract.

::: info
This is the second step in a withdrawal flow, or more generally, an L2 -> L1 call flow.
Expand All @@ -19,7 +19,7 @@ From Viem [writeContract](https://viem.sh/docs/contract/writeContract.html#write

> The `writeContract` internally sends a transaction – it **does not** validate if the contract write will succeed (the contract may throw an error). It is highly recommended to [simulate the contract write with `simulateContract`](#usage) before you execute it.

In this case, you can use [simulateProveWithdrawalTransactoin](/docs/actions/public/L1/simulateProveWithdrawalTransactoin).
In this case, you can use [simulateProveWithdrawalTransaction](/docs/actions/public/L1/simulateProveWithdrawalTransaction).

:::

Expand Down