Init Payment Delegation DB Relay Example Code

.gitignore

@@ -0,0 +1,2 @@
+/**/*/node_modules
+/**/*/.env

payment-delegation-db-relayer/nodejs/.env.example

@@ -0,0 +1,3 @@
+LIT_NETWORK=habanero
+LIT_RELAYER_API_KEY=
+LIT_PAYER_SECRET_KEY=

payment-delegation-db-relayer/nodejs/.mocharc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://json.schemastore.org/mocharc.json",
+  "require": "tsx"
+}

payment-delegation-db-relayer/nodejs/README.md

@@ -0,0 +1,35 @@
+# Payment Delegation Database
+
+This directory contains an example usage of the Payment Delegation Database to register a new payer wallet, and add users as payees. There is a corresponding Lit docs page that covers the code in this example which is available [here](https://developer.litprotocol.com/sdk/paying-for-lit/payment-delegation-db).
+
+## Getting Started
+
+1. After cloning this repo, `cd` into this directory:
+   ```
+   cd payment-delegation-db-relayer/nodejs
+   ```
+2. Install the dependencies with: `yarn`
+3. Initialize the `.env` file by copy `.env.example`:
+   ```
+   cp .env.example .env
+   ```
+4. Fill out the `.env`
+   - For the `LIT_NETWORK` variable, the following options are available:
+     - `habanero`
+     - `manzano`
+   - For the `LIT_RELAYER_API_KEY` variable, if you don't already have a Relayer API key, you can fill out [this form](https://docs.google.com/forms/d/e/1FAIpQLSeVraHsp1evK_9j-8LpUBiEJWFn4G5VKjOWBmHFjxFRJZJdrg/viewform) to request one.
+   - You may not already have a Payer wallet secret key to use for the `LIT_PAYER_SECRET_KEY` variable. In this case, you can run the [registerPayer.spec.ts](./test/registerPayer.spec.ts) test file to generate one:
+     ```ts
+     npx @dotenvx/dotenvx run -- mocha test/registerPayer.spec.ts
+     ```
+     - The `LIT_NETWORK` and `LIT_RELAYER_API_KEY` variables are required in order for this test to run successfully and generate a Payer wallet secret ket
+     - Running this test will log the following to the console:
+       ```
+       Registered a new payer wallet:  {
+           payerWalletAddress: '0x6133D5Ad3018981B90EC7849d4025e46aa976174',
+           payerSecretKey: '/tYbYhv8zy67SKYP51Vx7k4nVV=+41VhuofPDj63vM5QgUZkUfAbhdPVCV3ByZnCIxRT6hWo9fVuVVktQaDHfOQ=='
+       }
+       ```
+       `payerSecretKey` is what you'll want to set for the `LIT_PAYER_SECRET_KEY` variable
+5. Run `yarn test` to execute both tests
+   - In order for both tests to successfully run, you **must** have all the `.env` variables provided

payment-delegation-db-relayer/nodejs/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "nodejs",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "type": "module",
+  "scripts": {
+    "test": "npx @dotenvx/dotenvx run -- mocha test/**/*.spec.ts"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.3.16",
+    "@types/chai-json-schema": "^1.4.10",
+    "@types/mocha": "^10.0.6",
+    "chai": "^5.1.1",
+    "chai-json-schema": "^1.5.1",
+    "mocha": "^10.4.0",
+    "tsc": "^2.0.4",
+    "tsx": "^4.11.2",
+    "typescript": "^5.4.5"
+  },
+  "dependencies": {
+    "@dotenvx/dotenvx": "^0.44.1"
+  }
+}

payment-delegation-db-relayer/nodejs/src/addUsers.ts

@@ -0,0 +1,48 @@
+const getEnv = (name: string): string => {
+  const env = process.env[name];
+  if (env === undefined || env === "")
+    throw new Error(
+      `${name} ENV is not defined, please define it in the .env file`
+    );
+  return env;
+};
+
+const LIT_NETWORK = getEnv("LIT_NETWORK");
+const LIT_RELAYER_URL = `https://${LIT_NETWORK}-relayer.getlit.dev/add-users`;
+const LIT_RELAYER_API_KEY = getEnv("LIT_RELAYER_API_KEY");
+const LIT_PAYER_SECRET_KEY = getEnv("LIT_PAYER_SECRET_KEY");
+
+interface AddUserResponse {
+  success: boolean;
+  error?: string;
+}
+
+export const addUsers = async (users: string[]) => {
+  const headers = {
+    "api-key": LIT_RELAYER_API_KEY,
+    "payer-secret-key": LIT_PAYER_SECRET_KEY,
+    "Content-Type": "application/json",
+  };
+
+  try {
+    const response = await fetch(LIT_RELAYER_URL, {
+      method: "POST",
+      headers: headers,
+      body: JSON.stringify(users),
+    });
+
+    if (!response.ok) {
+      throw new Error(`Error: ${await response.text()}`);
+    }
+
+    const data = (await response.json()) as AddUserResponse;
+    if (data.success !== true) {
+      throw new Error(`Error: ${data.error}`);
+    }
+
+    return true;
+  } catch (error) {
+    console.error("Error registering payer:", error);
+    throw error;
+  }
+};

payment-delegation-db-relayer/nodejs/src/registerPayer.ts

@@ -0,0 +1,43 @@
+const getEnv = (name: string): string => {
+  const env = process.env[name];
+  if (env === undefined || env === "")
+    throw new Error(
+      `${name} ENV is not defined, please define it in the .env file`
+    );
+  return env;
+};
+
+const LIT_NETWORK = getEnv("LIT_NETWORK");
+const LIT_RELAYER_URL = `https://${LIT_NETWORK}-relayer.getlit.dev/register-payer`;
+const LIT_RELAYER_API_KEY = getEnv("LIT_RELAYER_API_KEY");
+
+interface RegisterPayerResponse {
+  payerWalletAddress: string;
+  payerSecretKey: string;
+}
+
+export const registerPayer = async () => {
+  const headers = {
+    "api-key": LIT_RELAYER_API_KEY,
+    "Content-Type": "application/json",
+  };
+
+  try {
+    const response = await fetch(LIT_RELAYER_URL, {
+      method: "POST",
+      headers: headers,
+    });
+
+    if (!response.ok) {
+      throw new Error(`Error: ${await response.text()}`);
+    }
+
+    const { payerWalletAddress, payerSecretKey } =
+      (await response.json()) as RegisterPayerResponse;
+
+    return { payerWalletAddress, payerSecretKey };
+  } catch (error) {
+    console.error("Error registering payer:", error);
+    throw error;
+  }
+};

payment-delegation-db-relayer/nodejs/test/addUsers.spec.ts

@@ -0,0 +1,16 @@
+import { expect } from "chai";
+
+import { addUsers } from "../src/addUsers";
+
+describe("addUsers", () => {
+  const users = [
+    "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
+    "0x6c6ee5e31d828de241282b9606c8e98ea48526e2",
+    "0x53d284357ec70ce289d6d64134dfac8e511c8a3d",
+  ];
+
+  it("should add users as delegatees", async () => {
+    const result = await addUsers(users);
+    expect(result).to.be.true;
+  }).timeout(30_000);
+});

payment-delegation-db-relayer/nodejs/test/registerPayer.spec.ts

@@ -0,0 +1,25 @@
+import { expect, use } from "chai";
+import chaiJsonSchema from "chai-json-schema";
+
+import { registerPayer } from "../src/registerPayer";
+
+use(chaiJsonSchema);
+
+describe("registerPayer", () => {
+  const registerPayerResponseSchema = {
+    type: "object",
+    properties: {
+      payerWalletAddress: { type: "string" },
+      payerSecretKey: { type: "string" },
+    },
+    required: ["payerWalletAddress", "payerSecretKey"],
+    additionalProperties: false,
+  };
+
+  it("should register a new payer", async () => {
+    const payerInfo = await registerPayer();
+    console.log("Registered a new payer wallet: ", payerInfo);
+
+    expect(payerInfo).to.be.jsonSchema(registerPayerResponseSchema);
+  }).timeout(30_000);
+});

payment-delegation-db-relayer/nodejs/tsconfig.json

@@ -0,0 +1,111 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "ES2020" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    "lib": [
+      "ES2020"
+    ] /* Specify a set of bundled library declaration files that describe the target runtime environment. */,
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "es2022" /* Specify what module code is generated. */,
+    "rootDir": "./src" /* Specify the root folder within your source files. */,
+    "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+    /* Type Checking */
+    "strict": true /* Enable all strict type-checking options. */,
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  }
+}