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

Correct Typos and Improve Documentation Examples #185

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

Correct Typos and Improve Documentation Examples #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
133cb34
typos Update CHANGELOG.md
zlyusia Nov 26, 2024
aa54468
typo Update getDepositTransaction.md
zlyusia Nov 26, 2024
d587cc5
fix code Update index.md
zlyusia Nov 26, 2024
5f7db81
typo Update CHANGELOG.md
zlyusia Nov 26, 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
4 changes: 2 additions & 2 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
- fa49872: Update minGasLimit to be type number for consistency with ABI
- 745a65a: Fix getTransactionHash to use un-decorated function for better tree shaking
- 7a21a29: readFinalizedWithdrawals, txReceipt to getDeposits and getWithdrawals
- 7d16f9b: Actions now receive contract addresses instead of L2 config objects for simplicty and Viem upstream compatibility. op-viem/chains now eexports addresses objects that be spread into actions to pass the required address.
- 7d16f9b: Actions now receive contract addresses instead of L2 config objects for simplicty and Viem upstream compatibility. op-viem/chains now exports addresses objects that be spread into actions to pass the required address.

Previously

Expand Down Expand Up @@ -89,7 +89,7 @@

### Patch Changes

- 7d16f9b: Actions now receive contract addresses instead of L2 config objects for simplicty and Viem upstream compatibility. op-viem/chains now eexports addresses objects that be spread into actions to pass the required address.
- 7d16f9b: Actions now receive contract addresses instead of L2 config objects for simplicity and Viem upstream compatibility. op-viem/chains now exports addresses objects that be spread into actions to pass the required address.

Previously

Expand Down
2 changes: 1 addition & 1 deletion site/docs/utilities/deposits/getDepositTransaction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ head:

# getDepositTransaction

Returns a [DepositTransaction](/docs/glossary/types#deposittransaction) from a [TransactionDepositedEvent](/docs/glossary/types#transasctiondepositedevent) and [sourceHash](/docs/glossary/types#sourcehash) or logIndex, L1 block hash and [SourceHashDomain](/docs/glossary/types#sourcehashdomain).
Returns a [DepositTransaction](/docs/glossary/types#deposittransaction) from a [TransactionDepositedEvent](/docs/glossary/types#transactiondepositedevent) and [sourceHash](/docs/glossary/types#sourcehash) or logIndex, L1 block hash and [SourceHashDomain](/docs/glossary/types#sourcehashdomain).

Internally, if [`sourceHash`](#sourcehash-optional) not provided, will call [`getSourceHash({ domain, logIndex, l1BlockHash })`](docs/utilities/deposits/getSourceHash).

Expand Down
2 changes: 1 addition & 1 deletion site/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,5 @@ export const opStackL2PublicClient = createPublicClient({
}).extend(publicL2OpStackActions)

// perform an action
opStackL1PublicClient.getOutputForL2Block(blockNumber: 2725977n, ...baseAddresses)
await opStackL1PublicClient.getOutputForL2Block(blockNumber: 2725977n, ...baseAddresses)
```