Create stale.yml

.env.example

@@ -0,0 +1,100 @@
+# 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.
+
+##############################
+# Private Key Configurations #
+##############################=
+# The key to a pre-funded deployer address
+DEPLOYER_PRIVATE_KEY=
+
+############################
+# FiatToken Configurations #
+############################
+# The ERC20 name of the FiatToken.
+TOKEN_NAME=USDC
+
+# The ERC20 symbol of the FiatToken.
+TOKEN_SYMBOL=USDC
+
+# The fiat currency that that FiatToken represents.
+TOKEN_CURRENCY=USD
+
+# The ERC20 decimals for the FiatToken.
+TOKEN_DECIMALS=6
+
+# [OPTIONAL] The address to a deployed FiatTokenProxy contract.
+# FIAT_TOKEN_PROXY_ADDRESS=
+
+# [OPTIONAL] The address to a deployed FiatToken implementation contract.
+# FIAT_TOKEN_IMPLEMENTATION_ADDRESS=
+
+# The address of the FiatTokenProxy's admin.
+PROXY_ADMIN_ADDRESS=
+
+# The address of the FiatToken's owner.
+OWNER_ADDRESS=
+
+# The address of the MasterMinter's owner.
+MASTER_MINTER_OWNER_ADDRESS=
+
+# [OPTIONAL] The address of the FiatToken's pauser. Defaults to the owner address.
+# PAUSER_ADDRESS=
+
+# [OPTIONAL] The address of the FiatToken's blacklister. Defaults to the owner address.
+# BLACKLISTER_ADDRESS=
+
+# [OPTIONAL] The address to which locked funds are sent to. Only applicable for version 2 -> 2.1 upgrades. Defaults to the owner address.
+# LOST_AND_FOUND_ADDRESS=
+
+##########################
+# Network Configurations #
+##########################
+# [OPTIONAL] The URL to a mainnet JSON-RPC node.
+# MAINNET_RPC_URL=
+
+# [OPTIONAL] The URL to a testnet JSON-RPC node.
+# TESTNET_RPC_URL=
+
+# The percentage to multiply gas usage estimations by (eg. 200 to double the estimation). Defaults to 130.
+GAS_MULTIPLIER=110
+
+################################
+# Celo Specific Configurations #
+################################
+
+# [OPTIONAL] The address to a deployed FiatTokenCelo implementation contract.
+# FIAT_TOKEN_CELO_IMPLEMENTATION_ADDRESS=
+
+# [OPTIONAL] The address to a deployed FiatTokenProxy contract for FiatTokenCeloV2_2. Required for Celo Fee Adapter deployment.
+# FIAT_TOKEN_CELO_PROXY_ADDRESS=
+
+# [OPTIONAL] The address of the Fee Adapter Proxy's admin. Required for Celo Fee Adapter deployment.
+# FEE_ADAPTER_PROXY_ADMIN_ADDRESS=
+
+# [OPTIONAL] The number of decimals to scale the USDC contract to. Required for Celo Fee Adapter deployment.
+# FEE_ADAPTER_DECIMALS=
+
+################################
+# Miscellaneous Configurations #
+################################
+# The file name from which to read the list of addresses to blacklist
+BLACKLIST_FILE_NAME=blacklist.remote.json
+
+# [OPTIONAL] The API key to an Etherscan flavor block explorer.
+# ETHERSCAN_KEY=
+
+# [OPTIONAL] The number of runs the Solidity optimizers should perform. Defaults to 10000000.
+# OPTIMIZER_RUNS=

.eslintignore

@@ -1,4 +1,18 @@
-.DS_Store
+.idea/
+**/.DS_Store
+
+artifacts/
+cache/
+@types/generated/
+
 node_modules/
+yarn-error.log
+
 coverage/
-@types/generated/
+coverage.json
+
+verification_artifacts/
+
+blacklist.*.json
+
+LICENSE

.eslintrc.js

@@ -1,3 +1,21 @@
+/**
+ * Copyright 2023 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.
+ */
+
 module.exports = {
   root: true,
   env: {

.gitattributes

@@ -1,2 +1 @@
 @types/generated/**/* linguist-generated=true
-

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

@@ -0,0 +1,52 @@
+# 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: Setup CI
+runs:
+  using: composite
+  steps:
+    - name: Install Node
+      uses: actions/setup-node@v4
+      with:
+        node-version: "20.9.0"
+
+    - name: Install Foundry
+      uses: foundry-rs/foundry-toolchain@v1
+
+    - name: Update submodules
+      run: git submodule update --init --recursive
+      shell: bash
+
+    - name: Install Yarn
+      run: npm install -g [email protected]
+      shell: bash
+
+    - name: Get Yarn cache directory path
+      id: yarn-cache-dir-path
+      run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
+      shell: bash
+
+    - name: Retrieve cache
+      uses: actions/cache@v4
+      with:
+        path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+        key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-yarn-
+
+    - name: Install packages & Setup repository
+      run: yarn install --frozen-lockfile
+      shell: bash

.github/pull_request_template.md

@@ -0,0 +1,11 @@
+## Summary
+
+## Detail
+
+## Testing
+
+## Documentation
+
+---
+
+**Requested Reviewers:** @mention

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

@@ -0,0 +1,33 @@
+<!--
+ 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.
+-->
+
+## Coverage Report
+
+Commit: [{{short_commit_sha}}]({{commit_link}})
+
+| Type                      | Coverage                              |
+| ------------------------- | ------------------------------------- |
+| Total Statements Coverage | {{total_statements_coverage_percent}} |
+| Total Branches Coverage   | {{total_branches_coverage_percent}}   |
+| Total Functions Coverage  | {{total_functions_coverage_percent}}  |
+| Total Lines Coverage      | {{total_lines_coverage_percent}}      |
+
+<details>
+<summary>Details </summary>
+{{files_coverage_table}}
+</details>

.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