From 8e07375d986dca30c8f15d3d65357da8027f29e5 Mon Sep 17 00:00:00 2001 From: 0x6e616d Date: Tue, 30 Apr 2024 11:23:47 +0700 Subject: [PATCH] feat(packages/tokamak): update NPM info --- packages/tokamak/core-utils/README.md | 4 ++-- packages/tokamak/core-utils/package.json | 6 +++--- packages/tokamak/sdk/README.md | 12 +++++------- packages/tokamak/sdk/package.json | 4 ++-- 4 files changed, 12 insertions(+), 14 deletions(-) diff --git a/packages/tokamak/core-utils/README.md b/packages/tokamak/core-utils/README.md index d2c88a1dee..e2f1c4a87e 100644 --- a/packages/tokamak/core-utils/README.md +++ b/packages/tokamak/core-utils/README.md @@ -1,10 +1,10 @@ -# @eth-optimism/core-utils +# @tokamak-network/core-utils [![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/develop/graph/badge.svg?token=0VTG7PG7YR&flag=core-utils-tests)](https://codecov.io/gh/ethereum-optimism/optimism) ## What is this? -`@eth-optimism/core-utils` contains the Optimistic Virtual Machine core utilities. +`@tokamak-network/core-utils` contains the Optimistic Virtual Machine core utilities. ## Getting started diff --git a/packages/tokamak/core-utils/package.json b/packages/tokamak/core-utils/package.json index 0c5985ed41..92402cc531 100644 --- a/packages/tokamak/core-utils/package.json +++ b/packages/tokamak/core-utils/package.json @@ -1,7 +1,7 @@ { "name": "@tokamak-network/core-utils", "version": "0.0.1", - "description": "[Optimism] Core typescript utilities", + "description": "[Thanos] Core typescript utilities", "main": "dist/index", "types": "dist/index", "files": [ @@ -25,12 +25,12 @@ "core", "utils" ], - "homepage": "https://github.com/ethereum-optimism/optimism/tree/develop/packages/core-utils#readme", + "homepage": "https://github.com/tokamak-network/tokamak-thanos/tree/main/packages/tokamak/core-utils#readme", "license": "MIT", "author": "Optimism PBC", "repository": { "type": "git", - "url": "https://github.com/ethereum-optimism/optimism.git" + "url": "https://github.com/tokamak-network/tokamak-thanos.git" }, "dependencies": { "@ethersproject/abi": "^5.7.0", diff --git a/packages/tokamak/sdk/README.md b/packages/tokamak/sdk/README.md index 284aa86cd5..e85e3fb4b5 100644 --- a/packages/tokamak/sdk/README.md +++ b/packages/tokamak/sdk/README.md @@ -1,14 +1,12 @@ -# @eth-optimism/sdk +# @tokamak-network/thanos-sdk -[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/master/graph/badge.svg?token=0VTG7PG7YR&flag=sdk-tests)](https://codecov.io/gh/ethereum-optimism/optimism) - -The `@eth-optimism/sdk` package provides a set of tools for interacting with Optimism. +The `@tokamak-network/thanos-sdk` package provides a set of tools for interacting with Thanos. ## Installation ``` -npm install @eth-optimism/sdk +npm install @tokamak-network/thanos-sdk ``` ## Docs @@ -19,7 +17,7 @@ You can find auto-generated API documentation over at [sdk.optimism.io](https:// ### CrossChainMessenger -The [`CrossChainMessenger`](https://github.com/ethereum-optimism/optimism/blob/develop/packages/sdk/src/cross-chain-messenger.ts) class simplifies the process of moving assets and data between Ethereum and Optimism. +The [`CrossChainMessenger`](https://github.com/tokamak-network/tokamak-thanos/blob/main/packages/tokamak/sdk/src/cross-chain-messenger.ts) class simplifies the process of moving assets and data between Ethereum and Optimism. You can use this class to, for example, initiate a withdrawal of ERC20 tokens from Optimism back to Ethereum, accurately track when the withdrawal is ready to be finalized on Ethereum, and execute the finalization transaction after the challenge period has elapsed. The `CrossChainMessenger` can handle deposits and withdrawals of ETH and any ERC20-compatible token. Detailed API descriptions can be found at [sdk.optimism.io](https://sdk.optimism.io/classes/crosschainmessenger). @@ -27,7 +25,7 @@ The `CrossChainMessenger` automatically connects to all relevant contracts so co ### L2Provider and related utilities -The Optimism SDK includes [various utilities](https://github.com/ethereum-optimism/optimism/blob/develop/packages/sdk/src/l2-provider.ts) for handling Optimism's [transaction fee model](https://community.optimism.io/docs/developers/build/transaction-fees/). +The Optimism SDK includes [various utilities](https://github.com/tokamak-network/tokamak-thanos/blob/main/packages/tokamak/sdk/src/l2-provider.ts) for handling Optimism's [transaction fee model](https://community.optimism.io/docs/developers/build/transaction-fees/). For instance, [`estimateTotalGasCost`](https://sdk.optimism.io/modules.html#estimateTotalGasCost) will estimate the total cost (in wei) to send at transaction on Optimism including both the L2 execution cost and the L1 data cost. You can also use the [`asL2Provider`](https://sdk.optimism.io/modules.html#asL2Provider) function to wrap an ethers Provider object into an `L2Provider` which will have all of these helper functions attached. diff --git a/packages/tokamak/sdk/package.json b/packages/tokamak/sdk/package.json index 40d2d4f58b..87fc8ad8c0 100644 --- a/packages/tokamak/sdk/package.json +++ b/packages/tokamak/sdk/package.json @@ -28,12 +28,12 @@ "ethereum", "sdk" ], - "homepage": "https://github.com/ethereum-optimism/optimism/tree/develop/packages/sdk#readme", + "homepage": "https://github.com/tokamak-network/tokamak-thanos/tree/main/packages/tokamak/sdk#readme", "license": "MIT", "author": "Optimism PBC", "repository": { "type": "git", - "url": "https://github.com/ethereum-optimism/optimism.git" + "url": "https://github.com/tokamak-network/tokamak-thanos.git" }, "devDependencies": { "@ethersproject/abstract-provider": "^5.7.0",