thirdweb Web3-API Repo
Best in class web3 SDKs for Browser, Node and Mobile apps
- Docker
- Nodesjs (>= v18)
- PostgreSQL DB
- ENV Variables (Check
.env.example) - PG-Admin (Optional. PostgreSQL DB GUI)
Check the How to install required packages guide for more details.
View all end-points details (Open API Specification) : https://web3-api-akbv.chainsaw-dev.zeet.app
- Create a
.envfile based off.env.examplewith all the variables filled in. - Update the
WALLET_PRIVATE_KEYvalue on the.envfile - Update the
THIRDWEB_API_KEYvalue on the.envfile
Click to expand
You will need a PostgreSQL DB running instance to run the API Server & Worker. You can either run PostgreSQL DB on cloud, on a local instance or on docker. Check installation guide for more details.
Once you have PostgreSQL DB running on cloud or a local instance, update the following PostgreSQL DB ENV Variables Value on .env file:
POSTGRES_HOST: PostgreSQL Host NamePOSTGRES_DATABASE_NAME: PostgreSQL Database NamePOSTGRES_USER: PostgreSQL UsernamePOSTGRES_PASSWORD: PostgreSQL PasswordPOSTGRES_PORT: PostgreSQL Port (Defaults to 5432)POSTGRES_USE_SSL: Flag to indicate whether to use SSL
| Required: Docker, Postgres |
|---|
- Check Setup Instruction section to update the
.envfile - Check Advance Setup : PostgreSQL DB section to update the
.envfile - Run the below command
docker run --env-file ./.env -p 3005:3005 thirdweb/web3-api:latest
Run on a Server (EC2 Instance/Google Compute/VM)
| Required: A PostgreSQL DB running instance. |
|---|
- Clone the project on the remote server
- Check Setup Instruction section to update the
.envfile - Check Advance Setup : PostgreSQL DB section to update the
.envfile - Update the
HOSTvalue on the.envfile tolocalhost. Example:HOST=localhost - Run:
yarn install - Run:
yarn build && yarn copy-files - Run:
yarn start
| Required: Docker |
|---|
Note: This is the recommended way to run the API locally. It will spin up infra services, i.e., PostgreSQL DB, PG-Admin on Docker and run the API Server & Worker on local machine.
- Clone the Repo
- Check Setup Instruction section to update the
.envfile - Run:
yarn install - Run:
yarn dev
The API defaults to http://localhost:3005
We use docker-compose-infra.yml to spin up the supporting infra services, a postgres database and the pg-admin GUI.
Click to expand
| REQUIRED: PostgreSQL DB running instance |
|---|
- Clone the Repo
- Check Setup Instruction section to update the
.envfile - Check Advance Setup : PostgreSQL DB section to update the
.envfile - Run:
yarn install - Run:
yarn dev:server & yarn dev:worker
The API defaults to http://localhost:3005
NOTE: Do not run yarn install |
|---|
In this approach we run everything, i.e., Web3-API Server & Worker, Postgres DB, PG-Admin on Docker.
- Clone the Repo
- Check Setup Instruction section to update the
.envfile - Update the
HOSTvalue on the.envfile to0.0.0.0. Example:HOST=0.0.0.0 - Update the
POSTGRES_HOSTvalue on the.envfile tohost.docker.internal. Example :POSTGRES_HOST=host.docker.internal - Run:
yarn docker
We use docker-compose.yml to spin up the API Server & Worker along with supporting infra services, a postgres database and the pg-admin GUI.
The API defaults to http://localhost:3005
We welcome contributions from all developers, regardless of experience level. If you are interested in contributing, please read our Contributing Guide where you'll learn how the repo works, how to test your changes, and how to submit a pull request.
The best place to discuss your ideas, ask questions, and troubleshoot issues is our Discord server.
If you believe you have found a security vulnerability in any of our packages, we kindly ask you not to open a public issue; and to disclose this to us by emailing security@thirdweb.com.