@bloxchain/sdk 1.0.0-alpha

package/dist/utils/viem-error-handler.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @file viem-error-handler.ts
+ * @description Utility for handling and decoding Viem transaction errors
+ *
+ * This module provides clean error handling for Viem errors, integrating
+ * with the contract-errors.ts utilities for proper error decoding.
+ *
+ * @author Guardian Framework Team
+ * @version 1.0.0
+ */
+import { GuardianContractError } from './contract-errors';
+/**
+ * Enhanced Viem error with decoded contract error information
+ */
+export interface EnhancedViemError extends Error {
+    originalError: any;
+    contractError: GuardianContractError | null;
+    userMessage: string;
+    isKnownError: boolean;
+    errorData?: string;
+}
+/**
+ * Extract error data from Viem error object
+ * @param error The Viem error object
+ * @returns Hex string of error data or null if not found
+ */
+declare function extractErrorData(error: any): string | null;
+/**
+ * Enhance Viem error with contract error information
+ * @param error The original Viem error
+ * @param abi Contract ABI for decoding
+ * @returns Enhanced error with decoded contract error information
+ */
+export declare function enhanceViemError(error: any, abi: any[]): Promise<EnhancedViemError>;
+/**
+ * Handle Viem error and throw enhanced error
+ * @param error The original Viem error
+ * @param abi Contract ABI for decoding
+ * @throws EnhancedViemError with decoded contract error information
+ */
+export declare function handleViemError(error: any, abi: any[]): Promise<never>;
+declare const _default: {
+    enhanceViemError: typeof enhanceViemError;
+    handleViemError: typeof handleViemError;
+    extractErrorData: typeof extractErrorData;
+};
+export default _default;
+//# sourceMappingURL=viem-error-handler.d.ts.map

package/dist/utils/viem-error-handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"viem-error-handler.d.ts","sourceRoot":"","sources":["../../utils/viem-error-handler.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EAAiD,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAEzG;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,KAAK;IAC9C,aAAa,EAAE,GAAG,CAAC;IACnB,aAAa,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC5C,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,OAAO,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,iBAAS,gBAAgB,CAAC,KAAK,EAAE,GAAG,GAAG,MAAM,GAAG,IAAI,CA2CnD;AA+CD;;;;;GAKG;AACH,wBAAsB,gBAAgB,CACpC,KAAK,EAAE,GAAG,EACV,GAAG,EAAE,GAAG,EAAE,GACT,OAAO,CAAC,iBAAiB,CAAC,CAgE5B;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAG5E;;;;;;AAED,wBAIE"}

package/dist/utils/viem-error-handler.js

@@ -0,0 +1,172 @@
+/**
+ * @file viem-error-handler.ts
+ * @description Utility for handling and decoding Viem transaction errors
+ *
+ * This module provides clean error handling for Viem errors, integrating
+ * with the contract-errors.ts utilities for proper error decoding.
+ *
+ * @author Guardian Framework Team
+ * @version 1.0.0
+ */
+import { decodeAbiParameters, decodeErrorResult } from 'viem';
+import { extractErrorInfo } from './contract-errors';
+/**
+ * Extract error data from Viem error object
+ * @param error The Viem error object
+ * @returns Hex string of error data or null if not found
+ */
+function extractErrorData(error) {
+    if (!error)
+        return null;
+    // Check common Viem error data locations
+    if (error.data) {
+        const data = typeof error.data === 'string' ? error.data : error.data.data || error.data;
+        if (data && typeof data === 'string' && data.startsWith('0x')) {
+            return data;
+        }
+    }
+    if (error.cause?.data) {
+        const data = typeof error.cause.data === 'string' ? error.cause.data : error.cause.data.data || error.cause.data;
+        if (data && typeof data === 'string' && data.startsWith('0x')) {
+            return data;
+        }
+    }
+    // Check for error in nested structures
+    if (error.details) {
+        if (typeof error.details === 'string' && error.details.startsWith('0x')) {
+            return error.details;
+        }
+        // Check if details is an object with data
+        if (error.details.data && typeof error.details.data === 'string' && error.details.data.startsWith('0x')) {
+            return error.details.data;
+        }
+    }
+    // Check error.reason for Ganache/Truffle errors
+    if (error.reason && typeof error.reason === 'string' && error.reason.startsWith('0x')) {
+        return error.reason;
+    }
+    // Check error.message for hex data
+    if (error.message && typeof error.message === 'string') {
+        const hexMatch = error.message.match(/0x[0-9a-fA-F]+/);
+        if (hexMatch && hexMatch[0].length > 10) { // At least 4 bytes (selector) + some data
+            return hexMatch[0];
+        }
+    }
+    return null;
+}
+/**
+ * Try to decode error using Viem's decodeErrorResult
+ * @param errorData Hex string of error data
+ * @param abi Contract ABI
+ * @returns Decoded error result or null if decoding fails
+ */
+async function tryDecodeWithViem(errorData, abi) {
+    try {
+        const decoded = decodeErrorResult({
+            abi,
+            data: errorData
+        });
+        return {
+            errorName: decoded.errorName,
+            args: decoded.args
+        };
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * Try to decode Error(string) selector
+ * @param errorData Hex string of error data
+ * @returns Decoded string message or null if decoding fails
+ */
+async function tryDecodeErrorString(errorData) {
+    try {
+        // Check for Error(string) selector (0x08c379a0)
+        if (errorData.length > 10 && errorData.slice(0, 10) === '0x08c379a0') {
+            const decoded = decodeAbiParameters([{ type: 'string' }], errorData.slice(10));
+            return decoded[0];
+        }
+        return null;
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * Enhance Viem error with contract error information
+ * @param error The original Viem error
+ * @param abi Contract ABI for decoding
+ * @returns Enhanced error with decoded contract error information
+ */
+export async function enhanceViemError(error, abi) {
+    const errorData = extractErrorData(error);
+    // Default enhanced error
+    const enhancedError = {
+        name: error.name || 'TransactionError',
+        message: error.message || 'Transaction failed',
+        originalError: error,
+        contractError: null,
+        userMessage: error.message || 'Transaction failed',
+        isKnownError: false,
+        errorData: errorData || undefined
+    };
+    // If no error data, return with original message
+    if (!errorData) {
+        return enhancedError;
+    }
+    // Try to decode using Viem's decodeErrorResult first (most accurate)
+    const viemDecoded = await tryDecodeWithViem(errorData, abi);
+    if (viemDecoded) {
+        const viemMessage = `${viemDecoded.errorName}(${JSON.stringify(viemDecoded.args)})`;
+        enhancedError.message = `${error.message} (${viemMessage})`;
+        enhancedError.userMessage = `${error.message} (${viemMessage})`;
+        // Try to map to GuardianContractError if possible
+        const errorInfo = extractErrorInfo(errorData);
+        if (errorInfo.error) {
+            enhancedError.contractError = errorInfo.error;
+            enhancedError.userMessage = errorInfo.userMessage;
+            enhancedError.isKnownError = errorInfo.isKnownError;
+        }
+        return enhancedError;
+    }
+    // Try to decode Error(string)
+    const errorString = await tryDecodeErrorString(errorData);
+    if (errorString) {
+        enhancedError.message = `${error.message} (Error: ${errorString})`;
+        enhancedError.userMessage = `${error.message} (Error: ${errorString})`;
+        // Try to extract error info using contract-errors utilities
+        const errorInfo = extractErrorInfo(errorData);
+        if (errorInfo.error) {
+            enhancedError.contractError = errorInfo.error;
+            enhancedError.userMessage = errorInfo.userMessage;
+            enhancedError.isKnownError = errorInfo.isKnownError;
+        }
+        return enhancedError;
+    }
+    // Fall back to contract-errors.ts utilities
+    const errorInfo = extractErrorInfo(errorData);
+    if (errorInfo.error) {
+        enhancedError.contractError = errorInfo.error;
+        enhancedError.userMessage = errorInfo.userMessage;
+        enhancedError.isKnownError = errorInfo.isKnownError;
+        enhancedError.message = `${error.message} (${errorInfo.userMessage})`;
+    }
+    return enhancedError;
+}
+/**
+ * Handle Viem error and throw enhanced error
+ * @param error The original Viem error
+ * @param abi Contract ABI for decoding
+ * @throws EnhancedViemError with decoded contract error information
+ */
+export async function handleViemError(error, abi) {
+    const enhanced = await enhanceViemError(error, abi);
+    throw enhanced;
+}
+export default {
+    enhanceViemError,
+    handleViemError,
+    extractErrorData
+};
+//# sourceMappingURL=viem-error-handler.js.map

package/dist/utils/viem-error-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"viem-error-handler.js","sourceRoot":"","sources":["../../utils/viem-error-handler.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAsD,MAAM,mBAAmB,CAAC;AAazG;;;;GAIG;AACH,SAAS,gBAAgB,CAAC,KAAU;IAClC,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC;IAExB,yCAAyC;IACzC,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACf,MAAM,IAAI,GAAG,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC;QACzF,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9D,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,IAAI,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC;QACtB,MAAM,IAAI,GAAG,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;QACjH,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9D,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,uCAAuC;IACvC,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;QAClB,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACxE,OAAO,KAAK,CAAC,OAAO,CAAC;QACvB,CAAC;QACD,0CAA0C;QAC1C,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,IAAI,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACxG,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,gDAAgD;IAChD,IAAI,KAAK,CAAC,MAAM,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACtF,OAAO,KAAK,CAAC,MAAM,CAAC;IACtB,CAAC;IAED,mCAAmC;IACnC,IAAI,KAAK,CAAC,OAAO,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;QACvD,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QACvD,IAAI,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC,CAAC,0CAA0C;YACnF,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,iBAAiB,CAC9B,SAAiB,EACjB,GAAU;IAEV,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,iBAAiB,CAAC;YAChC,GAAG;YACH,IAAI,EAAE,SAA0B;SACjC,CAAC,CAAC;QACH,OAAO;YACL,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,IAAI,EAAE,OAAO,CAAC,IAAI;SACnB,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,oBAAoB,CAAC,SAAiB;IACnD,IAAI,CAAC;QACH,gDAAgD;QAChD,IAAI,SAAS,CAAC,MAAM,GAAG,EAAE,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,YAAY,EAAE,CAAC;YACrE,MAAM,OAAO,GAAG,mBAAmB,CACjC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,EACpB,SAAS,CAAC,KAAK,CAAC,EAAE,CAAkB,CACrC,CAAC;YACF,OAAO,OAAO,CAAC,CAAC,CAAW,CAAC;QAC9B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,KAAU,EACV,GAAU;IAEV,MAAM,SAAS,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAE1C,yBAAyB;IACzB,MAAM,aAAa,GAAsB;QACvC,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,kBAAkB;QACtC,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,oBAAoB;QAC9C,aAAa,EAAE,KAAK;QACpB,aAAa,EAAE,IAAI;QACnB,WAAW,EAAE,KAAK,CAAC,OAAO,IAAI,oBAAoB;QAClD,YAAY,EAAE,KAAK;QACnB,SAAS,EAAE,SAAS,IAAI,SAAS;KAClC,CAAC;IAEF,iDAAiD;IACjD,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,qEAAqE;IACrE,MAAM,WAAW,GAAG,MAAM,iBAAiB,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IAC5D,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,WAAW,GAAG,GAAG,WAAW,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC;QACpF,aAAa,CAAC,OAAO,GAAG,GAAG,KAAK,CAAC,OAAO,KAAK,WAAW,GAAG,CAAC;QAC5D,aAAa,CAAC,WAAW,GAAG,GAAG,KAAK,CAAC,OAAO,KAAK,WAAW,GAAG,CAAC;QAEhE,kDAAkD;QAClD,MAAM,SAAS,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;QAC9C,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;YACpB,aAAa,CAAC,aAAa,GAAG,SAAS,CAAC,KAAK,CAAC;YAC9C,aAAa,CAAC,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;YAClD,aAAa,CAAC,YAAY,GAAG,SAAS,CAAC,YAAY,CAAC;QACtD,CAAC;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,8BAA8B;IAC9B,MAAM,WAAW,GAAG,MAAM,oBAAoB,CAAC,SAAS,CAAC,CAAC;IAC1D,IAAI,WAAW,EAAE,CAAC;QAChB,aAAa,CAAC,OAAO,GAAG,GAAG,KAAK,CAAC,OAAO,YAAY,WAAW,GAAG,CAAC;QACnE,aAAa,CAAC,WAAW,GAAG,GAAG,KAAK,CAAC,OAAO,YAAY,WAAW,GAAG,CAAC;QAEvE,4DAA4D;QAC5D,MAAM,SAAS,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;QAC9C,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;YACpB,aAAa,CAAC,aAAa,GAAG,SAAS,CAAC,KAAK,CAAC;YAC9C,aAAa,CAAC,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;YAClD,aAAa,CAAC,YAAY,GAAG,SAAS,CAAC,YAAY,CAAC;QACtD,CAAC;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,4CAA4C;IAC5C,MAAM,SAAS,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC9C,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;QACpB,aAAa,CAAC,aAAa,GAAG,SAAS,CAAC,KAAK,CAAC;QAC9C,aAAa,CAAC,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;QAClD,aAAa,CAAC,YAAY,GAAG,SAAS,CAAC,YAAY,CAAC;QACpD,aAAa,CAAC,OAAO,GAAG,GAAG,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC,WAAW,GAAG,CAAC;IACxE,CAAC;IAED,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,KAAU,EAAE,GAAU;IAC1D,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACpD,MAAM,QAAQ,CAAC;AACjB,CAAC;AAED,eAAe;IACb,gBAAgB;IAChB,eAAe;IACf,gBAAgB;CACjB,CAAC"}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@bloxchain/sdk",
+  "version": "1.0.0-alpha",
+  "description": "Library engine for building enterprise grade decentralized permissioned applications",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "abi",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "cd ../.. && npm run release:sync-versions && cd sdk/typescript && npm run build",
+    "clean": "rm -rf dist"
+  },
+  "keywords": [
+    "bloxchain",
+    "blockchain",
+    "ethereum",
+    "smart-contracts",
+    "state-abstraction",
+    "typescript",
+    "sdk",
+    "viem",
+    "multi-signature",
+    "rbac",
+    "secure-ownership"
+  ],
+  "author": "Particle Crypto Security",
+  "license": "MPL-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/PracticalParticle/Bloxchain-Protocol.git",
+    "directory": "sdk/typescript"
+  },
+  "homepage": "https://bloxchain.app/",
+  "bugs": {
+    "url": "https://github.com/PracticalParticle/Bloxchain-Protocol/issues",
+    "email": "security@particlecs.com"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "viem": "^2.23.7"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.0.0"
+  },
+  "peerDependencies": {
+    "viem": "^2.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}