@solana/errors 2.0.0-experimental.6cea83c → 2.0.0-experimental.7712fc3

package/dist/types/messages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../src/messages.ts"],"names":[],"mappings":"AAAA,OAAO,EAGH,eAAe,EAClB,MAAM,SAAS,CAAC;AAEjB;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,EAAE,QAAQ,CAAC;KAGtC,CAAC,IAAI,eAAe,GAAG,MAAM;CACjC,CAKA,CAAC"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../src/messages.ts"],"names":[],"mappings":"AAAA,OAAO,EA4IH,eAAe,EAClB,MAAM,SAAS,CAAC;AAEjB;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,EAAE,QAAQ,CAAC;KAGtC,CAAC,IAAI,eAAe,GAAG,MAAM;CACjC,CAqNA,CAAC"}

package/dist/types/rpc-enum-errors.d.ts

@@ -0,0 +1,31 @@
+import { SolanaErrorCode } from './codes.js';
+import { SolanaErrorContext } from './context.js';
+import { SolanaError } from './error.js';
+type Config = Readonly<{
+    /**
+     * Oh, hello. You might wonder what in tarnation is going on here. Allow us to explain.
+     *
+     * One of the goals of `@solana/errors` is to allow errors that are not interesting to your
+     * application to shake out of your app bundle in production. This means that we must never
+     * export large hardcoded maps of error codes/messages.
+     *
+     * Unfortunately, where instruction and transaction errors from the RPC are concerned, we have
+     * no choice but to keep a map between the RPC `rpcEnumError` enum name and its corresponding
+     * `SolanaError` code. In the interest of implementing that map in as few bytes of source code
+     * as possible, we do the following:
+     *
+     *   1. Reserve a block of sequential error codes for the enum in question
+     *   2. Hardcode the list of enum names in that same order
+     *   3. Match the enum error name from the RPC with its index in that list, and reconstruct the
+     *      `SolanaError` code by adding the `errorCodeBaseOffset` to that index
+     */
+    errorCodeBaseOffset: number;
+    getErrorContext: (errorCode: SolanaErrorCode, rpcErrorName: string, rpcErrorContext?: unknown) => SolanaErrorContext[SolanaErrorCode];
+    orderedErrorNames: string[];
+    rpcEnumError: string | {
+        [key: string]: unknown;
+    };
+}>;
+export declare function getSolanaErrorFromRpcError({ errorCodeBaseOffset, getErrorContext, orderedErrorNames, rpcEnumError }: Config, constructorOpt: Function): SolanaError;
+export {};
+//# sourceMappingURL=rpc-enum-errors.d.ts.map

package/dist/types/rpc-enum-errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-enum-errors.d.ts","sourceRoot":"","sources":["../../src/rpc-enum-errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAC1C,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,KAAK,MAAM,GAAG,QAAQ,CAAC;IACnB;;;;;;;;;;;;;;;;OAgBG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B,eAAe,EAAE,CACb,SAAS,EAAE,eAAe,EAC1B,YAAY,EAAE,MAAM,EACpB,eAAe,CAAC,EAAE,OAAO,KACxB,kBAAkB,CAAC,eAAe,CAAC,CAAC;IACzC,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,YAAY,EAAE,MAAM,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACrD,CAAC,CAAC;AAEH,wBAAgB,0BAA0B,CACtC,EAAE,mBAAmB,EAAE,eAAe,EAAE,iBAAiB,EAAE,YAAY,EAAE,EAAE,MAAM,EAEjF,cAAc,EAAE,QAAQ,GACzB,WAAW,CAiBb"}

package/dist/types/transaction-error.d.ts

@@ -0,0 +1,5 @@
+import { SolanaError } from './error.js';
+export declare function getSolanaErrorFromTransactionError(transactionError: string | {
+    [key: string]: unknown;
+}): SolanaError;
+//# sourceMappingURL=transaction-error.d.ts.map

package/dist/types/transaction-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction-error.d.ts","sourceRoot":"","sources":["../../src/transaction-error.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAsDtC,wBAAgB,kCAAkC,CAAC,gBAAgB,EAAE,MAAM,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,GAAG,WAAW,CAiCrH"}

package/package.json

@@ -1,103 +1,80 @@
 {
-    "name": "@solana/errors",
-    "version": "2.0.0-experimental.6cea83c",
-    "description": "Throw, identify, and decode Solana JavaScript errors",
-    "exports": {
-        "browser": {
-            "import": "./dist/index.browser.js",
-            "require": "./dist/index.browser.cjs"
-        },
-        "node": {
-            "import": "./dist/index.node.js",
-            "require": "./dist/index.node.cjs"
-        },
-        "react-native": "./dist/index.native.js",
-        "types": "./dist/types/index.d.ts"
-    },
+  "name": "@solana/errors",
+  "version": "2.0.0-experimental.7712fc3",
+  "description": "Throw, identify, and decode Solana JavaScript errors",
+  "exports": {
     "browser": {
-        "./dist/index.node.cjs": "./dist/index.browser.cjs",
-        "./dist/index.node.js": "./dist/index.browser.js"
+      "import": "./dist/index.browser.js",
+      "require": "./dist/index.browser.cjs"
+    },
+    "node": {
+      "import": "./dist/index.node.js",
+      "require": "./dist/index.node.cjs"
     },
-    "main": "./dist/index.node.cjs",
-    "module": "./dist/index.node.js",
     "react-native": "./dist/index.native.js",
-    "types": "./dist/types/index.d.ts",
-    "type": "module",
+    "types": "./dist/types/index.d.ts"
+  },
+  "browser": {
+    "./dist/index.node.cjs": "./dist/index.browser.cjs",
+    "./dist/index.node.js": "./dist/index.browser.js"
+  },
+  "main": "./dist/index.node.cjs",
+  "module": "./dist/index.node.js",
+  "react-native": "./dist/index.native.js",
+  "types": "./dist/types/index.d.ts",
+  "type": "module",
+  "files": [
+    "./dist/"
+  ],
+  "sideEffects": false,
+  "keywords": [
+    "blockchain",
+    "solana",
+    "web3"
+  ],
+  "bin": "./bin/cli.js",
+  "author": "Solana Labs Maintainers <maintainers@solanalabs.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/solana-labs/solana-web3.js"
+  },
+  "bugs": {
+    "url": "http://github.com/solana-labs/solana-web3.js/issues"
+  },
+  "browserslist": [
+    "supports bigint and not dead",
+    "maintained node versions"
+  ],
+  "engine": {
+    "node": ">=17.4"
+  },
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "commander": "^12.0.0"
+  },
+  "bundlewatch": {
+    "defaultCompression": "gzip",
     "files": [
-        "./dist/"
-    ],
-    "sideEffects": false,
-    "keywords": [
-        "blockchain",
-        "solana",
-        "web3"
-    ],
-    "bin": "./bin/cli.ts",
-    "scripts": {
-        "compile:js": "tsup --config build-scripts/tsup.config.package.ts",
-        "compile:typedefs": "tsc -p ./tsconfig.declarations.json && node node_modules/build-scripts/add-js-extension-to-types.mjs",
-        "dev": "jest -c node_modules/test-config/jest-dev.config.ts --rootDir . --watch",
-        "prepublishOnly": "version-from-git --no-git-tag-version --template experimental.short",
-        "publish-packages": "pnpm publish --tag experimental --access public --no-git-checks",
-        "style:fix": "pnpm eslint --fix src/* && pnpm prettier -w src/* package.json",
-        "test:lint": "jest -c node_modules/test-config/jest-lint.config.ts --rootDir . --silent",
-        "test:prettier": "jest -c node_modules/test-config/jest-prettier.config.ts --rootDir . --silent",
-        "test:treeshakability:browser": "agadoo dist/index.browser.js",
-        "test:treeshakability:native": "agadoo dist/index.native.js",
-        "test:treeshakability:node": "agadoo dist/index.node.js",
-        "test:typecheck": "tsc --noEmit",
-        "test:unit:browser": "jest -c node_modules/test-config/jest-unit.config.browser.ts --rootDir . --silent",
-        "test:unit:node": "jest -c node_modules/test-config/jest-unit.config.node.ts --rootDir . --silent"
-    },
-    "author": "Solana Labs Maintainers <maintainers@solanalabs.com>",
-    "license": "MIT",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/solana-labs/solana-web3.js"
-    },
-    "bugs": {
-        "url": "http://github.com/solana-labs/solana-web3.js/issues"
-    },
-    "browserslist": [
-        "supports bigint and not dead",
-        "maintained node versions"
-    ],
-    "engine": {
-        "node": ">=17.4"
-    },
-    "devDependencies": {
-        "@solana/addresses": "2.0.0-experimental.b93299a",
-        "@solana/eslint-config-solana": "^1.0.2",
-        "@swc/jest": "^0.2.29",
-        "@types/jest": "^29.5.11",
-        "@types/node": "18.11.19",
-        "@typescript-eslint/eslint-plugin": "^6.13.2",
-        "@typescript-eslint/parser": "^6.3.0",
-        "agadoo": "^3.0.0",
-        "build-scripts": "0.0.0",
-        "chalk": "^5.3.0",
-        "commander": "^11.1.0",
-        "eslint": "^8.45.0",
-        "eslint-plugin-jest": "^27.4.2",
-        "eslint-plugin-sort-keys-fix": "^1.1.2",
-        "jest": "^29.7.0",
-        "jest-environment-jsdom": "^29.7.0",
-        "jest-runner-eslint": "^2.1.2",
-        "jest-runner-prettier": "^1.0.0",
-        "prettier": "^3.1",
-        "test-config": "0.0.0",
-        "tsconfig": "0.0.0",
-        "tsup": "^8.0.1",
-        "tsx": "^4.7.0",
-        "typescript": "^5.2.2",
-        "version-from-git": "^1.1.1"
-    },
-    "bundlewatch": {
-        "defaultCompression": "gzip",
-        "files": [
-            {
-                "path": "./dist/index*.js"
-            }
-        ]
-    }
-}
+      {
+        "path": "./dist/index*.js"
+      }
+    ]
+  },
+  "scripts": {
+    "compile:js": "tsup --config build-scripts/tsup.config.package.ts && tsup src/cli.ts --format esm",
+    "compile:typedefs": "tsc -p ./tsconfig.declarations.json && node node_modules/@solana/build-scripts/add-js-extension-to-types.mjs",
+    "dev": "jest -c node_modules/@solana/test-config/jest-dev.config.ts --rootDir . --watch",
+    "publish-impl": "npm view $npm_package_name@$npm_package_version > /dev/null 2>&1 || pnpm publish --tag experimental --access public --no-git-checks",
+    "publish-packages": "pnpm prepublishOnly && pnpm publish-impl",
+    "style:fix": "pnpm eslint --fix src/* && pnpm prettier -w src/* package.json",
+    "test:lint": "jest -c node_modules/@solana/test-config/jest-lint.config.ts --rootDir . --silent",
+    "test:prettier": "jest -c node_modules/@solana/test-config/jest-prettier.config.ts --rootDir . --silent",
+    "test:treeshakability:browser": "agadoo dist/index.browser.js",
+    "test:treeshakability:native": "agadoo dist/index.native.js",
+    "test:treeshakability:node": "agadoo dist/index.node.js",
+    "test:typecheck": "tsc --noEmit",
+    "test:unit:browser": "jest -c node_modules/@solana/test-config/jest-unit.config.browser.ts --rootDir . --silent",
+    "test:unit:node": "jest -c node_modules/@solana/test-config/jest-unit.config.node.ts --rootDir . --silent"
+  }
+}

package/bin/cli.ts

@@ -1,55 +0,0 @@
-#!/usr/bin/env -S tsx
-
-import chalk from 'chalk';
-import { Command, InvalidArgumentError } from 'commander';
-
-import { version } from '../package.json';
-import { SolanaErrorCode } from '../src/codes';
-import { getHumanReadableErrorMessage } from '../src/message-formatter';
-import { SolanaErrorMessages } from '../src/messages';
-
-const program = new Command();
-
-program.name('@solana/errors').description('Decode Solana JavaScript errors thrown in production').version(version);
-
-program
-    .command('decode')
-    .description('Decode a `SolanaErrorCode` to a human-readable message')
-    .argument('<code>', 'numeric error code to decode', rawCode => {
-        const code = parseInt(rawCode, 10);
-        if (isNaN(code) || `${code}` !== rawCode) {
-            throw new InvalidArgumentError('It must be an integer');
-        }
-        if (!(code in SolanaErrorMessages)) {
-            throw new InvalidArgumentError('There exists no error with that code');
-        }
-        return code;
-    })
-    .argument('[encodedContext]', 'encoded context to interpolate into the error message', encodedContext =>
-        Object.fromEntries(new URLSearchParams(encodedContext).entries()),
-    )
-    .action((code: number, context) => {
-        const message = getHumanReadableErrorMessage(code as SolanaErrorCode, context);
-        console.log(`
-${
-    chalk.bold(
-        chalk.rgb(154, 71, 255)('[') +
-            chalk.rgb(144, 108, 244)('D') +
-            chalk.rgb(134, 135, 233)('e') +
-            chalk.rgb(122, 158, 221)('c') +
-            chalk.rgb(110, 178, 209)('o') +
-            chalk.rgb(95, 195, 196)('d') +
-            chalk.rgb(79, 212, 181)('e') +
-            chalk.rgb(57, 227, 166)('d') +
-            chalk.rgb(19, 241, 149)(']'),
-    ) + chalk.rgb(19, 241, 149)(' Solana error code #' + code)
-}
-    - ${message}`);
-        if (context) {
-            console.log(`
-${chalk.yellowBright(chalk.bold('[Context]'))}
-    ${JSON.stringify(context, null, 4).split('\n').join('\n    ')}`);
-        }
-    });
-
-program.parse();