@imtbl/minting-backend 2.0.0-alpha.9 → 2.0.0

package/README.md

@@ -21,7 +21,7 @@ To install this package, run the following command:
 ```sh
 npm add @imtbl/minting-backend
 # or
-yarn add @imtbl/minting-backend
+pnpm add @imtbl/minting-backend
 # or
 pnpm add @imtbl/minting-backend
 ```

package/dist/types/index.d.ts

@@ -16,12 +16,31 @@ export declare class MintingBackendModule {
     private readonly blockchainDataClient;
     private readonly logger;
     constructor(config: MintingBackendModuleConfiguration);
+    /**
+     * Records a mint request in the persistence layer.
+     * @param {CreateMintRequest} mintRequest - The mint request to be recorded
+     * @returns {Promise<void>} A promise that resolves when the mint request is recorded
+     */
     recordMint(mintRequest: CreateMintRequest): Promise<void>;
+    /**
+     * Submits minting requests for processing.
+     * @param {Object} config - Configuration options for submitting minting requests
+     * @param {number} [config.defaultBatchSize] - The number of minting requests to process in a batch
+     * @param {string} [config.chainName] - The blockchain network to process mints for
+     * @param {number} [config.maxNumberOfTries] - Maximum number of retry attempts for failed requests
+     * @returns {Promise<void>} A promise that resolves when the minting requests are submitted
+     */
     submitMintingRequests(config: {
         defaultBatchSize?: number;
         chainName?: string;
         maxNumberOfTries?: number;
     }): Promise<void>;
+    /**
+     * Processes a mint webhook event.
+     * @param {string | Record<string, unknown>} body - The webhook event payload
+     * @param {Object} [otherHandlers=noopHandlers] - Additional handlers for the webhook event
+     * @returns {Promise<void>} A promise that resolves when the mint is processed
+     */
     processMint(body: string | Record<string, unknown>, otherHandlers?: {
         zkevmMintRequestUpdated: (event: ZkevmMintRequestUpdated) => Promise<void>;
     }): Promise<void>;

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@imtbl/minting-backend",
   "description": "minting backend utilising Immutable Minting API",
-  "version": "2.0.0-alpha.9",
+  "version": "2.0.0",
   "author": "Immutable",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
   "dependencies": {
-    "@imtbl/blockchain-data": "2.0.0-alpha.9",
-    "@imtbl/config": "2.0.0-alpha.9",
-    "@imtbl/generated-clients": "2.0.0-alpha.9",
-    "@imtbl/metrics": "2.0.0-alpha.9",
-    "@imtbl/webhook": "2.0.0-alpha.9",
+    "@imtbl/blockchain-data": "2.0.0",
+    "@imtbl/config": "2.0.0",
+    "@imtbl/generated-clients": "2.0.0",
+    "@imtbl/metrics": "2.0.0",
+    "@imtbl/webhook": "2.0.0",
     "uuid": "^8.3.2"
   },
   "devDependencies": {
@@ -59,6 +59,7 @@
     "build": "pnpm transpile && pnpm typegen",
     "transpile": "tsup src/index.ts --config ./tsup.config.js",
     "typegen": "tsc --customConditions default --emitDeclarationOnly --outDir dist/types",
+    "pack:root": "pnpm pack --pack-destination $(dirname $(pnpm root -w))",
     "lint": "eslint ./src --ext .ts,.jsx,.tsx --max-warnings=0",
     "test": "jest --passWithNoTests",
     "test:watch": "jest --watch",