@leather.io/stacks 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Leather Wallet LLC [a subsidiary of Nassau Machines]
+
+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/dist/index.d.ts

@@ -0,0 +1,44 @@
+import * as _stacks_transactions from '@stacks/transactions';
+import { ChainID, StacksPrivateKey, ClarityValue } from '@stacks/transactions';
+import { HDKey } from '@scure/bip32';
+import { NetworkModes } from '@leather.io/models';
+
+declare const stxDerivationWithAccount = "m/44'/5757'/0'/0/{account}";
+declare function makeAccountIndexDerivationPathFactory(derivationPath: string): (account: number) => string;
+declare function extractStacksDerivationPathAccountIndex(path: string): number;
+/**
+ * Stacks accounts always use the same derivation path, regardless of network
+ */
+declare const makeStxDerivationPath: (account: number) => string;
+declare function stacksChainIdToCoreNetworkMode(chainId: ChainID): NetworkModes;
+interface WhenStacksChainIdMap<T> {
+    [ChainID.Mainnet]: T;
+    [ChainID.Testnet]: T;
+}
+declare function whenStacksChainId(chainId: ChainID): <T>(chainIdMap: WhenStacksChainIdMap<T>) => T;
+declare function deriveStxPrivateKey({ keychain, index }: {
+    keychain: HDKey;
+    index: number;
+}): string;
+declare function deriveStxPublicKey({ keychain, index }: {
+    keychain: HDKey;
+    index: number;
+}): _stacks_transactions.StacksPublicKey;
+declare function stacksRootKeychainToAccountDescriptor(keychain: HDKey, accountIndex: number): string;
+declare function initalizeStacksAccount(descriptor: string, network: NetworkModes): {
+    descriptor: string;
+    keyOrigin: string;
+    fingerprint: string;
+    accountIndex: number;
+    publicKey: _stacks_transactions.StacksPublicKey;
+    address: string;
+};
+
+interface SignatureData {
+    signature: string;
+    publicKey: string;
+}
+declare function signMessage(message: string, privateKey: StacksPrivateKey): SignatureData;
+declare function signStructuredDataMessage(message: ClarityValue, domain: ClarityValue, privateKey: StacksPrivateKey): SignatureData;
+
+export { deriveStxPrivateKey, deriveStxPublicKey, extractStacksDerivationPathAccountIndex, initalizeStacksAccount, makeAccountIndexDerivationPathFactory, makeStxDerivationPath, signMessage, signStructuredDataMessage, stacksChainIdToCoreNetworkMode, stacksRootKeychainToAccountDescriptor, stxDerivationWithAccount, whenStacksChainId };

package/dist/index.js

@@ -0,0 +1,116 @@
+// src/stacks.utils.ts
+import { bytesToHex } from "@noble/hashes/utils";
+import { compressPrivateKey } from "@stacks/encryption";
+import {
+  AddressVersion,
+  ChainID,
+  createStacksPrivateKey,
+  createStacksPublicKey,
+  getPublicKey,
+  publicKeyToAddress
+} from "@stacks/transactions";
+import {
+  DerivationPathDepth,
+  createDescriptor,
+  createKeyOriginPath,
+  extractAddressIndexFromPath,
+  extractFingerprintFromKeyOriginPath,
+  extractKeyFromDescriptor,
+  extractKeyOriginPathFromDescriptor
+} from "@leather.io/crypto";
+import { assertIsTruthy, toHexString, whenNetwork } from "@leather.io/utils";
+var stxDerivationWithAccount = `m/44'/5757'/0'/0/{account}`;
+function makeAccountIndexDerivationPathFactory(derivationPath) {
+  return (account) => derivationPath.replace("{account}", account.toString());
+}
+function extractStacksDerivationPathAccountIndex(path) {
+  if (!path.includes("5757")) throw new Error("Not a valid Stacks derivation path: " + path);
+  return extractAddressIndexFromPath(path);
+}
+var makeStxDerivationPath = makeAccountIndexDerivationPathFactory(stxDerivationWithAccount);
+function stacksChainIdToCoreNetworkMode(chainId) {
+  return whenStacksChainId(chainId)({ [ChainID.Mainnet]: "mainnet", [ChainID.Testnet]: "testnet" });
+}
+function whenStacksChainId(chainId) {
+  return (chainIdMap) => chainIdMap[chainId];
+}
+function deriveStxPrivateKey({ keychain, index }) {
+  if (keychain.depth !== DerivationPathDepth.Root) throw new Error("Root keychain must be depth 0");
+  const accountKeychain = keychain.derive(makeStxDerivationPath(index));
+  assertIsTruthy(accountKeychain.privateKey);
+  return bytesToHex(compressPrivateKey(accountKeychain.privateKey));
+}
+function deriveStxPublicKey({ keychain, index }) {
+  return getPublicKey(createStacksPrivateKey(deriveStxPrivateKey({ keychain, index })));
+}
+function stacksRootKeychainToAccountDescriptor(keychain, accountIndex) {
+  const fingerprint = toHexString(keychain.fingerprint);
+  const publicKey = deriveStxPublicKey({ keychain, index: accountIndex });
+  return createDescriptor(
+    createKeyOriginPath(fingerprint, makeStxDerivationPath(accountIndex)),
+    bytesToHex(publicKey.data)
+  );
+}
+function initalizeStacksAccount(descriptor, network) {
+  const keyOrigin = extractKeyOriginPathFromDescriptor(descriptor);
+  const pubKey = extractKeyFromDescriptor(descriptor);
+  const accountIndex = extractStacksDerivationPathAccountIndex(keyOrigin);
+  const publicKey = createStacksPublicKey(pubKey);
+  return {
+    descriptor,
+    keyOrigin,
+    fingerprint: extractFingerprintFromKeyOriginPath(keyOrigin),
+    accountIndex,
+    publicKey,
+    address: publicKeyToAddress(
+      whenNetwork(network)({
+        mainnet: AddressVersion.MainnetSingleSig,
+        testnet: AddressVersion.TestnetSingleSig
+      }),
+      publicKey
+    )
+  };
+}
+
+// src/message-signing.ts
+import { bytesToHex as bytesToHex2 } from "@noble/hashes/utils";
+import { hashMessage } from "@stacks/encryption";
+import {
+  getPublicKey as getPublicKey2,
+  publicKeyToString,
+  signMessageHashRsv,
+  signStructuredData
+} from "@stacks/transactions";
+function signMessage(message, privateKey) {
+  const hash = hashMessage(message);
+  return {
+    signature: signMessageHashRsv({ privateKey, messageHash: bytesToHex2(hash) }).data,
+    publicKey: publicKeyToString(getPublicKey2(privateKey))
+  };
+}
+function signStructuredDataMessage(message, domain, privateKey) {
+  const signature = signStructuredData({
+    message,
+    domain,
+    privateKey
+  }).data;
+  return {
+    signature,
+    publicKey: publicKeyToString(getPublicKey2(privateKey))
+  };
+}
+export {
+  deriveStxPrivateKey,
+  deriveStxPublicKey,
+  extractStacksDerivationPathAccountIndex,
+  initalizeStacksAccount,
+  makeAccountIndexDerivationPathFactory,
+  makeStxDerivationPath,
+  signMessage,
+  signStructuredDataMessage,
+  stacksChainIdToCoreNetworkMode,
+  stacksRootKeychainToAccountDescriptor,
+  stxDerivationWithAccount,
+  whenStacksChainId
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/stacks.utils.ts","../src/message-signing.ts"],"sourcesContent":["import { bytesToHex } from '@noble/hashes/utils';\nimport { HDKey } from '@scure/bip32';\nimport { compressPrivateKey } from '@stacks/encryption';\nimport {\n  AddressVersion,\n  ChainID,\n  createStacksPrivateKey,\n  createStacksPublicKey,\n  getPublicKey,\n  publicKeyToAddress,\n} from '@stacks/transactions';\n\nimport {\n  DerivationPathDepth,\n  createDescriptor,\n  createKeyOriginPath,\n  extractAddressIndexFromPath,\n  extractFingerprintFromKeyOriginPath,\n  extractKeyFromDescriptor,\n  extractKeyOriginPathFromDescriptor,\n} from '@leather.io/crypto';\nimport type { NetworkModes } from '@leather.io/models';\nimport { assertIsTruthy, toHexString, whenNetwork } from '@leather.io/utils';\n\nexport const stxDerivationWithAccount = `m/44'/5757'/0'/0/{account}`;\n\nexport function makeAccountIndexDerivationPathFactory(derivationPath: string) {\n  return (account: number) => derivationPath.replace('{account}', account.toString());\n}\n\nexport function extractStacksDerivationPathAccountIndex(path: string) {\n  if (!path.includes('5757')) throw new Error('Not a valid Stacks derivation path: ' + path);\n  return extractAddressIndexFromPath(path);\n}\n\n/**\n * Stacks accounts always use the same derivation path, regardless of network\n */\nexport const makeStxDerivationPath =\n  makeAccountIndexDerivationPathFactory(stxDerivationWithAccount);\n\nexport function stacksChainIdToCoreNetworkMode(chainId: ChainID): NetworkModes {\n  return whenStacksChainId(chainId)({ [ChainID.Mainnet]: 'mainnet', [ChainID.Testnet]: 'testnet' });\n}\n\ninterface WhenStacksChainIdMap<T> {\n  [ChainID.Mainnet]: T;\n  [ChainID.Testnet]: T;\n}\nexport function whenStacksChainId(chainId: ChainID) {\n  return <T>(chainIdMap: WhenStacksChainIdMap<T>): T => chainIdMap[chainId];\n}\n\n// From `@stacks/wallet-sdk` package we are trying not to use\nexport function deriveStxPrivateKey({ keychain, index }: { keychain: HDKey; index: number }) {\n  if (keychain.depth !== DerivationPathDepth.Root) throw new Error('Root keychain must be depth 0');\n  const accountKeychain = keychain.derive(makeStxDerivationPath(index));\n  assertIsTruthy(accountKeychain.privateKey);\n  return bytesToHex(compressPrivateKey(accountKeychain.privateKey));\n}\n\nexport function deriveStxPublicKey({ keychain, index }: { keychain: HDKey; index: number }) {\n  return getPublicKey(createStacksPrivateKey(deriveStxPrivateKey({ keychain, index })));\n}\n\nexport function stacksRootKeychainToAccountDescriptor(keychain: HDKey, accountIndex: number) {\n  const fingerprint = toHexString(keychain.fingerprint);\n  const publicKey = deriveStxPublicKey({ keychain, index: accountIndex });\n  return createDescriptor(\n    createKeyOriginPath(fingerprint, makeStxDerivationPath(accountIndex)),\n    bytesToHex(publicKey.data)\n  );\n}\n\nexport function initalizeStacksAccount(descriptor: string, network: NetworkModes) {\n  const keyOrigin = extractKeyOriginPathFromDescriptor(descriptor);\n  const pubKey = extractKeyFromDescriptor(descriptor);\n  const accountIndex = extractStacksDerivationPathAccountIndex(keyOrigin);\n  const publicKey = createStacksPublicKey(pubKey);\n\n  return {\n    descriptor,\n    keyOrigin,\n    fingerprint: extractFingerprintFromKeyOriginPath(keyOrigin),\n    accountIndex,\n    publicKey,\n    address: publicKeyToAddress(\n      whenNetwork(network)({\n        mainnet: AddressVersion.MainnetSingleSig,\n        testnet: AddressVersion.TestnetSingleSig,\n      }),\n      publicKey\n    ),\n  };\n}\n","import { bytesToHex } from '@noble/hashes/utils';\nimport { hashMessage } from '@stacks/encryption';\nimport {\n  ClarityValue,\n  StacksPrivateKey,\n  getPublicKey,\n  publicKeyToString,\n  signMessageHashRsv,\n  signStructuredData,\n} from '@stacks/transactions';\n\ninterface SignatureData {\n  signature: string;\n  publicKey: string;\n}\n\nexport function signMessage(message: string, privateKey: StacksPrivateKey): SignatureData {\n  const hash = hashMessage(message);\n  return {\n    signature: signMessageHashRsv({ privateKey, messageHash: bytesToHex(hash) }).data,\n    publicKey: publicKeyToString(getPublicKey(privateKey)),\n  };\n}\n\nexport function signStructuredDataMessage(\n  message: ClarityValue,\n  domain: ClarityValue,\n  privateKey: StacksPrivateKey\n): SignatureData {\n  const signature = signStructuredData({\n    message,\n    domain,\n    privateKey,\n  }).data;\n\n  return {\n    signature,\n    publicKey: publicKeyToString(getPublicKey(privateKey)),\n  };\n}\n"],"mappings":";AAAA,SAAS,kBAAkB;AAE3B,SAAS,0BAA0B;AACnC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP,SAAS,gBAAgB,aAAa,mBAAmB;AAElD,IAAM,2BAA2B;AAEjC,SAAS,sCAAsC,gBAAwB;AAC5E,SAAO,CAAC,YAAoB,eAAe,QAAQ,aAAa,QAAQ,SAAS,CAAC;AACpF;AAEO,SAAS,wCAAwC,MAAc;AACpE,MAAI,CAAC,KAAK,SAAS,MAAM,EAAG,OAAM,IAAI,MAAM,yCAAyC,IAAI;AACzF,SAAO,4BAA4B,IAAI;AACzC;AAKO,IAAM,wBACX,sCAAsC,wBAAwB;AAEzD,SAAS,+BAA+B,SAAgC;AAC7E,SAAO,kBAAkB,OAAO,EAAE,EAAE,CAAC,QAAQ,OAAO,GAAG,WAAW,CAAC,QAAQ,OAAO,GAAG,UAAU,CAAC;AAClG;AAMO,SAAS,kBAAkB,SAAkB;AAClD,SAAO,CAAI,eAA2C,WAAW,OAAO;AAC1E;AAGO,SAAS,oBAAoB,EAAE,UAAU,MAAM,GAAuC;AAC3F,MAAI,SAAS,UAAU,oBAAoB,KAAM,OAAM,IAAI,MAAM,+BAA+B;AAChG,QAAM,kBAAkB,SAAS,OAAO,sBAAsB,KAAK,CAAC;AACpE,iBAAe,gBAAgB,UAAU;AACzC,SAAO,WAAW,mBAAmB,gBAAgB,UAAU,CAAC;AAClE;AAEO,SAAS,mBAAmB,EAAE,UAAU,MAAM,GAAuC;AAC1F,SAAO,aAAa,uBAAuB,oBAAoB,EAAE,UAAU,MAAM,CAAC,CAAC,CAAC;AACtF;AAEO,SAAS,sCAAsC,UAAiB,cAAsB;AAC3F,QAAM,cAAc,YAAY,SAAS,WAAW;AACpD,QAAM,YAAY,mBAAmB,EAAE,UAAU,OAAO,aAAa,CAAC;AACtE,SAAO;AAAA,IACL,oBAAoB,aAAa,sBAAsB,YAAY,CAAC;AAAA,IACpE,WAAW,UAAU,IAAI;AAAA,EAC3B;AACF;AAEO,SAAS,uBAAuB,YAAoB,SAAuB;AAChF,QAAM,YAAY,mCAAmC,UAAU;AAC/D,QAAM,SAAS,yBAAyB,UAAU;AAClD,QAAM,eAAe,wCAAwC,SAAS;AACtE,QAAM,YAAY,sBAAsB,MAAM;AAE9C,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,aAAa,oCAAoC,SAAS;AAAA,IAC1D;AAAA,IACA;AAAA,IACA,SAAS;AAAA,MACP,YAAY,OAAO,EAAE;AAAA,QACnB,SAAS,eAAe;AAAA,QACxB,SAAS,eAAe;AAAA,MAC1B,CAAC;AAAA,MACD;AAAA,IACF;AAAA,EACF;AACF;;;AC9FA,SAAS,cAAAA,mBAAkB;AAC3B,SAAS,mBAAmB;AAC5B;AAAA,EAGE,gBAAAC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAOA,SAAS,YAAY,SAAiB,YAA6C;AACxF,QAAM,OAAO,YAAY,OAAO;AAChC,SAAO;AAAA,IACL,WAAW,mBAAmB,EAAE,YAAY,aAAaD,YAAW,IAAI,EAAE,CAAC,EAAE;AAAA,IAC7E,WAAW,kBAAkBC,cAAa,UAAU,CAAC;AAAA,EACvD;AACF;AAEO,SAAS,0BACd,SACA,QACA,YACe;AACf,QAAM,YAAY,mBAAmB;AAAA,IACnC;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC,EAAE;AAEH,SAAO;AAAA,IACL;AAAA,IACA,WAAW,kBAAkBA,cAAa,UAAU,CAAC;AAAA,EACvD;AACF;","names":["bytesToHex","getPublicKey"]}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@leather.io/stacks",
+  "author": "leather.io",
+  "description": "Stacks package for Leather",
+  "version": "0.0.1",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "dependencies": {
+    "@noble/hashes": "1.4.0",
+    "@scure/bip32": "1.4.0",
+    "@stacks/encryption": "6.16.1",
+    "@stacks/transactions": "6.15.0",
+    "@leather.io/crypto": "1.3.0",
+    "@leather.io/models": "0.11.0",
+    "@leather.io/utils": "0.12.0"
+  },
+  "devDependencies": {
+    "tsup": "8.1.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "build:watch": "tsup --watch",
+    "prepublish": "pnpm build",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit",
+    "types": "tsc --declaration --emitDeclarationOnly"
+  }
+}