Merge pull request #425 from yvonnezhangc/release_v2_2

Fiat Token v2.2

.eslintrc.js

@@ -1,3 +1,21 @@
+/**
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Copyright (c) 2023, Circle Internet Financial, LLC.
+ *
+ * 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: {

.github/pull_request_template.md

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

.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: Continuous Integration
+on:
+  pull_request:
+
+jobs:
+  run_ci_tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v3
+
+      - name: Install Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: "16.14.0"
+
+      - name: Install Yarn
+        run: npm install -g [email protected]
+
+      - name: Install packages
+        run: yarn install --frozen-lockfile
+
+      - name: Setup local environment
+        run: cp config.js.example config.js && ./start-ganache.sh
+
+      - name: Run static checks
+        run: yarn static-check
+
+      - name: Run size check
+        run: yarn contract-size
+
+      - name: Run tests
+        run: yarn test

.gitignore

@@ -14,6 +14,16 @@ validate/apikey.infura
 ganache-blockchain-log.txt
 .coverage_artifacts
 .coverage_contracts
-yarn-error.log
 @types/generated/
 config.js
+blacklist.*.json
+!blacklist.test.json
+out/
+cache/
+
+# Yarn & Node Modules
+yarn-error.log
+node_modules/
+
+logs/
+pids/

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn precommit

.nvmrc

@@ -0,0 +1 @@
+v16.14.0

.prettierignore

@@ -6,3 +6,4 @@ coverage.json
 build/
 .coverage_contracts/
 .coverage_artifacts/
+LICENSE

.solcover.js

@@ -1,3 +1,21 @@
+/**
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Copyright (c) 2023, Circle Internet Financial, LLC.
+ *
+ * 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 = {
   providerOptions: {
     port: 8555,

.vscode/extensions.json

@@ -2,6 +2,7 @@
   "recommendations": [
     "dbaeumer.vscode-eslint",
     "esbenp.prettier-vscode",
-    "juanblanco.solidity"
+    "juanblanco.solidity",
+    "ymotongpoo.licenser"
   ]
 }

.vscode/settings.json

@@ -1,8 +1,4 @@
 {
-  "files.exclude": {
-    "**/.DS_Store": true,
-    "**/node_modules/": true
-  },
   "solidity.packageDefaultDependenciesContractsDirectory": "",
   "solidity.packageDefaultDependenciesDirectory": "node_modules",
   "solidity.formatter": "none",
@@ -21,9 +17,15 @@
   },
   "[solidity]": {
     "editor.tabSize": 4,
-    "editor.formatOnSave": true
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
   "[typescript]": {
     "editor.formatOnSave": true
-  }
+  },
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "licenser.license": "Custom",
+  "licenser.customHeader": "SPDX-License-Identifier: Apache-2.0\n\nCopyright (c) @YEAR@, Circle Internet Financial, LLC.\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\nhttp://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"
 }

@types/AnyFiatTokenV2Instance.d.ts

@@ -0,0 +1,35 @@
+/**
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Copyright (c) 2023, Circle Internet Financial, LLC.
+ *
+ * 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.
+ */
+
+import {
+  FiatTokenV2Instance,
+  FiatTokenV21Instance,
+  FiatTokenV22Instance,
+} from "./generated";
+
+export interface FiatTokenV22InstanceExtended extends FiatTokenV22Instance {
+  permit?: typeof FiatTokenV2Instance.permit;
+  transferWithAuthorization?: typeof FiatTokenV2Instance.transferWithAuthorization;
+  receiveWithAuthorization?: typeof FiatTokenV2Instance.receiveWithAuthorization;
+  cancelAuthorization?: typeof FiatTokenV2Instance.cancelAuthorization;
+}
+
+export type AnyFiatTokenV2Instance =
+  | FiatTokenV2Instance
+  | FiatTokenV21Instance
+  | FiatTokenV22InstanceExtended;

@types/TransactionRawLog.d.ts

@@ -1,3 +1,21 @@
+/**
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Copyright (c) 2023, Circle Internet Financial, LLC.
+ *
+ * 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.
+ */
+
 export interface TransactionRawLog {
   logIndex: number;
   transactionIndex: number;

CHANGELOG.md

@@ -0,0 +1,47 @@
+# Changelog
+
+## 2.2.0 (2023-11-09)
+
+- Add ERC-1271 signature validation support to EIP-2612 and EIP-3009 functions
+- Combine the balance state and the blacklist state for an address in a
+  `balanceAndBlacklistStates` map to reduce gas usage
+- Update `DOMAIN_SEPARATOR` to be a dynamic value
+- Remove `notBlacklisted` modifiers for `approve`, `increaseAllowance`,
+  `decreaseAllowance` and `permit`
+- Enable bypassing `TIMESTAMP` opcode in `permit` by using `uint256.max`
+
+## 2.1.1 (2021-06-03)
+
+- Add the multi-issuer minter contracts from the `multi-issuer` branch
+
+## 2.1.0 (2021-02-17)
+
+- Move locked USDC to a "lost and found" address and blacklists itself so that
+  accidental sends will no longer be possible
+- Conform to EIP-3009 in FiatToken
+  - Add `receiveWithAuthorization`
+  - Remove `approveWithAuthorization`, `increaseAllowanceWithAuthorization` and
+    `decreaseAllowanceWithAuthorization`
+
+## 2.0.0 (2020-07-30)
+
+- Add support for EIP-2612 in FiatToken
+- Add `transferWithAuthorization`, `approveWithAuthorization`,
+  `increaseAllowanceWithAuthorization`, `decreaseAllowanceWithAuthorization` to
+  enable ETH-less transactions
+- Add `increaseAllowance` and `decreaseAllowance` to mitigate the
+  multi-withdrawal attack vulnerability in ERC-20 `approve` function
+- Update Solidity version to `0.6.12`
+
+## 1.1.0 (2020-05-27)
+
+- Add Rescuable functionalities to FiatToken
+- Update Solidity version to `0.6.8`
+- Remove `ifAdmin` modifier from admin() and implementation() in FiatTokenProxy
+
+## 1.0.0 (2018-07-24)
+
+- Create ERC-20 compliant FiatToken contract
+- Add Ownable, Pausable and Blacklistable functionalities to FiatToken
+- Create FiatTokenProxy contracts based on Zeppelinos's Unstructured-Storage
+  Proxy pattern