{"_id":"@offchainlabs/stablecoin-evm","_rev":"2-59b36adbe15a1acea187d06b9d9b1b78","name":"@offchainlabs/stablecoin-evm","description":"Circle's Stablecoin Smart Contracts on EVM-compatible blockchains","dist-tags":{"latest":"1.0.0-orbit-alpha.0","alpha":"1.0.0-orbit-alpha.2"},"versions":{"1.0.0-orbit-alpha.0":{"name":"@offchainlabs/stablecoin-evm","version":"1.0.0-orbit-alpha.0","keywords":[],"author":{},"license":"Apache-2.0","_id":"@offchainlabs/stablecoin-evm@1.0.0-orbit-alpha.0","homepage":"https://github.com/OffchainLabs/stablecoin-evm#readme","bugs":{"url":"https://github.com/OffchainLabs/stablecoin-evm/issues"},"dist":{"shasum":"2138db1c47e868523c4d315152105625c9248391","tarball":"https://registry.npmjs.org/@offchainlabs/stablecoin-evm/-/stablecoin-evm-1.0.0-orbit-alpha.0.tgz","fileCount":270,"integrity":"sha512-nqJWIT8vMIFicOEr+u6AYlrknb5oxDti8jsuYD8gUEpwHYD8NzRkrzM1nA3vYNFar/N6Rj7sa1GikEecQbsXVw==","signatures":[{"sig":"MEQCIEkh8pjUP8HV5PiokbRvHlobvfGgvpyJYY89RBleDrK5AiBM6H2JrHiS/huapanEHllKk6PqYgqAz9rmWSPKh9BQfA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1999362},"engines":{"node":"16.14.0","yarn":"1.22.19"},"scripts":{"fmt":"yarn fmt:base --write","lint":"eslint --ext '.js,.ts' './**/*.{j,t}s'","test":"hardhat test","compile":"hardhat compile && forge build && ./flatten-generated-types.sh","solhint":"solhint 'contracts/**/*.sol'","coverage":"hardhat coverage","fmt:base":"prettier './**/*.sol' './**/*.js' './**/*.ts' './**/*.json' './**/*.md'","fmt:check":"yarn fmt:base --check","precommit":"yarn fmt && yarn static-check","typecheck":"tsc -p . --noEmit","gas-report":"hardhat test test/misc/gas.ts","postinstall":"bash setup.sh && husky install","forge:verify":"yarn forge:simulate --verify --resume --etherscan-api-key $(dotenv -p ETHERSCAN_KEY) --private-key $(dotenv -p DEPLOYER_PRIVATE_KEY)","static-check":"yarn hardhat typechain && yarn typecheck && yarn lint && yarn fmt:check && yarn solhint","contract-size":"hardhat size-contracts","forge:simulate":"forge script -vv --gas-estimate-multiplier $(dotenv -p GAS_MULTIPLIER)","prepublishOnly":"hardhat clean && forge clean && yarn compile","forge:broadcast":"yarn forge:simulate --broadcast","forge:broadcastAndVerify":"yarn forge:broadcast --verify --etherscan-api-key $(dotenv -p ETHERSCAN_KEY)"},"_npmUser":{"name":"gzeon","email":"im@gzeon.dev"},"repository":{"url":"git+https://github.com/OffchainLabs/stablecoin-evm.git","type":"git"},"description":"Circle's Stablecoin Smart Contracts on EVM-compatible blockchains","directories":{},"licenseText":"\n                                 Apache License\n                           Version 2.0, January 2004\n                        http://www.apache.org/licenses/\n\n   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n   1. Definitions.\n\n      \"License\" shall mean the terms and conditions for use, reproduction,\n      and distribution as defined by Sections 1 through 9 of this document.\n\n      \"Licensor\" shall mean the copyright owner or entity authorized by\n      the copyright owner that is granting the License.\n\n      \"Legal Entity\" shall mean the union of the acting entity and all\n      other entities that control, are controlled by, or are under common\n      control with that entity. For the purposes of this definition,\n      \"control\" means (i) the power, direct or indirect, to cause the\n      direction or management of such entity, whether by contract or\n      otherwise, or (ii) ownership of fifty percent (50%) or more of the\n      outstanding shares, or (iii) beneficial ownership of such entity.\n\n      \"You\" (or \"Your\") shall mean an individual or Legal Entity\n      exercising permissions granted by this License.\n\n      \"Source\" form shall mean the preferred form for making modifications,\n      including but not limited to software source code, documentation\n      source, and configuration files.\n\n      \"Object\" form shall mean any form resulting from mechanical\n      transformation or translation of a Source form, including but\n      not limited to compiled object code, generated documentation,\n      and conversions to other media types.\n\n      \"Work\" shall mean the work of authorship, whether in Source or\n      Object form, made available under the License, as indicated by a\n      copyright notice that is included in or attached to the work\n      (an example is provided in the Appendix below).\n\n      \"Derivative Works\" shall mean any work, whether in Source or Object\n      form, that is based on (or derived from) the Work and for which the\n      editorial revisions, annotations, elaborations, or other modifications\n      represent, as a whole, an original work of authorship. For the purposes\n      of this License, Derivative Works shall not include works that remain\n      separable from, or merely link (or bind by name) to the interfaces of,\n      the Work and Derivative Works thereof.\n\n      \"Contribution\" shall mean any work of authorship, including\n      the original version of the Work and any modifications or additions\n      to that Work or Derivative Works thereof, that is intentionally\n      submitted to Licensor for inclusion in the Work by the copyright owner\n      or by an individual or Legal Entity authorized to submit on behalf of\n      the copyright owner. For the purposes of this definition, \"submitted\"\n      means any form of electronic, verbal, or written communication sent\n      to the Licensor or its representatives, including but not limited to\n      communication on electronic mailing lists, source code control systems,\n      and issue tracking systems that are managed by, or on behalf of, the\n      Licensor for the purpose of discussing and improving the Work, but\n      excluding communication that is conspicuously marked or otherwise\n      designated in writing by the copyright owner as \"Not a Contribution.\"\n\n      \"Contributor\" shall mean Licensor and any individual or Legal Entity\n      on behalf of whom a Contribution has been received by Licensor and\n      subsequently incorporated within the Work.\n\n   2. Grant of Copyright License. Subject to the terms and conditions of\n      this License, each Contributor hereby grants to You a perpetual,\n      worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n      copyright license to reproduce, prepare Derivative Works of,\n      publicly display, publicly perform, sublicense, and distribute the\n      Work and such Derivative Works in Source or Object form.\n\n   3. Grant of Patent License. Subject to the terms and conditions of\n      this License, each Contributor hereby grants to You a perpetual,\n      worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n      (except as stated in this section) patent license to make, have made,\n      use, offer to sell, sell, import, and otherwise transfer the Work,\n      where such license applies only to those patent claims licensable\n      by such Contributor that are necessarily infringed by their\n      Contribution(s) alone or by combination of their Contribution(s)\n      with the Work to which such Contribution(s) was submitted. If You\n      institute patent litigation against any entity (including a\n      cross-claim or counterclaim in a lawsuit) alleging that the Work\n      or a Contribution incorporated within the Work constitutes direct\n      or contributory patent infringement, then any patent licenses\n      granted to You under this License for that Work shall terminate\n      as of the date such litigation is filed.\n\n   4. Redistribution. You may reproduce and distribute copies of the\n      Work or Derivative Works thereof in any medium, with or without\n      modifications, and in Source or Object form, provided that You\n      meet the following conditions:\n\n      (a) You must give any other recipients of the Work or\n          Derivative Works a copy of this License; and\n\n      (b) You must cause any modified files to carry prominent notices\n          stating that You changed the files; and\n\n      (c) You must retain, in the Source form of any Derivative Works\n          that You distribute, all copyright, patent, trademark, and\n          attribution notices from the Source form of the Work,\n          excluding those notices that do not pertain to any part of\n          the Derivative Works; and\n\n      (d) If the Work includes a \"NOTICE\" text file as part of its\n          distribution, then any Derivative Works that You distribute must\n          include a readable copy of the attribution notices contained\n          within such NOTICE file, excluding those notices that do not\n          pertain to any part of the Derivative Works, in at least one\n          of the following places: within a NOTICE text file distributed\n          as part of the Derivative Works; within the Source form or\n          documentation, if provided along with the Derivative Works; or,\n          within a display generated by the Derivative Works, if and\n          wherever such third-party notices normally appear. The contents\n          of the NOTICE file are for informational purposes only and\n          do not modify the License. You may add Your own attribution\n          notices within Derivative Works that You distribute, alongside\n          or as an addendum to the NOTICE text from the Work, provided\n          that such additional attribution notices cannot be construed\n          as modifying the License.\n\n      You may add Your own copyright statement to Your modifications and\n      may provide additional or different license terms and conditions\n      for use, reproduction, or distribution of Your modifications, or\n      for any such Derivative Works as a whole, provided Your use,\n      reproduction, and distribution of the Work otherwise complies with\n      the conditions stated in this License.\n\n   5. Submission of Contributions. Unless You explicitly state otherwise,\n      any Contribution intentionally submitted for inclusion in the Work\n      by You to the Licensor shall be under the terms and conditions of\n      this License, without any additional terms or conditions.\n      Notwithstanding the above, nothing herein shall supersede or modify\n      the terms of any separate license agreement you may have executed\n      with Licensor regarding such Contributions.\n\n   6. Trademarks. This License does not grant permission to use the trade\n      names, trademarks, service marks, or product names of the Licensor,\n      except as required for reasonable and customary use in describing the\n      origin of the Work and reproducing the content of the NOTICE file.\n\n   7. Disclaimer of Warranty. Unless required by applicable law or\n      agreed to in writing, Licensor provides the Work (and each\n      Contributor provides its Contributions) on an \"AS IS\" BASIS,\n      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n      implied, including, without limitation, any warranties or conditions\n      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n      PARTICULAR PURPOSE. You are solely responsible for determining the\n      appropriateness of using or redistributing the Work and assume any\n      risks associated with Your exercise of permissions under this License.\n\n   8. Limitation of Liability. In no event and under no legal theory,\n      whether in tort (including negligence), contract, or otherwise,\n      unless required by applicable law (such as deliberate and grossly\n      negligent acts) or agreed to in writing, shall any Contributor be\n      liable to You for damages, including any direct, indirect, special,\n      incidental, or consequential damages of any character arising as a\n      result of this License or out of the use or inability to use the\n      Work (including but not limited to damages for loss of goodwill,\n      work stoppage, computer failure or malfunction, or any and all\n      other commercial damages or losses), even if such Contributor\n      has been advised of the possibility of such damages.\n\n   9. Accepting Warranty or Additional Liability. While redistributing\n      the Work or Derivative Works thereof, You may choose to offer,\n      and charge a fee for, acceptance of support, warranty, indemnity,\n      or other liability obligations and/or rights consistent with this\n      License. However, in accepting such obligations, You may act only\n      on Your own behalf and on Your sole responsibility, not on behalf\n      of any other Contributor, and only if You agree to indemnify,\n      defend, and hold each Contributor harmless for any liability\n      incurred by, or claims asserted against, such Contributor by reason\n      of your accepting any such warranty or additional liability.\n\n   END OF TERMS AND CONDITIONS\n\n   APPENDIX: How to apply the Apache License to your work.\n\n      To apply the Apache License to your work, attach the following\n      boilerplate notice, with the fields enclosed by brackets \"[]\"\n      replaced with your own identifying information. (Don't include\n      the brackets!)  The text should be enclosed in the appropriate\n      comment syntax for the file format. We also recommend that a\n      file or class name and description of purpose be included on the\n      same \"printed page\" as the copyright notice for easier\n      identification within third-party archives.\n\n   Copyright [yyyy] [name of copyright owner]\n\n   Licensed under the Apache License, Version 2.0 (the \"License\");\n   you may not use this file except in compliance with the License.\n   You may obtain a copy of the License at\n\n       http://www.apache.org/licenses/LICENSE-2.0\n\n   Unless required by applicable law or agreed to in writing, software\n   distributed under the License is distributed on an \"AS IS\" BASIS,\n   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n   See the License for the specific language governing permissions and\n   limitations under the License.","_hasShrinkwrap":false,"devDependencies":{"q":"^1.5.1","chai":"^4.2.0","solc":"0.6.12","web3":"^1.2.11","husky":"^8.0.3","dotenv":"^16.4.1","eslint":"^7.5.0","ethers":"^6.11.0","lodash":"^4.17.19","hardhat":"2.19.4","solhint":"^3.1.0","ts-node":">=8.0.0","prettier":"2.0.5","typechain":"^8.1.0","dotenv-cli":"^7.3.0","typescript":">=4.5.0","@types/chai":"4.3.5","@types/node":"20.5.1","assert-diff":"1.2.6","@types/mocha":"10.0.1","@types/lodash":"^4.14.158","ethereumjs-abi":"^0.6.8","ethereumjs-util":"^7.0.3","solidity-coverage":"^0.8.9","@typechain/hardhat":"^9.0.0","eslint-plugin-node":"^11.1.0","@typechain/ethers-v6":"^0.4.0","eslint-plugin-import":"^2.22.0","hardhat-gas-reporter":"^1.0.10","mocha-junit-reporter":"^2.2.1","@typechain/truffle-v5":"^8.0.6","@types/ethereumjs-abi":"^0.6.3","eslint-plugin-promise":"^4.2.1","mocha-multi-reporters":"^1.5.1","eslint-config-prettier":"^6.11.0","eslint-config-standard":"^14.1.1","eslint-plugin-prettier":"^3.1.4","eslint-plugin-standard":"^4.0.1","hardhat-contract-sizer":"^2.10.0","@nomiclabs/hardhat-web3":"2.0.0","@openzeppelin/contracts":"^3.1.0","prettier-plugin-solidity":"1.0.0-alpha.54","@typescript-eslint/parser":"^3.7.0","@nomiclabs/hardhat-truffle5":"2.0.7","@nomicfoundation/hardhat-ethers":"3.0.4","@nomicfoundation/hardhat-foundry":"1.1.1","@typescript-eslint/eslint-plugin":"^3.7.0","@nomicfoundation/hardhat-chai-matchers":"2.0.2","@nomicfoundation/hardhat-network-helpers":"1.0.8"},"_npmOperationalInternal":{"tmp":"tmp/stablecoin-evm_1.0.0-orbit-alpha.0_1718960409523_0.6261275250762264","host":"s3://npm-registry-packages"}},"1.0.0-orbit-alpha.1":{"name":"@offchainlabs/stablecoin-evm","version":"1.0.0-orbit-alpha.1","keywords":[],"author":{},"license":"Apache-2.0","_id":"@offchainlabs/stablecoin-evm@1.0.0-orbit-alpha.1","homepage":"https://github.com/OffchainLabs/stablecoin-evm#readme","bugs":{"url":"https://github.com/OffchainLabs/stablecoin-evm/issues"},"dist":{"shasum":"6b728724202c714e1aae893487196f0eddc93687","tarball":"https://registry.npmjs.org/@offchainlabs/stablecoin-evm/-/stablecoin-evm-1.0.0-orbit-alpha.1.tgz","fileCount":270,"integrity":"sha512-mhy1zP/04lSp+jkkeVPblzzBzrrQu0lTq5zysek3jkv1hhy3+UuMU5PZDR8ftd9jWtDGd7kpN1Or767FjYFuIw==","signatures":[{"sig":"MEYCIQC56GkQyA3Ntl/ROkBnHkMxfmGbaE/6EZSjKm6THGhaXwIhAKqEHi2O0+/mgN2UtV010EE9jKZqlkaYbcyIXDjJ9HLS","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1999309},"readme":"<!-- prettier-ignore-start -->\n<!-- omit in toc -->\n# Circle's Stablecoin Smart Contracts on EVM-compatible blockchains\n<!-- prettier-ignore-end -->\n\nThis repository contains the smart contracts used by\n[Circle's](https://www.circle.com/) stablecoins on EVM-compatible blockchains.\nAll contracts are written in [Solidity](https://soliditylang.org/) and managed\nby the [Hardhat](https://hardhat.org/) framework.\n\n<!-- prettier-ignore-start -->\n<!-- omit in toc -->\n## Table of contents\n<!-- prettier-ignore-end -->\n\n- [Setup](#setup)\n  - [Development Environment](#development-environment)\n  - [IDE](#ide)\n- [Development](#development)\n  - [TypeScript type definition files for the contracts](#typescript-type-definition-files-for-the-contracts)\n  - [Linting and Formatting](#linting-and-formatting)\n  - [Testing](#testing)\n- [Deployment](#deployment)\n- [Contracts](#contracts)\n- [FiatToken features](#fiattoken-features)\n  - [ERC20 compatible](#erc20-compatible)\n  - [Pausable](#pausable)\n  - [Upgradable](#upgradable)\n  - [Blacklist](#blacklist)\n  - [Minting/Burning](#mintingburning)\n  - [Ownable](#ownable)\n- [Additional Documentations](#additional-documentations)\n\n## Setup\n\n### Development Environment\n\nRequirements:\n\n- Node 16.14.0\n- Yarn 1.22.19\n- [Foundry@f625d0f](https://github.com/foundry-rs/foundry/releases/tag/nightly-f625d0fa7c51e65b4bf1e8f7931cd1c6e2e285e9)\n\n```sh\n$ git clone git@github.com:circlefin/stablecoin-evm.git\n$ cd stablecoin-evm\n$ nvm use\n$ npm i -g yarn@1.22.19 # Install yarn if you don't already have it\n$ yarn install          # Install npm packages and other dependencies listed in setup.sh\n```\n\n### IDE\n\nWe recommend using VSCode for the project here with these\n[extensions](./.vscode/extensions.json) installed.\n\n## Development\n\n### TypeScript type definition files for the contracts\n\nTypes are automatically generated as a part of contract compilation:\n\n```sh\n$ yarn compile\n```\n\nTo generate typing without re-compiling, run\n\n```sh\n$ yarn hardhat typechain\n```\n\n### Linting and Formatting\n\nTo check code for problems:\n\n```sh\n$ yarn static-check   # Runs a static check on the repo.\n```\n\nor run the checks individually:\n\n```sh\n$ yarn typecheck      # Type-check TypeScript code\n$ yarn lint           # Check JavaScript and TypeScript code\n$ yarn lint --fix     # Fix problems where possible\n$ yarn solhint        # Check Solidity code\n```\n\nTo auto-format code:\n\n```sh\n$ yarn fmt\n```\n\n### Testing\n\nRun all tests:\n\n```sh\n$ yarn test\n```\n\nTo run tests in a specific file, run:\n\n```sh\n$ yarn test [path/to/file]\n```\n\nTo run tests and generate test coverage, run:\n\n```sh\n$ yarn coverage\n```\n\nTo check the size of contracts in the repo, run the following command.\n\n```sh\n$ yarn contract-size # Ignores tests\n```\n\n## Deployment\n\n1. Create a copy of the file `.env.example`, and name it `.env`. Fill in\n   appropriate values in the `.env` file. This file must not be checked into the\n   repository.\n\n```sh\ncp .env.example .env\n```\n\n2. Create a `blacklist.remote.json` file and populate it with a list of\n   addresses to be blacklisted. This file must not be checked into the\n   repository.\n\n```sh\necho \"[]\" > blacklist.remote.json\n```\n\n3. Simulate a deployment by running the following command\n\n```sh\nyarn forge:simulate scripts/deploy/deploy-fiat-token.s.sol --rpc-url <testnet OR mainnet>\n```\n\n4. Validate that all transactions to be broadcasted are filled in with the\n   correct values\n5. Deploy the contracts by running the following command\n\n```sh\nyarn forge:broadcast scripts/deploy/deploy-fiat-token.s.sol --rpc-url <testnet OR mainnet>\n```\n\n6. Verify the contracts on an Etherscan flavored block explorer by running the\n   following command. Ensure that `ETHERSCAN_KEY` is set in the `.env` file.\n\n```sh\nyarn forge:verify scripts/deploy/deploy-fiat-token.s.sol --rpc-url <testnet OR mainnet>\n```\n\n## Contracts\n\nThe FiatToken contracts adheres to OpenZeppelin's\n[Proxy Upgrade Pattern](https://docs.openzeppelin.com/upgrades-plugins/1.x/proxies)\n([permalink](https://github.com/OpenZeppelin/openzeppelin-upgrades/blob/65cf285bd36af24570186ca6409341540c67238a/docs/modules/ROOT/pages/proxies.adoc#L1)).\nThere are 2 main contracts - an implementation contract\n([`FiatTokenV2_2.sol`](./contracts/v2/FiatTokenV2_2.sol)) that contains the main\nlogic for FiatToken's functionalities, and a proxy contract\n([`FiatTokenProxy.sol`](./contracts/v1/FiatTokenProxy.sol)) that redirects\nfunction calls to the implementation contract. This allows upgrading FiatToken's\nfunctionalities, as a new implementation contact can be deployed and the Proxy\ncan be updated to point to it.\n\n## FiatToken features\n\nThe FiatToken offers a number of capabilities, which briefly are described\nbelow. There are more [detailed design docs](./doc/tokendesign.md) in the `doc`\ndirectory.\n\n### ERC20 compatible\n\nThe FiatToken implements the ERC20 interface.\n\n### Pausable\n\nThe entire contract can be frozen, in case a serious bug is found or there is a\nserious key compromise. No transfers can take place while the contract is\npaused. Access to the pause functionality is controlled by the `pauser` address.\n\n### Upgradable\n\nA new implementation contract can be deployed, and the proxy contract will\nforward calls to the new contract. Access to the upgrade functionality is\nguarded by a `proxyOwner` address. Only the `proxyOwner` address can change the\n`proxyOwner` address.\n\n### Blacklist\n\nThe contract can blacklist certain addresses which will prevent those addresses\nfrom transferring or receiving tokens. Access to the blacklist functionality is\ncontrolled by the `blacklister` address.\n\n### Minting/Burning\n\nTokens can be minted or burned on demand. The contract supports having multiple\nminters simultaneously. There is a `masterMinter` address which controls the\nlist of minters and how much each is allowed to mint. The mint allowance is\nsimilar to the ERC20 allowance - as each minter mints new tokens their allowance\ndecreases. When it gets too low they will need the allowance increased again by\nthe `masterMinter`.\n\n### Ownable\n\nThe contract has an Owner, who can change the `owner`, `pauser`, `blacklister`,\nor `masterMinter` addresses. The `owner` can not change the `proxyOwner`\naddress.\n\n## Additional Documentations\n\n- [FiatToken design](./doc/tokendesign.md)\n- [MasterMinter design](./doc/masterminter.md)\n- [Bridged USDC Standard](./doc/bridged_USDC_standard.md)\n- [Deployment process](./doc/deployment.md)\n- [Preparing an upgrade](./doc/upgrade.md)\n- [Upgrading from v2.1 to v2.2](./doc/v2.2_upgrade.md)\n- [Celo FiatToken extension](./doc/celo.md)\n","engines":{"node":"16.14.0","yarn":"1.22.19"},"scripts":{"fmt":"yarn fmt:base --write","lint":"eslint --ext '.js,.ts' './**/*.{j,t}s'","test":"hardhat test","compile":"hardhat compile && forge build && ./flatten-generated-types.sh","solhint":"solhint 'contracts/**/*.sol'","coverage":"hardhat coverage","fmt:base":"prettier './**/*.sol' './**/*.js' './**/*.ts' './**/*.json' './**/*.md'","fmt:check":"yarn fmt:base --check","precommit":"yarn fmt && yarn static-check","typecheck":"tsc -p . --noEmit","gas-report":"hardhat test test/misc/gas.ts","forge:verify":"yarn forge:simulate --verify --resume --etherscan-api-key $(dotenv -p ETHERSCAN_KEY) --private-key $(dotenv -p DEPLOYER_PRIVATE_KEY)","static-check":"yarn hardhat typechain && yarn typecheck && yarn lint && yarn fmt:check && yarn solhint","contract-size":"hardhat size-contracts","forge:simulate":"forge script -vv --gas-estimate-multiplier $(dotenv -p GAS_MULTIPLIER)","prepublishOnly":"hardhat clean && forge clean && yarn compile","forge:broadcast":"yarn forge:simulate --broadcast","forge:broadcastAndVerify":"yarn forge:broadcast --verify --etherscan-api-key $(dotenv -p ETHERSCAN_KEY)"},"_npmUser":{"name":"gzeon","email":"im@gzeon.dev"},"repository":{"url":"git+https://github.com/OffchainLabs/stablecoin-evm.git","type":"git"},"description":"Circle's Stablecoin Smart Contracts on EVM-compatible blockchains","directories":{},"licenseText":"\n                                 Apache License\n                           Version 2.0, January 2004\n                        http://www.apache.org/licenses/\n\n   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n   1. Definitions.\n\n      \"License\" shall mean the terms and conditions for use, reproduction,\n      and distribution as defined by Sections 1 through 9 of this document.\n\n      \"Licensor\" shall mean the copyright owner or entity authorized by\n      the copyright owner that is granting the License.\n\n      \"Legal Entity\" shall mean the union of the acting entity and all\n      other entities that control, are controlled by, or are under common\n      control with that entity. For the purposes of this definition,\n      \"control\" means (i) the power, direct or indirect, to cause the\n      direction or management of such entity, whether by contract or\n      otherwise, or (ii) ownership of fifty percent (50%) or more of the\n      outstanding shares, or (iii) beneficial ownership of such entity.\n\n      \"You\" (or \"Your\") shall mean an individual or Legal Entity\n      exercising permissions granted by this License.\n\n      \"Source\" form shall mean the preferred form for making modifications,\n      including but not limited to software source code, documentation\n      source, and configuration files.\n\n      \"Object\" form shall mean any form resulting from mechanical\n      transformation or translation of a Source form, including but\n      not limited to compiled object code, generated documentation,\n      and conversions to other media types.\n\n      \"Work\" shall mean the work of authorship, whether in Source or\n      Object form, made available under the License, as indicated by a\n      copyright notice that is included in or attached to the work\n      (an example is provided in the Appendix below).\n\n      \"Derivative Works\" shall mean any work, whether in Source or Object\n      form, that is based on (or derived from) the Work and for which the\n      editorial revisions, annotations, elaborations, or other modifications\n      represent, as a whole, an original work of authorship. For the purposes\n      of this License, Derivative Works shall not include works that remain\n      separable from, or merely link (or bind by name) to the interfaces of,\n      the Work and Derivative Works thereof.\n\n      \"Contribution\" shall mean any work of authorship, including\n      the original version of the Work and any modifications or additions\n      to that Work or Derivative Works thereof, that is intentionally\n      submitted to Licensor for inclusion in the Work by the copyright owner\n      or by an individual or Legal Entity authorized to submit on behalf of\n      the copyright owner. For the purposes of this definition, \"submitted\"\n      means any form of electronic, verbal, or written communication sent\n      to the Licensor or its representatives, including but not limited to\n      communication on electronic mailing lists, source code control systems,\n      and issue tracking systems that are managed by, or on behalf of, the\n      Licensor for the purpose of discussing and improving the Work, but\n      excluding communication that is conspicuously marked or otherwise\n      designated in writing by the copyright owner as \"Not a Contribution.\"\n\n      \"Contributor\" shall mean Licensor and any individual or Legal Entity\n      on behalf of whom a Contribution has been received by Licensor and\n      subsequently incorporated within the Work.\n\n   2. Grant of Copyright License. Subject to the terms and conditions of\n      this License, each Contributor hereby grants to You a perpetual,\n      worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n      copyright license to reproduce, prepare Derivative Works of,\n      publicly display, publicly perform, sublicense, and distribute the\n      Work and such Derivative Works in Source or Object form.\n\n   3. Grant of Patent License. Subject to the terms and conditions of\n      this License, each Contributor hereby grants to You a perpetual,\n      worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n      (except as stated in this section) patent license to make, have made,\n      use, offer to sell, sell, import, and otherwise transfer the Work,\n      where such license applies only to those patent claims licensable\n      by such Contributor that are necessarily infringed by their\n      Contribution(s) alone or by combination of their Contribution(s)\n      with the Work to which such Contribution(s) was submitted. If You\n      institute patent litigation against any entity (including a\n      cross-claim or counterclaim in a lawsuit) alleging that the Work\n      or a Contribution incorporated within the Work constitutes direct\n      or contributory patent infringement, then any patent licenses\n      granted to You under this License for that Work shall terminate\n      as of the date such litigation is filed.\n\n   4. Redistribution. You may reproduce and distribute copies of the\n      Work or Derivative Works thereof in any medium, with or without\n      modifications, and in Source or Object form, provided that You\n      meet the following conditions:\n\n      (a) You must give any other recipients of the Work or\n          Derivative Works a copy of this License; and\n\n      (b) You must cause any modified files to carry prominent notices\n          stating that You changed the files; and\n\n      (c) You must retain, in the Source form of any Derivative Works\n          that You distribute, all copyright, patent, trademark, and\n          attribution notices from the Source form of the Work,\n          excluding those notices that do not pertain to any part of\n          the Derivative Works; and\n\n      (d) If the Work includes a \"NOTICE\" text file as part of its\n          distribution, then any Derivative Works that You distribute must\n          include a readable copy of the attribution notices contained\n          within such NOTICE file, excluding those notices that do not\n          pertain to any part of the Derivative Works, in at least one\n          of the following places: within a NOTICE text file distributed\n          as part of the Derivative Works; within the Source form or\n          documentation, if provided along with the Derivative Works; or,\n          within a display generated by the Derivative Works, if and\n          wherever such third-party notices normally appear. The contents\n          of the NOTICE file are for informational purposes only and\n          do not modify the License. You may add Your own attribution\n          notices within Derivative Works that You distribute, alongside\n          or as an addendum to the NOTICE text from the Work, provided\n          that such additional attribution notices cannot be construed\n          as modifying the License.\n\n      You may add Your own copyright statement to Your modifications and\n      may provide additional or different license terms and conditions\n      for use, reproduction, or distribution of Your modifications, or\n      for any such Derivative Works as a whole, provided Your use,\n      reproduction, and distribution of the Work otherwise complies with\n      the conditions stated in this License.\n\n   5. Submission of Contributions. Unless You explicitly state otherwise,\n      any Contribution intentionally submitted for inclusion in the Work\n      by You to the Licensor shall be under the terms and conditions of\n      this License, without any additional terms or conditions.\n      Notwithstanding the above, nothing herein shall supersede or modify\n      the terms of any separate license agreement you may have executed\n      with Licensor regarding such Contributions.\n\n   6. Trademarks. This License does not grant permission to use the trade\n      names, trademarks, service marks, or product names of the Licensor,\n      except as required for reasonable and customary use in describing the\n      origin of the Work and reproducing the content of the NOTICE file.\n\n   7. Disclaimer of Warranty. Unless required by applicable law or\n      agreed to in writing, Licensor provides the Work (and each\n      Contributor provides its Contributions) on an \"AS IS\" BASIS,\n      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n      implied, including, without limitation, any warranties or conditions\n      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n      PARTICULAR PURPOSE. You are solely responsible for determining the\n      appropriateness of using or redistributing the Work and assume any\n      risks associated with Your exercise of permissions under this License.\n\n   8. Limitation of Liability. In no event and under no legal theory,\n      whether in tort (including negligence), contract, or otherwise,\n      unless required by applicable law (such as deliberate and grossly\n      negligent acts) or agreed to in writing, shall any Contributor be\n      liable to You for damages, including any direct, indirect, special,\n      incidental, or consequential damages of any character arising as a\n      result of this License or out of the use or inability to use the\n      Work (including but not limited to damages for loss of goodwill,\n      work stoppage, computer failure or malfunction, or any and all\n      other commercial damages or losses), even if such Contributor\n      has been advised of the possibility of such damages.\n\n   9. Accepting Warranty or Additional Liability. While redistributing\n      the Work or Derivative Works thereof, You may choose to offer,\n      and charge a fee for, acceptance of support, warranty, indemnity,\n      or other liability obligations and/or rights consistent with this\n      License. However, in accepting such obligations, You may act only\n      on Your own behalf and on Your sole responsibility, not on behalf\n      of any other Contributor, and only if You agree to indemnify,\n      defend, and hold each Contributor harmless for any liability\n      incurred by, or claims asserted against, such Contributor by reason\n      of your accepting any such warranty or additional liability.\n\n   END OF TERMS AND CONDITIONS\n\n   APPENDIX: How to apply the Apache License to your work.\n\n      To apply the Apache License to your work, attach the following\n      boilerplate notice, with the fields enclosed by brackets \"[]\"\n      replaced with your own identifying information. (Don't include\n      the brackets!)  The text should be enclosed in the appropriate\n      comment syntax for the file format. We also recommend that a\n      file or class name and description of purpose be included on the\n      same \"printed page\" as the copyright notice for easier\n      identification within third-party archives.\n\n   Copyright [yyyy] [name of copyright owner]\n\n   Licensed under the Apache License, Version 2.0 (the \"License\");\n   you may not use this file except in compliance with the License.\n   You may obtain a copy of the License at\n\n       http://www.apache.org/licenses/LICENSE-2.0\n\n   Unless required by applicable law or agreed to in writing, software\n   distributed under the License is distributed on an \"AS IS\" BASIS,\n   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n   See the License for the specific language governing permissions and\n   limitations under the License.","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"q":"^1.5.1","chai":"^4.2.0","solc":"0.6.12","web3":"^1.2.11","husky":"^8.0.3","dotenv":"^16.4.1","eslint":"^7.5.0","ethers":"^6.11.0","lodash":"^4.17.19","hardhat":"2.19.4","solhint":"^3.1.0","ts-node":">=8.0.0","prettier":"2.0.5","typechain":"^8.1.0","dotenv-cli":"^7.3.0","typescript":">=4.5.0","@types/chai":"4.3.5","@types/node":"20.5.1","assert-diff":"1.2.6","@types/mocha":"10.0.1","@types/lodash":"^4.14.158","ethereumjs-abi":"^0.6.8","ethereumjs-util":"^7.0.3","solidity-coverage":"^0.8.9","@typechain/hardhat":"^9.0.0","eslint-plugin-node":"^11.1.0","@typechain/ethers-v6":"^0.4.0","eslint-plugin-import":"^2.22.0","hardhat-gas-reporter":"^1.0.10","mocha-junit-reporter":"^2.2.1","@typechain/truffle-v5":"^8.0.6","@types/ethereumjs-abi":"^0.6.3","eslint-plugin-promise":"^4.2.1","mocha-multi-reporters":"^1.5.1","eslint-config-prettier":"^6.11.0","eslint-config-standard":"^14.1.1","eslint-plugin-prettier":"^3.1.4","eslint-plugin-standard":"^4.0.1","hardhat-contract-sizer":"^2.10.0","@nomiclabs/hardhat-web3":"2.0.0","@openzeppelin/contracts":"^3.1.0","prettier-plugin-solidity":"1.0.0-alpha.54","@typescript-eslint/parser":"^3.7.0","@nomiclabs/hardhat-truffle5":"2.0.7","@nomicfoundation/hardhat-ethers":"3.0.4","@nomicfoundation/hardhat-foundry":"1.1.1","@typescript-eslint/eslint-plugin":"^3.7.0","@nomicfoundation/hardhat-chai-matchers":"2.0.2","@nomicfoundation/hardhat-network-helpers":"1.0.8"},"_npmOperationalInternal":{"tmp":"tmp/stablecoin-evm_1.0.0-orbit-alpha.1_1718966348688_0.23445246145096044","host":"s3://npm-registry-packages"}},"1.0.0-orbit-alpha.2":{"name":"@offchainlabs/stablecoin-evm","version":"1.0.0-orbit-alpha.2","description":"Circle's Stablecoin Smart Contracts on EVM-compatible blockchains","scripts":{"prepublishOnly":"hardhat clean && forge clean && yarn compile","compile":"hardhat compile && forge build && ./flatten-generated-types.sh","contract-size":"hardhat size-contracts","coverage":"hardhat coverage","forge:simulate":"forge script -vv --gas-estimate-multiplier $(dotenv -p GAS_MULTIPLIER)","forge:broadcast":"yarn forge:simulate --broadcast","forge:broadcastAndVerify":"yarn forge:broadcast --verify --etherscan-api-key $(dotenv -p ETHERSCAN_KEY)","forge:verify":"yarn forge:simulate --verify --resume --etherscan-api-key $(dotenv -p ETHERSCAN_KEY) --private-key $(dotenv -p DEPLOYER_PRIVATE_KEY)","fmt:base":"prettier './**/*.sol' './**/*.js' './**/*.ts' './**/*.json' './**/*.md'","fmt:check":"yarn fmt:base --check","fmt":"yarn fmt:base --write","gas-report":"hardhat test test/misc/gas.ts","lint":"eslint --ext '.js,.ts' './**/*.{j,t}s'","precommit":"yarn fmt && yarn static-check","solhint":"solhint 'contracts/**/*.sol'","static-check":"yarn hardhat typechain && yarn typecheck && yarn lint && yarn fmt:check && yarn solhint","test":"hardhat test","typecheck":"tsc -p . --noEmit"},"repository":{"type":"git","url":"git+https://github.com/OffchainLabs/stablecoin-evm.git"},"keywords":[],"author":{},"license":"Apache-2.0","bugs":{"url":"https://github.com/OffchainLabs/stablecoin-evm/issues"},"homepage":"https://github.com/OffchainLabs/stablecoin-evm#readme","devDependencies":{"@nomicfoundation/hardhat-chai-matchers":"2.0.2","@nomicfoundation/hardhat-ethers":"3.0.4","@nomicfoundation/hardhat-foundry":"1.1.1","@nomicfoundation/hardhat-network-helpers":"1.0.8","@nomiclabs/hardhat-truffle5":"2.0.7","@nomiclabs/hardhat-web3":"2.0.0","@openzeppelin/contracts":"^3.1.0","@typechain/ethers-v6":"^0.4.0","@typechain/hardhat":"^9.0.0","@typechain/truffle-v5":"^8.0.6","@types/chai":"4.3.5","@types/ethereumjs-abi":"^0.6.3","@types/lodash":"^4.14.158","@types/mocha":"10.0.1","@types/node":"20.5.1","@typescript-eslint/eslint-plugin":"^3.7.0","@typescript-eslint/parser":"^3.7.0","assert-diff":"1.2.6","chai":"^4.2.0","dotenv":"^16.4.1","dotenv-cli":"^7.3.0","eslint":"^7.5.0","eslint-config-prettier":"^6.11.0","eslint-config-standard":"^14.1.1","eslint-plugin-import":"^2.22.0","eslint-plugin-node":"^11.1.0","eslint-plugin-prettier":"^3.1.4","eslint-plugin-promise":"^4.2.1","eslint-plugin-standard":"^4.0.1","ethereumjs-abi":"^0.6.8","ethereumjs-util":"^7.0.3","ethers":"^6.11.0","hardhat":"2.19.4","hardhat-contract-sizer":"^2.10.0","hardhat-gas-reporter":"^1.0.10","husky":"^8.0.3","lodash":"^4.17.19","mocha-junit-reporter":"^2.2.1","mocha-multi-reporters":"^1.5.1","prettier":"2.0.5","prettier-plugin-solidity":"1.0.0-alpha.54","q":"^1.5.1","solc":"0.6.12","solhint":"^3.1.0","solidity-coverage":"^0.8.9","ts-node":">=8.0.0","typechain":"^8.1.0","typescript":">=4.5.0","web3":"^1.2.11"},"readmeFilename":"README.md","readme":"<!-- prettier-ignore-start -->\n<!-- omit in toc -->\n# Circle's Stablecoin Smart Contracts on EVM-compatible blockchains\n<!-- prettier-ignore-end -->\n\nThis repository contains the smart contracts used by\n[Circle's](https://www.circle.com/) stablecoins on EVM-compatible blockchains.\nAll contracts are written in [Solidity](https://soliditylang.org/) and managed\nby the [Hardhat](https://hardhat.org/) framework.\n\n<!-- prettier-ignore-start -->\n<!-- omit in toc -->\n## Table of contents\n<!-- prettier-ignore-end -->\n\n- [Setup](#setup)\n  - [Development Environment](#development-environment)\n  - [IDE](#ide)\n- [Development](#development)\n  - [TypeScript type definition files for the contracts](#typescript-type-definition-files-for-the-contracts)\n  - [Linting and Formatting](#linting-and-formatting)\n  - [Testing](#testing)\n- [Deployment](#deployment)\n- [Contracts](#contracts)\n- [FiatToken features](#fiattoken-features)\n  - [ERC20 compatible](#erc20-compatible)\n  - [Pausable](#pausable)\n  - [Upgradable](#upgradable)\n  - [Blacklist](#blacklist)\n  - [Minting/Burning](#mintingburning)\n  - [Ownable](#ownable)\n- [Additional Documentations](#additional-documentations)\n\n## Setup\n\n### Development Environment\n\nRequirements:\n\n- Node 16.14.0\n- Yarn 1.22.19\n- [Foundry@f625d0f](https://github.com/foundry-rs/foundry/releases/tag/nightly-f625d0fa7c51e65b4bf1e8f7931cd1c6e2e285e9)\n\n```sh\n$ git clone git@github.com:circlefin/stablecoin-evm.git\n$ cd stablecoin-evm\n$ nvm use\n$ npm i -g yarn@1.22.19 # Install yarn if you don't already have it\n$ yarn install          # Install npm packages and other dependencies listed in setup.sh\n```\n\n### IDE\n\nWe recommend using VSCode for the project here with these\n[extensions](./.vscode/extensions.json) installed.\n\n## Development\n\n### TypeScript type definition files for the contracts\n\nTypes are automatically generated as a part of contract compilation:\n\n```sh\n$ yarn compile\n```\n\nTo generate typing without re-compiling, run\n\n```sh\n$ yarn hardhat typechain\n```\n\n### Linting and Formatting\n\nTo check code for problems:\n\n```sh\n$ yarn static-check   # Runs a static check on the repo.\n```\n\nor run the checks individually:\n\n```sh\n$ yarn typecheck      # Type-check TypeScript code\n$ yarn lint           # Check JavaScript and TypeScript code\n$ yarn lint --fix     # Fix problems where possible\n$ yarn solhint        # Check Solidity code\n```\n\nTo auto-format code:\n\n```sh\n$ yarn fmt\n```\n\n### Testing\n\nRun all tests:\n\n```sh\n$ yarn test\n```\n\nTo run tests in a specific file, run:\n\n```sh\n$ yarn test [path/to/file]\n```\n\nTo run tests and generate test coverage, run:\n\n```sh\n$ yarn coverage\n```\n\nTo check the size of contracts in the repo, run the following command.\n\n```sh\n$ yarn contract-size # Ignores tests\n```\n\n## Deployment\n\n1. Create a copy of the file `.env.example`, and name it `.env`. Fill in\n   appropriate values in the `.env` file. This file must not be checked into the\n   repository.\n\n```sh\ncp .env.example .env\n```\n\n2. Create a `blacklist.remote.json` file and populate it with a list of\n   addresses to be blacklisted. This file must not be checked into the\n   repository.\n\n```sh\necho \"[]\" > blacklist.remote.json\n```\n\n3. Simulate a deployment by running the following command\n\n```sh\nyarn forge:simulate scripts/deploy/deploy-fiat-token.s.sol --rpc-url <testnet OR mainnet>\n```\n\n4. Validate that all transactions to be broadcasted are filled in with the\n   correct values\n5. Deploy the contracts by running the following command\n\n```sh\nyarn forge:broadcast scripts/deploy/deploy-fiat-token.s.sol --rpc-url <testnet OR mainnet>\n```\n\n6. Verify the contracts on an Etherscan flavored block explorer by running the\n   following command. Ensure that `ETHERSCAN_KEY` is set in the `.env` file.\n\n```sh\nyarn forge:verify scripts/deploy/deploy-fiat-token.s.sol --rpc-url <testnet OR mainnet>\n```\n\n## Contracts\n\nThe FiatToken contracts adheres to OpenZeppelin's\n[Proxy Upgrade Pattern](https://docs.openzeppelin.com/upgrades-plugins/1.x/proxies)\n([permalink](https://github.com/OpenZeppelin/openzeppelin-upgrades/blob/65cf285bd36af24570186ca6409341540c67238a/docs/modules/ROOT/pages/proxies.adoc#L1)).\nThere are 2 main contracts - an implementation contract\n([`FiatTokenV2_2.sol`](./contracts/v2/FiatTokenV2_2.sol)) that contains the main\nlogic for FiatToken's functionalities, and a proxy contract\n([`FiatTokenProxy.sol`](./contracts/v1/FiatTokenProxy.sol)) that redirects\nfunction calls to the implementation contract. This allows upgrading FiatToken's\nfunctionalities, as a new implementation contact can be deployed and the Proxy\ncan be updated to point to it.\n\n## FiatToken features\n\nThe FiatToken offers a number of capabilities, which briefly are described\nbelow. There are more [detailed design docs](./doc/tokendesign.md) in the `doc`\ndirectory.\n\n### ERC20 compatible\n\nThe FiatToken implements the ERC20 interface.\n\n### Pausable\n\nThe entire contract can be frozen, in case a serious bug is found or there is a\nserious key compromise. No transfers can take place while the contract is\npaused. Access to the pause functionality is controlled by the `pauser` address.\n\n### Upgradable\n\nA new implementation contract can be deployed, and the proxy contract will\nforward calls to the new contract. Access to the upgrade functionality is\nguarded by a `proxyOwner` address. Only the `proxyOwner` address can change the\n`proxyOwner` address.\n\n### Blacklist\n\nThe contract can blacklist certain addresses which will prevent those addresses\nfrom transferring or receiving tokens. Access to the blacklist functionality is\ncontrolled by the `blacklister` address.\n\n### Minting/Burning\n\nTokens can be minted or burned on demand. The contract supports having multiple\nminters simultaneously. There is a `masterMinter` address which controls the\nlist of minters and how much each is allowed to mint. The mint allowance is\nsimilar to the ERC20 allowance - as each minter mints new tokens their allowance\ndecreases. When it gets too low they will need the allowance increased again by\nthe `masterMinter`.\n\n### Ownable\n\nThe contract has an Owner, who can change the `owner`, `pauser`, `blacklister`,\nor `masterMinter` addresses. The `owner` can not change the `proxyOwner`\naddress.\n\n## Additional Documentations\n\n- [FiatToken design](./doc/tokendesign.md)\n- [MasterMinter design](./doc/masterminter.md)\n- [Bridged USDC Standard](./doc/bridged_USDC_standard.md)\n- [Deployment process](./doc/deployment.md)\n- [Preparing an upgrade](./doc/upgrade.md)\n- [Upgrading from v2.1 to v2.2](./doc/v2.2_upgrade.md)\n- [Celo FiatToken extension](./doc/celo.md)\n","licenseText":"\n                                 Apache License\n                           Version 2.0, January 2004\n                        http://www.apache.org/licenses/\n\n   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n   1. Definitions.\n\n      \"License\" shall mean the terms and conditions for use, reproduction,\n      and distribution as defined by Sections 1 through 9 of this document.\n\n      \"Licensor\" shall mean the copyright owner or entity authorized by\n      the copyright owner that is granting the License.\n\n      \"Legal Entity\" shall mean the union of the acting entity and all\n      other entities that control, are controlled by, or are under common\n      control with that entity. For the purposes of this definition,\n      \"control\" means (i) the power, direct or indirect, to cause the\n      direction or management of such entity, whether by contract or\n      otherwise, or (ii) ownership of fifty percent (50%) or more of the\n      outstanding shares, or (iii) beneficial ownership of such entity.\n\n      \"You\" (or \"Your\") shall mean an individual or Legal Entity\n      exercising permissions granted by this License.\n\n      \"Source\" form shall mean the preferred form for making modifications,\n      including but not limited to software source code, documentation\n      source, and configuration files.\n\n      \"Object\" form shall mean any form resulting from mechanical\n      transformation or translation of a Source form, including but\n      not limited to compiled object code, generated documentation,\n      and conversions to other media types.\n\n      \"Work\" shall mean the work of authorship, whether in Source or\n      Object form, made available under the License, as indicated by a\n      copyright notice that is included in or attached to the work\n      (an example is provided in the Appendix below).\n\n      \"Derivative Works\" shall mean any work, whether in Source or Object\n      form, that is based on (or derived from) the Work and for which the\n      editorial revisions, annotations, elaborations, or other modifications\n      represent, as a whole, an original work of authorship. For the purposes\n      of this License, Derivative Works shall not include works that remain\n      separable from, or merely link (or bind by name) to the interfaces of,\n      the Work and Derivative Works thereof.\n\n      \"Contribution\" shall mean any work of authorship, including\n      the original version of the Work and any modifications or additions\n      to that Work or Derivative Works thereof, that is intentionally\n      submitted to Licensor for inclusion in the Work by the copyright owner\n      or by an individual or Legal Entity authorized to submit on behalf of\n      the copyright owner. For the purposes of this definition, \"submitted\"\n      means any form of electronic, verbal, or written communication sent\n      to the Licensor or its representatives, including but not limited to\n      communication on electronic mailing lists, source code control systems,\n      and issue tracking systems that are managed by, or on behalf of, the\n      Licensor for the purpose of discussing and improving the Work, but\n      excluding communication that is conspicuously marked or otherwise\n      designated in writing by the copyright owner as \"Not a Contribution.\"\n\n      \"Contributor\" shall mean Licensor and any individual or Legal Entity\n      on behalf of whom a Contribution has been received by Licensor and\n      subsequently incorporated within the Work.\n\n   2. Grant of Copyright License. Subject to the terms and conditions of\n      this License, each Contributor hereby grants to You a perpetual,\n      worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n      copyright license to reproduce, prepare Derivative Works of,\n      publicly display, publicly perform, sublicense, and distribute the\n      Work and such Derivative Works in Source or Object form.\n\n   3. Grant of Patent License. Subject to the terms and conditions of\n      this License, each Contributor hereby grants to You a perpetual,\n      worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n      (except as stated in this section) patent license to make, have made,\n      use, offer to sell, sell, import, and otherwise transfer the Work,\n      where such license applies only to those patent claims licensable\n      by such Contributor that are necessarily infringed by their\n      Contribution(s) alone or by combination of their Contribution(s)\n      with the Work to which such Contribution(s) was submitted. If You\n      institute patent litigation against any entity (including a\n      cross-claim or counterclaim in a lawsuit) alleging that the Work\n      or a Contribution incorporated within the Work constitutes direct\n      or contributory patent infringement, then any patent licenses\n      granted to You under this License for that Work shall terminate\n      as of the date such litigation is filed.\n\n   4. Redistribution. You may reproduce and distribute copies of the\n      Work or Derivative Works thereof in any medium, with or without\n      modifications, and in Source or Object form, provided that You\n      meet the following conditions:\n\n      (a) You must give any other recipients of the Work or\n          Derivative Works a copy of this License; and\n\n      (b) You must cause any modified files to carry prominent notices\n          stating that You changed the files; and\n\n      (c) You must retain, in the Source form of any Derivative Works\n          that You distribute, all copyright, patent, trademark, and\n          attribution notices from the Source form of the Work,\n          excluding those notices that do not pertain to any part of\n          the Derivative Works; and\n\n      (d) If the Work includes a \"NOTICE\" text file as part of its\n          distribution, then any Derivative Works that You distribute must\n          include a readable copy of the attribution notices contained\n          within such NOTICE file, excluding those notices that do not\n          pertain to any part of the Derivative Works, in at least one\n          of the following places: within a NOTICE text file distributed\n          as part of the Derivative Works; within the Source form or\n          documentation, if provided along with the Derivative Works; or,\n          within a display generated by the Derivative Works, if and\n          wherever such third-party notices normally appear. The contents\n          of the NOTICE file are for informational purposes only and\n          do not modify the License. You may add Your own attribution\n          notices within Derivative Works that You distribute, alongside\n          or as an addendum to the NOTICE text from the Work, provided\n          that such additional attribution notices cannot be construed\n          as modifying the License.\n\n      You may add Your own copyright statement to Your modifications and\n      may provide additional or different license terms and conditions\n      for use, reproduction, or distribution of Your modifications, or\n      for any such Derivative Works as a whole, provided Your use,\n      reproduction, and distribution of the Work otherwise complies with\n      the conditions stated in this License.\n\n   5. Submission of Contributions. Unless You explicitly state otherwise,\n      any Contribution intentionally submitted for inclusion in the Work\n      by You to the Licensor shall be under the terms and conditions of\n      this License, without any additional terms or conditions.\n      Notwithstanding the above, nothing herein shall supersede or modify\n      the terms of any separate license agreement you may have executed\n      with Licensor regarding such Contributions.\n\n   6. Trademarks. This License does not grant permission to use the trade\n      names, trademarks, service marks, or product names of the Licensor,\n      except as required for reasonable and customary use in describing the\n      origin of the Work and reproducing the content of the NOTICE file.\n\n   7. Disclaimer of Warranty. Unless required by applicable law or\n      agreed to in writing, Licensor provides the Work (and each\n      Contributor provides its Contributions) on an \"AS IS\" BASIS,\n      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n      implied, including, without limitation, any warranties or conditions\n      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n      PARTICULAR PURPOSE. You are solely responsible for determining the\n      appropriateness of using or redistributing the Work and assume any\n      risks associated with Your exercise of permissions under this License.\n\n   8. Limitation of Liability. In no event and under no legal theory,\n      whether in tort (including negligence), contract, or otherwise,\n      unless required by applicable law (such as deliberate and grossly\n      negligent acts) or agreed to in writing, shall any Contributor be\n      liable to You for damages, including any direct, indirect, special,\n      incidental, or consequential damages of any character arising as a\n      result of this License or out of the use or inability to use the\n      Work (including but not limited to damages for loss of goodwill,\n      work stoppage, computer failure or malfunction, or any and all\n      other commercial damages or losses), even if such Contributor\n      has been advised of the possibility of such damages.\n\n   9. Accepting Warranty or Additional Liability. While redistributing\n      the Work or Derivative Works thereof, You may choose to offer,\n      and charge a fee for, acceptance of support, warranty, indemnity,\n      or other liability obligations and/or rights consistent with this\n      License. However, in accepting such obligations, You may act only\n      on Your own behalf and on Your sole responsibility, not on behalf\n      of any other Contributor, and only if You agree to indemnify,\n      defend, and hold each Contributor harmless for any liability\n      incurred by, or claims asserted against, such Contributor by reason\n      of your accepting any such warranty or additional liability.\n\n   END OF TERMS AND CONDITIONS\n\n   APPENDIX: How to apply the Apache License to your work.\n\n      To apply the Apache License to your work, attach the following\n      boilerplate notice, with the fields enclosed by brackets \"[]\"\n      replaced with your own identifying information. (Don't include\n      the brackets!)  The text should be enclosed in the appropriate\n      comment syntax for the file format. We also recommend that a\n      file or class name and description of purpose be included on the\n      same \"printed page\" as the copyright notice for easier\n      identification within third-party archives.\n\n   Copyright [yyyy] [name of copyright owner]\n\n   Licensed under the Apache License, Version 2.0 (the \"License\");\n   you may not use this file except in compliance with the License.\n   You may obtain a copy of the License at\n\n       http://www.apache.org/licenses/LICENSE-2.0\n\n   Unless required by applicable law or agreed to in writing, software\n   distributed under the License is distributed on an \"AS IS\" BASIS,\n   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n   See the License for the specific language governing permissions and\n   limitations under the License.","_id":"@offchainlabs/stablecoin-evm@1.0.0-orbit-alpha.2","dist":{"shasum":"1156ab9436d0791739b56b355d7cff2e3aadaede","integrity":"sha512-g9SO/KD4QoIA5Mvo+wE7GDe3PwNtQ0IK3b+RNRClHKH2if4emneQtEj/eD0Tc32BuYzPRK5cbd4/lBjARo9izQ==","tarball":"https://registry.npmjs.org/@offchainlabs/stablecoin-evm/-/stablecoin-evm-1.0.0-orbit-alpha.2.tgz","fileCount":270,"unpackedSize":1999244,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIA772Mk08fuO8m8HdOQ0Oz0rUvf515dSzCIr4/MW9OvlAiEAtCBJsslq9RSdRR59rk+HNFsRAG/Uwyegl4p9YZLRYnw="}]},"_npmUser":{"name":"gzeon","email":"im@gzeon.dev"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/stablecoin-evm_1.0.0-orbit-alpha.2_1719231008228_0.8357661902745859"},"_hasShrinkwrap":false}},"time":{"created":"2024-06-21T09:00:09.426Z","modified":"2024-06-24T12:10:08.723Z","1.0.0-orbit-alpha.0":"2024-06-21T09:00:09.825Z","1.0.0-orbit-alpha.1":"2024-06-21T10:39:08.906Z","1.0.0-orbit-alpha.2":"2024-06-24T12:10:08.463Z"},"maintainers":[{"name":"spsjvc","email":"dragisaspasojevic@gmail.com"},{"name":"gzeon","email":"im@gzeon.dev"},{"name":"hkalodner","email":"harry@offchainlabs.com"}],"author":{},"repository":{"url":"git+https://github.com/OffchainLabs/stablecoin-evm.git","type":"git"},"keywords":[],"license":"Apache-2.0","homepage":"https://github.com/OffchainLabs/stablecoin-evm#readme","bugs":{"url":"https://github.com/OffchainLabs/stablecoin-evm/issues"},"readme":"","readmeFilename":""}