Add payments config and charge according to configured rates (#395)

* Track amount paid on payment channels and charge as per query cost * Add payments manager config * Fix received payment checks * Separate out payment not received and amount insufficient errors * Serve a query for free if its rate is not configured * Load open payment channels from the stored state * Take list of free queries from config * Take mutation rates from config * Rename query rates config fields * Take cache settings and request timeout from config * Upgrade ts-nitro packages * Upgrade package versions
cerc-io · Jul 27, 2023 · 198d3e6 · 198d3e6
1 parent aa10a2d
commit 198d3e6
Show file tree

Hide file tree

Showing 15 changed files with 206 additions and 109 deletions.
diff --git a/lerna.json b/lerna.json
@@ -2,7 +2,7 @@
   "packages": [
     "packages/*"
   ],
-  "version": "0.2.49",
+  "version": "0.2.50",
   "npmClient": "yarn",
   "useWorkspaces": true,
   "command": {

diff --git a/packages/cache/package.json b/packages/cache/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/cache",
-  "version": "0.2.49",
+  "version": "0.2.50",
   "description": "Generic object cache",
   "main": "dist/index.js",
   "scripts": {

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/cli",
-  "version": "0.2.49",
+  "version": "0.2.50",
   "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.49",
-    "@cerc-io/util": "^0.2.49",
+    "@cerc-io/peer": "^0.2.50",
+    "@cerc-io/util": "^0.2.50",
     "@ethersproject/providers": "^5.4.4",
     "@graphql-tools/utils": "^9.1.1",
     "@ipld/dag-cbor": "^8.0.0",

diff --git a/packages/codegen/package.json b/packages/codegen/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/codegen",
-  "version": "0.2.49",
+  "version": "0.2.50",
   "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.49",
+    "@cerc-io/util": "^0.2.50",
     "@graphql-tools/load-files": "^6.5.2",
     "@poanet/solidity-flattener": "https://github.com/vulcanize/solidity-flattener.git",
     "@solidity-parser/parser": "^0.13.2",

diff --git a/packages/codegen/src/templates/package-template.handlebars b/packages/codegen/src/templates/package-template.handlebars
@@ -41,12 +41,12 @@
   "homepage": "https://github.com/cerc-io/watcher-ts#readme",
   "dependencies": {
     "@apollo/client": "^3.3.19",
-    "@cerc-io/cli": "^0.2.49",
-    "@cerc-io/ipld-eth-client": "^0.2.49",
-    "@cerc-io/solidity-mapper": "^0.2.49",
-    "@cerc-io/util": "^0.2.49",
+    "@cerc-io/cli": "^0.2.50",
+    "@cerc-io/ipld-eth-client": "^0.2.50",
+    "@cerc-io/solidity-mapper": "^0.2.50",
+    "@cerc-io/util": "^0.2.50",
     {{#if (subgraphPath)}}
-    "@cerc-io/graph-node": "^0.2.49",
+    "@cerc-io/graph-node": "^0.2.50",
     {{/if}}
     "@ethersproject/providers": "^5.4.4",
     "apollo-type-bigint": "^0.1.3",

diff --git a/packages/graph-node/package.json b/packages/graph-node/package.json
@@ -1,10 +1,10 @@
 {
   "name": "@cerc-io/graph-node",
-  "version": "0.2.49",
+  "version": "0.2.50",
   "main": "dist/index.js",
   "license": "AGPL-3.0",
   "devDependencies": {
-    "@cerc-io/solidity-mapper": "^0.2.49",
+    "@cerc-io/solidity-mapper": "^0.2.50",
     "@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.49",
-    "@cerc-io/ipld-eth-client": "^0.2.49",
-    "@cerc-io/util": "^0.2.49",
+    "@cerc-io/cache": "^0.2.50",
+    "@cerc-io/ipld-eth-client": "^0.2.50",
+    "@cerc-io/util": "^0.2.50",
     "@types/json-diff": "^0.5.2",
     "@types/yargs": "^17.0.0",
     "bn.js": "^4.11.9",

diff --git a/packages/ipld-eth-client/package.json b/packages/ipld-eth-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/ipld-eth-client",
-  "version": "0.2.49",
+  "version": "0.2.50",
   "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.49",
+    "@cerc-io/cache": "^0.2.50",
     "cross-fetch": "^3.1.4",
     "debug": "^4.3.1",
     "ethers": "^5.4.4",

diff --git a/packages/peer/package.json b/packages/peer/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/peer",
-  "version": "0.2.49",
+  "version": "0.2.50",
   "description": "libp2p module",
   "main": "dist/index.js",
   "exports": "./dist/index.js",

diff --git a/packages/solidity-mapper/package.json b/packages/solidity-mapper/package.json
@@ -1,10 +1,10 @@
 {
   "name": "@cerc-io/solidity-mapper",
-  "version": "0.2.49",
+  "version": "0.2.50",
   "main": "dist/index.js",
   "license": "AGPL-3.0",
   "devDependencies": {
-    "@cerc-io/ipld-eth-client": "^0.2.49",
+    "@cerc-io/ipld-eth-client": "^0.2.50",
     "@ethersproject/abi": "^5.3.0",
     "@nomiclabs/hardhat-ethers": "^2.0.2",
     "@nomiclabs/hardhat-waffle": "^2.0.1",

diff --git a/packages/test/package.json b/packages/test/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/test",
-  "version": "0.2.49",
+  "version": "0.2.50",
   "main": "dist/index.js",
   "license": "AGPL-3.0",
   "private": true,

diff --git a/packages/tracing-client/package.json b/packages/tracing-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/tracing-client",
-  "version": "0.2.49",
+  "version": "0.2.50",
   "description": "ETH VM tracing client",
   "main": "dist/index.js",
   "scripts": {

diff --git a/packages/util/package.json b/packages/util/package.json
@@ -1,12 +1,12 @@
 {
   "name": "@cerc-io/util",
-  "version": "0.2.49",
+  "version": "0.2.50",
   "main": "dist/index.js",
   "license": "AGPL-3.0",
   "dependencies": {
     "@apollo/utils.keyvaluecache": "^1.0.1",
-    "@cerc-io/nitro-client": "^0.1.4",
-    "@cerc-io/solidity-mapper": "^0.2.49",
+    "@cerc-io/nitro-client": "^0.1.5",
+    "@cerc-io/solidity-mapper": "^0.2.50",
     "@cerc-io/ts-channel": "1.0.3-ts-nitro-0.1.1",
     "@ethersproject/providers": "^5.4.4",
     "@graphql-tools/schema": "^9.0.10",
@@ -40,8 +40,8 @@
     "yargs": "^17.0.1"
   },
   "devDependencies": {
-    "@cerc-io/cache": "^0.2.49",
-    "@cerc-io/ipld-eth-client": "^0.2.49",
+    "@cerc-io/cache": "^0.2.50",
+    "@cerc-io/ipld-eth-client": "^0.2.50",
     "@nomiclabs/hardhat-waffle": "^2.0.1",
     "@types/express": "^4.17.14",
     "@types/fs-extra": "^9.0.11",

diff --git a/packages/util/src/config.ts b/packages/util/src/config.ts
@@ -81,7 +81,7 @@ interface L2TxsConfig {
   privateKey: string;
 
   // Gas limit for tx
-  gasLimit?: number
+  gasLimit?: number;
 }
 
 // Peer config
@@ -126,11 +126,37 @@ export interface PeerConfig {
   l2TxsConfig?: L2TxsConfig;
 }
 
+export interface BaseRatesConfig {
+  freeQueriesLimit: number;
+  freeQueriesList: string[];
+  queries: { [key: string]: string };
+  mutations: { [key: string]: string };
+}
+
+export interface PaymentsCacheConfig {
+  maxAccounts: number;
+  accountTTLInSecs: number;
+  maxVouchersPerAccount: number;
+  voucherTTLInSecs: number;
+  maxPaymentChannels: number;
+  paymentChannelTTLInSecs: number;
+}
+
+// Payments manager config
+export interface PaymentsConfig {
+  ratesFile: string;
+  requestTimeoutInSecs: number;
+  cache: PaymentsCacheConfig;
+}
+
 // ts-nitro config
 export interface NitroConfig {
-  store: string
-  privateKey: string
-  chainPrivateKey: string
+  store: string;
+
+  privateKey: string;
+  chainPrivateKey: string;
+
+  payments: PaymentsConfig;
 }
 
 // P2P config
@@ -179,7 +205,7 @@ export interface ServerConfig {
 
   // 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
+  rpcSupportsBlockHashParam: boolean;
 }
 
 export interface UpstreamConfig {