@proton/wrap-constants 0.3.0 → 0.3.1

package/dist/index.mjs

@@ -1,6 +1,9 @@
 import * as z from "zod";
 import cloneDeep from "lodash.clonedeep";
 import BN from "bignumber.js";
+import { base32nopad, base58, base58xrp, bech32, bech32m, createBase58check } from "@scure/base";
+import { sha256 } from "@noble/hashes/sha2";
+import { keccak_256 } from "@noble/hashes/sha3";
 // src/coins.ts
 let Chains = /* @__PURE__ */ function(Chains) {
 	Chains["BitcoinMainnet"] = "Bitcoin";
@@ -2272,4 +2275,292 @@ const applyDiscountToFee = (fee, staked) => {
 	else if (staked >= 1e5) return fee * .66;
 	else return fee;
 };
-export { Chains, ExtendedAssetParser, FEE_FACTOR, Graph, ILink, INode, ITopics, Networks, Providers, Status, TOPICS, Type, WRAP_AUTH_ACTION, WRAP_CONTRACT, accountParser, accountRamDeltaParser, actParser, actionTraceParser, addressParser, applyDiscountToFee, authorizationParser, authorizationsParser, baseActionParser, baseActionSerializedParser, bloksRatesParser, chronicleTransactionParser, compute_liquidity, compute_transfer, compute_transfer_curve, createAbstractAuthParser, dailyParser, dbHistoryTransactionParser, dbMarketParser, depositBodyParser, depthParser, exchangeRateParser, exchangeRatesParser, explorerLinkByChain, fillType, generateAddressBodyParser, generateAddressResponse, generateAuthActionsBaseParser, generateAuthParser, getDailyResponseParser, getDepthParser, getDepthResponseParser, getHistoryActionsParser, getHistoryActionsResponseParser, getHistoryTransactionResponseParser, getHistoryTransfersParser, getHistoryTransfersResponseParser, getLeaderboardParser, getLeaderboardResponseParser, getMarketsResponseParser, getOhlcvParser, getOhlcvResponseParser, getOpenOrdersBalancesResponseParser, getOpenOrdersParser, getOpenOrdersResponseParser, getOrderHistoryParser, getOrderHistoryResponseParser, getOrderLifecycleParser, getOrderLifecycleResponseParser, getReferralTotalsParser, getReferralTotalsResponseParser, getReferralsParser, getReferralsResponseParser, getSyncResponseParser, getTradeHistoryParser, getTradeHistoryResponseParser, getTradesParser, getTradesResponseParser, historyActionParser, historyPartialParser, historyTransactionParser, historyTransferParser, initializeCoins, initializeConstants, isInputInvalid, isSameToken, leaderboardParser, logStatus, loginAccountParamsV3Parser, marketOpenOrdersBalanceParser, marketParser, median, metalTransactionParser, ohlcvParser, openOrderParser, orderHistoryParser, orderLogParser, orderSide, orderType, otcOrderResponseParser, otcQuoteBodyParser, otcQuoteResponseParser, postSerializeOrderParser, postSerializeOrderResponseParser, postSubmitOrderParser, postSubmitOrderResponseParser, protonExplorerTxUrl, rateParser, receiptParser, refferalParser, refferalTotalParser, similarChains, singleActionTransactionParser, sortDirectionEnum, syncParser, traceParser, tradeLogParser, tradeParser, webauthActionParser, withdrawBodyBaseAction, withdrawBodyParser, withdrawHistoryMetalResponseParser, withdrawHistoryMetalSwapParser, withdrawMetalResponseParser, withdrawalFeeQuoteParser, wrapParser, wrapSetConfParser, wrapStartParser };
+// src/validation/address.ts
+/**
+* Withdrawal destination validation for the bridge (MFE-855).
+*
+* The address and memo end up inside the XPR transfer memo as
+* `coin:network:address[?memo=...]:fee`, which the bridge server splits on ':'.
+* So beyond per-chain format checks, these validators also reject characters
+* that would corrupt that structure.
+*
+* Result levels:
+*  - 'full'  : the chain's address format was fully checked, including its
+*              checksum where the format has one. Formats without a checksum
+*              (Solana keys, EOS names, Hedera ids, single-case EVM) cannot
+*              catch every typo even at this level.
+*  - 'basic' : only the shared safety rules (and partial format checks) ran,
+*              because no complete validator exists for this chain/format.
+*/
+const MAX_ADDRESS_LENGTH = 128;
+const MAX_DEFAULT_MEMO_BYTES = 256;
+const FULL = {
+	valid: true,
+	level: "full"
+};
+const BASIC = {
+	valid: true,
+	level: "basic"
+};
+const fail = (reason) => ({
+	valid: false,
+	reason
+});
+const PRINTABLE_ASCII = /^[\x21-\x7e]+$/;
+const sharedAddressChecks = (address) => {
+	if (typeof address !== "string" || address.length === 0) return fail("Address is required.");
+	if (address.length > 128) return fail("Address is too long.");
+	if (!PRINTABLE_ASCII.test(address)) return fail("Address contains spaces or unsupported characters.");
+	if (address.includes(":")) return fail("Address must not contain \":\". If you pasted a payment link, paste only the address.");
+	if (address.includes("?")) return fail("Address must not contain \"?\". Use the memo field for memos or tags.");
+	return null;
+};
+const tryDecode = (fn) => {
+	try {
+		return fn();
+	} catch {
+		return;
+	}
+};
+const bytesEqual = (a, b) => a.length === b.length && a.every((v, i) => v === b[i]);
+const allZero = (a) => a.every((v) => v === 0);
+const UTXO_PARAMS = {
+	["Bitcoin"]: {
+		name: "Bitcoin",
+		segwitHrp: "bc",
+		base58Versions: [0, 5]
+	},
+	["Bitcoin (Testnet)"]: {
+		name: "Bitcoin testnet",
+		segwitHrp: "tb",
+		base58Versions: [111, 196]
+	},
+	["Litecoin"]: {
+		name: "Litecoin",
+		segwitHrp: "ltc",
+		base58Versions: [
+			48,
+			50,
+			5
+		]
+	},
+	["Litecoin (Testnet)"]: {
+		name: "Litecoin testnet",
+		segwitHrp: "tltc",
+		base58Versions: [
+			111,
+			58,
+			196
+		]
+	},
+	["Dogecoin"]: {
+		name: "Dogecoin",
+		base58Versions: [30, 22]
+	}
+};
+const base58check = createBase58check(sha256);
+const BECH32_CHARSET = "qpzry9x8gf2tvdw0s3jn54khce6mua7l";
+const validateSegwit = (address, hrp, name) => {
+	if (address.length > 90) return fail(`Not a valid ${name} address.`);
+	const lower = address.toLowerCase();
+	const version = BECH32_CHARSET.indexOf(lower.charAt(hrp.length + 1));
+	if (version < 0) return fail(`Not a valid ${name} address.`);
+	const decoded = tryDecode(() => (version === 0 ? bech32 : bech32m).decode(address, 90));
+	if (!decoded || decoded.prefix !== hrp) return fail(`Not a valid ${name} address (checksum or network mismatch).`);
+	const program = tryDecode(() => bech32.fromWords(decoded.words.slice(1)));
+	if (!program) return fail(`Not a valid ${name} address.`);
+	if (version === 0 && program.length !== 20 && program.length !== 32) return fail(`Not a valid ${name} address.`);
+	if (version === 1 && program.length !== 32) return fail(`Not a valid ${name} address.`);
+	if (version > 1) return fail(`Unsupported ${name} address version.`);
+	return FULL;
+};
+const validateUtxo = (address, params) => {
+	const { name, segwitHrp, base58Versions } = params;
+	if (segwitHrp && address.toLowerCase().startsWith(`${segwitHrp}1`)) return validateSegwit(address, segwitHrp, name);
+	const payload = tryDecode(() => base58check.decode(address));
+	if (!payload || payload.length !== 21 || !base58Versions.includes(payload[0])) return fail(`Not a valid ${name} address (checksum or network mismatch).`);
+	return FULL;
+};
+const EVM_CHAINS = /* @__PURE__ */ new Set([
+	"Ethereum",
+	"Ethereum (Sepolia)",
+	"Binance (BEP20)",
+	"Polygon",
+	"Avalanche C-Chain",
+	"Metal C-Chain",
+	"Metal C-Chain (Testnet)",
+	"Metal L2",
+	"Metal L2 (Testnet)"
+]);
+const toHex = (bytes) => Array.from(bytes, (b) => b.toString(16).padStart(2, "0")).join("");
+const validateHex40 = (hex) => {
+	if (!/^[0-9a-fA-F]{40}$/.test(hex)) return fail("Address must be 0x followed by 40 hexadecimal characters.");
+	if (/^0{40}$/.test(hex)) return fail("Withdrawing to the zero address would burn the funds.");
+	const lower = hex.toLowerCase();
+	if (hex === lower || hex === hex.toUpperCase()) return FULL;
+	const hash = toHex(keccak_256(new TextEncoder().encode(lower)));
+	for (let i = 0; i < 40; i++) {
+		const c = hex[i];
+		if (c >= "0" && c <= "9") continue;
+		const shouldBeUpper = parseInt(hash[i], 16) >= 8;
+		if (c === c.toUpperCase() !== shouldBeUpper) return fail("Address checksum (EIP-55 capitalization) is invalid. Check for a typo.");
+	}
+	return FULL;
+};
+const validateEvm = (address) => address.startsWith("0x") ? validateHex40(address.slice(2)) : fail("Address must start with 0x.");
+const validateXdc = (address) => {
+	if (address.startsWith("xdc") || address.startsWith("0x")) return validateHex40(address.slice(address.startsWith("xdc") ? 3 : 2));
+	return fail("Address must start with xdc or 0x.");
+};
+const crc16xmodem = (data) => {
+	let crc = 0;
+	for (const byte of data) {
+		crc ^= byte << 8;
+		for (let i = 0; i < 8; i++) crc = crc & 32768 ? (crc << 1 ^ 4129) & 65535 : crc << 1 & 65535;
+	}
+	return crc;
+};
+const STELLAR_KINDS = {
+	G: {
+		length: 56,
+		version: 48,
+		bytes: 35
+	},
+	M: {
+		length: 69,
+		version: 96,
+		bytes: 43
+	}
+};
+const validateStellar = (address) => {
+	const kind = STELLAR_KINDS[address[0]];
+	if (!kind || address.length !== kind.length || !/^[A-Z2-7]+$/.test(address)) return fail("Not a valid Stellar address (should start with G and be 56 characters).");
+	const data = tryDecode(() => base32nopad.decode(address));
+	if (!data || data.length !== kind.bytes || data[0] !== kind.version) return fail("Not a valid Stellar address.");
+	const body = data.slice(0, -2);
+	const crc = crc16xmodem(body);
+	if (data[data.length - 2] !== (crc & 255) || data[data.length - 1] !== crc >> 8) return fail("Stellar address checksum is invalid. Check for a typo.");
+	return FULL;
+};
+const XRP_BLACKHOLES = [/* @__PURE__ */ new Uint8Array(20), Uint8Array.from([.../* @__PURE__ */ new Uint8Array(19), 1])];
+const validateXrp = (address) => {
+	if (address.startsWith("X") || address.startsWith("T")) return fail("X-addresses are not supported. Use the classic r-address and put the destination tag in the memo field.");
+	if (!address.startsWith("r") || address.length < 25 || address.length > 35) return fail("Not a valid XRP address.");
+	const data = tryDecode(() => base58xrp.decode(address));
+	if (!data || data.length !== 25 || data[0] !== 0) return fail("Not a valid XRP address.");
+	const checksum = sha256(sha256(data.slice(0, 21))).slice(0, 4);
+	if (!bytesEqual(checksum, data.slice(21))) return fail("XRP address checksum is invalid. Check for a typo.");
+	const accountId = data.slice(1, 21);
+	if (XRP_BLACKHOLES.some((b) => bytesEqual(b, accountId))) return fail("This XRP address is unspendable (black hole).");
+	return FULL;
+};
+const validateSolana = (address) => {
+	if (address.length < 32 || address.length > 44) return fail("Not a valid Solana address.");
+	const key = tryDecode(() => base58.decode(address));
+	if (!key || key.length !== 32) return fail("Not a valid Solana address.");
+	if (allZero(key)) return fail("This is the Solana system program, not a wallet address.");
+	return FULL;
+};
+const validateCardano = (address) => {
+	const lower = address.toLowerCase();
+	if (lower.startsWith("addr_test1")) return fail("This is a Cardano testnet address.");
+	if (lower.startsWith("stake")) return fail("This is a Cardano stake (reward) address, not a payment address.");
+	if (lower.startsWith("addr1")) {
+		const decoded = tryDecode(() => bech32.decode(address, 1023));
+		const data = decoded && tryDecode(() => bech32.fromWords(decoded.words));
+		if (!decoded || decoded.prefix !== "addr" || !data || data.length === 0) return fail("Not a valid Cardano address (checksum failed). Check for a typo.");
+		const type = data[0] >> 4;
+		if ((data[0] & 15) !== 1) return fail("This Cardano address is not for mainnet.");
+		return (type <= 3 ? data.length === 57 : type <= 5 ? data.length > 29 : type <= 7 ? data.length === 29 : false) ? FULL : fail("Not a valid Cardano payment address.");
+	}
+	if ((address.startsWith("Ae2") || address.startsWith("DdzFF")) && tryDecode(() => base58.decode(address))) return BASIC;
+	return fail("Not a valid Cardano address.");
+};
+const validateEos = (address) => /^[a-z1-5.]{1,12}$/.test(address) && !address.endsWith(".") ? FULL : fail("EOS account names are 1-12 characters: a-z, 1-5 and \".\" (not at the end).");
+const validateHedera = (address) => {
+	const match = /^0\.0\.(\d{1,19})(-[a-z]{5})?$/.exec(address);
+	if (!match) return fail("Hedera account ids look like 0.0.12345.");
+	return match[2] ? BASIC : FULL;
+};
+const VALIDATORS = {
+	["XDC Network"]: validateXdc,
+	["Stellar"]: validateStellar,
+	["Stellar (Testnet)"]: validateStellar,
+	["Ripple"]: validateXrp,
+	["Solana"]: validateSolana,
+	["Cardano"]: validateCardano,
+	["EOS"]: validateEos,
+	["EOS (Jungle Testnet)"]: validateEos,
+	["Hedera (Mainnet)"]: validateHedera,
+	["Hedera (Testnet)"]: validateHedera
+};
+/**
+* Validate a withdrawal destination address for the given bridge chain
+* (a `Chains` enum value, i.e. `wallet.chain`). Expects already-trimmed input.
+* Pure and synchronous, so it is safe to call on every keystroke.
+*/
+const validateWithdrawAddress = (chain, address) => {
+	const sharedFailure = sharedAddressChecks(address);
+	if (sharedFailure) return sharedFailure;
+	const utxo = UTXO_PARAMS[chain];
+	if (utxo) return validateUtxo(address, utxo);
+	if (EVM_CHAINS.has(chain)) return validateEvm(address);
+	const validator = VALIDATORS[chain];
+	return validator ? validator(address) : BASIC;
+};
+const MEMO_BYTE_LIMITS = {
+	["Stellar"]: 28,
+	["Stellar (Testnet)"]: 28,
+	["Hedera (Mainnet)"]: 100,
+	["Hedera (Testnet)"]: 100
+};
+/**
+* Validate an optional withdrawal memo / destination tag. The memo is appended
+* to the address as `?memo=...` inside the ':'-delimited bridge memo, so
+* delimiter and URL-structure characters are rejected on every chain.
+*/
+const validateWithdrawMemo = (chain, memo) => {
+	if (memo === void 0 || memo === "") return { valid: true };
+	if (typeof memo !== "string") return fail("Memo must be text.");
+	if (/\p{Cc}/u.test(memo)) return fail("Memo contains unsupported characters.");
+	if (/[:?&#=]/.test(memo)) return fail("Memo must not contain : ? & # or =.");
+	if (chain === "Ripple") return /^\d{1,10}$/.test(memo) && Number(memo) <= 4294967295 ? { valid: true } : fail("XRP destination tags must be a whole number between 0 and 4294967295.");
+	const limit = MEMO_BYTE_LIMITS[chain] ?? MAX_DEFAULT_MEMO_BYTES;
+	if (new TextEncoder().encode(memo).length > limit) return fail(`Memo must be at most ${limit} bytes.`);
+	return { valid: true };
+};
+// src/validation/withdrawError.ts
+/**
+* Turn a failed bridge withdrawal request into a message that is safe to show
+* to the user (MFE-855).
+*
+* Only 4xx responses are treated as user-facing: they describe a problem with
+* the request (for example an invalid address passed through from Proton Swap).
+* 5xx responses, network failures and anything unrecognised get a generic
+* message, so server internals such as stack traces are never displayed and
+* the raw "AxiosError: Request failed with status code 500" is never shown.
+*
+* Duck-typed so it has no axios dependency.
+*/
+const GENERIC_WITHDRAW_ERROR = "Withdrawal failed. Please check the amount and address and try again.";
+const MAX_WITHDRAW_ERROR_LENGTH = 200;
+const sanitize = (raw) => {
+	const cleaned = raw.replace(/[\p{Cc}\s]+/gu, " ").trim();
+	return cleaned.length > 200 ? `${cleaned.slice(0, 199)}…` : cleaned;
+};
+const messageFromBody = (data) => {
+	if (typeof data === "string") return data;
+	if (data && typeof data === "object") {
+		const { message, error } = data;
+		if (typeof message === "string") return message;
+		if (typeof error === "string") return error;
+	}
+};
+const withdrawErrorMessage = (error) => {
+	const response = error?.response;
+	const status = response?.status;
+	if (typeof status !== "number" || status < 400 || status >= 500) return GENERIC_WITHDRAW_ERROR;
+	const raw = messageFromBody(response?.data);
+	return (raw === void 0 ? "" : sanitize(raw)) || "Withdrawal failed. Please check the amount and address and try again.";
+};
+export { Chains, ExtendedAssetParser, FEE_FACTOR, GENERIC_WITHDRAW_ERROR, Graph, ILink, INode, ITopics, MAX_ADDRESS_LENGTH, MAX_WITHDRAW_ERROR_LENGTH, Networks, Providers, Status, TOPICS, Type, WRAP_AUTH_ACTION, WRAP_CONTRACT, accountParser, accountRamDeltaParser, actParser, actionTraceParser, addressParser, applyDiscountToFee, authorizationParser, authorizationsParser, baseActionParser, baseActionSerializedParser, bloksRatesParser, chronicleTransactionParser, compute_liquidity, compute_transfer, compute_transfer_curve, createAbstractAuthParser, dailyParser, dbHistoryTransactionParser, dbMarketParser, depositBodyParser, depthParser, exchangeRateParser, exchangeRatesParser, explorerLinkByChain, fillType, generateAddressBodyParser, generateAddressResponse, generateAuthActionsBaseParser, generateAuthParser, getDailyResponseParser, getDepthParser, getDepthResponseParser, getHistoryActionsParser, getHistoryActionsResponseParser, getHistoryTransactionResponseParser, getHistoryTransfersParser, getHistoryTransfersResponseParser, getLeaderboardParser, getLeaderboardResponseParser, getMarketsResponseParser, getOhlcvParser, getOhlcvResponseParser, getOpenOrdersBalancesResponseParser, getOpenOrdersParser, getOpenOrdersResponseParser, getOrderHistoryParser, getOrderHistoryResponseParser, getOrderLifecycleParser, getOrderLifecycleResponseParser, getReferralTotalsParser, getReferralTotalsResponseParser, getReferralsParser, getReferralsResponseParser, getSyncResponseParser, getTradeHistoryParser, getTradeHistoryResponseParser, getTradesParser, getTradesResponseParser, historyActionParser, historyPartialParser, historyTransactionParser, historyTransferParser, initializeCoins, initializeConstants, isInputInvalid, isSameToken, leaderboardParser, logStatus, loginAccountParamsV3Parser, marketOpenOrdersBalanceParser, marketParser, median, metalTransactionParser, ohlcvParser, openOrderParser, orderHistoryParser, orderLogParser, orderSide, orderType, otcOrderResponseParser, otcQuoteBodyParser, otcQuoteResponseParser, postSerializeOrderParser, postSerializeOrderResponseParser, postSubmitOrderParser, postSubmitOrderResponseParser, protonExplorerTxUrl, rateParser, receiptParser, refferalParser, refferalTotalParser, similarChains, singleActionTransactionParser, sortDirectionEnum, syncParser, traceParser, tradeLogParser, tradeParser, validateWithdrawAddress, validateWithdrawMemo, webauthActionParser, withdrawBodyBaseAction, withdrawBodyParser, withdrawErrorMessage, withdrawHistoryMetalResponseParser, withdrawHistoryMetalSwapParser, withdrawMetalResponseParser, withdrawalFeeQuoteParser, wrapParser, wrapSetConfParser, wrapStartParser };

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@proton/wrap-constants",
+  "description": "Shared constants, coin metadata, and API parsers for MetalX",
   "author": "Metallicus",
-  "module": "dist/index.mjs",
+  "module": "./dist/index.mjs",
   "type": "module",
   "exports": {
     ".": {
@@ -18,29 +19,32 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.3.0",
+  "version": "0.3.1",
   "license": "MIT",
-  "main": "dist/index.cjs",
-  "typings": "dist/index.d.cts",
+  "main": "./dist/index.cjs",
+  "typings": "./dist/index.d.cts",
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "engines": {
     "node": ">=20"
   },
   "devDependencies": {
-    "@bloks/numbers": "^27.0.0",
     "@eslint/js": "^10.0.1",
     "@size-limit/preset-small-lib": "^14.3.0",
     "@types/lodash.clonedeep": "^4.5.6",
+    "@vitest/coverage-v8": "^5.1.0",
     "eslint": "^10.11.0",
     "size-limit": "^14.3.0",
     "tsdown": "0.22.14",
     "typescript": "~6.0.0",
-    "typescript-eslint": "^8.70.1"
+    "typescript-eslint": "^8.70.1",
+    "vitest": "^5.1.0"
   },
   "dependencies": {
+    "@bloks/numbers": "^27.0.0",
+    "@noble/hashes": "^1.8.0",
+    "@scure/base": "^1.2.6",
     "bignumber.js": "^9.3.1",
     "lodash.clonedeep": "^4.5.0",
     "zod": "^4.6.7"
@@ -50,6 +54,8 @@
     "dev": "tsdown src/index.ts --watch",
     "size": "size-limit",
     "analyze": "size-limit --why",
-    "lint": "eslint ."
+    "lint": "eslint .",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage"
   }
 }