@getomnichain/omnichain 0.2.0 → 0.2.1

package/dist/cjs/network_type.js

@@ -0,0 +1,152 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NetworkType = void 0;
+exports.registerNonEvmChain = registerNonEvmChain;
+exports.unregisterChain = unregisterChain;
+exports.networkTypeRegistrations = networkTypeRegistrations;
+exports.networkTypeOf = networkTypeOf;
+exports.tryNetworkTypeOf = tryNetworkTypeOf;
+const chain_ids_ts_1 = require("./chain_ids.js");
+const errors_ts_1 = require("./errors.js");
+/** BTC address-grammar family. Distinct from the full `CHAIN_FAMILY_UTXO`
+ *  (which includes LTC/DOGE/DASH/ZEC/BCH — those have their own address
+ *  grammars and must not route through the BTC parser). */
+const BTC_ADDRESS_GRAMMAR_IDS = [
+    chain_ids_ts_1.CHAIN_ID_BITCOIN_MAINNET,
+    chain_ids_ts_1.CHAIN_ID_BITCOIN_TESTNET,
+    chain_ids_ts_1.CHAIN_ID_BITCOIN_SIGNET,
+];
+var NetworkType;
+(function (NetworkType) {
+    NetworkType["EVM"] = "EVM";
+    NetworkType["COSMOS"] = "COSMOS";
+    NetworkType["TON"] = "TON";
+    NetworkType["SOLANA"] = "SOLANA";
+    NetworkType["BTC"] = "BTC";
+    NetworkType["TRON"] = "TRON";
+})(NetworkType || (exports.NetworkType = NetworkType = {}));
+const networkTypeRegistry = new Map();
+// Seed the registry statically for families that have a working address
+// parser in v0. Only BTC (bech32 + base58 with BTC HRPs), Solana, TON, Tron.
+//
+// LTC/DOGE/DASH/ZEC/BCH are NOT statically seeded: their address grammars
+// differ from BTC's (different HRPs, different version bytes, CashAddr for
+// BCH, t-addr/z-addr for ZEC). `networkTypeOf` on those ids throws until a
+// chain instance is constructed.
+//
+// **Known v0 gap**: `UtxoChain`'s constructor currently registers *every*
+// UTXO coin as `NetworkType.BTC`, so `addressFor(-10, 'ltc1q…')` (after
+// constructing a Litecoin chain) throws from `btcParamsForChainId` — the
+// only currently-workable path is `chain.validateAddress(raw)` on the chain
+// instance itself. Full LTC/DOGE `addressFor` support requires per-family
+// NetworkType values (deferred; noted in the migration guide).
+for (const id of BTC_ADDRESS_GRAMMAR_IDS)
+    networkTypeRegistry.set(id, NetworkType.BTC);
+for (const id of chain_ids_ts_1.CHAIN_FAMILY_SOLANA)
+    networkTypeRegistry.set(id, NetworkType.SOLANA);
+for (const id of chain_ids_ts_1.CHAIN_FAMILY_TON)
+    networkTypeRegistry.set(id, NetworkType.TON);
+for (const id of chain_ids_ts_1.CHAIN_FAMILY_TRON)
+    networkTypeRegistry.set(id, NetworkType.TRON);
+/**
+ * Register (or re-register) a chainId's NetworkType. Idempotent for the SAME
+ * NetworkType; throws `ChainError(InvalidArgument)` on a conflict — silently
+ * flipping a chainId's family would let `addressFor` parse addresses under
+ * the wrong rules.
+ *
+ * **Positive chainIds are EVM by construction (EIP-155) and cannot be
+ * reclassified.** `unregisterChain(id)` only removes an explicit
+ * registration entry; `tryNetworkTypeOf` still synthesizes `EVM` for any
+ * positive integer, so a subsequent
+ * `registerNonEvmChain(<positive>, SOLANA)` still conflicts and throws.
+ * Matches `omnichain-py`'s static family sets in
+ * `chain_ids.py` — the Python side has no reclassification hook at all.
+ * Consumers who need a non-EVM chain must use a distinct (negative)
+ * chainId reserved by the family seed.
+ */
+function registerNonEvmChain(chainId, networkType) {
+    // iter-15 minor #1: reject non-integers at the registration point rather than
+    // letting the failure surface much later at first networkTypeOf() lookup.
+    if (!Number.isInteger(chainId)) {
+        throw new errors_ts_1.ChainError(errors_ts_1.ChainErrorKinds.InvalidArgument, `chainId must be an integer (got ${chainId})`, { chainId });
+    }
+    const existing = tryNetworkTypeOf(chainId);
+    if (existing !== undefined && existing !== networkType) {
+        throw new errors_ts_1.ChainError(errors_ts_1.ChainErrorKinds.InvalidArgument, `chainId ${chainId} already registered as ${existing}; refusing to reclassify as ${networkType}. Call unregisterChain(${chainId}) first if this is intentional.`, { chainId });
+    }
+    networkTypeRegistry.set(chainId, networkType);
+}
+/**
+ * Remove a chainId from the network-type registry. Advanced — intended for
+ * test isolation and for consumers who need to reclassify a chainId that
+ * collides with a family seed (e.g. treating a Cosmos-labelled positive
+ * chainId as EVM). Silent no-op if the chainId isn't registered.
+ *
+ * After `unregisterChain(id)`, `networkTypeOf(id)` returns EVM for positive
+ * ids and throws for negatives (same as an id that was never seeded).
+ *
+ * **Paired cleanup**: if you had also called
+ * `registerBtcChainParams(BigInt(id), …)` for the same id, call
+ * `unregisterBtcChainParams(BigInt(id))` from `utxo/btc/network_params.ts`
+ * to keep the two registries in sync. `unregisterChain` deliberately does
+ * NOT reach across into `btcParamsByChainId` to avoid a layering
+ * dependency from this base module into the utxo/btc leaf.
+ */
+function unregisterChain(chainId) {
+    networkTypeRegistry.delete(chainId);
+}
+/**
+ * Snapshot of the current registry. Read-only; mutations don't affect the
+ * live registry. Useful for consumer startup diagnostics ("show me every
+ * chainId this SDK will route and how").
+ */
+function networkTypeRegistrations() {
+    return new Map(networkTypeRegistry);
+}
+/**
+ * Resolve the NetworkType for a chainId.
+ *
+ * - Static seeds (UTXO / Solana / TON / Tron families from `chain_ids.ts`)
+ *   win first.
+ * - Instance constructors override via `registerNonEvmChain` (idempotent per
+ *   the guard above).
+ * - Positive chainIds NOT in a static family default to `EVM` (EIP-155).
+ * - Negative chainIds without a registration throw
+ *   `ChainError(ChainNotSupported)` rather than silently misclassifying.
+ *
+ * The `is*` predicates in `chain_ids.ts` operate on the static family sets
+ * only (Python parity, immutable); `networkTypeOf` is the runtime authority
+ * that also reflects consumer registrations.
+ */
+function networkTypeOf(chainId) {
+    if (!Number.isInteger(chainId)) {
+        throw new errors_ts_1.ChainError(errors_ts_1.ChainErrorKinds.InvalidArgument, `chainId must be an integer (got ${chainId})`, { chainId });
+    }
+    const registered = networkTypeRegistry.get(chainId);
+    if (registered !== undefined)
+        return registered;
+    // Positive integers default to EVM (EIP-155). `0` is not a valid EIP-155
+    // chainId (0-conflict is why EIP-155 exists) — treat like an unregistered
+    // negative and fail closed.
+    if (chainId > 0)
+        return NetworkType.EVM;
+    throw new errors_ts_1.ChainError(errors_ts_1.ChainErrorKinds.ChainNotSupported, `Unregistered non-positive chainId ${chainId} — no NetworkType known`, { chainId });
+}
+/**
+ * Non-throwing variant of `networkTypeOf`. Returns `undefined` instead of
+ * throwing `ChainError(ChainNotSupported)` for unregistered negative
+ * chainIds. Use when the caller legitimately needs "unknown" as a valid
+ * outcome (e.g. a pre-validation guard that wants to route to a custom
+ * error type rather than a try/catch around every lookup).
+ */
+function tryNetworkTypeOf(chainId) {
+    if (!Number.isInteger(chainId))
+        return undefined;
+    const registered = networkTypeRegistry.get(chainId);
+    if (registered !== undefined)
+        return registered;
+    if (chainId > 0)
+        return NetworkType.EVM;
+    return undefined;
+}
+//# sourceMappingURL=network_type.js.map

package/dist/cjs/network_type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"network_type.js","sourceRoot":"","sources":["../../network_type.ts"],"names":[],"mappings":";;;AAiEA,kDAmBC;AAkBD,0CAEC;AAOD,4DAEC;AAiBD,sCAmBC;AASD,4CAMC;AApKD,iDAOwB;AACxB,2CAA0D;AAE1D;;2DAE2D;AAC3D,MAAM,uBAAuB,GAAsB;IACjD,uCAAwB;IACxB,uCAAwB;IACxB,sCAAuB;CACxB,CAAC;AAEF,IAAY,WAOX;AAPD,WAAY,WAAW;IACrB,0BAAW,CAAA;IACX,gCAAiB,CAAA;IACjB,0BAAW,CAAA;IACX,gCAAiB,CAAA;IACjB,0BAAW,CAAA;IACX,4BAAa,CAAA;AACf,CAAC,EAPW,WAAW,2BAAX,WAAW,QAOtB;AAED,MAAM,mBAAmB,GAAG,IAAI,GAAG,EAAuB,CAAC;AAE3D,wEAAwE;AACxE,6EAA6E;AAC7E,EAAE;AACF,0EAA0E;AAC1E,2EAA2E;AAC3E,2EAA2E;AAC3E,iCAAiC;AACjC,EAAE;AACF,0EAA0E;AAC1E,wEAAwE;AACxE,yEAAyE;AACzE,4EAA4E;AAC5E,0EAA0E;AAC1E,+DAA+D;AAC/D,KAAK,MAAM,EAAE,IAAI,uBAAuB;IAAE,mBAAmB,CAAC,GAAG,CAAC,EAAE,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;AACvF,KAAK,MAAM,EAAE,IAAI,kCAAmB;IAAE,mBAAmB,CAAC,GAAG,CAAC,EAAE,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;AACtF,KAAK,MAAM,EAAE,IAAI,+BAAgB;IAAE,mBAAmB,CAAC,GAAG,CAAC,EAAE,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;AAChF,KAAK,MAAM,EAAE,IAAI,gCAAiB;IAAE,mBAAmB,CAAC,GAAG,CAAC,EAAE,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;AAElF;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,mBAAmB,CAAC,OAAe,EAAE,WAAwB;IAC3E,8EAA8E;IAC9E,0EAA0E;IAC1E,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,sBAAU,CAClB,2BAAe,CAAC,eAAe,EAC/B,mCAAmC,OAAO,GAAG,EAC7C,EAAE,OAAO,EAAE,CACZ,CAAC;IACJ,CAAC;IACD,MAAM,QAAQ,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAC3C,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,WAAW,EAAE,CAAC;QACvD,MAAM,IAAI,sBAAU,CAClB,2BAAe,CAAC,eAAe,EAC/B,WAAW,OAAO,0BAA0B,QAAQ,+BAA+B,WAAW,0BAA0B,OAAO,iCAAiC,EAChK,EAAE,OAAO,EAAE,CACZ,CAAC;IACJ,CAAC;IACD,mBAAmB,CAAC,GAAG,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,eAAe,CAAC,OAAe;IAC7C,mBAAmB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AACtC,CAAC;AAED;;;;GAIG;AACH,SAAgB,wBAAwB;IACtC,OAAO,IAAI,GAAG,CAAC,mBAAmB,CAAC,CAAC;AACtC,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAgB,aAAa,CAAC,OAAe;IAC3C,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,sBAAU,CAClB,2BAAe,CAAC,eAAe,EAC/B,mCAAmC,OAAO,GAAG,EAC7C,EAAE,OAAO,EAAE,CACZ,CAAC;IACJ,CAAC;IACD,MAAM,UAAU,GAAG,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACpD,IAAI,UAAU,KAAK,SAAS;QAAE,OAAO,UAAU,CAAC;IAChD,yEAAyE;IACzE,0EAA0E;IAC1E,4BAA4B;IAC5B,IAAI,OAAO,GAAG,CAAC;QAAE,OAAO,WAAW,CAAC,GAAG,CAAC;IACxC,MAAM,IAAI,sBAAU,CAClB,2BAAe,CAAC,iBAAiB,EACjC,qCAAqC,OAAO,yBAAyB,EACrE,EAAE,OAAO,EAAE,CACZ,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAAC,OAAe;IAC9C,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC;QAAE,OAAO,SAAS,CAAC;IACjD,MAAM,UAAU,GAAG,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACpD,IAAI,UAAU,KAAK,SAAS;QAAE,OAAO,UAAU,CAAC;IAChD,IAAI,OAAO,GAAG,CAAC;QAAE,OAAO,WAAW,CAAC,GAAG,CAAC;IACxC,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/cjs/priority.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeePriority = exports.DEFAULT_PRIORITY = exports.Priority = void 0;
+/**
+ * Speed-vs-cost knob for landing a transaction on chain. Lives in the chain SDK so that
+ * every chain's `suggest*` helpers and `createTransferUnsignedTransaction` can speak the
+ * same vocabulary. Consumers (depositron, pluton) re-export or re-use this enum directly —
+ * they should never invent their own three-tier mirror.
+ *
+ * The semantics per chain are documented on each chain's `suggest*` method.
+ */
+var Priority;
+(function (Priority) {
+    Priority["SLOW"] = "SLOW";
+    Priority["NORMAL"] = "NORMAL";
+    Priority["FAST"] = "FAST";
+})(Priority || (exports.Priority = Priority = {}));
+exports.DEFAULT_PRIORITY = Priority.NORMAL;
+/**
+ * Python-name alias for `Priority`. omnichain-py names the same enum
+ * `FeePriority` (base/base.py:123); consumers writing Python-parity code
+ * can import either identifier. `Priority` remains the canonical TS name
+ * for back-compat.
+ */
+exports.FeePriority = Priority;
+//# sourceMappingURL=priority.js.map

package/dist/cjs/priority.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"priority.js","sourceRoot":"","sources":["../../priority.ts"],"names":[],"mappings":";;;AAAA;;;;;;;GAOG;AACH,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,yBAAa,CAAA;IACb,6BAAiB,CAAA;IACjB,yBAAa,CAAA;AACf,CAAC,EAJW,QAAQ,wBAAR,QAAQ,QAInB;AAEY,QAAA,gBAAgB,GAAa,QAAQ,CAAC,MAAM,CAAC;AAE1D;;;;;GAKG;AACU,QAAA,WAAW,GAAG,QAAQ,CAAC"}

package/dist/cjs/solana/index.js

@@ -0,0 +1,25 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./solana_address.js"), exports);
+__exportStar(require("./solana_chain.js"), exports);
+__exportStar(require("./solana_chains.js"), exports);
+__exportStar(require("./solana_gas_pricing.js"), exports);
+__exportStar(require("./solana_token.js"), exports);
+__exportStar(require("./solana_tokens.js"), exports);
+__exportStar(require("./solana_transaction_status.js"), exports);
+__exportStar(require("./unsigned_solana_transaction.js"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/solana/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../solana/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC;AACpC,oDAAkC;AAClC,qDAAmC;AACnC,0DAAwC;AACxC,oDAAkC;AAClC,qDAAmC;AACnC,iEAA+C;AAC/C,mEAAiD"}

package/dist/cjs/solana/solana_address.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SolanaAddress = void 0;
+const web3_js_1 = require("@solana/web3.js");
+const address_ts_1 = require("../address.js");
+const network_type_ts_1 = require("../network_type.js");
+/**
+ * Solana addresses are 32-byte ed25519 public keys, encoded in base58 (no fixed length but
+ * always 32–44 chars after encoding). Validation defers to `PublicKey` which checks the
+ * base58 alphabet, decodes, and asserts the 32-byte length.
+ *
+ * Unlike EVM there is no case-folding / EIP-55 checksum — every valid address has exactly
+ * one canonical string form, so `canonical()` just returns the trimmed input verbatim once
+ * we've confirmed it parses.
+ */
+class SolanaAddress extends address_ts_1.Address {
+    pubkey;
+    constructor(raw) {
+        super(SolanaAddress.assertValid(raw));
+        this.pubkey = new web3_js_1.PublicKey(this.raw);
+    }
+    canonical() {
+        return this.raw;
+    }
+    get networkType() {
+        return network_type_ts_1.NetworkType.SOLANA;
+    }
+    static assertValid(raw) {
+        if (typeof raw !== 'string') {
+            throw new Error('Invalid Solana address: not a string');
+        }
+        const trimmed = raw.trim();
+        if (trimmed.length === 0) {
+            throw new Error('Invalid Solana address: empty');
+        }
+        try {
+            const pk = new web3_js_1.PublicKey(trimmed);
+            if (pk.toBytes().length !== 32) {
+                throw new Error('Solana address must be 32 bytes');
+            }
+        }
+        catch (err) {
+            throw new Error(`Invalid Solana address: "${raw}": ${err.message}`);
+        }
+        return trimmed;
+    }
+}
+exports.SolanaAddress = SolanaAddress;
+//# sourceMappingURL=solana_address.js.map

package/dist/cjs/solana/solana_address.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"solana_address.js","sourceRoot":"","sources":["../../../solana/solana_address.ts"],"names":[],"mappings":";;;AAAA,6CAA4C;AAE5C,8CAAwC;AACxC,wDAAiD;AAEjD;;;;;;;;GAQG;AACH,MAAa,aAAc,SAAQ,oBAAO;IAC/B,MAAM,CAAY;IAE3B,YAAY,GAAW;QACrB,KAAK,CAAC,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,IAAI,mBAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxC,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED,IAAI,WAAW;QACb,OAAO,6BAAW,CAAC,MAAM,CAAC;IAC5B,CAAC;IAEO,MAAM,CAAC,WAAW,CAAC,GAAW;QACpC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QACD,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;QAC3B,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC;QACD,IAAI,CAAC;YACH,MAAM,EAAE,GAAG,IAAI,mBAAS,CAAC,OAAO,CAAC,CAAC;YAClC,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;gBAC/B,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;YACrD,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,4BAA4B,GAAG,MAAO,GAAa,CAAC,OAAO,EAAE,CAAC,CAAC;QACjF,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;CACF;AAlCD,sCAkCC"}