Skip to content

Latest commit

 

History

History
80 lines (50 loc) · 4.35 KB

README.md

File metadata and controls

80 lines (50 loc) · 4.35 KB
Raw

Superfluid Stream Gating

Streamline your content access with Superfluid Stream Gating.

About Superfluid:

Superfluid is a revolutionary asset streaming protocol that brings subscriptions, salaries, vesting, and rewards to DAOs and crypto-native businesses worldwide - https://www.superfluid.finance/

Problem Statement:

sfsg-idea

Solution Overview:

This project tried to implement superfluid streams gating mechanism as mentioned in the problem statement by providing a serverless function that generates JWTs on-demand for authorized users. This function is built using the Netlify/AWS Lambda serverless architecture and is written in Node.js. It requires a list of authorized API keys and a secret key to generate JWT tokens. When a user sends a request to the function with a valid API key, it uses the Superfluid protocol subgraph to check if a stream exists for the specified sender, receiver, and token. If a stream exists with active flow rate, it generates a JWT token using the secret key and either returns the token and redirect URL or redirects the user to the protected resource with the token appended as a query parameter.

Deployment

To deploy the Superfluid Stream Gating serverless function, you need to have a Netlify account. Follow these steps to deploy the function:

Deploy to Netlify

Click the button above to deploy the function to your Netlify account. Follow the instructions to deploy your function.

Once the function is deployed, you need to update the following environment variables. You can do this by going to the Site settings tab of your Netlify site and clicking on Environment Variables > Select a variable > Options > Edit.

JWT_SECRET=
APP_URL=
WHITELISTED_API_KEYS=api_key_1,api_key_2,api_key_3

After updating the environment variables, you can access the function endpoint by going to the Functions tab of your Netlify site and clicking on the authorize function.

Usage

To use the Superfluid Stream Gating function authorize.js, you need to make a POST request to the deployed function endpoint with the following parameters in the request body:

sender: the Ethereum address of the sender of the stream

receiver: the Ethereum address of the receiver of the stream

token: the Ethereum address of the token being streamed

chain: The Ethereum network where the stream is taking place. Possible values: sepolia, mainnet, matic

Note: This project uses subgraph to verify the existence of the stream before authenticating access. You can specify chain in request body to use the subgraph of the specified chain. The supported chains are sepolia, mainnet, matic.

x-api-key: the API key in the request header

Here is an example curl command for making a request:

curl -X POST https://superfluid-stream-gating.netlify.app/.netlify/functions/authorize \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: zaLcG9' \
  -d '{
    "chain": "sepolia",
    "sender": "0xc7203561ef179333005a9b81215092413ab86ae9",
    "receiver": "0xdc7c5b449d4417a5aa01bf53ad280b1bedf4b078",
    "token": "0x9ce2062b085a2268e8d769ffc040f6692315fd2c"
  }'

Roadmap:

  • Create a standalone npm package for the Superfluid stream gating function with in-built token verfication functionality. Check out the package super-jwt
  • Add more example integrations with various app frameworks such as React, Nextjs, Nodejs(Server-side).
  • Add support for more Ethereum networks and improve error handling

Credits & Resources:

License

This project is licensed under the MIT License - see the LICENSE file for details