Skip to content

Commit 80e8ad9

Browse files
chore: update execution API docs (#124)
## Description <!-- Describe your changes in detail --> Updates the Execution API docs to reflect latest updates to v2: astriaorg/astria#2006 and astriaorg/astria#1962 ## Motivation and Context <!-- Why is this change required? What problem does it solve? --> <!-- If it fixes an open issue, please link to the issue here. --> The v2 Execution API starkly contrasts to v1, so changing the documentation seemed appropriate. ## Screenshots (if appropriate): <!-- Provide before and after screen shots --> ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [x] Edits to existing documentation - [ ] Changing documentation structure (relocating existing files, ensure redirects exist) - [ ] Stylistic changes (provide screenshots above)
1 parent 8195bea commit 80e8ad9

File tree

5 files changed

+1748
-1449
lines changed

5 files changed

+1748
-1449
lines changed

.github/workflows/lint.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ jobs:
77
lint:
88
runs-on: ubuntu-latest
99
steps:
10-
- uses: actions/checkout@v3
11-
- uses: actions/setup-node@v3.3.0
10+
- uses: actions/checkout@v4.2.2
11+
- uses: actions/setup-node@v4.4.0
1212
with:
1313
node-version: 18
1414
cache: npm

.github/workflows/test-deploy.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ jobs:
1010
name: Test deployment
1111
runs-on: ubuntu-latest
1212
steps:
13-
- uses: actions/checkout@v3
14-
- uses: actions/setup-node@v3.3.0
13+
- uses: actions/checkout@v4.2.2
14+
- uses: actions/setup-node@v4.4.0
1515
with:
1616
node-version: 18
1717
cache: npm

docs/developer/apis.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -78,24 +78,22 @@ is:
7878
See the Astria `composer-apis` Protobuf definitions
7979
[here](https://buf.build/astria/composer-apis/docs/main:astria.composer.v1).
8080

81-
## Execution-APIs
81+
## Execution-API
8282

83-
The Execution APIs are used to drive deterministic production of blocks for any
83+
The Execution API is used to drive deterministic production of blocks for any
8484
rollup that utilizes The Astria Sequencer and is connected to the [Astria
85-
Conductor](../overview/components/conductor.md). This includes methods such as:
86-
87-
- [GetGenesisInfo](https://buf.build/astria/execution-apis/docs/main:astria.execution.v1#astria.execution.v1.ExecutionService.GetGenesisInfo):
88-
For the Conductor to get the necessary genesis information from the rollup.
89-
- [GetBlock](https://buf.build/astria/execution-apis/docs/main:astria.execution.v1#astria.execution.v1.ExecutionService.GetBlock):
90-
Retrieves information about a block from the sequencer.
91-
- [BatchGetBlocks](https://buf.build/astria/execution-apis/docs/main:astria.execution.v1#astria.execution.v1.ExecutionService.BatchGetBlocks):
92-
Retrieve the information about a collection of blocks from the sequencer.
93-
- [ExecuteBlock](https://buf.build/astria/execution-apis/docs/main:astria.execution.v1#astria.execution.v1.ExecutionService.ExecuteBlock):
94-
Get all the transaction information required to create a new rollup block for execution.
95-
- [GetCommitmentState](https://buf.build/astria/execution-apis/docs/main:astria.execution.v1#astria.execution.v1.ExecutionService.GetCommitmentState):
96-
Retrieve the current commitment state of the rollup.
97-
- [UpdateCommitmentState](https://buf.build/astria/execution-apis/docs/main:astria.execution.v1#astria.execution.v1.ExecutionService.UpdateCommitmentState):
98-
Pass the updated commitment state to the rollup.
85+
Conductor](../overview/components/conductor.md). It includes the following methods:
86+
87+
- [CreateExecutionSession](https://buf.build/astria/execution-apis/docs/main:astria.execution.v2#astria.execution.v2.ExecutionService.CreateExecutionSession):
88+
Requests a new execution session from the rollup. See the
89+
[Execution API Spec](https://github.com/astriaorg/astria/blob/b0bd4025bfb7702b99e79e23cc6bc2c5d2b10db2/specs/execution-api.md#execution-sessions)
90+
for more details on Execution Sessions.
91+
- [ExecuteBlock](https://buf.build/astria/execution-apis/docs/main:astria.execution.v2#astria.execution.v2.ExecutionService.ExecuteBlock):
92+
Drives block execution on rollup, returning its metadata once execution is complete.
93+
- [GetExecutedBlockMetadata](https://buf.build/astria/execution-apis/docs/main:astria.execution.v2#astria.execution.v2.ExecutionService.GetExecutedBlockMetadata):
94+
Retrieves information about a previously executed block from the rollup.
95+
- [UpdateCommitmentState](https://buf.build/astria/execution-apis/docs/main:astria.execution.v2#astria.execution.v2.ExecutionService.UpdateCommitmentState):
96+
Passes the updated commitment state to the rollup.
9997

10098
See the Astria `execution-apis` Protobuf definitions
101-
[here](https://buf.build/astria/execution-apis/docs/main:astria.execution.v1).
99+
[here](https://buf.build/astria/execution-apis/docs/main:astria.execution.v2).

docs/flame/flame-testnet.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ Bundles/bids submitted to the Auctioneer are simulated against the latest block
5555
to calculate the bid paid to the Auctioneer.
5656

5757
:::tip
58-
*The current version of the trusted auctioneer supports `eth_sendTransaction` for submission.
59-
Bids are calculated from the tip paid by the transaction as follows:*
58+
*The current version of the trusted auctioneer supports `eth_sendTransaction` for
59+
submission. Bids are calculated from the tip paid by the transaction as follows:*
6060

6161
`totalFee = tx.Gas * min(tx.GasTipCap, tx.GasFeeCap - tx.baseFee)`
6262
:::

0 commit comments

Comments
 (0)