diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 00000000..12622f16 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,7 @@ +################################### +##### Global Protection Rule ###### +################################### +# NOTE: This rule is overriden by the more specific rules below. This is the catch-all rule for all files not covered by the more specific rules below +* @hashgraph/hedera-smart-contracts @hashgraph/dev-experience + + diff --git a/LICENSE b/LICENSE index e1fd273f..261eeb9e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,201 @@ -MIT License - -Copyright (c) 2023 - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/README.md b/README.md index 4c0c2c8a..e241df19 100644 --- a/README.md +++ b/README.md @@ -30,8 +30,10 @@ From the root of the project workspace: 1. Run `npm ci`. This will create populate and link `node_modules`. 2. `cp environments/.env.dev.hedera environments/.env` 3. Make sure the following variables defined in `.env` point to directories which exist on the file system: `REPOSITORY_PATH, SOLC_REPO, SOLJSON_REPO` (paths relative to the environments/ directory) -4. Run `npx lerna bootstrap && npx lerna run build`. This will build the server and ui as well as needed libraries. -5. Run `docker-compose -f environments/build-repository.yaml build`. This will build the docker image for the repository service. +4. `cp environments/example-docker-config.json environments/docker-config.json` + * Adjust as needed. With local build, this is used by the repository container, which only needs the SERVER_URL +5. Run `npx lerna bootstrap && npx lerna run build`. This will build the server and ui as well as needed libraries. +6. Run `docker-compose -f environments/build-repository.yaml build`. This will build the docker image for the repository service. ### Run @@ -44,7 +46,7 @@ From the root of the project workspace: This assumes the default ports (per .env.dev.hedera) are used: * `Open http://localhost:10000`. This should open the Repository select-contract-form. The options available for the Chain should be the 3 Hedera networks (mainnet, testnet, previewnet). -* `Open http://localhost:5555/chains`. This should return a JSON value containing the 3 Hedera networks +* `Open http://localhost:5002/chains`. This should return a JSON value containing the 3 Hedera networks * `Open http://localhost:5555/files/contracts/296`. This should return a JSON value containing the addresses of all contracts verified on testnet (or report error "_Contracts have not been found!_" if nothing has been verified yet) * `Open http://localhost:3000`. This should bring up the Verifier page. @@ -64,9 +66,9 @@ or build the images locally. ### Pulling pre-built images -* Run `docker pull ghcr.io/hashgraph/hedera-sourcify:ui-latest` -* Run `docker pull ghcr.io/hashgraph/hedera-sourcify:server-latest` -* Run `docker pull ghcr.io/hashgraph/hedera-sourcify:repository-latest` +* Run `docker pull ghcr.io/hashgraph/hedera-sourcify:ui-main` +* Run `docker pull ghcr.io/hashgraph/hedera-sourcify:server-main` +* Run `docker pull ghcr.io/hashgraph/hedera-sourcify:repository-main` * Then follow _Run_ step below. ### Build images @@ -212,4 +214,4 @@ to [oss@hedera.com](mailto:oss@hedera.com). ## License -[TBD](LICENSE) \ No newline at end of file +[Apache License 2.0](LICENSE) \ No newline at end of file diff --git a/environments/.env.dev.hedera b/environments/.env.dev.hedera index 7847b784..b7fdef18 100644 --- a/environments/.env.dev.hedera +++ b/environments/.env.dev.hedera @@ -35,7 +35,7 @@ REPOSITORY_SERVER_EXTERNAL_PORT=10000 # Other config TESTING=false -TAG=latest +TAG=main NODE_ENV=development USE_LOCAL_NODE=true diff --git a/environments/.env.docker.hedera b/environments/.env.docker.hedera index 2b191dbc..edb4b07a 100644 --- a/environments/.env.docker.hedera +++ b/environments/.env.docker.hedera @@ -43,7 +43,7 @@ REPOSITORY_SERVER_EXTERNAL_PORT=10000 # Other config TESTING=false -TAG=latest +TAG=main # Needed to call create2 APIs, format is: TOKEN1,TOKEN2,... CREATE2_CLIENT_TOKENS= diff --git a/environments/docker-compose-hedera.yaml b/environments/docker-compose-hedera.yaml index 904089b6..caaa2779 100644 --- a/environments/docker-compose-hedera.yaml +++ b/environments/docker-compose-hedera.yaml @@ -17,8 +17,8 @@ services: repository: <<: *project-base - image: ghcr.io/hashgraph/hedera-sourcify:repository-latest - container_name: repository-latest + image: ghcr.io/hashgraph/hedera-sourcify:repository-${TAG} + container_name: repository-${TAG} volumes: - <<: *project-repository-mount target: /data @@ -31,8 +31,8 @@ services: server: <<: *project-base - image: ghcr.io/hashgraph/hedera-sourcify:server-latest - container_name: server-latest + image: ghcr.io/hashgraph/hedera-sourcify:server-${TAG} + container_name: server-${TAG} ports: - "${SERVER_EXTERNAL_PORT}:${SERVER_PORT}" volumes: @@ -52,8 +52,8 @@ services: ui: <<: *project-base - image: ghcr.io/hashgraph/hedera-sourcify:ui-latest - container_name: ui-latest + image: ghcr.io/hashgraph/hedera-sourcify:ui-${TAG} + container_name: ui-${TAG} healthcheck: test: ["CMD", "curl", "-f", "http://localhost"] interval: 30s diff --git a/environments/example-docker-config.json b/environments/example-docker-config.json index db89531d..c2853343 100644 --- a/environments/example-docker-config.json +++ b/environments/example-docker-config.json @@ -1,5 +1,13 @@ { "SERVER_URL": "http://localhost:5002", "REPOSITORY_SERVER_URL": "http://localhost:10000", - "EXPLORER_URL": "http://localhost:8080" + "EXPLORER_URL": "http://localhost:8080", + "BRAND_PRODUCT_LOGO_URL": "", + "TERMS_OF_SERVICE_URL": "", + "REMOTE_IMPORT": false, + "GITHUB_IMPORT": false, + "CONTRACT_IMPORT": false, + "JSON_IMPORT": false, + "OPEN_IN_REMIX": false, + "CREATE2_VERIFICATION": false } \ No newline at end of file