Merge pull request #323 from tokamak-network/chore/update-readme

README.md

@@ -1,63 +1,21 @@
 <div align="center">
+  <img alt="Thanos" src="symbol/[email protected]" width=280></a>
   <br />
-  <br />
-  <a href="https://optimism.io"><img alt="Optimism" src="https://raw.githubusercontent.com/ethereum-optimism/brand-kit/main/assets/svg/OPTIMISM-R.svg" width=600></a>
-  <br />
-  <h3><a href="https://optimism.io">Optimism</a> is Ethereum, scaled.</h3>
-  <br />
+  <h1> The Thanos Monorepo</h1>
 </div>
 
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-**Table of Contents**
-
-- [What is Optimism?](#what-is-optimism)
-- [Documentation](#documentation)
-- [Specification](#specification)
-- [Community](#community)
-- [Contributing](#contributing)
-- [Security Policy and Vulnerability Reporting](#security-policy-and-vulnerability-reporting)
-- [Directory Structure](#directory-structure)
-- [Development and Release Process](#development-and-release-process)
-  - [Overview](#overview)
-  - [Production Releases](#production-releases)
-  - [Development branch](#development-branch)
-- [License](#license)
-
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
-
-## What is Optimism?
-
-[Optimism](https://www.optimism.io/) is a project dedicated to scaling Ethereum's technology and expanding its ability to coordinate people from across the world to build effective decentralized economies and governance systems. The [Optimism Collective](https://app.optimism.io/announcement) builds open-source software for running L2 blockchains and aims to address key governance and economic challenges in the wider cryptocurrency ecosystem. Optimism operates on the principle of **impact=profit**, the idea that individuals who positively impact the Collective should be proportionally rewarded with profit. **Change the incentives and you change the world.**
-
-In this repository, you'll find numerous core components of the OP Stack, the decentralized software stack maintained by the Optimism Collective that powers Optimism and forms the backbone of blockchains like [OP Mainnet](https://explorer.optimism.io/) and [Base](https://base.org). Designed to be "aggressively open source," the OP Stack encourages you to explore, modify, extend, and test the code as needed. Although not all elements of the OP Stack are contained here, many of its essential components can be found within this repository. By collaborating on free, open software and shared standards, the Optimism Collective aims to prevent siloed software development and rapidly accelerate the development of the Ethereum ecosystem. Come contribute, build the future, and redefine power, together.
+## TL;DR
+This is core repository for Thanos maintained by [Tokamak Network](https://tokamak.network/#/)
 
 ## Documentation
 
-- If you want to build on top of OP Mainnet, refer to the [Optimism Documentation](https://docs.optimism.io)
-- If you want to build your own OP Stack based blockchain, refer to the [OP Stack Guide](https://docs.optimism.io/stack/getting-started), and make sure to understand this repository's [Development and Release Process](#development-and-release-process)
+More detailed documentation of Thanos can be found [here](https://docs.tokamak.network/home/service-guide/tokamak-l2/thanos-stack).
 
-## Specification
+Tokamak Network also facilitates Thanos-based rollup deployments through the [Tokamak Rollup Hub](https://rolluphub.tokamak.network/). For further details and deployment guidelines, please review the following resources:
 
-If you're interested in the technical details of how Optimism works, refer to the [Optimism Protocol Specification](https://github.com/ethereum-optimism/specs).
+- **Devnet:** [Rollup Hub - Devnet](https://docs.tokamak.network/home/service-guide/rollup-hub/devnet)
+- **Mainnet/Testnet:** [Rollup Hub - Mainnet Beta](https://docs.tokamak.network/home/service-guide/rollup-hub/mainnet-beta)
 
-## Community
-
-General discussion happens most frequently on the [Optimism discord](https://discord.gg/optimism).
-Governance discussion can also be found on the [Optimism Governance Forum](https://gov.optimism.io/).
-
-## Contributing
-
-Read through [CONTRIBUTING.md](./CONTRIBUTING.md) for a general overview of the contributing process for this repository.
-Use the [Developer Quick Start](./CONTRIBUTING.md#development-quick-start) to get your development environment set up to start working on the Optimism Monorepo.
-Then check out the list of [Good First Issues](https://github.com/ethereum-optimism/optimism/issues?q=is:open+is:issue+label:D-good-first-issue) to find something fun to work on!
-Typo fixes are welcome; however, please create a single commit with all of the typo fixes & batch as many fixes together in a PR as possible. Spammy PRs will be closed.
-
-## Security Policy and Vulnerability Reporting
-
-Please refer to the canonical [Security Policy](https://github.com/ethereum-optimism/.github/blob/master/SECURITY.md) document for detailed information about how to report vulnerabilities in this codebase.
-Bounty hunters are encouraged to check out [the Optimism Immunefi bug bounty program](https://immunefi.com/bounty/optimism/).
-The Optimism Immunefi program offers up to $2,000,042 for in-scope critical vulnerabilities.
 
 ## Directory Structure
 
@@ -77,69 +35,19 @@ The Optimism Immunefi program offers up to $2,000,042 for in-scope critical vuln
 ├── <a href="./op-ufm">op-ufm</a>: Simulations for monitoring end-to-end transaction latency
 ├── <a href="./op-wheel">op-wheel</a>: Database utilities
 ├── <a href="./ops">ops</a>: Various operational packages
-├── <a href="./ops-bedrock">ops-bedrock</a>: Bedrock devnet work
-├── <a href="./packages">packages</a>
-│   ├── <a href="./packages/chain-mon">chain-mon</a>: Chain monitoring services
-│   ├── <a href="./packages/contracts-bedrock">contracts-bedrock</a>: Bedrock smart contracts
-│   ├── <a href="./packages/sdk">sdk</a>: provides a set of tools for interacting with Optimism
+├── <a href="./ops-bedrock">ops-bedrock</a>: Bedrock devnet work for Thanos
+├── <a href="./packages/tokamak">packages for Thanos</a>
+│   ├── <a href="./packages/tokamak/contracts-bedrock">contracts-bedrock</a>: Bedrock + Thanos smart contracts
+│   ├── <a href="./packages/tokamak/sdk">sdk</a>: provides a set of tools for interacting with Thanos
+│   ├── <a href="./packages/tokamak/core-utils">core-utils</a>: provides core utilities for interacting with Thanos
 ├── <a href="./proxyd">proxyd</a>: Configurable RPC request router and proxy
 ├── <a href="./specs">specs</a>: Specs of the rollup starting at the Bedrock upgrade
 </pre>
 
-## Development and Release Process
-
-### Overview
-
-Please read this section if you're planning to fork this repository, or make frequent PRs into this repository.
-
-### Production Releases
-
-Production releases are always tags, versioned as `<component-name>/v<semver>`.
-For example, an `op-node` release might be versioned as `op-node/v1.1.2`, and  smart contract releases might be versioned as `op-contracts/v1.0.0`.
-Release candidates are versioned in the format `op-node/v1.1.2-rc.1`.
-We always start with `rc.1` rather than `rc`.
-
-For contract releases, refer to the GitHub release notes for a given release, which will list the specific contracts being released—not all contracts are considered production ready within a release, and many are under active development.
-
-Tags of the form `v<semver>`, such as `v1.1.4`, indicate releases of all Go code only, and **DO NOT** include smart contracts.
-This naming scheme is required by Golang.
-In the above list, this means these `v<semver` releases contain all `op-*` components, and exclude all `contracts-*` components.
-
-`op-geth` embeds upstream geth’s version inside it’s own version as follows: `vMAJOR.GETH_MAJOR GETH_MINOR GETH_PATCH.PATCH`.
-Basically, geth’s version is our minor version.
-For example if geth is at `v1.12.0`, the corresponding op-geth version would be `v1.101200.0`.
-Note that we pad out to three characters for the geth minor version and two characters for the geth patch version.
-Since we cannot left-pad with zeroes, the geth major version is not padded.
-
-See the [Node Software Releases](https://docs.optimism.io/builders/node-operators/releases) page of the documentation for more information about releases for the latest node components.
-The full set of components that have releases are:
-
-- `chain-mon`
-- `ci-builder`
-- `ci-builder`
-- `indexer`
-- `op-batcher`
-- `op-contracts`
-- `op-challenger`
-- `op-heartbeat`
-- `op-node`
-- `op-proposer`
-- `op-ufm`
-- `proxyd`
-
-All other components and packages should be considered development components only and do not have releases.
-
-### Development branch
-
-The primary development branch is [`develop`](https://github.com/ethereum-optimism/optimism/tree/develop/).
-`develop` contains the most up-to-date software that remains backwards compatible with the latest experimental [network deployments](https://community.optimism.io/docs/useful-tools/networks/).
-If you're making a backwards compatible change, please direct your pull request towards `develop`.
+## License
 
-**Changes to contracts within `packages/contracts-bedrock/src` are usually NOT considered backwards compatible.**
-Some exceptions to this rule exist for cases in which we absolutely must deploy some new contract after a tag has already been fully deployed.
-If you're changing or adding a contract and you're unsure about which branch to make a PR into, default to using a feature branch.
-Feature branches are typically used when there are conflicts between 2 projects touching the same code, to avoid conflicts from merging both into `develop`.
+Thanos is forked from [`optimism (OP Stack v1.7.7)`](https://github.com/ethereum-optimism/optimism/tree/v1.7.7) is licensed under the MIT License unless stated otherwise.
 
-## License
+## Community
 
-All other files within this repository are licensed under the [MIT License](https://github.com/ethereum-optimism/optimism/blob/master/LICENSE) unless stated otherwise.
+[Discord](https://discord.com/invite/J4chV2zuAK) | [Wwitter](https://twitter.com/tokamak_network) | [Medium](https://medium.com/@tokamak_network) | [Telegram](https://t.me/tokamak_network)

package.json

@@ -1,11 +1,11 @@
 {
-  "name": "optimism",
-  "version": "1.0.0",
-  "author": "Optimism PBC",
+  "name": "thanos",
+  "version": "2.0.0",
+  "author": "Tokamak Network (The origin by Optimism PBC)",
   "license": "MIT",
   "private": true,
   "engines": {
-    "node": ">=16",
+    "node": ">=20",
     "pnpm": ">=9"
   },
   "scripts": {

packages/tokamak/contracts-bedrock/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tokamak-network/thanos-contracts",
   "version": "0.0.7",
-  "description": "Contracts for Optimism Specs",
+  "description": "Bedrock + Thanos smart contracts",
   "license": "MIT",
   "files": [
     "forge-artifacts/**/*.json",
@@ -16,7 +16,7 @@
     "sdk"
   ],
   "homepage": "https://github.com/tokamak-network/tokamak-thanos/tree/main/packages/tokamak/contracts-bedrock#readme",
-  "author": "Optimism PBC & Tokamak Network",
+  "author": "Tokamak Network (The origin by Optimism PBC)",
   "repository": {
     "type": "git",
     "url": "https://github.com/tokamak-network/tokamak-thanos.git"

packages/tokamak/contracts-bedrock/src/L1/OptimismPortal2.sol

@@ -543,8 +543,7 @@ contract OptimismPortal2 is Initializable, ResourceMetering, OnApprove, ISemver
         require(_data.length <= 120_000, "OptimismPortal: data too large");
 
         // Transform the from-address to its alias if the caller is a contract.
-        address from =
-            ((_sender != tx.origin)) ? AddressAliasHelper.applyL1ToL2Alias(_sender) : _sender;
+        address from = ((_sender != tx.origin)) ? AddressAliasHelper.applyL1ToL2Alias(_sender) : _sender;
 
         // Compute the opaque data that will be emitted as part of the TransactionDeposited event.
         // We use opaque data so that we can update the TransactionDeposited event in the future

packages/tokamak/contracts-bedrock/src/L2/L1BlockInterop.sol

@@ -1,4 +1,3 @@
-
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.15;
 

packages/tokamak/contracts-bedrock/src/L2/L2CrossDomainMessenger.sol

@@ -17,7 +17,6 @@ import { Predeploys } from "src/libraries/Predeploys.sol";
 ///         L2 on the L2 side. Users are generally encouraged to use this contract instead of lower
 ///         level message passing contracts.
 contract L2CrossDomainMessenger is CrossDomainMessenger, ISemver {
-
     /// @custom:semver 2.1.0
     string public constant version = "2.1.0";
 

packages/tokamak/core-utils/package.json

@@ -20,14 +20,14 @@
     "test:coverage": "nyc ts-mocha test/**/*.spec.ts && nyc merge .nyc_output coverage.json"
   },
   "keywords": [
-    "optimism",
+    "thanos",
     "ethereum",
     "core",
     "utils"
   ],
   "homepage": "https://github.com/tokamak-network/tokamak-thanos/tree/main/packages/tokamak/core-utils#readme",
   "license": "MIT",
-  "author": "Optimism PBC",
+  "author": "Tokamak Network (The origin by Optimism PBC)",
   "repository": {
     "type": "git",
     "url": "https://github.com/tokamak-network/tokamak-thanos.git"