From b1dbc566e0fcb9e1a7d9faa5891e6c92b2e489cc Mon Sep 17 00:00:00 2001 From: Salman Dabbakuti <29351207+Salmandabbakuti@users.noreply.github.com> Date: Thu, 5 Sep 2024 09:02:22 +0530 Subject: [PATCH] Update readme, version bump --- README.md | 12 ++++++------ package.json | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d4d8cd8..8da15a7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # SuperJWT -![npm version](https://img.shields.io/badge/npm-0.2.0-brightgreen) +![npm version](https://img.shields.io/badge/npm-0.2.1-brightgreen) Super-JWT is a Node.js package that helps authenticate users based on Superfluid streams using JSON Web Tokens (JWT). @@ -36,7 +36,7 @@ An object that represents the required parameters for authenticating a Superflui `token`: A string that represents the ethereum address of the SuperToken being used. -In addition to the required parameters mentioned earlier, you can also pass any of the `where` parameters of the Superfluid subgraph `streams` query. This allows you to filter streams based on other properties such as `currentFlowRate_gt`, which is the flow rate in the stream. For more information on the available query parameters, you can refer to the [Superfluid subgraph documentation](https://thegraph.com/hosted-service/subgraph/superfluid-finance/protocol-v1-goerli). +In addition to the required parameters mentioned earlier, you can also pass any of the `where` parameters of the Superfluid subgraph `streams` query. This allows you to filter streams based on other properties such as `currentFlowRate_gt`, which is the flow rate in the stream. For more information on the available query parameters, you can refer to the [Superfluid subgraph documentation](https://console.superfluid.finance/subgraph). #### Example @@ -44,7 +44,7 @@ In addition to the required parameters mentioned earlier, you can also pass any import { authenticateWithStream } from "super-jwt"; const streamPayload = { - chain: "goerli", + chain: "sepolia", sender: "0x123456789", receiver: "0x987654321", token: "0x0123456789abcdef", @@ -85,9 +85,9 @@ const decoded = verifyToken(jwtToken, secret); console.log(decoded); // expected output: prints the decoded JWT Stream payload // { -// chain: 'goerli', +// chain: 'sepolia', // sender: '0xc7203561ef179333005a9b81215092413ab86ae9', -// receiver: '0x7348943c8d263ea253c0541656c36b88becd77b9', +// receiver: '0xdc7c5b449d4417a5aa01bf53ad280b1bedf4b078', // token: '0xf2d68898557ccb2cf4c10c3ef2b034b2a69dad00', // iat: 1680752577, // } @@ -150,4 +150,4 @@ I do not give any warranties and will not be liable for any loss incurred throug # License -This package is licensed under the MIT License. +This package is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information. diff --git a/package.json b/package.json index 79c4d2f..bff1b90 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "super-jwt", - "version": "0.2.0", + "version": "0.2.1", "description": "Super-JWT helps to authenticate your users based on Superfluid streams using JSON Web Tokens (JWT)", "author": "Salman Dabbakuti", "license": "MIT",