https://github.com/lit-protocol/relay-server
Relay server to facilitate and subsidize some interactions with smart contracts.
https://github.com/lit-protocol/relay-server
gasless-transactions relay-server
Last synced: 9 months ago
JSON representation
Relay server to facilitate and subsidize some interactions with smart contracts.
- Host: GitHub
- URL: https://github.com/lit-protocol/relay-server
- Owner: LIT-Protocol
- Created: 2022-10-25T07:43:48.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-05T15:09:40.000Z (about 1 year ago)
- Last Synced: 2024-12-05T16:23:18.755Z (about 1 year ago)
- Topics: gasless-transactions, relay-server
- Language: TypeScript
- Homepage:
- Size: 610 KB
- Stars: 9
- Watchers: 3
- Forks: 13
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Relay Server
_⚠️ NOTE: This repo is a work in progress._
_This repo was initially made via the instructions from Simple WebAuthn (https://simplewebauthn.dev/docs/advanced/example-project) and provides a fully-functional reference implementation of **@simplewebauthn/server** and **@simplewebauthn/browser**._
Relay Server is a server that is centrally run by the Lit Protocol team to facilitate and subsidize some interactions with the Lit Protocol smart contracts.
The Relay Server hosted by the Lit Protocol team currently only interacts with the smart contracts on Lit's [Chronicle Vesuvius](https://developer.litprotocol.com/connecting-to-a-lit-network/lit-blockchains/chronicle-vesuvius) chain.
**If you are to use the contract addresses that are hardcoded into this repo, minting a PKP will work but not storing an encryption condition, as our private key is the only authorized signer to store a condition on behalf of an address.**
## Running The Server
### Prerequisites
- Install Redis and have a valid connection to it
- Have access to a valid RPC service endpoint for the network you plan to interact with
- Have access to a ECDSA private key, with its corresponding wallet containing some funds on the network you plan to interact with
### Instructions
Create a `.env` file at the root of the repo and populate the corresponding environment variables:
- `REDIS_URL`
- `PORT`
- `LIT_TXSENDER_RPC_URL`
- `LIT_TXSENDER_PRIVATE_KEY`
- `LIT_DELEGATION_ROOT_MNEMONIC`
- `LIT_DELEGATION_USES`
- `GAS_LIMIT_INCREASE_PERCENTAGE`
Make sure to start your Redis server if you plan to host one locally.
Run `yarn install` to install the dependencies.
Run `yarn start` to start the server.
## Available Endpoints
Staging instance of the relay server is live at https://relay-server-staging.herokuapp.com. Check out the [demo app](https://github.com/LIT-Protocol/oauth-pkp-signup-example) for an example of how to use the relay server.
### Minting PKPs
| HTTP Verb | Path | Description |
| --------- | -------------------------------------------- | -------------------------------------------------------------- |
| POST | /auth/google | Mint PKP for authorized Google account |
| POST | /auth/discord | Mint PKP for authorized Discord account |
| POST | /auth/wallet | Mint PKP for verified Eth wallet account |
| GET | /auth/webauthn/generate-registration-options | Register (i.e., create an account) via supported authenticator |
| POST | /auth/webauthn/verify-registration | Verify the authenticator's response |
| GET | /auth/status/:requestId | Poll status of minting PKP transaction |
### Fetching PKPs
| HTTP Verb | Path | Description |
| --------- | ----------------------- | ------------------------------------------------------ |
| POST | /auth/google/userinfo | Fetch PKPs associated with authorized Google account |
| POST | /auth/discord/userinfo | Fetch PKPs associated with authorized Discord account |
| POST | /auth/wallet/userinfo | Fetch PKPs associated with verified Eth wallet account |
| POST | /auth/webauthn/userinfo | Fetch PKPs associated with WebAuthn credential |
\*Note: WebAuthn implementation is still a work in progress.
### Storing Conditions (only available on Serrano and Cayenne)
| HTTP Verb | Path | Description |
| --------- | ---------------- | ------------------------------------ |
| POST | /store-condition | Write encryption conditions to chain |