From 64015ea1ec82d741602c3c75024e7bc5c0eb2525 Mon Sep 17 00:00:00 2001 From: Shine Li Date: Mon, 20 May 2024 13:47:45 +1000 Subject: [PATCH] fix: minting sample app with pg (#1805) --- .../minting-sample-app-pg/.gitignore | 69 +++++++++++ .../minting-sample-app-pg/README.md | 39 +++++++ .../minting-sample-app-pg/index.ts | 86 ++++++++++++++ .../minting-sample-app-pg/package.json | 25 ++++ .../minting-sample-app-pg/seed.sql | 20 ++++ .../minting-sample-app-pg/tsconfig.json | 109 ++++++++++++++++++ .../sdk/src/persistence/pg/postgres.ts | 2 +- 7 files changed, 349 insertions(+), 1 deletion(-) create mode 100644 packages/minting-backend/minting-sample-app-pg/.gitignore create mode 100644 packages/minting-backend/minting-sample-app-pg/README.md create mode 100644 packages/minting-backend/minting-sample-app-pg/index.ts create mode 100644 packages/minting-backend/minting-sample-app-pg/package.json create mode 100644 packages/minting-backend/minting-sample-app-pg/seed.sql create mode 100644 packages/minting-backend/minting-sample-app-pg/tsconfig.json diff --git a/packages/minting-backend/minting-sample-app-pg/.gitignore b/packages/minting-backend/minting-sample-app-pg/.gitignore new file mode 100644 index 0000000000..f78b1dfaf9 --- /dev/null +++ b/packages/minting-backend/minting-sample-app-pg/.gitignore @@ -0,0 +1,69 @@ +# Logs +logs +*.log +npm-debug.log* + +# Runtime data +pids +*.pid +*.seed + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage + +# nyc test coverage +.nyc_output + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules +jspm_packages + +# Optional npm cache directory +.npm + +# Optional REPL history +.node_repl_history + +# 0x +profile-* + +# mac files +.DS_Store + +# vim swap files +*.swp + +# webstorm +.idea + +#tap files +.tap/ + +# vscode +.vscode +*code-workspace + +# clinic +profile* +*clinic* +*flamegraph* + +# lock files +yarn.lock +package-lock.json + +# generated code +examples/typescript-server.js +test/types/index.js \ No newline at end of file diff --git a/packages/minting-backend/minting-sample-app-pg/README.md b/packages/minting-backend/minting-sample-app-pg/README.md new file mode 100644 index 0000000000..6fe0ae27ba --- /dev/null +++ b/packages/minting-backend/minting-sample-app-pg/README.md @@ -0,0 +1,39 @@ +## Minting backend sample using PG + +This sample app uses Immutable minting backend SDK to manage minting. This repo assumes Postgres as database and fastify as webserver. + +## Get Started + +### Install dependency + +```bash +npm i # with nodejs version >= 20 +``` + +### expose local port for webhook + +You can use services like below to expose ports locally. + +- https://ngrok.com/ +- localtunnel + +Please make sure the url with port 3000 exposed is set up in the webhook section in [Immutable Hub](hub.immmutable.com). + +### run server + +```bash +# Replace the contract address and api key from hub in the command below +COLLECTION_ADDRESS={your_nft_contract_address} IM_API_KEY={your_api_key} npm run dev +``` + +This will start a fastify server at port 3000. + +Make sure to trigger the confirmation event again on webhook page via hub if you have missed it the first time. + +### mint + +Replace YOUR_WALLET_ADDRESS with your NFT recipient's wallet address. You can get a random eth address from [here](https://vanity-eth.tk/). + +``` +curl -X POST -H "Content-Type: application/json" -d '{"mintTo": "YOUR_WALLET_ADDRESS"}' http://localhost:3000/mint +``` diff --git a/packages/minting-backend/minting-sample-app-pg/index.ts b/packages/minting-backend/minting-sample-app-pg/index.ts new file mode 100644 index 0000000000..00f94c6a35 --- /dev/null +++ b/packages/minting-backend/minting-sample-app-pg/index.ts @@ -0,0 +1,86 @@ +import Fastify, { FastifyReply, FastifyRequest } from 'fastify' +import { mintingBackend, blockchainData, config, webhook } from '@imtbl/sdk'; +import { Pool } from 'pg'; +import { v4 as uuidv4 } from 'uuid'; + +const fastify = Fastify({ + logger: true +}); + +// setup database client +const pgClient = new Pool({ + user: process.env.PG_USER || 'postgres', + host: process.env.PG_HOST || 'localhost', + database: process.env.DB_NAME || 'minting_backend', + password: process.env.PG_PASSWORD || 'password', + port: 5432, +}); + +// persistence setup for minting backend +const mintingPersistence = mintingBackend.mintingPersistencePg(pgClient); + +// blockchainData client for submit minting. +export const blockchainDataClient = new blockchainData.BlockchainData({ + baseConfig: { + environment: config.Environment.SANDBOX, + apiKey: process.env.IM_API_KEY, + }, +}); + +export interface MintRequest { + mintTo: string; +} + +// mint route +fastify.post('/mint', async (request: FastifyRequest<{Body: MintRequest}>, reply: FastifyReply) => { + const collectionAddress = process.env.COLLECTION_ADDRESS as string; + const assetId = uuidv4(); + const mintTo = request.body.mintTo; + const metadata = { + name: 'My NFT', + description: 'This is my first NFT', + image: 'https://placehold.co/600x400', + }; + + await mintingBackend.recordMint(mintingPersistence, { + asset_id: assetId, + contract_address: collectionAddress, + owner_address: mintTo, + metadata + }); + reply.send({}); +}); + +const url = "/api/process_webhook_event" // Set this url on the wbehook config screen in hub.immutable.com +fastify.post(url, async (request: FastifyRequest, reply: any) => { + await webhook.init(request.body as any, config.Environment.SANDBOX, { + zkevmMintRequestUpdated: async (event) => { + mintingBackend.processMint(mintingPersistence, event); + } + }); + + reply.send({ status: "ok" }); +}); + + +/** + * Run the server! + */ +const start = async () => { + try { + await fastify.listen({ port: 3000 }) + + // long running process to submit minting requests + await mintingBackend.submitMintingRequests( + mintingBackend.mintingPersistencePg(pgClient), + blockchainDataClient, + {}, + console + ) + + } catch (err) { + fastify.log.error(err) + process.exit(1) + } +} +start(); \ No newline at end of file diff --git a/packages/minting-backend/minting-sample-app-pg/package.json b/packages/minting-backend/minting-sample-app-pg/package.json new file mode 100644 index 0000000000..d1738c5d87 --- /dev/null +++ b/packages/minting-backend/minting-sample-app-pg/package.json @@ -0,0 +1,25 @@ +{ + "name": "minting-backend-sample", + "version": "1.0.0", + "description": "", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1", + "dev": "ts-node-dev --respawn --transpile-only index.ts" + }, + "author": "", + "license": "ISC", + "dependencies": { + "@imtbl/sdk": "^1.35.3-alpha", + "@types/pg": "^8.11.6", + "@types/uuid": "^9.0.8", + "fastify": "^4.27.0", + "pg": "^8.11.5", + "uuid": "^9.0.1" + }, + "devDependencies": { + "fastify-cli": "^6.1.1", + "ts-node-dev": "^2.0.0", + "typescript": "^5.4.5" + } +} diff --git a/packages/minting-backend/minting-sample-app-pg/seed.sql b/packages/minting-backend/minting-sample-app-pg/seed.sql new file mode 100644 index 0000000000..86bd02b659 --- /dev/null +++ b/packages/minting-backend/minting-sample-app-pg/seed.sql @@ -0,0 +1,20 @@ +CREATE EXTENSION IF NOT EXISTS "uuid-ossp"; + +CREATE TABLE IF NOT EXISTS im_assets ( + id UUID PRIMARY KEY DEFAULT gen_random_uuid(), + asset_id UUID NOT NULL, + owner_address varchar NOT NULL, -- TODO: should be case insensitive + metadata jsonb, + token_id varchar NULL, + contract_address varchar NOT NULL, + error varchar NULL, + -- NOTE: minting_status is purposely not an enum for ease of future expansion without running a migration + minting_status varchar NULL, + metadata_id UUID NULL, + tried_count INT DEFAULT 0, + last_imtbl_zkevm_mint_request_updated_id UUID NULL, + created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP, + updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP +); + +CREATE UNIQUE INDEX IF NOT EXISTS im_assets_uindex ON im_assets (asset_id, contract_address); \ No newline at end of file diff --git a/packages/minting-backend/minting-sample-app-pg/tsconfig.json b/packages/minting-backend/minting-sample-app-pg/tsconfig.json new file mode 100644 index 0000000000..e075f973c4 --- /dev/null +++ b/packages/minting-backend/minting-sample-app-pg/tsconfig.json @@ -0,0 +1,109 @@ +{ + "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": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ + // "lib": [], /* 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": "commonjs", /* Specify what module code is generated. */ + // "rootDir": "./", /* Specify the root folder within your source files. */ + // "moduleResolution": "node10", /* 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 ''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. */ + } +} diff --git a/packages/minting-backend/sdk/src/persistence/pg/postgres.ts b/packages/minting-backend/sdk/src/persistence/pg/postgres.ts index 999189d02d..ba1ae4e25a 100644 --- a/packages/minting-backend/sdk/src/persistence/pg/postgres.ts +++ b/packages/minting-backend/sdk/src/persistence/pg/postgres.ts @@ -6,7 +6,7 @@ export const mintingPersistence = (client: Pool): MintingPersistence => ({ const r = await client.query( ` INSERT INTO im_assets (asset_id, contract_address, owner_address, metadata) - VALUES ($1, $2, $3, $4) ON CONFLICT (asset_id) DO NOTHING; + VALUES ($1, $2, $3, $4) ON CONFLICT (asset_id, contract_address) DO NOTHING; `, [request.asset_id, request.contract_address, request.owner_address, request.metadata] );