pkg: Add DTL (#11)

* pkg: Add DTL * fix: use correct tsconfig when building Co-authored-by: Georgios Konstantopoulos <[email protected]>
ethereum-optimism · Mar 29, 2021 · 8f5982d · 8f5982d
1 parent 46ec5bc
commit 8f5982d
Show file tree

Hide file tree

Showing 44 changed files with 8,524 additions and 42 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,5 @@
 node_modules
-dist
+**/dist
 results
 .nyc_output
 *.tsbuildinfo
diff --git a/packages/data-transport-layer/.env.example b/packages/data-transport-layer/.env.example
@@ -0,0 +1,24 @@
+# General options
+DATA_TRANSPORT_LAYER__DB_PATH=./db
+DATA_TRANSPORT_LAYER__ADDRESS_MANAGER=
+DATA_TRANSPORT_LAYER__POLLING_INTERVAL=5000
+DATA_TRANSPORT_LAYER__DANGEROUSLY_CATCH_ALL_ERRORS=true
+DATA_TRANSPORT_LAYER__CONFIRMATIONS=12
+
+# Server options
+DATA_TRANSPORT_LAYER__SERVER_HOSTNAME=localhost
+DATA_TRANSPORT_LAYER__SERVER_PORT=7878
+
+# Set to "true" if you want to sync confirmed transactions from L1 (Ethereum).
+# You probably want to set this to "true".
+DATA_TRANSPORT_LAYER__SYNC_FROM_L1=true
+DATA_TRANSPORT_LAYER__L1_RPC_ENDPOINT=
+DATA_TRANSPORT_LAYER__LOGS_PER_POLLING_INTERVAL=2000
+
+# Set to "true" if you want to sync unconfirmed transactions from a sequencer.
+# Make sure to fill in the below values if you intend to do so.
+DATA_TRANSPORT_LAYER__SYNC_FROM_L2=false
+DATA_TRANSPORT_LAYER__L2_RPC_ENDPOINT=
+DATA_TRANSPORT_LAYER__TRANSACTIONS_PER_POLLING_INTERVAL=1000
+DATA_TRANSPORT_LAYER__L2_CHAIN_ID=69
+DATA_TRANSPORT_LAYER__LEGACY_SEQUENCER_COMPATIBILITY=false
diff --git a/packages/data-transport-layer/.gitignore b/packages/data-transport-layer/.gitignore
@@ -0,0 +1,6 @@
+/db/
+node_modules/
+yarn-error.log
+.env
+test/temp/
+build/
diff --git a/packages/data-transport-layer/CHANGELOG.md b/packages/data-transport-layer/CHANGELOG.md
@@ -0,0 +1,16 @@
+# data transport layer
+
+## v0.1.2
+
+- Fix bug in L2 sync
+
+## v0.1.1
+
+- Prioritize L2 synced API requests
+- Stop syncing L2 at a certain height
+
+## v0.1.0
+
+- Sync From L1
+- Sync From L2
+- Initial Release
diff --git a/packages/data-transport-layer/LICENSE.txt b/packages/data-transport-layer/LICENSE.txt
@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright 2020-2021 Optimism
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/packages/data-transport-layer/README.md b/packages/data-transport-layer/README.md
@@ -0,0 +1,274 @@
+# @eth-optimism/data-transport-layer
+
+## What is this?
+
+The Optimistic Ethereum Data Transport Layer is a long-running software service (written in TypeScript) designed to reliably index Optimistic Ethereum transaction data from Layer 1 (Ethereum). Specifically, this service indexes:
+
+* Transactions that have been enqueued for submission to the CanonicalTransactionChain via [`enqueue`](https://github.com/ethereum-optimism/contracts-v2/blob/13b7deef60f773241723ea874fc6e81b4003b164/contracts/optimistic-ethereum/OVM/chain/OVM_CanonicalTransactionChain.sol#L225-L231).
+* Transactions that have been included in the CanonicalTransactionChain via [`appendQueueBatch`](https://github.com/ethereum-optimism/contracts-v2/blob/13b7deef60f773241723ea874fc6e81b4003b164/contracts/optimistic-ethereum/OVM/chain/OVM_CanonicalTransactionChain.sol#L302-L306) or [`appendSequencerBatch`](https://github.com/ethereum-optimism/contracts-v2/blob/13b7deef60f773241723ea874fc6e81b4003b164/contracts/optimistic-ethereum/OVM/chain/OVM_CanonicalTransactionChain.sol#L352-L354).
+* State roots (transaction results) that have been published to the StateCommitmentChain via [`appendStateBatch`](https://github.com/ethereum-optimism/contracts-v2/blob/13b7deef60f773241723ea874fc6e81b4003b164/contracts/optimistic-ethereum/OVM/chain/OVM_StateCommitmentChain.sol#L127-L132).
+
+## How does it work?
+
+We run two sub-services, the [`L1IngestionService`](./src/services/l1-ingestion/service.ts) and the [`L1TransportServer`](./src/services/server/service.ts). The `L1IngestionService` is responsible for querying for the various events and transaction data necessary to accurately index information from our Layer 1 (Ethereum) smart contracts. The `L1TransportServer` simply provides an API for accessing this information.
+
+## Getting started
+
+### Configuration
+
+See an example config at [.env.example](.env.example); copy into a `.env` file before running.
+
+`L1_TRANSPORT__L1_RPC_ENDPOINT` can be the JSON RPC endpoint of any L1 Ethereum node. `L1_TRANSPORT__ADDRESS_MANAGER` should be the contract addresss of the Address Manager on the corresponding network; find their values in the [Regenesis repo](https://github.com/ethereum-optimism/regenesis).
+
+### Building and usage
+
+After cloning and switching to the repository, install dependencies:
+
+```bash
+$ yarn
+```
+
+Use the following commands to build, use, test, and lint:
+
+```bash
+$ yarn build
+$ yarn start
+$ yarn test
+$ yarn lint
+```
+
+## Configuration
+
+We're using `dotenv` for our configuration.
+Copy `.env.example` into `.env`, feel free to modify it.
+Here's the list of environment variables you can change:
+
+| Variable                                                | Default   |  Description |
+| ------------------------------------------------------- | --------- | ------------ |
+| DATA_TRANSPORT_LAYER__DB_PATH                           | ./db      | Path to the database for this service. |
+| DATA_TRANSPORT_LAYER__ADDRESS_MANAGER                   | -         | Address of the AddressManager contract on L1. See [regenesis](https://github.com/ethereum-optimism/regenesis) repo to find this address for mainnet or kovan. |
+| DATA_TRANSPORT_LAYER__POLLING_INTERVAL                  | 5000      | Period of time between execution loops. |
+| DATA_TRANSPORT_LAYER__DANGEROUSLY_CATCH_ALL_ERRORS      | false     | If true, will catch all errors without throwing. |
+| DATA_TRANSPORT_LAYER__CONFIRMATIONS                     | 12        | Number of confirmations to wait before accepting transactions as "canonical". |
+| DATA_TRANSPORT_LAYER__SERVER_HOSTNAME                   | localhost | Host to run the API on. |
+| DATA_TRANSPORT_LAYER__SERVER_PORT                       | 7878      | Port to run the API on. |
+| DATA_TRANSPORT_LAYER__SYNC_FROM_L1                      | true      | Whether or not to sync from L1. |
+| DATA_TRANSPORT_LAYER__L1_RPC_ENDPOINT                   | -         | RPC endpoint for an L1 node. |
+| DATA_TRANSPORT_LAYER__LOGS_PER_POLLING_INTERVAL         | 2000      | Logs to sync per polling interval. |
+| DATA_TRANSPORT_LAYER__SYNC_FROM_L2                      | false     | Whether or not to sync from L2. |
+| DATA_TRANSPORT_LAYER__L2_RPC_ENDPOINT                   | -         | RPC endpoint for an L2 node. |
+| DATA_TRANSPORT_LAYER__TRANSACTIONS_PER_POLLING_INTERVAL | 1000      | Number of L2 transactions to query per polling interval. |
+| DATA_TRANSPORT_LAYER__L2_CHAIN_ID                       | -         | L2 chain ID. |
+| DATA_TRANSPORT_LAYER__LEGACY_SEQUENCER_COMPATIBILITY    | false     | Whether or not to enable "legacy" sequencer sync (without the custom `eth_getBlockRange` endpoint) |
+
+## HTTP API
+
+This section describes the HTTP API for accessing indexed Layer 1 data.
+
+### Latest Ethereum Block Context
+
+#### Request
+
+```
+GET /eth/context/latest
+```
+
+#### Response
+
+```ts
+{
+    "blockNumber": number,
+    "timestamp": number
+}
+```
+
+### Enqueue by Index
+
+#### Request
+
+```
+GET /enqueue/index/{index: number}
+```
+
+#### Response
+
+```ts
+{
+  "index": number,
+  "target": string,
+  "data": string,
+  "gasLimit": number,
+  "origin": string,
+  "blockNumber": number,
+  "timestamp": number
+}
+```
+
+### Transaction by Index
+
+#### Request
+
+```
+GET /transaction/index/{index: number}
+```
+
+#### Response
+
+```ts
+{
+    "transaction": {
+        "index": number,
+        "batchIndex": number,
+        "data": string,
+        "blockNumber": number,
+        "timestamp": number,
+        "gasLimit": number,
+        "target": string,
+        "origin": string,
+        "queueOrigin": string,
+        "type": string | null,
+        "decoded": {
+            "sig": {
+                "r": string,
+                "s": string,
+                "v": string
+            },
+            "gasLimit": number,
+            "gasPrice": number,
+            "nonce": number,
+            "target": string,
+            "data": string
+        } | null,
+        "queueIndex": number | null,
+    },
+
+    "batch": {
+        "index": number,
+        "blockNumber": number,
+        "timestamp": number,
+        "submitter": string,
+        "size": number,
+        "root": string,
+        "prevTotalElements": number,
+        "extraData": string
+    }
+}
+```
+
+### Transaction Batch by Index
+
+#### Request
+
+```
+GET /batch/transaction/index/{index: number}
+```
+
+#### Response
+
+```ts
+{
+    "batch": {
+        "index": number,
+        "blockNumber": number,
+        "timestamp": number,
+        "submitter": string,
+        "size": number,
+        "root": string,
+        "prevTotalElements": number,
+        "extraData": string
+    },
+
+    "transactions": [
+      {
+        "index": number,
+        "batchIndex": number,
+        "data": string,
+        "blockNumber": number,
+        "timestamp": number,
+        "gasLimit": number,
+        "target": string,
+        "origin": string,
+        "queueOrigin": string,
+        "type": string | null,
+        "decoded": {
+            "sig": {
+                "r": string,
+                "s": string,
+                "v": string
+            },
+            "gasLimit": number,
+            "gasPrice": number,
+            "nonce": number,
+            "target": string,
+            "data": string
+        } | null,
+        "queueIndex": number | null,
+      }
+    ]
+}
+```
+
+
+### State Root by Index
+
+#### Request
+
+```
+GET /stateroot/index/{index: number}
+```
+
+#### Response
+
+```ts
+{
+    "stateRoot": {
+        "index": number,
+        "batchIndex": number,
+        "value": string
+    },
+
+    "batch": {
+        "index": number,
+        "blockNumber": number,
+        "timestamp": number,
+        "submitter": string,
+        "size": number,
+        "root": string,
+        "prevTotalElements": number,
+        "extraData": string
+    },
+}
+```
+
+### State Root Batch by Index
+
+#### Request
+
+```
+GET /batch/stateroot/index/{index: number}
+```
+
+#### Response
+
+```ts
+{
+    "batch": {
+        "index": number,
+        "blockNumber": number,
+        "timestamp": number,
+        "submitter": string,
+        "size": number,
+        "root": string,
+        "prevTotalElements": number,
+        "extraData": string
+    },
+
+    "stateRoots": [
+        {
+            "index": number,
+            "batchIndex": number,
+            "value": string
+        }
+    ]
+}
+```