OpenTensor API & PaaS

This repository is designed to provide simple and easy-to-use templates (PaaS -- Product as a Service) for validators which enables:

• API endpoints to Bittensor subnet services and digital commodities

• Frontend and Backend templates

• Monetization with stripe integration

NOTE: At present, you have to manually configure your own validator to route the requests to. Reach out to [email protected] for further assistance. In addition, if you need a customized design & UI beyond the templates given, the OTF team is here to help.

Deploy

We use vercel for deployment: https://opentensor-paas-template.vercel.app/

API documentation

https://opentensor-paas-template.apidog.io/

Setup

1. Clone the repository

Clone the opentensor-api repository to your local machine:

git clone https://github.com/opentensor/opentensor-api.git

2. Setup environment

After cloning the repository, you first need to configure the project's environment variables.

In the projects root directory, rename the .env.example file to .env.

Database

DATABASE_URL:

Any postgresSQL database connection url

Stripe

STRIPE_SECRET:

Get your stripe keys: https://stripe.com/docs/keys

Email

RESEND_SECRET:

RESEND_DOMAIN: your custom domain or 'resend.dev'

Create a free Resend account and paste in your API key: https://resend.com

Connect your domain, and replace the email in src/lib/email/mailer.ts file.

Auth

1. Create your Google Auth Credentials here: https://console.cloud.google.com/apis/

   GOOGLE_CLIENT_ID:

   GOOGLE_CLIENT_SECRET:

2. Create your Github Auth Credentials here: https://github.com/settings/developers

   GITHUB_CLIENT_ID:

   GITHUB_CLIENT_SECRET:

3. NEXTAUTH_URL='http://localhost:3000' for development for production, replace this with your website url

   NEXTAUTH_SECRET: A random string is used to hash tokens, sign/encrypt cookies and generate cryptographic keys.

   APIKEY_ENCRYPT_KEY:

Vision(SN19)

Modify these to set your own validator url and key

VISION_KEY_OTF_VALIDATOR:

VISION_URL_OTF_VALIDATOR:

Niche(SN23)

Modify these to set your own validator url and key

NICHE_KEY_OTF_VALIDATOR:

NICHE_URL_OTF_VALIDATOR:

NOTE:

3. Install

Next, to install the projects dependencies, run the following command in your console inside of the projects directory:

pnpm install

4. Generate Prisma

In order to make sure your DB has the correct schema run:

pnpm dlx prisma db push

Then, generate the prisma client using:

pnpm dlx prisma generate

5. Run

Run the local development server:

pnpm run dev

6. Notes

When deploying to Vercel, make sure you update your environment variables.

Resources

Links