@flashnet/sdk 0.1.1

package/dist/src/utils/spark-address.js

@@ -0,0 +1,227 @@
+import { secp256k1 } from '@noble/curves/secp256k1';
+import { bytesToHex, hexToBytes } from '@noble/hashes/utils';
+import { bech32m } from '@scure/base';
+const AddressNetworkPrefix = {
+    MAINNET: 'sp',
+    TESTNET: 'spt',
+    REGTEST: 'sprt',
+    SIGNET: 'sps',
+    LOCAL: 'spl',
+};
+const PrefixToNetwork = Object.fromEntries(Object.entries(AddressNetworkPrefix).map(([network, prefix]) => [
+    prefix,
+    network,
+]));
+/**
+ * Simple implementation of protobuf-style encoding for SparkAddress
+ * Field 1: identityPublicKey (bytes type)
+ */
+function encodeProto(publicKeyBytes) {
+    // Calculate the total length: tag (1 byte) + length prefix (1 byte) + key bytes
+    const length = 2 + publicKeyBytes.length;
+    const result = new Uint8Array(length);
+    // Field 1, wire type 2 (length-delimited) = tag 10 (1 << 3 | 2)
+    result[0] = 10;
+    // Length of the key bytes
+    result[1] = publicKeyBytes.length;
+    // Copy the key bytes
+    result.set(publicKeyBytes, 2);
+    return result;
+}
+/**
+ * Simple implementation of protobuf-style decoding for SparkAddress
+ */
+function decodeProto(data) {
+    let pos = 0;
+    const result = {
+        identityPublicKey: new Uint8Array(0),
+    };
+    while (pos < data.length) {
+        // Read tag
+        const tag = data[pos++];
+        // Field 1, wire type 2 (length-delimited) = tag 10
+        if (tag === 10) {
+            // Read length
+            const length = data[pos++] ?? 0;
+            // Read bytes
+            result.identityPublicKey = data.slice(pos, pos + length);
+            pos += length;
+        }
+        else {
+            // Skip unknown fields
+            // For simplicity, we only handle field 1 and assume no other fields exist
+            break;
+        }
+    }
+    // Basic validation: check if a public key was actually decoded
+    if (result.identityPublicKey.length === 0) {
+        throw new Error('Failed to decode public key from proto bytes');
+    }
+    return result;
+}
+/**
+ * Encodes a public key and network into a Spark address
+ * @param payload Object containing hex public key and network type
+ * @returns Bech32m encoded Spark address
+ */
+export function encodeSparkAddress(payload) {
+    isValidPublicKey(payload.identityPublicKey);
+    // Convert hex public key to bytes
+    const publicKeyBytes = hexToBytes(payload.identityPublicKey);
+    // Use proto-style encoding to match the original implementation
+    const protoEncoded = encodeProto(publicKeyBytes);
+    // Convert to bech32m words
+    const words = bech32m.toWords(protoEncoded);
+    // Encode with bech32m
+    const prefix = AddressNetworkPrefix[payload.network];
+    const encoded = bech32m.encode(prefix, words, 200);
+    return encoded;
+}
+/**
+ * Decodes a Spark address to extract the public key
+ * @param address Bech32m encoded Spark address
+ * @param network Expected network type (used to check prefix)
+ * @returns Hex-encoded public key
+ * @throws Error if address format, prefix, or decoded key is invalid
+ */
+export function decodeSparkAddress(address, network) {
+    const prefix = AddressNetworkPrefix[network];
+    if (!address?.startsWith(prefix)) {
+        throw new Error(`Invalid Spark address: expected prefix ${prefix}`);
+    }
+    // Decode the bech32m address
+    const sparkAddress = address;
+    const decoded = bech32m.decode(sparkAddress, 200);
+    // Convert words back to bytes
+    const protoBytes = bech32m.fromWords(decoded.words);
+    // Decode the proto format to get the SparkAddress
+    const sparkAddressData = decodeProto(protoBytes);
+    // Convert the public key bytes back to hex
+    const publicKey = bytesToHex(sparkAddressData.identityPublicKey);
+    // Validate the extracted public key
+    isValidPublicKey(publicKey);
+    return publicKey;
+}
+/**
+ * Attempts to determine the network type from a Spark address prefix.
+ * @param address The potential Spark address.
+ * @returns The NetworkType ('MAINNET', 'REGTEST', etc.) or null if the prefix is invalid.
+ */
+export function getNetworkFromAddress(address) {
+    if (!address || typeof address !== 'string') {
+        return null;
+    }
+    const parts = address.split('1');
+    if (parts.length < 2) {
+        return null; // Missing separator '1'
+    }
+    const prefix = parts[0] ?? '';
+    return PrefixToNetwork[prefix] || null; // Return NetworkType or null
+}
+/**
+ * Checks if a string is a valid Spark address for *any* known network,
+ * and optionally validates against a specific network.
+ * @param address String to validate
+ * @param network Optional specific network type to check against
+ * @returns Boolean indicating validity
+ */
+export function isValidSparkAddress(address, network) {
+    try {
+        if (!address?.includes('1')) {
+            return false;
+        }
+        const addressAsPossibleFormat = address;
+        const decoded = bech32m.decode(addressAsPossibleFormat, 200);
+        const prefix = decoded.prefix;
+        // Check if prefix is known
+        const networkFromPrefix = PrefixToNetwork[prefix];
+        if (!networkFromPrefix) {
+            return false; // Unknown prefix
+        }
+        // If a specific network is required, check if it matches
+        if (network && network !== networkFromPrefix) {
+            return false;
+        }
+        // Try to decode the payload and validate the pubkey
+        const protoBytes = bech32m.fromWords(decoded.words);
+        const sparkAddressData = decodeProto(protoBytes);
+        const publicKey = bytesToHex(sparkAddressData.identityPublicKey);
+        isValidPublicKey(publicKey); // Throws on invalid key
+        return true; // All checks passed
+    }
+    catch (_error) {
+        return false;
+    }
+}
+/**
+ * Checks if a string looks like a valid hex-encoded public key (basic check).
+ * Does NOT validate point on curve here, use isValidPublicKey for that.
+ * @param key The potential public key hex string.
+ * @returns True if it matches the basic format, false otherwise.
+ */
+export function looksLikePublicKey(key) {
+    if (!key || typeof key !== 'string') {
+        return false;
+    }
+    return key.length === 66 && /^(02|03)[0-9a-fA-F]{64}$/.test(key);
+}
+/**
+ * Validates a secp256k1 public key format and curve point.
+ * @param publicKey Hex-encoded public key
+ * @throws Error if public key is invalid
+ */
+export function isValidPublicKey(publicKey) {
+    if (!looksLikePublicKey(publicKey)) {
+        throw new Error('Invalid public key format/length.');
+    }
+    try {
+        const point = secp256k1.ProjectivePoint.fromHex(publicKey);
+        point.assertValidity();
+    }
+    catch (error) {
+        const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+        throw new Error(`Invalid public key point: ${errorMessage}`);
+    }
+}
+/**
+ * Converts a Spark address to a specific network.
+ * If the address is already on the requested network, it returns the original address.
+ * Otherwise, it extracts the public key and creates a new address for the target network.
+ *
+ * @param sparkAddress The Spark address to convert
+ * @param targetNetwork The target network ('mainnet' or 'regtest')
+ * @returns The Spark address for the target network or null if conversion fails
+ */
+export function convertSparkAddressToNetwork(sparkAddress, targetNetwork) {
+    try {
+        // Check if the address is valid
+        if (!isValidSparkAddress(sparkAddress)) {
+            return null;
+        }
+        // Extract the current network from the address
+        const currentNetworkType = getNetworkFromAddress(sparkAddress);
+        if (!currentNetworkType) {
+            return null;
+        }
+        // Map the input string to NetworkType
+        const targetNetworkType = targetNetwork === 'mainnet' ? 'MAINNET' : 'REGTEST';
+        // If already on the target network, return the original address
+        if (currentNetworkType === targetNetworkType) {
+            return sparkAddress;
+        }
+        // Extract the public key from the address
+        const decoded = bech32m.decode(sparkAddress, 200);
+        const protoBytes = bech32m.fromWords(decoded.words);
+        const sparkAddressData = decodeProto(protoBytes);
+        const publicKey = bytesToHex(sparkAddressData.identityPublicKey);
+        // Create a new address for the target network
+        return encodeSparkAddress({
+            identityPublicKey: publicKey,
+            network: targetNetworkType,
+        });
+    }
+    catch (_error) {
+        return null;
+    }
+}
+//# sourceMappingURL=spark-address.js.map

package/dist/src/utils/spark-address.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spark-address.js","sourceRoot":"","sources":["../../../src/utils/spark-address.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AActC,MAAM,oBAAoB,GAAgC;IACxD,OAAO,EAAE,IAAI;IACb,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,MAAM;IACf,MAAM,EAAE,KAAK;IACb,KAAK,EAAE,KAAK;CACJ,CAAC;AAEX,MAAM,eAAe,GAAgC,MAAM,CAAC,WAAW,CACrE,MAAM,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC;IAC9D,MAAM;IACN,OAAsB;CACvB,CAAC,CACH,CAAC;AAUF;;;GAGG;AACH,SAAS,WAAW,CAAC,cAA0B;IAC7C,gFAAgF;IAChF,MAAM,MAAM,GAAG,CAAC,GAAG,cAAc,CAAC,MAAM,CAAC;IACzC,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IAEtC,gEAAgE;IAChE,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;IAEf,0BAA0B;IAC1B,MAAM,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,MAAM,CAAC;IAElC,qBAAqB;IACrB,MAAM,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;IAE9B,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,SAAS,WAAW,CAAC,IAAgB;IACnC,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,MAAM,MAAM,GAAiB;QAC3B,iBAAiB,EAAE,IAAI,UAAU,CAAC,CAAC,CAAC;KACrC,CAAC;IAEF,OAAO,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACzB,WAAW;QACX,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAExB,mDAAmD;QACnD,IAAI,GAAG,KAAK,EAAE,EAAE,CAAC;YACf,cAAc;YACd,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;YAEhC,aAAa;YACb,MAAM,CAAC,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,CAAC,CAAC;YACzD,GAAG,IAAI,MAAM,CAAC;QAChB,CAAC;aAAM,CAAC;YACN,sBAAsB;YACtB,0EAA0E;YAC1E,MAAM;QACR,CAAC;IACH,CAAC;IACD,+DAA+D;IAC/D,IAAI,MAAM,CAAC,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAyB;IAEzB,gBAAgB,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAE5C,kCAAkC;IAClC,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAE7D,gEAAgE;IAChE,MAAM,YAAY,GAAG,WAAW,CAAC,cAAc,CAAC,CAAC;IAEjD,2BAA2B;IAC3B,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAE5C,sBAAsB;IACtB,MAAM,MAAM,GAAG,oBAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACrD,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAEnD,OAAO,OAA6B,CAAC;AACvC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAe,EACf,OAAoB;IAEpB,MAAM,MAAM,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAC7C,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,0CAA0C,MAAM,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,6BAA6B;IAC7B,MAAM,YAAY,GAAG,OAA6B,CAAC;IACnD,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;IAElD,8BAA8B;IAC9B,MAAM,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAEpD,kDAAkD;IAClD,MAAM,gBAAgB,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;IAEjD,2CAA2C;IAC3C,MAAM,SAAS,GAAG,UAAU,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;IAEjE,oCAAoC;IACpC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAE5B,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,OAAe;IACnD,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC5C,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACjC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC,CAAC,wBAAwB;IACvC,CAAC;IACD,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC9B,OAAO,eAAe,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,6BAA6B;AACvE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CACjC,OAAe,EACf,OAAqB;IAErB,IAAI,CAAC;QACH,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,uBAAuB,GAAG,OAA6B,CAAC;QAC9D,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC;QAC7D,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAE9B,2BAA2B;QAC3B,MAAM,iBAAiB,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACvB,OAAO,KAAK,CAAC,CAAC,iBAAiB;QACjC,CAAC;QAED,yDAAyD;QACzD,IAAI,OAAO,IAAI,OAAO,KAAK,iBAAiB,EAAE,CAAC;YAC7C,OAAO,KAAK,CAAC;QACf,CAAC;QAED,oDAAoD;QACpD,MAAM,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACpD,MAAM,gBAAgB,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;QACjD,MAAM,SAAS,GAAG,UAAU,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;QACjE,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,wBAAwB;QAErD,OAAO,IAAI,CAAC,CAAC,oBAAoB;IACnC,CAAC;IAAC,OAAO,MAAe,EAAE,CAAC;QACzB,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,GAAW;IAC5C,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,GAAG,CAAC,MAAM,KAAK,EAAE,IAAI,0BAA0B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACnE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,SAAiB;IAChD,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACvD,CAAC;IACD,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,SAAS,CAAC,eAAe,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC3D,KAAK,CAAC,cAAc,EAAE,CAAC;IACzB,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,MAAM,YAAY,GAChB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;QAC3D,MAAM,IAAI,KAAK,CAAC,6BAA6B,YAAY,EAAE,CAAC,CAAC;IAC/D,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,4BAA4B,CAC1C,YAAoB,EACpB,aAAoC;IAEpC,IAAI,CAAC;QACH,gCAAgC;QAChC,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,EAAE,CAAC;YACvC,OAAO,IAAI,CAAC;QACd,CAAC;QAED,+CAA+C;QAC/C,MAAM,kBAAkB,GAAG,qBAAqB,CAAC,YAAY,CAAC,CAAC;QAC/D,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,sCAAsC;QACtC,MAAM,iBAAiB,GACrB,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;QAEtD,gEAAgE;QAChE,IAAI,kBAAkB,KAAK,iBAAiB,EAAE,CAAC;YAC7C,OAAO,YAAY,CAAC;QACtB,CAAC;QAED,0CAA0C;QAC1C,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,YAAkC,EAAE,GAAG,CAAC,CAAC;QACxE,MAAM,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACpD,MAAM,gBAAgB,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;QACjD,MAAM,SAAS,GAAG,UAAU,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;QAEjE,8CAA8C;QAC9C,OAAO,kBAAkB,CAAC;YACxB,iBAAiB,EAAE,SAAS;YAC5B,OAAO,EAAE,iBAAiB;SAC3B,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,MAAe,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@flashnet/sdk",
+  "version": "0.1.1",
+  "module": "dist/index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "2.0.5",
+    "@types/bun": "latest",
+    "@types/node": "^20.0.0",
+    "typescript": "^5"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "@buildonspark/issuer-sdk": "^0.0.74",
+    "@buildonspark/spark-sdk": "0.1.43",
+    "@noble/curves": "^1.7.0",
+    "@noble/hashes": "^1.8.0",
+    "@noble/secp256k1": "^2.3.0",
+    "@scure/base": "^1.2.1"
+  },
+  "author": "",
+  "license": "MIT",
+  "description": "Flashnet SDK for Spark wallet operations and AMM interactions"
+}