https://github.com/pokt-foundation/portal-api
The Portal API Gateway is a single endpoint that offers access to the full range of supported blockchains through one URL.
https://github.com/pokt-foundation/portal-api
blockchain infrastructure pocket web3
Last synced: 6 months ago
JSON representation
The Portal API Gateway is a single endpoint that offers access to the full range of supported blockchains through one URL.
- Host: GitHub
- URL: https://github.com/pokt-foundation/portal-api
- Owner: pokt-foundation
- License: mit
- Created: 2020-05-06T17:31:34.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2023-04-03T19:44:54.000Z (over 2 years ago)
- Last Synced: 2025-03-24T16:52:27.302Z (7 months ago)
- Topics: blockchain, infrastructure, pocket, web3
- Language: TypeScript
- Homepage: https://pokt.network
- Size: 7.92 MB
- Stars: 11
- Watchers: 12
- Forks: 8
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Pocket Gateway
Access the full range of Pocket Network's supported blockchains through a single URL!
[](#contributors) [](https://github.com/pokt-foundation/portal-api/actions)
## Quick start
Only the steps 1 and 2 are required, steps 3 and 4 are only needed if you want to bootstrap the app with existing data.
1. Run the following commands to copy the environment variables and optionally replace them with your own.
```
$ cp .tasks.env.example .tasks.env
$ cp .env.example .env
```
2. Spin up all services locally (requires docker and docker-compose)
```
$ npm install
$ npm run services:all:up
```
3. Download the production data in your machine.
```bash
$ npm run tasks:db:download-production-data
```
4. Retrieve the production data to be imported into the local app.
```bash
$ npm run tasks:db:import-production-data
```
**Hint**: If you still got issues about compiling when running the project after following at least the steps 1 and 2, run the command `npm run clean` and then `npm run services:all:up` again.
## Custom Error List
If you ever get an error from the API, it will be in JSON-RPC format. This is our list of custom errors for context.
| Code | Message | Meaning | Category |
|---|---|---|---|
| -32603 | Internal JSON-RPC error. | Request failed to be served | non-standard |
| -32051 | Overall timeout exceeded | Request took too long | non-standard |
| -32052 | Invalid domain | Invalid blockchain domain | non-standard |
| -32053 | Method cannot be served over HTTPS | We do not support WebSockets yet | non-standard |
| -32054 | Loader balancer not found | Not found in database | non-standard |
| -32055 | No application found in load balancer | Not found in database | non-standard |
| -32056 | Application not found | Not found in database | non-standard |
| -32057 | Incorrect blockchain | Not found in database | non-standard |
| -32058 | Load Balancer configuration invalid | Load balancer misconfigured in database | non-standard |
| -32059 | Secret key does not match | Application's secret key doesn't match | non-standard |
| -32060 | Whitelist origin check failed | Application configuration doesn't allow specified origin | non-standard |
| -32061 | Whitelist user agent failed | Application configuration doesn't allow specified user-agent | non-standard |
| -32064 | You cannot query logs for more than X amount of blocks | eth_getLogs Restriction Error | non-standard |
| -32066 | The request body is not proper JSON | The request body couldn't be parsed | non-standard |
| -32067 | GET requests are not supported. Use POST instead | Attempt to send a relay through a GET request | non-standard |
## Support & Contact
If you come across an issue with the Portal, do a search in the [Issues](https://github.com/pokt-foundation/portal/issues) tab of this repo to make sure it hasn't been reported before. Follow these steps to help us prevent duplicate issues and unnecessary notifications going to the many people watching this repo:
- If the issue you found has been reported and is still open, and the details match your issue, give a "thumbs up" to the relevant posts in the issue thread to signal that you have the same issue. No further action is required on your part.
- If the issue you found has been reported and is still open, but the issue is missing some details, you can add a comment to the issue thread describing the additional details.
- If the issue you found has been reported but has been closed, you can comment on the closed issue thread and ask to have the issue reopened because you are still experiencing the issue. Alternatively, you can open a new issue, reference the closed issue by number or link, and state that you are still experiencing the issue. Provide any additional details in your post, so we can better understand the issue and how to fix it.
## License
This project is licensed under the MIT License; see the [LICENSE.md](LICENSE.md) file for details.