@droplinked_inc/web3-kit 0.1.0

package/dist/types.js

@@ -0,0 +1,140 @@
+/**
+ * Public types and zod schemas for @droplinked_inc/web3-kit.
+ *
+ * Every value crossing an external boundary (user-supplied chain id,
+ * token symbol, RPC URL, ABI-encoded payload) is validated against these
+ * schemas. See THREAT_MODEL.md for the rationale on each invariant.
+ */
+import { z } from 'zod';
+/* -------------------------------------------------------------------------- */
+/*  Chain identifiers (preserved 1:1 with the original v1.0.13 surface)        */
+/* -------------------------------------------------------------------------- */
+/**
+ * Canonical chain identifier used across the kit. String-valued so the
+ * representation is stable across JSON wire-formats and survives
+ * postMessage / fetch round-trips.
+ */
+export var Chains;
+(function (Chains) {
+    Chains["POLYGON"] = "POLYGON";
+    Chains["BINANCE"] = "BINANCE";
+    Chains["SKALE"] = "SKALE";
+    Chains["BASE"] = "BASE";
+    Chains["LINEA"] = "LINEA";
+    Chains["ETH"] = "ETH";
+    Chains["SOLANA"] = "SOLANA";
+    Chains["REDBELLY"] = "REDBELLY";
+    Chains["UNSTOPPABLE"] = "UNSTOPPABLE";
+    Chains["BITLAYER"] = "BITLAYER";
+    Chains["XION"] = "XION";
+})(Chains || (Chains = {}));
+export var Network;
+(function (Network) {
+    Network["TESTNET"] = "TESTNET";
+    Network["MAINNET"] = "MAINNET";
+})(Network || (Network = {}));
+export var Groups;
+(function (Groups) {
+    Groups["EVM"] = "EVM";
+    Groups["SOL"] = "SOL";
+    Groups["BTC"] = "BTC";
+    Groups["XION"] = "XION";
+    Groups["UD"] = "UD";
+})(Groups || (Groups = {}));
+export const ChainsSchema = z.nativeEnum(Chains);
+export const NetworkSchema = z.nativeEnum(Network);
+export const GroupsSchema = z.nativeEnum(Groups);
+/* -------------------------------------------------------------------------- */
+/*  EVM primitives                                                             */
+/* -------------------------------------------------------------------------- */
+export const EvmAddressSchema = z
+    .string()
+    .regex(/^0x[a-fA-F0-9]{40}$/u, 'invalid EVM address')
+    .transform((s) => s.toLowerCase());
+export const HexStringSchema = z
+    .string()
+    .regex(/^0x[a-fA-F0-9]*$/u, 'invalid hex string');
+/**
+ * Accepts the v1.0.13 wire-format for unsigned 256-bit numbers
+ * (`bigint`, base-10 string, non-negative finite integer) and
+ * normalizes to bigint. Negative, fractional, or out-of-range
+ * inputs are rejected.
+ */
+export const Uint256Schema = z
+    .union([
+    z.bigint(),
+    z.number().int().nonnegative(),
+    z.string().regex(/^\d+$/u),
+])
+    .transform((v) => (typeof v === 'bigint' ? v : BigInt(v)))
+    .refine((v) => v >= 0n && v <= (1n << 256n) - 1n, 'uint256 out of range');
+/* -------------------------------------------------------------------------- */
+/*  Token identifiers                                                          */
+/* -------------------------------------------------------------------------- */
+/**
+ * Canonical short-symbol identifier for known fiat-equivalent or
+ * native tokens used during checkout. The set is intentionally small
+ * — anything outside is rejected by the registry to prevent symbol
+ * impersonation attacks (see THREAT_MODEL.md §4).
+ */
+export var PaymentTokens;
+(function (PaymentTokens) {
+    PaymentTokens["ETH"] = "ETH";
+    PaymentTokens["BNB"] = "BNB";
+    PaymentTokens["MATIC"] = "MATIC";
+    PaymentTokens["SOL"] = "SOL";
+    PaymentTokens["BTC"] = "BTC";
+    PaymentTokens["USDC"] = "USDC";
+    PaymentTokens["USDT"] = "USDT";
+    PaymentTokens["USDS"] = "USDS";
+    PaymentTokens["DAI"] = "DAI";
+    PaymentTokens["WETH"] = "WETH";
+})(PaymentTokens || (PaymentTokens = {}));
+export const PaymentTokensSchema = z.nativeEnum(PaymentTokens);
+/* -------------------------------------------------------------------------- */
+/*  Chain payment payload (replaces v1.0.13's `IChainPayment`)                 */
+/* -------------------------------------------------------------------------- */
+export const ChainPaymentSchema = z.object({
+    totalPrice: Uint256Schema,
+    tbdValues: z.array(Uint256Schema),
+    tbdReceivers: z.array(EvmAddressSchema),
+    tokenAddress: EvmAddressSchema.optional(),
+    memo: z.string().max(512, 'memo too long'),
+    chainLinkRoundId: z.string().regex(/^\d+$/u).optional(),
+});
+/* -------------------------------------------------------------------------- */
+/*  Purchase / claim signature                                                 */
+/* -------------------------------------------------------------------------- */
+export const PurchaseConfirmationDataSchema = z.array(z.object({
+    amount: z.number().int().nonnegative(),
+    productId: z.string().min(1).max(128),
+    nullifier: z.string().regex(/^0x[a-fA-F0-9]{1,128}$/u),
+}));
+export const PurchaseSignatureSchema = z.object({
+    signature: z.string().regex(/^0x[a-fA-F0-9]{130}$/u, 'invalid 65-byte secp256k1 signature'),
+    purchaseData: PurchaseConfirmationDataSchema,
+});
+/* -------------------------------------------------------------------------- */
+/*  Misc                                                                       */
+/* -------------------------------------------------------------------------- */
+export const ZERO_ADDRESS = '0x0000000000000000000000000000000000000000';
+export var NFTType;
+(function (NFTType) {
+    NFTType[NFTType["ERC1155"] = 0] = "ERC1155";
+    NFTType[NFTType["ERC721"] = 1] = "ERC721";
+})(NFTType || (NFTType = {}));
+export var ProductType;
+(function (ProductType) {
+    ProductType[ProductType["DIGITAL"] = 0] = "DIGITAL";
+    ProductType[ProductType["POD"] = 1] = "POD";
+    ProductType[ProductType["PHYSICAL"] = 2] = "PHYSICAL";
+})(ProductType || (ProductType = {}));
+export var Actions;
+(function (Actions) {
+    Actions["Payment"] = "Payment";
+    Actions["ClaimNFT"] = "ClaimNFT";
+    Actions["Record"] = "Record";
+    Actions["Auth"] = "Auth";
+    Actions["Login"] = "Login";
+})(Actions || (Actions = {}));
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,gFAAgF;AAChF,iFAAiF;AACjF,gFAAgF;AAEhF;;;;GAIG;AACH,MAAM,CAAN,IAAY,MAYX;AAZD,WAAY,MAAM;IAChB,6BAAmB,CAAA;IACnB,6BAAmB,CAAA;IACnB,yBAAe,CAAA;IACf,uBAAa,CAAA;IACb,yBAAe,CAAA;IACf,qBAAW,CAAA;IACX,2BAAiB,CAAA;IACjB,+BAAqB,CAAA;IACrB,qCAA2B,CAAA;IAC3B,+BAAqB,CAAA;IACrB,uBAAa,CAAA;AACf,CAAC,EAZW,MAAM,KAAN,MAAM,QAYjB;AAED,MAAM,CAAN,IAAY,OAGX;AAHD,WAAY,OAAO;IACjB,8BAAmB,CAAA;IACnB,8BAAmB,CAAA;AACrB,CAAC,EAHW,OAAO,KAAP,OAAO,QAGlB;AAED,MAAM,CAAN,IAAY,MAMX;AAND,WAAY,MAAM;IAChB,qBAAW,CAAA;IACX,qBAAW,CAAA;IACX,qBAAW,CAAA;IACX,uBAAa,CAAA;IACb,mBAAS,CAAA;AACX,CAAC,EANW,MAAM,KAAN,MAAM,QAMjB;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;AACjD,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;AACnD,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;AAEjD,gFAAgF;AAChF,iFAAiF;AACjF,gFAAgF;AAEhF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,MAAM,EAAE;KACR,KAAK,CAAC,sBAAsB,EAAE,qBAAqB,CAAC;KACpD,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAmB,CAAC,CAAC;AAItD,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC;KAC7B,MAAM,EAAE;KACR,KAAK,CAAC,mBAAmB,EAAE,oBAAoB,CAAC,CAAC;AAEpD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC;KAC3B,KAAK,CAAC;IACL,CAAC,CAAC,MAAM,EAAE;IACV,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IAC9B,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC;CAC3B,CAAC;KACD,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;KACzD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,GAAG,EAAE,EAAE,sBAAsB,CAAC,CAAC;AAI5E,gFAAgF;AAChF,iFAAiF;AACjF,gFAAgF;AAEhF;;;;;GAKG;AACH,MAAM,CAAN,IAAY,aAWX;AAXD,WAAY,aAAa;IACvB,4BAAW,CAAA;IACX,4BAAW,CAAA;IACX,gCAAe,CAAA;IACf,4BAAW,CAAA;IACX,4BAAW,CAAA;IACX,8BAAa,CAAA;IACb,8BAAa,CAAA;IACb,8BAAa,CAAA;IACb,4BAAW,CAAA;IACX,8BAAa,CAAA;AACf,CAAC,EAXW,aAAa,KAAb,aAAa,QAWxB;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AAE/D,gFAAgF;AAChF,iFAAiF;AACjF,gFAAgF;AAEhF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,UAAU,EAAE,aAAa;IACzB,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC;IACjC,YAAY,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC;IACvC,YAAY,EAAE,gBAAgB,CAAC,QAAQ,EAAE;IACzC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,EAAE,eAAe,CAAC;IAC1C,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE;CACxD,CAAC,CAAC;AAIH,gFAAgF;AAChF,iFAAiF;AACjF,gFAAgF;AAEhF,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CACnD,CAAC,CAAC,MAAM,CAAC;IACP,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IACtC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IACrC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,yBAAyB,CAAC;CACvD,CAAC,CACH,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,uBAAuB,EAAE,qCAAqC,CAAC;IAC3F,YAAY,EAAE,8BAA8B;CAC7C,CAAC,CAAC;AAIH,gFAAgF;AAChF,iFAAiF;AACjF,gFAAgF;AAEhF,MAAM,CAAC,MAAM,YAAY,GAAe,4CAA4C,CAAC;AAErF,MAAM,CAAN,IAAY,OAGX;AAHD,WAAY,OAAO;IACjB,2CAAW,CAAA;IACX,yCAAU,CAAA;AACZ,CAAC,EAHW,OAAO,KAAP,OAAO,QAGlB;AAED,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,mDAAW,CAAA;IACX,2CAAO,CAAA;IACP,qDAAY,CAAA;AACd,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AAED,MAAM,CAAN,IAAY,OAMX;AAND,WAAY,OAAO;IACjB,8BAAmB,CAAA;IACnB,gCAAqB,CAAA;IACrB,4BAAiB,CAAA;IACjB,wBAAa,CAAA;IACb,0BAAe,CAAA;AACjB,CAAC,EANW,OAAO,KAAP,OAAO,QAMlB"}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@droplinked_inc/web3-kit",
+  "version": "0.1.0",
+  "description": "Higher-level web3 building blocks (chain registry, known-token registry, display formatters, tx builders) — hardened rebuild of the original droplinked-web3-kit@1.0.13.",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "THREAT_MODEL.md",
+    "CHANGELOG.md"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "viem": "^2.21.0",
+    "zod": "^3.23.8"
+  },
+  "peerDependencies": {
+    "@droplinked_inc/wallet-connection": "0.1.1"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "@types/node": "^22.5.0",
+    "fast-check": "^3.22.0",
+    "typescript": "^5.6.0",
+    "@droplinked_inc/wallet-connection": "0.1.1"
+  },
+  "publishConfig": {
+    "provenance": false,
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/droplinked/droplink-packages.git",
+    "directory": "packages/web3-kit"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "jest",
+    "test:coverage": "jest --coverage",
+    "lint": "eslint src --max-warnings=0",
+    "typecheck": "tsc --noEmit -p tsconfig.json"
+  }
+}