add a GitHub workflow for automated bytecode verification, update bri…

…dged USDC standard documentation, update the entity name in copyright headers

.env.example

@@ -1,4 +1,4 @@
-# Copyright 2024 Circle Internet Financial, LTD. All rights reserved.
+# Copyright 2024 Circle Internet Group, Inc. All rights reserved.
 #
 # SPDX-License-Identifier: Apache-2.0
 #

.eslintrc.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2023 Circle Internet Financial, LTD. All rights reserved.
+ * Copyright 2023 Circle Internet Group, Inc. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  *

.github/composite-actions/setup-ci/action.yml

@@ -1,4 +1,4 @@
-# Copyright 2024 Circle Internet Financial, LTD. All rights reserved.
+# Copyright 2024 Circle Internet Group, Inc. All rights reserved.
 #
 # SPDX-License-Identifier: Apache-2.0
 #
@@ -19,9 +19,9 @@ runs:
   using: composite
   steps:
     - name: Install Node
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
-        node-version: "16.14.0"
+        node-version: "20.9.0"
 
     - name: Install Foundry
       uses: foundry-rs/foundry-toolchain@v1
@@ -40,7 +40,7 @@ runs:
       shell: bash
 
     - name: Retrieve cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
         key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}

.github/resources/coverage-report-template.md

@@ -1,5 +1,5 @@
 <!--
- Copyright 2024 Circle Internet Financial, LTD. All rights reserved.
+ Copyright 2024 Circle Internet Group, Inc. All rights reserved.
 
  SPDX-License-Identifier: Apache-2.0
 

.github/workflows/bytecode-verification.yml

@@ -0,0 +1,37 @@
+# Copyright 2024 Circle Internet Group, Inc. All rights reserved.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: Bridged USDC deployment - Bytecode Verification
+on:
+  pull_request:
+    paths:
+      - "**/verification_artifacts/input.json"
+
+jobs:
+  bytecode-verification:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+
+      - name: Setup CI Environment
+        uses: ./.github/composite-actions/setup-ci
+
+      - name: Compile contracts
+        run: yarn compile
+
+      - name: Run Verification
+        run: yarn hardhat run scripts/verifyBridgedTokenBytecode.ts --network mainnet

.github/workflows/check-pr.yml

@@ -0,0 +1,50 @@
+# Copyright 2024 Circle Internet Group, Inc. All rights reserved.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: Check PR
+on:
+  workflow_run:
+    workflows: [CI]
+    types: [completed]
+
+permissions:
+  checks: write
+  contents: write
+  actions: read
+
+jobs:
+  post_run_hardhat_tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download test results
+        uses: actions/download-artifact@v4
+        with:
+          pattern: junit-report-*
+          run-id: ${{ github.event.workflow_run.id }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Publish combined test report
+        uses: mikepenz/action-junit-report@v4
+        with:
+          check_name: upload_test_results
+          job_summary: true
+          detailed_summary: true
+          commit: ${{ github.event.workflow_run.head_sha }}
+          report_paths: "./junit-report-*/junit.xml"
+
+  release-sbom:
+    if: github.event.workflow_run.event == 'push'
+    uses: circlefin/circle-public-github-workflows/.github/workflows/attach-release-assets.yaml@v1

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-# Copyright 2024 Circle Internet Financial, LTD. All rights reserved.
+# Copyright 2024 Circle Internet Group, Inc. All rights reserved.
 #
 # SPDX-License-Identifier: Apache-2.0
 #
@@ -20,6 +20,8 @@ on:
     branches: [master]
   pull_request:
 
+permissions: read-all
+
 # Celo USDC contracts violate Spurious Dragon with existing configs, so
 # we need to lower the number of runs to decrease the contract size.
 env:
@@ -72,6 +74,9 @@ jobs:
       - name: Setup CI Environment
         uses: ./.github/composite-actions/setup-ci
 
+      - name: Compile contracts
+        run: yarn compile
+
       - name: Run hardhat tests
         run: HARDHAT_TEST_GREP='${{ matrix.test-groups.grep }}' HARDHAT_TEST_INVERT='${{ matrix.test-groups.invert }}' yarn test
 
@@ -82,30 +87,12 @@ jobs:
           name: junit-report-${{ hashFiles('report/junit.xml') }}
           path: report/junit.xml
 
-  post_run_hardhat_tests:
-    runs-on: ubuntu-latest
-    needs: [run_hardhat_tests]
-    if: always()
-    steps:
-      - name: Download test results
-        uses: actions/download-artifact@v4
-        with:
-          pattern: junit-report-*
-
-      - name: Publish combined test report
-        uses: mikepenz/action-junit-report@v4
-        with:
-          check_name: upload_test_results
-          job_summary: true
-          detailed_summary: true
-          report_paths: "./junit-report-*/junit.xml"
-
   scan:
     if: github.event_name == 'pull_request'
-    uses: circlefin/circle-public-github-workflows/.github/workflows/[email protected]
+    uses: circlefin/circle-public-github-workflows/.github/workflows/pr-scan.yaml@v1
+    permissions:
+      pull-requests: write
+      contents: read
     with:
       allow-reciprocal-licenses: false
 
-  release-sbom:
-    if: github.event_name == 'push'
-    uses: circlefin/circle-public-github-workflows/.github/workflows/attach-release-assets.yaml@v1

.github/workflows/coverage.yml

@@ -1,4 +1,4 @@
-# Copyright 2024 Circle Internet Financial, LTD. All rights reserved.
+# Copyright 2024 Circle Internet Group, Inc. All rights reserved.
 #
 # SPDX-License-Identifier: Apache-2.0
 #

.licenseignore

@@ -1,7 +1,11 @@
 pkg:npm/pako
 pkg:npm/highlightjs-solidity
 pkg:npm/ethereum-ens
+pkg:npm/interface-ipld-format
+pkg:npm/multiformats
 pkg:npm/%40ethereumjs/[email protected]
+pkg:npm/%40ethereumjs/[email protected]
+pkg:npm/%40ethereumjs/[email protected]
 pkg:npm/%40ethereumjs/[email protected]
 pkg:npm/%40nomicfoundation/[email protected]
 pkg:npm/%40nomicfoundation/[email protected]
@@ -13,6 +17,9 @@ pkg:npm/%40nomicfoundation/[email protected]
 pkg:npm/%40nomicfoundation/[email protected]
 pkg:npm/%40nomicfoundation/[email protected]
 pkg:npm/%40nomicfoundation/[email protected]
+pkg:npm/[email protected]
+pkg:npm/[email protected]
+pkg:npm/[email protected]
 pkg:npm/[email protected]
 pkg:npm/[email protected]
 pkg:npm/[email protected]

.nvmrc

@@ -1 +1 @@
-v16.14.0
+v20.9.0

.solcover.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2023 Circle Internet Financial, LTD. All rights reserved.
+ * Copyright 2023 Circle Internet Group, Inc. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  *

.vscode/settings.json

@@ -25,7 +25,7 @@
   },
   "typescript.tsdk": "node_modules/typescript/lib",
   "licenser.license": "Custom",
-  "licenser.customHeader": "Copyright @YEAR@ Circle Internet Financial, LTD. All rights reserved.\n\nSPDX-License-Identifier: Apache-2.0\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.",
+  "licenser.customHeader": "Copyright @YEAR@ Circle Internet Group, Inc. All rights reserved.\n\nSPDX-License-Identifier: Apache-2.0\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.",
   "licenser.useSingleLineStyle": false,
   "files.autoSave": "onFocusChange",
   "solidity.compileUsingRemoteVersion": "v0.6.12+commit.27d51765"

@types/AnyFiatTokenV2Instance.d.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2023 Circle Internet Financial, LTD. All rights reserved.
+ * Copyright 2023 Circle Internet Group, Inc. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  *

@types/TransactionRawLog.d.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2023 Circle Internet Financial, LTD. All rights reserved.
+ * Copyright 2023 Circle Internet Group, Inc. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  *

@types/ipfs-only-hash.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Copyright 2024 Circle Internet Group, Inc. All rights reserved.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare module "ipfs-only-hash";

README.md

@@ -37,13 +37,11 @@ by the [Hardhat](https://hardhat.org/) framework.
 
 Requirements:
 
-- Node 16.14.0
+- Node 20.9.0
 - Yarn 1.22.19
 - [Foundry@f625d0f](https://github.com/foundry-rs/foundry/releases/tag/nightly-f625d0fa7c51e65b4bf1e8f7931cd1c6e2e285e9)
 
 ```sh
-$ git clone [email protected]:circlefin/stablecoin-evm.git
-$ cd stablecoin-evm
 $ nvm use
 $ npm i -g [email protected] # Install yarn if you don't already have it
 $ yarn install          # Install npm packages and other dependencies listed in setup.sh

cached_artifacts/opMainnetFiatTokenProxyContractCreationBytecode.bin

@@ -0,0 +1 @@
+608060405234801561001057600080fd5b506040516108a93803806108a98339818101604052602081101561003357600080fd5b5051808061004081610051565b5061004a336100c3565b5050610123565b610064816100e760201b61042a1760201c565b61009f5760405162461bcd60e51b815260040180806020018281038252603b81526020018061086e603b913960400191505060405180910390fd5b7f7050c9e0f4ca769c69bd3a8ef740bc37934f8e2c036e5a723fd8ee048ed3f8c355565b7f10d6a54a4754c8869d6886b5f5d7fbfa5b4522237ea5c60d11bc4e7a1ff9390b55565b6000813f7fc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a47081811480159061011b57508115155b949350505050565b61073c806101326000396000f3fe60806040526004361061005a5760003560e01c80635c60da1b116100435780635c60da1b146101315780638f2839701461016f578063f851a440146101af5761005a565b80633659cfe6146100645780634f1ef286146100a4575b6100626101c4565b005b34801561007057600080fd5b506100626004803603602081101561008757600080fd5b503573ffffffffffffffffffffffffffffffffffffffff166101de565b610062600480360360408110156100ba57600080fd5b73ffffffffffffffffffffffffffffffffffffffff82351691908101906040810160208201356401000000008111156100f257600080fd5b82018360208201111561010457600080fd5b8035906020019184600183028401116401000000008311171561012657600080fd5b509092509050610232565b34801561013d57600080fd5b50610146610309565b6040805173ffffffffffffffffffffffffffffffffffffffff9092168252519081900360200190f35b34801561017b57600080fd5b506100626004803603602081101561019257600080fd5b503573ffffffffffffffffffffffffffffffffffffffff16610318565b3480156101bb57600080fd5b50610146610420565b6101cc610466565b6101dc6101d76104fa565b61051f565b565b6101e6610543565b73ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614156102275761022281610568565b61022f565b61022f6101c4565b50565b61023a610543565b73ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614156102fc5761027683610568565b60003073ffffffffffffffffffffffffffffffffffffffff16348484604051808383808284376040519201945060009350909150508083038185875af1925050503d80600081146102e3576040519150601f19603f3d011682016040523d82523d6000602084013e6102e8565b606091505b50509050806102f657600080fd5b50610304565b6103046101c4565b505050565b60006103136104fa565b905090565b610320610543565b73ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614156102275773ffffffffffffffffffffffffffffffffffffffff81166103bf576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260368152602001806106966036913960400191505060405180910390fd5b7f7e644d79422f17c01e4894b5f4f588d331ebfa28653d42ae832dc59e38c9798f6103e8610543565b6040805173ffffffffffffffffffffffffffffffffffffffff928316815291841660208301528051918290030190a1610222816105bd565b6000610313610543565b6000813f7fc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a47081811480159061045e57508115155b949350505050565b61046e610543565b73ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614156104f2576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260328152602001806106646032913960400191505060405180910390fd5b6101dc6101dc565b7f7050c9e0f4ca769c69bd3a8ef740bc37934f8e2c036e5a723fd8ee048ed3f8c35490565b3660008037600080366000845af43d6000803e80801561053e573d6000f35b3d6000fd5b7f10d6a54a4754c8869d6886b5f5d7fbfa5b4522237ea5c60d11bc4e7a1ff9390b5490565b610571816105e1565b6040805173ffffffffffffffffffffffffffffffffffffffff8316815290517fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b9181900360200190a150565b7f10d6a54a4754c8869d6886b5f5d7fbfa5b4522237ea5c60d11bc4e7a1ff9390b55565b6105ea8161042a565b61063f576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040180806020018281038252603b8152602001806106cc603b913960400191505060405180910390fd5b7f7050c9e0f4ca769c69bd3a8ef740bc37934f8e2c036e5a723fd8ee048ed3f8c35556fe43616e6e6f742063616c6c2066616c6c6261636b2066756e6374696f6e2066726f6d207468652070726f78792061646d696e43616e6e6f74206368616e6765207468652061646d696e206f6620612070726f787920746f20746865207a65726f206164647265737343616e6e6f742073657420612070726f787920696d706c656d656e746174696f6e20746f2061206e6f6e2d636f6e74726163742061646472657373a2646970667358221220046bec85a39556fa01d3014f9bbd881bf3dfd8a920836836698508b80c55e88964736f6c634300060c003343616e6e6f742073657420612070726f787920696d706c656d656e746174696f6e20746f2061206e6f6e2d636f6e74726163742061646472657373000000000000000000000000bd17deee53a58b48548117a11a2e7bbf2d0d6fa7

cached_artifacts/opMainnetFiatTokenProxyRuntimeBytecode.bin

@@ -0,0 +1 @@
+60806040526004361061005a5760003560e01c80635c60da1b116100435780635c60da1b146101315780638f2839701461016f578063f851a440146101af5761005a565b80633659cfe6146100645780634f1ef286146100a4575b6100626101c4565b005b34801561007057600080fd5b506100626004803603602081101561008757600080fd5b503573ffffffffffffffffffffffffffffffffffffffff166101de565b610062600480360360408110156100ba57600080fd5b73ffffffffffffffffffffffffffffffffffffffff82351691908101906040810160208201356401000000008111156100f257600080fd5b82018360208201111561010457600080fd5b8035906020019184600183028401116401000000008311171561012657600080fd5b509092509050610232565b34801561013d57600080fd5b50610146610309565b6040805173ffffffffffffffffffffffffffffffffffffffff9092168252519081900360200190f35b34801561017b57600080fd5b506100626004803603602081101561019257600080fd5b503573ffffffffffffffffffffffffffffffffffffffff16610318565b3480156101bb57600080fd5b50610146610420565b6101cc610466565b6101dc6101d76104fa565b61051f565b565b6101e6610543565b73ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614156102275761022281610568565b61022f565b61022f6101c4565b50565b61023a610543565b73ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614156102fc5761027683610568565b60003073ffffffffffffffffffffffffffffffffffffffff16348484604051808383808284376040519201945060009350909150508083038185875af1925050503d80600081146102e3576040519150601f19603f3d011682016040523d82523d6000602084013e6102e8565b606091505b50509050806102f657600080fd5b50610304565b6103046101c4565b505050565b60006103136104fa565b905090565b610320610543565b73ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614156102275773ffffffffffffffffffffffffffffffffffffffff81166103bf576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260368152602001806106966036913960400191505060405180910390fd5b7f7e644d79422f17c01e4894b5f4f588d331ebfa28653d42ae832dc59e38c9798f6103e8610543565b6040805173ffffffffffffffffffffffffffffffffffffffff928316815291841660208301528051918290030190a1610222816105bd565b6000610313610543565b6000813f7fc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a47081811480159061045e57508115155b949350505050565b61046e610543565b73ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614156104f2576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260328152602001806106646032913960400191505060405180910390fd5b6101dc6101dc565b7f7050c9e0f4ca769c69bd3a8ef740bc37934f8e2c036e5a723fd8ee048ed3f8c35490565b3660008037600080366000845af43d6000803e80801561053e573d6000f35b3d6000fd5b7f10d6a54a4754c8869d6886b5f5d7fbfa5b4522237ea5c60d11bc4e7a1ff9390b5490565b610571816105e1565b6040805173ffffffffffffffffffffffffffffffffffffffff8316815290517fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b9181900360200190a150565b7f10d6a54a4754c8869d6886b5f5d7fbfa5b4522237ea5c60d11bc4e7a1ff9390b55565b6105ea8161042a565b61063f576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040180806020018281038252603b8152602001806106cc603b913960400191505060405180910390fd5b7f7050c9e0f4ca769c69bd3a8ef740bc37934f8e2c036e5a723fd8ee048ed3f8c35556fe43616e6e6f742063616c6c2066616c6c6261636b2066756e6374696f6e2066726f6d207468652070726f78792061646d696e43616e6e6f74206368616e6765207468652061646d696e206f6620612070726f787920746f20746865207a65726f206164647265737343616e6e6f742073657420612070726f787920696d706c656d656e746174696f6e20746f2061206e6f6e2d636f6e74726163742061646472657373a2646970667358221220046bec85a39556fa01d3014f9bbd881bf3dfd8a920836836698508b80c55e88964736f6c634300060c0033

contracts/interface/IERC1271.sol

@@ -1,5 +1,5 @@
 /**
- * Copyright 2023 Circle Internet Financial, LTD. All rights reserved.
+ * Copyright 2023 Circle Internet Group, Inc. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  *

contracts/interface/celo/ICeloGasToken.sol

@@ -1,5 +1,5 @@
 /**
- * Copyright 2024 Circle Internet Financial, LTD. All rights reserved.
+ * Copyright 2024 Circle Internet Group, Inc. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  *

contracts/interface/celo/IDecimals.sol

@@ -1,5 +1,5 @@
 /**
- * Copyright 2024 Circle Internet Financial, LTD. All rights reserved.
+ * Copyright 2024 Circle Internet Group, Inc. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  *

contracts/interface/celo/IFiatTokenFeeAdapter.sol

@@ -1,5 +1,5 @@
 /**
- * Copyright 2024 Circle Internet Financial, LTD. All rights reserved.
+ * Copyright 2024 Circle Internet Group, Inc. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  *

contracts/minting/Controller.sol

@@ -1,5 +1,5 @@
 /**
- * Copyright 2023 Circle Internet Financial, LTD. All rights reserved.
+ * Copyright 2023 Circle Internet Group, Inc. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  *

contracts/minting/MasterMinter.sol

@@ -1,5 +1,5 @@
 /**
- * Copyright 2023 Circle Internet Financial, LTD. All rights reserved.
+ * Copyright 2023 Circle Internet Group, Inc. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  *

contracts/minting/MintController.sol

@@ -1,5 +1,5 @@
 /**
- * Copyright 2023 Circle Internet Financial, LTD. All rights reserved.
+ * Copyright 2023 Circle Internet Group, Inc. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  *