@axis-finance/curator-api v0.0.33

Curator API

Stateless middleware for authenticating curators via X (Twitter). This API can be used to prove a user owns a Twitter account. Axis uses this for verified curator onboarding.

Background

This API uses a private key process.env.SIGNER_KEY to sign a message associating a curator's twitter handle with their wallet address and their profile metadata IPFS CID. We have to handle this server side to prove the user owns the twitter account they're claiming is theirs. This signature is used by the axis-registry contract to enable curators to create and update their curator profiles. A curator who can't sign into a given twitter account will not be able to create a curator profile for that twitter account. You can deploy your own instance of the registry contract and use it to store your own curators' profiles.

This server is stateless and does not store any user data. It only verifies that a user owns a given twitter account. Sessions are stored in memory only.

Environment variables

Make sure you have a valid .env file in this package's root directory. See .env.example for an example.

Further reading on twitter-passport environment variables.

Setup

pnpm i

Running the dev server

pnpm dev

Running the build

pnpm build && pnpm start

Notes

This package uses twitter-passport to allow curators to authenticate with X (Twitter).

It also uses a free Twitter Rapid API service to enable your dapp to filter registered curators by twitter accounts you're following