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.

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

Interactive orbit sdk page #1191

Draft
wants to merge 69 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
69 commits
Select commit Hold shift + click to select a range
c2febbd
Rough file import from Prysm
anegg0 Apr 15, 2024
88bdc15
update content from latest edit session
anegg0 Apr 16, 2024
872be85
fix: assigned interactive files to tmp location + fixed broken links
anegg0 Apr 16, 2024
e40e2fc
fix: created backed for prysm example reference files
anegg0 Apr 16, 2024
0e2cc63
feat: functional partial
anegg0 Apr 16, 2024
64db847
fix: created a dedicated
anegg0 Apr 16, 2024
9630384
fix: link fixing
anegg0 Apr 16, 2024
512576c
Feat: Added two partials
anegg0 Apr 16, 2024
3d2d701
feat: added scss file for partials: will need renaming
anegg0 Apr 16, 2024
9349791
Fix: removed unnecessary prysm files
anegg0 Apr 16, 2024
3354c04
fix: first iteration main article with partials inserts
anegg0 Apr 16, 2024
2bded68
fix: first version of the multidimensional partial
anegg0 Apr 16, 2024
b03b190
fix: removed old prysm partial versions
anegg0 Apr 16, 2024
c57ac02
fix: removed old prysm article from sidebars
anegg0 Apr 16, 2024
f6c522e
fix: tmp config > functional
anegg0 Apr 16, 2024
9b420eb
fix: updated conflicting files
anegg0 Apr 17, 2024
ed8f6bb
fix: yarn format
anegg0 Apr 19, 2024
cb5c933
feat: added more APIs
anegg0 Apr 19, 2024
4ae0328
feat: new partials
anegg0 Apr 19, 2024
28e47dc
fix: removed irrelevant partials
anegg0 Apr 22, 2024
780ae61
fix: removed glitch
anegg0 Apr 22, 2024
dccb7e1
fix: removed obsolete partials from prysm article
anegg0 Apr 22, 2024
da93900
feat: added quicklook
anegg0 Apr 22, 2024
0b192a9
fix: removed unnecessary elements
anegg0 Apr 22, 2024
42d3435
fix: removed unnecessary elements
anegg0 Apr 22, 2024
e66f594
feat: add rollup info partial to replace table
anegg0 Apr 22, 2024
0d12d22
feat: added AnyTrust and custom token chain info partials
anegg0 Apr 22, 2024
84a624b
fix: retrofit chain info table content as a paragraph
anegg0 Apr 22, 2024
665caa1
feat: inserted chain info partials in tabs
anegg0 Apr 22, 2024
a497777
fix: removed chain info table
anegg0 Apr 22, 2024
6264061
fix: removed legacy sdk docs
anegg0 Apr 22, 2024
0ca9f39
fix: reformat
anegg0 Apr 22, 2024
f07ba55
feat: imported all partials in root article
anegg0 Apr 22, 2024
5de35a6
feat: added part of the partials
anegg0 Apr 22, 2024
43eaf25
fix: delete legacy Orbit SDK articles
anegg0 Apr 22, 2024
e4bfff6
fix: Orbit SDK relocation/naming in sidebar
anegg0 Apr 22, 2024
5f53147
feat: switch to mdx to enable <Toc>, <Details> and <Summary>
anegg0 Apr 22, 2024
d982888
fix: improved TabItems style
anegg0 Apr 23, 2024
49c04d2
feat: improved deployment instructions
anegg0 Apr 23, 2024
2776952
fix: merged rollup config and chainConfig in a single partial
anegg0 Apr 23, 2024
fd06e88
fix: merged config and chainConfig partials for Rollup and AnyTrust
anegg0 Apr 23, 2024
430127a
fix: header adjustment to align with all other modules
anegg0 Apr 23, 2024
e8ee036
feat: added node config partial
anegg0 Apr 23, 2024
d39002b
fix: updated article with new partials
anegg0 Apr 23, 2024
071df3c
fix: adjusted headers to align with other partials
anegg0 Apr 23, 2024
b4a824f
fix: rewrote header for context clarity
anegg0 Apr 23, 2024
c0ba74f
fix: created a token bridge deployment bridge for non custom token br…
anegg0 Apr 23, 2024
46a2aaf
fix: created a token bridge deployment bridge for custom token bridges
anegg0 Apr 23, 2024
d37ae3f
fix: created token bridge deployment partials for token bridges and
anegg0 Apr 23, 2024
19a4a38
feat: finalized Rollup and AnyTrust parts
anegg0 Apr 23, 2024
89f01e1
fix: content fixes
anegg0 Apr 23, 2024
77828ca
fix: token bridge deployment content fixes
anegg0 Apr 23, 2024
32f796f
fix: removed construction banner
anegg0 Apr 23, 2024
0801bf3
fix: corrected custom token chain partial
anegg0 Apr 23, 2024
3e3982e
fix: yarn format
anegg0 Apr 23, 2024
a1ec36a
fix: broken links
anegg0 Apr 24, 2024
628c574
fix: added <div>
anegg0 Apr 24, 2024
9570441
fix: removed select chain partial and merged its content into orbit-s…
anegg0 Apr 24, 2024
31e9fb5
fix: removed toc
anegg0 Apr 25, 2024
1ab2454
feat: created new css rules for tabItems
anegg0 Apr 25, 2024
48262d6
feat: completed multidimensional partial
anegg0 Apr 25, 2024
e4b69f0
fix: yarn format
anegg0 Apr 25, 2024
bd892c1
feat: put chain info into an admonition component
anegg0 Apr 26, 2024
8882832
Feat: functional multidimensional partial
anegg0 Apr 26, 2024
4ed7065
feat: added bottom page navigation
anegg0 Apr 26, 2024
d8f7b97
fix: .mdx > .md
anegg0 Apr 26, 2024
e49e69c
feat: added link to tabs in sidebar
anegg0 Apr 28, 2024
11dbb3e
feat: added numbered steps to tabs
anegg0 Apr 28, 2024
3084f57
fix: renamed main page label: Orbit SDK > Introduction
anegg0 Apr 28, 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
35 changes: 35 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# EditorConfig is awesome: https://EditorConfig.org

# top-most EditorConfig file
root = true

# Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
insert_final_newline = true

# Matches multiple files with brace expansion notation
# Set default charset
[*.{js,py}]
charset = utf-8

# 4 space indentation
[*.py]
indent_style = space
indent_size = 4

# Tab indentation (no size specified)
[Makefile]
indent_style = tab

# Indentation override for all JS under lib directory
[lib/**.js]
indent_style = space
indent_size = 2

# Matches the exact files either package.json or .travis.yml
[{package.json,.travis.yml}]
indent_style = space
indent_size = 2

trim_trailing_whitespace=true
22 changes: 11 additions & 11 deletions arbitrum-docs/arbos/l1-to-l2-messaging.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,17 @@ Here we walk through the different stages of the lifecycle of a retryable ticket

1. Creating a retryable ticket is initiated with a call (direct or internal) to the `createRetryableTicket` function of the [`inbox` contract][inbox_link]. A ticket is guaranteed to be created if this call succeeds. Here, we describe parameters that need to be carefully set. Note that, this function forces the sender to provide a _reasonable_ amount of funds (at least enough to submitting, and _attempting_ to executing the ticket), but that doesn't guarantee a successful auto-redemption.

| Parameter | Description |
| :------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- |
| `l1CallValue (also referred to as deposit)` | Not a real function parameter, it is rather the callValue that is sent along with the transaction |
| `address to` | The destination L2 address |
| `uint256 l2CallValue` | The callvalue for retryable L2 message that is supplied within the deposit (l1CallValue) |
| `uint256 maxSubmissionCost` | The maximum amount of ETH to be paid for submitting the ticket. This amount is (1) supplied within the deposit (l1CallValue) to be later deducted from sender's L2 balance and is (2) directly proportional to the size of the retryable’s data and L1 basefee |
| `address excessFeeRefundAddress` | The unused gas cost and submssion cost will deposit to this address, formula is: `(gasLimit x maxFeePerGas - execution cost) + (maxSubmission - (autoredeem ? 0 : submission cost))`. (Note: excess deposit will transfer to the alias address of the parent chain tx's `msg.sender` rather than this address) | |
| `address callValueRefundAddress` | The L2 address to which the l2CallValue is credited if the ticket times out or gets cancelled (this is also called the `beneficiary`, who's got a critical permission to cancel the ticket) |
| `uint256 gasLimit` | Maximum amount of gas used to cover L2 execution of the ticket |
| `uint256 maxFeePerGas` | The gas price bid for L2 execution of the ticket that is supplied within the deposit (l1CallValue) |
| `bytes calldata data` | The calldata to the destination L2 address |
```
- `l1CallValue (also referred to as deposit)`: Not a real function parameter, it is rather the callValue that is sent along with the transaction
- `address to`: The destination L2 address
- `uint256 l2CallValue`: The callvalue for retryable L2 message that is supplied within the deposit (l1CallValue)
- `uint256 maxSubmissionCost`: The maximum amount of ETH to be paid for submitting the ticket. This amount is (1) supplied within the deposit (l1CallValue) to be later deducted from sender's L2 balance and is (2) directly proportional to the size of the retryable’s data and L1 basefee
- `address excessFeeRefundAddress`: The L2 address to which the excess fee is credited (l1CallValue - (autoredeem ? ticket execution cost : submission cost) - l2CallValue)
- `address callValueRefundAddress`: The L2 address to which the l2CallValue is credited if the ticket times out or gets cancelled (this is also called the `beneficiary`, who's got a critical permission to cancel the ticket)
- `uint256 gasLimit`: Maximum amount of gas used to cover L2 execution of the ticket
- `uint256 maxFeePerGas`: The gas price bid for L2 execution of the ticket that is supplied within the deposit (l1CallValue)
- `bytes calldata data`: The calldata to the destination L2 address
```

2. Sender's deposit must be enough to make the L1 submission succeed and for the L2 execution to be _attempted_. If provided correctly, a new ticket with a unique `TicketID` is created and added to retryable buffer. Also, funds (`submissionCost` + `l2CallValue`) are deducted from the sender and placed into the escrow for later use in redeeming the ticket.

Expand Down
Binary file not shown.
Binary file removed arbitrum-docs/bold/assets/l2beat-pie-chart.png
Binary file not shown.
Binary file not shown.
Loading