Skip to content

Commit

Permalink
docs: needed items from circle at migration (#145)
Browse files Browse the repository at this point in the history
# 🤖 Linear

Closes OPT-196
  • Loading branch information
excaliborr authored Aug 8, 2024
1 parent 79f128e commit 71ac5a2
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,18 @@ And when you are ready to migrate to native USDC, run:
yarn script:migrate:broadcast
```

### What will circle need at migration?

#### Circle will need the metadata from the original deployment of the USDC implementation that was used

To do this you will need to go back to the `stablecoin-evm` github repo that the implementation was deployed from in order to extract the raw metadata from the compiled files. The compiled files are usually found in the `out/` or `artifacts/` folders. To extract the raw metadata you can run a command like this:

```bash
cat out/example.sol/example.json | jq -jr '.rawMetadata' > example.metadata.json
```

You will need to do this for both the token contract and any external libraries that get deployed with it, at the time of writing this these are `FiatTokenV2_2` and `SignatureChecker` but these are subject to change in the future.

## Licensing

The primary license for the boilerplate is MIT, see [`LICENSE`](https://github.com/defi-wonderland/opUSDC/blob/main/LICENSE)
2 changes: 1 addition & 1 deletion src/contracts/L2OpUSDCBridgeAdapter.sol
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ contract L2OpUSDCBridgeAdapter is IL2OpUSDCBridgeAdapter, OpUSDCBridgeAdapter {
/**
* @notice Receive the message from the other chain and mint the bridged representation for the user
* @dev This function should only be called when receiving a message to mint the bridged representation
* @dev If the mint fails the funds might be recovered by calling withdrawBlacklistedFunds
* @dev If the mint fails the funds might be recovered by calling withdrawLockedFunds
* @param _user The user to mint the bridged representation for
* @param _spender The address that provided the tokens
* @param _amount The amount of tokens to mint
Expand Down

0 comments on commit 71ac5a2

Please sign in to comment.