Skip to content

Commit

Permalink
Merge pull request #142 from tokamak-network/feat/update-tokamak-pack…
Browse files Browse the repository at this point in the history
…ages-info

feat(packages/tokamak): update NPM info
  • Loading branch information
0x6e616d authored Apr 30, 2024
2 parents f2269a0 + 8e07375 commit d44ca69
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 14 deletions.
4 changes: 2 additions & 2 deletions packages/tokamak/core-utils/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
6 changes: 3 additions & 3 deletions packages/tokamak/core-utils/package.json
Original file line number Diff line number Diff line change
@@ -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": [
Expand All @@ -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",
Expand Down
12 changes: 5 additions & 7 deletions packages/tokamak/sdk/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -19,15 +17,15 @@ 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).
The `CrossChainMessenger` automatically connects to all relevant contracts so complex configuration is not necessary.

### 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.

Expand Down
4 changes: 2 additions & 2 deletions packages/tokamak/sdk/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit d44ca69

Please sign in to comment.