@polymarket/types 0.0.0-canary-20260421120448

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Polymarket
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,31 @@
+# `@polymarket/types`
+
+The `@polymarket/types` package is shared TypeScript types for the Polymarket SDK.
+
+---
+
+**It is not intended to be used directly. Its interface will change without notice, use it at your own risk.**
+
+## Installation
+
+```bash
+pnpm add @polymarket/types
+```
+
+## Usage
+
+```ts
+import type { MarketId } from '@polymarket/types';
+```
+
+## Development
+
+From the monorepo root:
+
+```bash
+pnpm --filter @polymarket/types build
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,145 @@
+import { Result, ResultAsync } from 'neverthrow';
+export * from 'neverthrow';
+import { Tagged } from 'type-fest';
+
+/**
+ * A tuple type representing a non-empty array.
+ */
+type NonEmptyArray<T> = readonly [T, ...T[]];
+
+/**
+ * A string encoded as hexadecimal and prefixed with `0x`.
+ */
+type HexString = `0x${string}`;
+/**
+ * A hex-encoded 32-byte private key prefixed with `0x`.
+ */
+type PrivateKey = Tagged<HexString, 'PrivateKey'>;
+/**
+ * An EVM account or contract address.
+ */
+type EvmAddress = Tagged<HexString, 'EvmAddress'>;
+/**
+ * A hex-encoded EVM signature.
+ */
+type EvmSignature = Tagged<HexString, 'EvmSignature'>;
+/**
+ * A transaction hash returned by an EVM-compatible network.
+ */
+type TxHash = Tagged<HexString, 'TxHash'>;
+/**
+ * Checks whether a value is a hex string prefixed with `0x`.
+ */
+declare function isHexString(value: unknown): value is HexString;
+/**
+ * Checks whether a value is a hex-encoded 32-byte private key.
+ */
+declare function isPrivateKey(value: unknown): value is PrivateKey;
+
+/**
+ * The all-zero EVM address used to indicate the absence of a specific account.
+ */
+declare const ZERO_ADDRESS: EvmAddress;
+
+/**
+ * Base class for errors thrown by the Polymarket SDK.
+ */
+declare abstract class PolymarketError extends Error {
+    /**
+     * Returns `true` when the provided value is a `PolymarketError`.
+     */
+    static isError(error: unknown): error is PolymarketError;
+}
+/**
+ * Error thrown when code reaches a state that should be impossible.
+ */
+declare class InvariantError extends PolymarketError {
+    name: "InvariantError";
+}
+
+/**
+ * Returns `true` if the array contains at least one element.
+ */
+declare function isNonEmptyArray<T>(value: readonly T[]): value is NonEmptyArray<T>;
+/**
+ * Returns `true` if the value is `null` or `undefined`.
+ */
+declare function isNullish(value: unknown): value is null | undefined;
+/**
+ * Returns `true` if the value is not `null` or `undefined`.
+ */
+declare function isPresent<T>(value: T): value is Exclude<T, null | undefined>;
+
+/**
+ * Flattens an object type for clearer IDE hovers and inferred signatures.
+ */
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+/**
+ * Asserts that a condition is truthy.
+ *
+ * @internal
+ *
+ * @param condition - Value expected to be truthy.
+ * @param message - Message used for the thrown `InvariantError`.
+ */
+declare function invariant(condition: unknown, message: string): asserts condition;
+/**
+ * Throws an `InvariantError` and narrows the current code path to `never`.
+ *
+ * Useful for unreachable branches and exhaustive checks.
+ *
+ * @param message - Message used for the thrown `InvariantError`.
+ */
+declare function never(message?: string): never;
+/**
+ * Resolves after the provided delay in milliseconds.
+ */
+declare function delay(ms: number): Promise<void>;
+
+/**
+ * Refines a value to exclude `null` and `undefined`.
+ */
+declare function expectPresent<T>(value: T, message?: string): Exclude<T, null | undefined>;
+/**
+ * Refines an array to a non-empty tuple or throws when the array is empty.
+ */
+declare function expectNonEmptyArray<T>(value: readonly T[], message?: string): NonEmptyArray<T>;
+/**
+ * Refines a string to a hex string or throws when the value is invalid.
+ */
+declare function expectHexString(value: string, message?: string): HexString;
+/**
+ * Refines a string to an EVM address or throws when the value is invalid.
+ */
+declare function expectEvmAddress(value: unknown, message?: string): EvmAddress;
+/**
+ * Refines a string to an EVM signature or throws when the value is invalid.
+ */
+declare function expectEvmSignature(value: unknown, message?: string): EvmSignature;
+/**
+ * Refines a string to a transaction hash or throws when the value is invalid.
+ */
+declare function expectTxHash(value: unknown, message?: string): TxHash;
+
+/**
+ * Extracts the success value from a {@link Result} or {@link ResultAsync}, or
+ * throws the error branch.
+ *
+ * @example
+ * ```ts
+ * const value = unwrap(result.andThen(step1).andThen(step2));
+ *
+ * // value === 42
+ * ```
+ *
+ * @internal
+ *
+ * @param result - Result to unwrap.
+ * @returns The success value of the `result`.
+ */
+declare function unwrap<T, E>(result: Result<T, E>): T;
+declare function unwrap<T, E>(result: ResultAsync<T, E>): Promise<T>;
+
+export { type EvmAddress, type EvmSignature, type HexString, InvariantError, type NonEmptyArray, PolymarketError, type Prettify, type PrivateKey, type TxHash, ZERO_ADDRESS, delay, expectEvmAddress, expectEvmSignature, expectHexString, expectNonEmptyArray, expectPresent, expectTxHash, invariant, isHexString, isNonEmptyArray, isNullish, isPresent, isPrivateKey, never, unwrap };

package/dist/index.js

@@ -0,0 +1,2 @@
+import {ResultAsync}from'neverthrow';export*from'neverthrow';var a="0x0000000000000000000000000000000000000000";var i=class e extends Error{static isError(r){return r instanceof e}},o=class extends i{name="InvariantError"};function d(e){return e.length>0}function p(e){return e==null}function c(e){return !p(e)}function t(e,r){if(!e)throw new o(r)}function E(e="Unexpected call to never()"){throw new o(e)}function T(e){return new Promise(r=>setTimeout(r,e))}function n(e){return typeof e=="string"&&/^0x[a-fA-F0-9]+$/.test(e)}function l(e){return n(e)&&e.length===66}function w(e,r="Expected value to be present"){return t(e!=null,r),e}function S(e,r="Expected a non-empty array"){return t(e.length>0,r),e}function H(e,r="Expected a hex string"){return t(n(e),r),e}function P(e,r="Expected an EVM address"){return t(n(e)&&e.length===42,r),e}function k(e,r="Expected an EVM signature"){return t(n(e)&&e.length===132,r),e}function N(e,r="Expected a transaction hash"){return t(n(e)&&e.length===66,r),e}function s(e){throw e}function b(e){return e instanceof ResultAsync?e.match(r=>r,s):e.match(r=>r,s)}export{o as InvariantError,i as PolymarketError,a as ZERO_ADDRESS,T as delay,P as expectEvmAddress,k as expectEvmSignature,H as expectHexString,S as expectNonEmptyArray,w as expectPresent,N as expectTxHash,t as invariant,n as isHexString,d as isNonEmptyArray,p as isNullish,c as isPresent,l as isPrivateKey,E as never,b as unwrap};//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/constants.ts","../src/errors.ts","../src/guards.ts","../src/helpers.ts","../src/hex.ts","../src/refinements.ts","../src/result.ts"],"names":["ZERO_ADDRESS","PolymarketError","_PolymarketError","error","InvariantError","isNonEmptyArray","value","isNullish","isPresent","invariant","condition","message","never","delay","ms","resolve","isHexString","isPrivateKey","expectPresent","expectNonEmptyArray","expectHexString","expectEvmAddress","expectEvmSignature","expectTxHash","throwError","unwrap","result","ResultAsync"],"mappings":"6DAKO,IAAMA,CAAAA,CACX,6CCHK,IAAeC,CAAAA,CAAf,MAAeC,CAAAA,SAAwB,KAAM,CAIlD,OAAO,OAAA,CAAQC,CAAAA,CAA0C,CACvD,OAAOA,CAAAA,YAAiBD,CAC1B,CACF,CAAA,CAKaE,CAAAA,CAAN,cAA6BH,CAAgB,CACzC,IAAA,CAAO,gBAClB,ECZO,SAASI,CAAAA,CACdC,CAAAA,CAC2B,CAC3B,OAAOA,CAAAA,CAAM,MAAA,CAAS,CACxB,CAKO,SAASC,CAAAA,CAAUD,CAAAA,CAA2C,CACnE,OAAOA,CAAAA,EAAU,IACnB,CAKO,SAASE,CAAAA,CAAaF,CAAAA,CAAiD,CAC5E,OAAO,CAACC,CAAAA,CAAUD,CAAK,CACzB,CCNO,SAASG,CAAAA,CACdC,CAAAA,CACAC,CAAAA,CACmB,CACnB,GAAI,CAACD,EACH,MAAM,IAAIN,CAAAA,CAAeO,CAAO,CAEpC,CASO,SAASC,CAAAA,CAAMD,CAAAA,CAAU,4BAAA,CAAqC,CACnE,MAAM,IAAIP,CAAAA,CAAeO,CAAO,CAClC,CAKO,SAASE,CAAAA,CAAMC,CAAAA,CAA2B,CAC/C,OAAO,IAAI,OAAA,CAASC,CAAAA,EAAY,UAAA,CAAWA,CAAAA,CAASD,CAAE,CAAC,CACzD,CCZO,SAASE,CAAAA,CAAYV,CAAAA,CAAoC,CAC9D,OAAO,OAAOA,CAAAA,EAAU,QAAA,EAAY,kBAAA,CAAmB,IAAA,CAAKA,CAAK,CACnE,CAKO,SAASW,CAAAA,CAAaX,CAAAA,CAAqC,CAChE,OAAOU,CAAAA,CAAYV,CAAK,CAAA,EAAKA,CAAAA,CAAM,MAAA,GAAW,EAChD,CC1BO,SAASY,CAAAA,CACdZ,CAAAA,CACAK,CAAAA,CAAU,8BAAA,CACoB,CAC9B,OAAAF,CAAAA,CAAUH,CAAAA,EAAU,IAAA,CAA6BK,CAAO,CAAA,CACjDL,CACT,CAKO,SAASa,CAAAA,CACdb,CAAAA,CACAK,CAAAA,CAAU,4BAAA,CACQ,CAClB,OAAAF,CAAAA,CAAUH,CAAAA,CAAM,MAAA,CAAS,CAAA,CAAGK,CAAO,CAAA,CAE5BL,CACT,CAKO,SAASc,CAAAA,CACdd,CAAAA,CACAK,CAAAA,CAAU,uBAAA,CACC,CACX,OAAAF,EAAUO,CAAAA,CAAYV,CAAK,CAAA,CAAGK,CAAO,CAAA,CAC9BL,CACT,CAKO,SAASe,CAAAA,CACdf,CAAAA,CACAK,CAAAA,CAAU,yBAAA,CACE,CACZ,OAAAF,CAAAA,CAAUO,CAAAA,CAAYV,CAAK,CAAA,EAAKA,CAAAA,CAAM,MAAA,GAAW,EAAA,CAAIK,CAAO,CAAA,CACrDL,CACT,CAKO,SAASgB,CAAAA,CACdhB,CAAAA,CACAK,CAAAA,CAAU,2BAAA,CACI,CACd,OAAAF,CAAAA,CAAUO,CAAAA,CAAYV,CAAK,CAAA,EAAKA,CAAAA,CAAM,MAAA,GAAW,GAAA,CAAKK,CAAO,CAAA,CACtDL,CACT,CAKO,SAASiB,CAAAA,CACdjB,CAAAA,CACAK,CAAAA,CAAU,6BAAA,CACF,CACR,OAAAF,CAAAA,CAAUO,CAAAA,CAAYV,CAAK,CAAA,EAAKA,CAAAA,CAAM,MAAA,GAAW,EAAA,CAAIK,CAAO,CAAA,CACrDL,CACT,CCzEA,SAASkB,CAAAA,CAAWrB,CAAAA,CAAuB,CACzC,MAAMA,CACR,CAoBO,SAASsB,CAAAA,CACdC,CAAAA,CACgB,CAChB,OAAIA,CAAAA,YAAkBC,WAAAA,CACbD,CAAAA,CAAO,KAAA,CAAOpB,CAAAA,EAAUA,CAAAA,CAAOkB,CAAU,CAAA,CAG3CE,CAAAA,CAAO,KAAA,CAAOpB,CAAAA,EAAUA,CAAAA,CAAOkB,CAAU,CAClD","file":"index.js","sourcesContent":["import type { EvmAddress } from './hex';\n\n/**\n * The all-zero EVM address used to indicate the absence of a specific account.\n */\nexport const ZERO_ADDRESS =\n  '0x0000000000000000000000000000000000000000' as EvmAddress;\n","/**\n * Base class for errors thrown by the Polymarket SDK.\n */\nexport abstract class PolymarketError extends Error {\n  /**\n   * Returns `true` when the provided value is a `PolymarketError`.\n   */\n  static isError(error: unknown): error is PolymarketError {\n    return error instanceof PolymarketError;\n  }\n}\n\n/**\n * Error thrown when code reaches a state that should be impossible.\n */\nexport class InvariantError extends PolymarketError {\n  override name = 'InvariantError' as const;\n}\n","import type { NonEmptyArray } from './array';\n\n/**\n * Returns `true` if the array contains at least one element.\n */\nexport function isNonEmptyArray<T>(\n  value: readonly T[],\n): value is NonEmptyArray<T> {\n  return value.length > 0;\n}\n\n/**\n * Returns `true` if the value is `null` or `undefined`.\n */\nexport function isNullish(value: unknown): value is null | undefined {\n  return value === null || value === undefined;\n}\n\n/**\n * Returns `true` if the value is not `null` or `undefined`.\n */\nexport function isPresent<T>(value: T): value is Exclude<T, null | undefined> {\n  return !isNullish(value);\n}\n","import { InvariantError } from './errors';\n\n/**\n * Flattens an object type for clearer IDE hovers and inferred signatures.\n */\nexport type Prettify<T> = {\n  [K in keyof T]: T[K];\n} & {};\n\n/**\n * Asserts that a condition is truthy.\n *\n * @internal\n *\n * @param condition - Value expected to be truthy.\n * @param message - Message used for the thrown `InvariantError`.\n */\nexport function invariant(\n  condition: unknown,\n  message: string,\n): asserts condition {\n  if (!condition) {\n    throw new InvariantError(message);\n  }\n}\n\n/**\n * Throws an `InvariantError` and narrows the current code path to `never`.\n *\n * Useful for unreachable branches and exhaustive checks.\n *\n * @param message - Message used for the thrown `InvariantError`.\n */\nexport function never(message = 'Unexpected call to never()'): never {\n  throw new InvariantError(message);\n}\n\n/**\n * Resolves after the provided delay in milliseconds.\n */\nexport function delay(ms: number): Promise<void> {\n  return new Promise((resolve) => setTimeout(resolve, ms));\n}\n","import type { Tagged } from 'type-fest';\n\n/**\n * A string encoded as hexadecimal and prefixed with `0x`.\n */\nexport type HexString = `0x${string}`;\n\n/**\n * A hex-encoded 32-byte private key prefixed with `0x`.\n */\nexport type PrivateKey = Tagged<HexString, 'PrivateKey'>;\n\n/**\n * An EVM account or contract address.\n */\nexport type EvmAddress = Tagged<HexString, 'EvmAddress'>;\n\n/**\n * A hex-encoded EVM signature.\n */\nexport type EvmSignature = Tagged<HexString, 'EvmSignature'>;\n\n/**\n * A transaction hash returned by an EVM-compatible network.\n */\nexport type TxHash = Tagged<HexString, 'TxHash'>;\n\n/**\n * Checks whether a value is a hex string prefixed with `0x`.\n */\nexport function isHexString(value: unknown): value is HexString {\n  return typeof value === 'string' && /^0x[a-fA-F0-9]+$/.test(value);\n}\n\n/**\n * Checks whether a value is a hex-encoded 32-byte private key.\n */\nexport function isPrivateKey(value: unknown): value is PrivateKey {\n  return isHexString(value) && value.length === 66;\n}\n","import type { NonEmptyArray } from './array';\nimport { invariant } from './helpers';\nimport {\n  type EvmAddress,\n  type EvmSignature,\n  type HexString,\n  isHexString,\n  type TxHash,\n} from './hex';\n\n/**\n * Refines a value to exclude `null` and `undefined`.\n */\nexport function expectPresent<T>(\n  value: T,\n  message = 'Expected value to be present',\n): Exclude<T, null | undefined> {\n  invariant(value !== null && value !== undefined, message);\n  return value as Exclude<T, null | undefined>;\n}\n\n/**\n * Refines an array to a non-empty tuple or throws when the array is empty.\n */\nexport function expectNonEmptyArray<T>(\n  value: readonly T[],\n  message = 'Expected a non-empty array',\n): NonEmptyArray<T> {\n  invariant(value.length > 0, message);\n\n  return value as NonEmptyArray<T>;\n}\n\n/**\n * Refines a string to a hex string or throws when the value is invalid.\n */\nexport function expectHexString(\n  value: string,\n  message = 'Expected a hex string',\n): HexString {\n  invariant(isHexString(value), message);\n  return value;\n}\n\n/**\n * Refines a string to an EVM address or throws when the value is invalid.\n */\nexport function expectEvmAddress(\n  value: unknown,\n  message = 'Expected an EVM address',\n): EvmAddress {\n  invariant(isHexString(value) && value.length === 42, message);\n  return value as EvmAddress;\n}\n\n/**\n * Refines a string to an EVM signature or throws when the value is invalid.\n */\nexport function expectEvmSignature(\n  value: unknown,\n  message = 'Expected an EVM signature',\n): EvmSignature {\n  invariant(isHexString(value) && value.length === 132, message);\n  return value as EvmSignature;\n}\n\n/**\n * Refines a string to a transaction hash or throws when the value is invalid.\n */\nexport function expectTxHash(\n  value: unknown,\n  message = 'Expected a transaction hash',\n): TxHash {\n  invariant(isHexString(value) && value.length === 66, message);\n  return value as TxHash;\n}\n","import { type Result, ResultAsync } from 'neverthrow';\n\nfunction throwError(error: unknown): never {\n  throw error;\n}\n\n/**\n * Extracts the success value from a {@link Result} or {@link ResultAsync}, or\n * throws the error branch.\n *\n * @example\n * ```ts\n * const value = unwrap(result.andThen(step1).andThen(step2));\n *\n * // value === 42\n * ```\n *\n * @internal\n *\n * @param result - Result to unwrap.\n * @returns The success value of the `result`.\n */\nexport function unwrap<T, E>(result: Result<T, E>): T;\nexport function unwrap<T, E>(result: ResultAsync<T, E>): Promise<T>;\nexport function unwrap<T, E>(\n  result: Result<T, E> | ResultAsync<T, E>,\n): T | Promise<T> {\n  if (result instanceof ResultAsync) {\n    return result.match((value) => value, throwError);\n  }\n\n  return result.match((value) => value, throwError);\n}\n"]}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@polymarket/types",
+  "version": "0.0.0-canary-20260421120448",
+  "description": "Shared TypeScript types for the Polymarket SDK.",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "neverthrow": "^8.2.0",
+    "type-fest": "^5.5.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.5.1",
+    "typescript": "^6.0.2"
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
+}