2023-07-17 16:59:00 +00:00
|
|
|
# Bridging SNT with the Optimism SDK
|
|
|
|
|
|
|
|
|
|
This repository contains code to deploy SNT in Ethereum and bridge it to optimism.
|
|
|
|
|
|
2023-10-30 14:31:23 +00:00
|
|
|
# Deployments
|
|
|
|
|
|
|
|
|
|
| **Contract** | **Address** | **Snapshot** |
|
|
|
|
|
| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
|
|
|
|
|
| **Optimism Mainnet** | | |
|
|
|
|
|
| OptimismMintableMiniMeToken | [`0x650AF3C15AF43dcB218406d30784416D64Cfb6B2`](https://optimistic.etherscan.io/address/0x650AF3C15AF43dcB218406d30784416D64Cfb6B2) | [`1b3159a`](https://github.com/logos-co/optimism-bridge-snt/commit/1b3159ad4113378d95452866c0c43ca19a05aadd) |
|
|
|
|
|
| SNTOptimismController | [`0x76352764590378011CAE677b50110Ae02eDE2b62`](https://optimistic.etherscan.io/address/0x76352764590378011CAE677b50110Ae02eDE2b62#readContract) | [`1b3159a`](https://github.com/logos-co/optimism-bridge-snt/commit/1b3159ad4113378d95452866c0c43ca19a05aadd) |
|
2023-11-07 08:55:44 +00:00
|
|
|
| **Optimism Goerli** | | |
|
|
|
|
|
| OptimismMintableMiniMeToken | [`0xcAD273fA2bb77875333439FDf4417D995159c3E1`](https://goerli-optimism.etherscan.io/address/0xcAD273fA2bb77875333439FDf4417D995159c3E1) | [`dc28b89`](https://github.com/logos-co/optimism-bridge-snt/commit/dc28b89d6af0b8f48397b3efaea5e338496e40eb) |
|
|
|
|
|
| SNTOptimismController | [`0x650AF3C15AF43dcB218406d30784416D64Cfb6B2`](https://goerli-optimism.etherscan.io/address/0x650AF3C15AF43dcB218406d30784416D64Cfb6B2) | [`dc28b89`](https://github.com/logos-co/optimism-bridge-snt/commit/dc28b89d6af0b8f48397b3efaea5e338496e40eb) |
|
2023-10-30 14:31:23 +00:00
|
|
|
|
2023-07-17 16:59:00 +00:00
|
|
|
Scripts:
|
|
|
|
|
|
2023-10-06 08:40:35 +00:00
|
|
|
```
|
|
|
|
|
$ MNEMONIC=$YOUR_MNEMONIC forge script script/DeployBridge.s.sol --fork-url $YOUR_RPC_URL --broadcast
|
|
|
|
|
```
|
2023-07-17 16:59:00 +00:00
|
|
|
|
2023-10-06 08:40:35 +00:00
|
|
|
Where
|
2023-07-17 16:59:00 +00:00
|
|
|
|
2023-10-06 08:40:35 +00:00
|
|
|
- `$YOUR_MNEMONIC` is the mnemonic that contains the account from which you want to deploy. The deploy script will use
|
|
|
|
|
the first account derived from the mnemonic by default.
|
|
|
|
|
- `$YOUR_RPC_URL` is the RPC endpoint of the node you're connecting to.
|
2023-07-17 16:59:00 +00:00
|
|
|
|
2023-10-06 08:40:35 +00:00
|
|
|
You can omit the `--broadcast` option to simulate the deployment before actually performing it.
|
2023-07-17 16:59:00 +00:00
|
|
|
|
2023-10-06 08:40:35 +00:00
|
|
|
All tokens, even on Optimism, are [MiniMeToken variant](https://github.com/vacp2p/minime), meaning they save all
|
|
|
|
|
account's balance change on Ethereum state for democracy contract ballots. Learn more about MiniMeToken on the official
|
|
|
|
|
repository [vacpp2p/minime](https://github.com/vacp2p/minime).
|
2023-07-25 15:35:50 +00:00
|
|
|
|
|
|
|
|
# Differences from regular MiniMeToken
|
|
|
|
|
|
2023-10-06 08:40:35 +00:00
|
|
|
The MiniMeToken used in this repository is a fork of [the original](https://github.com/Giveth/minime). To learn about
|
|
|
|
|
the differences between the fork and the upstream repository, head over to its
|
|
|
|
|
[documentation](https://github.com/vacp2p/minime#readme).
|
|
|
|
|
|
2023-09-26 14:34:28 +00:00
|
|
|
1. There are 2 functions to mint/burn, one is mint() & generateTokens(), and other is burn() & destroyTokens(). One come
|
|
|
|
|
from MiniMeToken inheritance, and other comes from IOptimismMintableERC20 inheritance. See more on point 2.
|
|
|
|
|
2. MiniMeToken controller (SNTPlaceHolder) is also deployed on Optimism, and it _could_ be replaced by another
|
|
|
|
|
controller that _could_ call generateToken function, potentially breaking the bridge, however, if we don't do this
|
|
|
|
|
change, than it should be fine.
|
|
|
|
|
3. MiniMeTokenFactory used in createCloneToken create new MiniMeTokens that are one inheritance down from
|
|
|
|
|
OptimismMintableMiniMeToken, this is fine, just strange, but it couldnt be different, as clone tokens are not
|
|
|
|
|
suppoused to be minted by bridge. This function is not even used by us.
|
|
|
|
|
4. MiniMeToken `version()` had to be renamed to `token_version()` due a conflict on inheritance and requirements of
|
|
|
|
|
Optimism. Semver inheritance uses version() and this seems a requirement for Optimism.
|
