cf5cdc5ea6
Prettier is complaining about it on CI but it doesn't tell what it complains about. It lints perfectly fine locally. For now, ignoring `contracts.json` so we get past the linting stage. |
||
|---|---|---|
| .github | ||
| .vscode | ||
| contracts | ||
| lib | ||
| script | ||
| scripts | ||
| .editorconfig | ||
| .env.example | ||
| .gas-snapshot | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| .prettierignore | ||
| .prettierrc.yml | ||
| .solhint.json | ||
| PROPERTIES.md | ||
| README.md | ||
| codecov.yml | ||
| contracts.json | ||
| foundry.toml | ||
| index.js | ||
| package.json | ||
| pnpm-lock.yaml | ||
| remappings.txt | ||
| slither.config.json | ||
README.md
Bridging SNT with the Optimism SDK
This repository contains code to deploy SNT in Ethereum and bridge it to optimism.
Scripts:
npx hardhat run scripts/deploySNT.js --network <network> -> deploy to Optimism chain with the contracts.json
configured addresses.
npx hardhat run scripts/deployOptimism.js --network <network> -> deploy to an optimism chain with the contracts.json
configured addresses.
The script node index.js uses the configured goerli bridge to bridge 1 STT on Goerli into 1 SNT on Optimism-Goerli.
To everything work, .env needs to be created out of .env.example.
All tokens, even on Optimism, are MiniMeToken variant, meaning they save all account's balance change on Ethereum state for democracy contract ballots. Learn more about MiniMeToken on the official repository Giveth/minime.
Differences from regular MiniMeToken
- 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.
- 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.
- 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.
- MiniMeToken
version()had to be renamed totoken_version()due a conflict on inheritance and requirements of Optimism. Semver inheritance uses version() and this seems a requirement for Optimism.