feat: update docs, license, add feature flag to disable external api

CONTRIBUTING.md

@@ -18,25 +18,14 @@ There are many ways to contribute to the ZK Stack:
 
 ## Fixing issues
 
-To contribute code fixing issues, please fork the repo, fix an issue, commit, add documentation as per the PR template,
-and the repo's maintainers will review the PR.
-[here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)
-for guidance how to work with PRs created from a fork.
+To contribute code fixing issues, please clone the repo, fix an issue, commit, add documentation as per the PR template,
+and the repo's maintainers will review the PR. Please follow the Conventional Commits [specification](https://www.conventionalcommits.org/en/v1.0.0/#specification).
 
 ## Licenses
 
 If you contribute to this project, your contributions will be made to the project under both Apache 2.0 and the MIT
 license.
 
-## Resources
-
-We aim to make it as easy as possible to contribute to the mission. This is still WIP, and we're happy for contributions
-and suggestions here too. Some resources to help:
-
-1. [In-repo docs aimed at developers](docs)
-2. [zkSync Era docs!](https://era.zksync.io/docs/)
-3. Company links can be found in the [repo's readme](README.md)
-
 ## Code of Conduct
 
 Be polite and respectful.

LICENSE-APACHE

@@ -0,0 +1,176 @@
+                                 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

README.md

@@ -59,9 +59,9 @@ Make sure you have set up all the necessary env variables. Follow [Setting up en
 
 ## 👨‍💻 Running locally
 
-Before running the solution, make sure you have a database server up and running and you have created a database.
+Before running the solution, make sure you have a database server up and running, you have created a database and set up all the required environment variables.
 
-To run all the components (`Worker`, `API` and front-end `App`) in `development` mode run the following command from the root directory.
+To run all the packages (`Worker`, `API` and front-end `App`) in `development` mode run the following command from the root directory.
 ```bash
 $ npm run dev
 ```
@@ -104,4 +104,15 @@ For more details on testing please check individual packages `README`.
 We follow the Conventional Commits [specification](https://www.conventionalcommits.org/en/v1.0.0/#specification).
 
 ## 📘 License
-MIT License.
+zkSync Era Block Explorer is distributed under the terms of either
+
+- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)
+
+at your option.
+
+## 🔗 Production links
+- Testnet API: https://block-explorer-api.testnets.zksync.dev
+- Mainnet API: https://block-explorer-api.mainnet.zksync.io
+- Testnet App: https://goerli.explorer.zksync.io
+- Mainnet App: https://explorer.zksync.io

package.json

@@ -1,6 +1,11 @@
 {
   "name": "block-explorer",
   "version": "1.0.0-development",
+  "title": "zkSync Era Block Explorer",
+  "description": "zkSync Era Block Explorer",
+  "author": "Matter Labs",
+  "license": "MIT",
+  "repository": "https://github.com/matter-labs/block-explorer",
   "private": true,
   "workspaces": [
     "packages/*"

packages/api/.env.example

@@ -8,5 +8,6 @@ PORT=3000
 LOG_LEVEL=debug
 LIMITED_PAGINATION_MAX_ITEMS=100000
 DISABLE_API_SCHEMA_DOCS=false
+DISABLE_EXTERNAL_API=false
 DATABASE_STATEMENT_TIMEOUT_MS=90000
 CONTRACT_VERIFICATION_API_URL=https://zksync2-testnet-explorer.zksync.dev

packages/api/README.md

@@ -1,9 +1,11 @@
 # zkSync Era Block Explorer API
-## Description
+## Overview
 
 `zkSync Era Block Explorer API` is a block explorer API for zkSync Era blockchain.
 The service provides API for retrieving structured zkSync Era blockchain data. It must be connected to the [Block explorer Worker](https://github.com/matter-labs/block-explorer-worker) database.
 
+There are 2 sets of endpoints the service provides. All the endpoints under `/api/*` are designed for external direct usage. These endpoints are similar to [Etherscan API](https://docs.etherscan.io) endpoints. The development of these endpoints is in progress, so more of them will be added soon. The other set of endpoints (other than `/api/*`) is designed to be used by the front-end [App](/packages/app) only and is not meant to be used externally. Once all the new `/api/*` endpoints are developed all the other endpoints (other than `/api/*`) will be deprecated and removed.
+
 ## Installation
 
 ```bash
@@ -56,6 +58,9 @@ $ npm run test:e2e
 $ npm run test:cov
 ```
 
+## Docs
+Locally Swagger docs are available at http://localhost:3000/docs.
+
 ## Development
 
 ### Linter
@@ -86,4 +91,15 @@ To output performance results to a file use next command:
 artillery run ./performance/load-test.yaml -e testnet -o ./performance/29-06/testnet.json
 ```
 
-for more command options check [official artillery docs](https://www.artillery.io/docs).
+for more command options check [official artillery docs](https://www.artillery.io/docs).
+
+
+## Environments
+
+### *Staging*
+ - [Testnet](https://staging-block-explorer-api.testnets.zksync.dev)
+ - [Mainnet](https://staging-block-explorer-api.mainnet.zksync.io)
+
+### *Production*
+ - [Testnet](https://block-explorer-api.testnets.zksync.dev)
+ - [Mainnet](https://block-explorer-api.mainnet.zksync.io)

packages/api/package.json

@@ -1,12 +1,12 @@
 {
   "name": "api",
   "version": "0.0.0",
-  "title": "zkSync Block Explorer API",
-  "description": "zkSync Block Explorer API",
+  "title": "zkSync Era Block Explorer API",
+  "description": "zkSync Era Block Explorer API",
   "author": "Matter Labs",
   "private": true,
-  "license": "UNLICENSED",
-  "repository": "https://github.com/matter-labs/block-explorer-api",
+  "license": "MIT",
+  "repository": "https://github.com/matter-labs/block-explorer",
   "scripts": {
     "prebuild": "rimraf dist",
     "build": "nest build",

packages/api/src/app.module.ts

@@ -21,6 +21,9 @@ import { metricProviders } from "./metrics";
 import { DbMetricsService } from "./dbMetrics.service";
 import config from "./config";
 
+// TMP: disable external API until release
+const { disableExternalAPI } = config();
+
 @Module({
   imports: [
     ConfigModule.forRoot({ isGlobal: true, load: [config] }),
@@ -30,10 +33,8 @@ import config from "./config";
       inject: [ConfigService],
     }),
     ApiModule,
-    ApiBlockModule,
-    ApiAccountModule,
     ApiContractModule,
-    ApiTransactionModule,
+    ...(disableExternalAPI ? [] : [ApiBlockModule, ApiAccountModule, ApiTransactionModule]),
     TokenModule,
     AddressModule,
     BalanceModule,

packages/api/src/config.spec.ts

@@ -40,6 +40,7 @@ describe("config", () => {
       swagger: {
         enabled: true,
       },
+      disableExternalAPI: false,
     });
   });
 

packages/api/src/config.ts

@@ -10,6 +10,7 @@ export default () => {
     DATABASE_CONNECTION_POOL_SIZE,
     DATABASE_CONNECTION_IDLE_TIMEOUT_MS,
     DISABLE_API_SCHEMA_DOCS,
+    DISABLE_EXTERNAL_API,
     DATABASE_STATEMENT_TIMEOUT_MS,
     CONTRACT_VERIFICATION_API_URL,
   } = process.env;
@@ -75,6 +76,7 @@ export default () => {
     swagger: {
       enabled: DISABLE_API_SCHEMA_DOCS !== "true",
     },
+    disableExternalAPI: DISABLE_EXTERNAL_API === "true",
     contractVerificationApiUrl: CONTRACT_VERIFICATION_API_URL,
   };
 };