Wait for receiving voucher on GQL query (#392)

* Wait for receiving voucher on GQL query

* Add timeout while authenticating voucher and remove listener channel

* Clear timeout after payment received

* Rename variable to paymentListener

* Upgrade package versions

* Add rpcSupportsBlockHashParam flag in config
This commit is contained in:
Nabarun Gogoi 2023-07-24 13:36:13 +05:30 committed by GitHub
parent eec1965980
commit 10fa9d6b4b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 91 additions and 32 deletions

View File

@ -2,7 +2,7 @@
"packages": [
"packages/*"
],
"version": "0.2.47",
"version": "0.2.48",
"npmClient": "yarn",
"useWorkspaces": true,
"command": {

View File

@ -1,6 +1,6 @@
{
"name": "@cerc-io/cache",
"version": "0.2.47",
"version": "0.2.48",
"description": "Generic object cache",
"main": "dist/index.js",
"scripts": {

View File

@ -1,6 +1,6 @@
{
"name": "@cerc-io/cli",
"version": "0.2.47",
"version": "0.2.48",
"main": "dist/index.js",
"license": "AGPL-3.0",
"scripts": {
@ -11,8 +11,8 @@
"chat": "DEBUG='vulcanize:*, laconic:*' node dist/chat.js"
},
"dependencies": {
"@cerc-io/peer": "^0.2.47",
"@cerc-io/util": "^0.2.47",
"@cerc-io/peer": "^0.2.48",
"@cerc-io/util": "^0.2.48",
"@ethersproject/providers": "^5.4.4",
"@graphql-tools/utils": "^9.1.1",
"@ipld/dag-cbor": "^8.0.0",

View File

@ -1,6 +1,6 @@
{
"name": "@cerc-io/codegen",
"version": "0.2.47",
"version": "0.2.48",
"description": "Code generator",
"private": true,
"main": "index.js",
@ -20,7 +20,7 @@
},
"homepage": "https://github.com/cerc-io/watcher-ts#readme",
"dependencies": {
"@cerc-io/util": "^0.2.47",
"@cerc-io/util": "^0.2.48",
"@graphql-tools/load-files": "^6.5.2",
"@poanet/solidity-flattener": "https://github.com/vulcanize/solidity-flattener.git",
"@solidity-parser/parser": "^0.13.2",

View File

@ -41,12 +41,12 @@
"homepage": "https://github.com/cerc-io/watcher-ts#readme",
"dependencies": {
"@apollo/client": "^3.3.19",
"@cerc-io/cli": "^0.2.47",
"@cerc-io/ipld-eth-client": "^0.2.47",
"@cerc-io/solidity-mapper": "^0.2.47",
"@cerc-io/util": "^0.2.47",
"@cerc-io/cli": "^0.2.48",
"@cerc-io/ipld-eth-client": "^0.2.48",
"@cerc-io/solidity-mapper": "^0.2.48",
"@cerc-io/util": "^0.2.48",
{{#if (subgraphPath)}}
"@cerc-io/graph-node": "^0.2.47",
"@cerc-io/graph-node": "^0.2.48",
{{/if}}
"@ethersproject/providers": "^5.4.4",
"apollo-type-bigint": "^0.1.3",

View File

@ -1,10 +1,10 @@
{
"name": "@cerc-io/graph-node",
"version": "0.2.47",
"version": "0.2.48",
"main": "dist/index.js",
"license": "AGPL-3.0",
"devDependencies": {
"@cerc-io/solidity-mapper": "^0.2.47",
"@cerc-io/solidity-mapper": "^0.2.48",
"@ethersproject/providers": "^5.4.4",
"@graphprotocol/graph-ts": "^0.22.0",
"@nomiclabs/hardhat-ethers": "^2.0.2",
@ -51,9 +51,9 @@
"dependencies": {
"@apollo/client": "^3.3.19",
"@cerc-io/assemblyscript": "0.19.10-watcher-ts-0.1.2",
"@cerc-io/cache": "^0.2.47",
"@cerc-io/ipld-eth-client": "^0.2.47",
"@cerc-io/util": "^0.2.47",
"@cerc-io/cache": "^0.2.48",
"@cerc-io/ipld-eth-client": "^0.2.48",
"@cerc-io/util": "^0.2.48",
"@types/json-diff": "^0.5.2",
"@types/yargs": "^17.0.0",
"bn.js": "^4.11.9",

View File

@ -1,6 +1,6 @@
{
"name": "@cerc-io/ipld-eth-client",
"version": "0.2.47",
"version": "0.2.48",
"description": "IPLD ETH Client",
"main": "dist/index.js",
"scripts": {
@ -20,7 +20,7 @@
"homepage": "https://github.com/cerc-io/watcher-ts#readme",
"dependencies": {
"@apollo/client": "^3.7.1",
"@cerc-io/cache": "^0.2.47",
"@cerc-io/cache": "^0.2.48",
"cross-fetch": "^3.1.4",
"debug": "^4.3.1",
"ethers": "^5.4.4",

View File

@ -1,6 +1,6 @@
{
"name": "@cerc-io/peer",
"version": "0.2.47",
"version": "0.2.48",
"description": "libp2p module",
"main": "dist/index.js",
"exports": "./dist/index.js",

View File

@ -1,10 +1,10 @@
{
"name": "@cerc-io/solidity-mapper",
"version": "0.2.47",
"version": "0.2.48",
"main": "dist/index.js",
"license": "AGPL-3.0",
"devDependencies": {
"@cerc-io/ipld-eth-client": "^0.2.47",
"@cerc-io/ipld-eth-client": "^0.2.48",
"@ethersproject/abi": "^5.3.0",
"@nomiclabs/hardhat-ethers": "^2.0.2",
"@nomiclabs/hardhat-waffle": "^2.0.1",

View File

@ -1,6 +1,6 @@
{
"name": "@cerc-io/test",
"version": "0.2.47",
"version": "0.2.48",
"main": "dist/index.js",
"license": "AGPL-3.0",
"private": true,

View File

@ -1,6 +1,6 @@
{
"name": "@cerc-io/tracing-client",
"version": "0.2.47",
"version": "0.2.48",
"description": "ETH VM tracing client",
"main": "dist/index.js",
"scripts": {

View File

@ -1,13 +1,13 @@
{
"name": "@cerc-io/util",
"version": "0.2.47",
"version": "0.2.48",
"main": "dist/index.js",
"license": "AGPL-3.0",
"dependencies": {
"@apollo/utils.keyvaluecache": "^1.0.1",
"@cerc-io/nitro-client": "^0.1.3",
"@cerc-io/nitro-util": "^0.1.3",
"@cerc-io/solidity-mapper": "^0.2.47",
"@cerc-io/solidity-mapper": "^0.2.48",
"@cerc-io/ts-channel": "1.0.3-ts-nitro-0.1.1",
"@ethersproject/providers": "^5.4.4",
"@graphql-tools/schema": "^9.0.10",
@ -41,8 +41,8 @@
"yargs": "^17.0.1"
},
"devDependencies": {
"@cerc-io/cache": "^0.2.47",
"@cerc-io/ipld-eth-client": "^0.2.47",
"@cerc-io/cache": "^0.2.48",
"@cerc-io/ipld-eth-client": "^0.2.48",
"@nomiclabs/hardhat-waffle": "^2.0.1",
"@types/express": "^4.17.14",
"@types/fs-extra": "^9.0.11",

View File

@ -176,6 +176,10 @@ export interface ServerConfig {
gqlCache: GQLCacheConfig;
p2p: P2PConfig;
// Flag to specify whether RPC endpoint supports block hash as block tag parameter
// https://ethereum.org/en/developers/docs/apis/json-rpc/#default-block
rpcSupportsBlockHashParam: boolean
}
export interface UpstreamConfig {

View File

@ -35,12 +35,15 @@ const LRU_CACHE_VOUCHER_TTL = 5 * 60 * 1000; // 5mins
const FREE_QUERY_LIMIT = 10;
const FREE_QUERIES = ['latestBlock'];
const REQUEST_TIMEOUT = 10 * 1000; // 10 seconds
export class PaymentsManager {
// TODO: Persist data
private remainingFreeQueriesMap: Map<string, number> = new Map();
private receivedVouchers: LRUCache<string, LRUCache<string, Voucher>>;
private stopSubscriptionLoop: ReadWriteChannel<void>;
private paymentListeners: ReadWriteChannel<string>[] = [];
// TODO: Read query rate map from config
// TODO: Add a method to get rate for a query
@ -84,6 +87,11 @@ export class PaymentsManager {
}
vouchersMap.set(voucher.hash(), voucher);
for await (const [, listener] of this.paymentListeners.entries()) {
await listener.push(payer);
}
break;
}
@ -132,18 +140,65 @@ export class PaymentsManager {
}
private async authenticateVoucherForSender (voucherHash:string, senderAddress: string): Promise<boolean> {
if (this.acceptReceivedVouchers(voucherHash, senderAddress)) {
return true;
}
// Wait for payment voucher from sender
const paymentListener = Channel<string>();
this.paymentListeners.push(paymentListener);
let requestTimeout;
const timeoutPromise = new Promise(resolve => {
requestTimeout = setTimeout(resolve, REQUEST_TIMEOUT);
});
try {
while (true) {
const payer = await Promise.race([
paymentListener.shift(),
timeoutPromise
]);
// payer is undefined if timeout completes or channel is closed externally
if (!payer) {
return false;
}
if (payer === senderAddress) {
if (this.acceptReceivedVouchers(voucherHash, senderAddress)) {
return true;
}
}
}
} finally {
// Close and remove listener
await paymentListener.close();
this.paymentListeners = this.paymentListeners.filter(listener => listener !== paymentListener);
// Clear timeout
clearTimeout(requestTimeout);
}
}
// Check vouchers in LRU cache map and remove them
// Returns false if not found
// Returns true after being found and removed
private acceptReceivedVouchers (voucherHash:string, senderAddress: string): boolean {
const vouchersMap = this.receivedVouchers.get(senderAddress);
if (!vouchersMap) {
return false;
}
const receivedVoucher = vouchersMap.get(voucherHash);
if (receivedVoucher) {
vouchersMap.delete(voucherHash);
return true;
if (!receivedVoucher) {
return false;
}
return false;
vouchersMap.delete(voucherHash);
return true;
}
}