@leather.io/models 0.10.0

package/dist/index.js

@@ -0,0 +1,284 @@
+// src/crypto-assets/crypto-asset-balance.model.ts
+function createCryptoAssetBalance(balance) {
+  return { availableBalance: balance };
+}
+
+// src/network.model.ts
+var HIRO_API_BASE_URL_MAINNET = "https://api.hiro.so";
+var HIRO_API_BASE_URL_TESTNET = "https://api.testnet.hiro.so";
+var HIRO_INSCRIPTIONS_API_URL = "https://api.hiro.so/ordinals/v1/inscriptions";
+var HIRO_API_BASE_URL_NAKAMOTO_TESTNET = "https://api.nakamoto.testnet.hiro.so";
+var BITCOIN_API_BASE_URL_MAINNET = "https://blockstream.info/api";
+var BITCOIN_API_BASE_URL_TESTNET = "https://blockstream.info/testnet/api";
+var BITCOIN_API_BASE_URL_SIGNET = "https://mempool.space/signet/api";
+var BESTINSLOT_API_BASE_URL_MAINNET = "https://leatherapi.bestinslot.xyz/v3";
+var BESTINSLOT_API_BASE_URL_TESTNET = "https://leatherapi_testnet.bestinslot.xyz/v3";
+var STX20_API_BASE_URL_MAINNET = "https://api.stx20.com/api/v1";
+var ChainID = /* @__PURE__ */ ((ChainID2) => {
+  ChainID2[ChainID2["Testnet"] = 2147483648] = "Testnet";
+  ChainID2[ChainID2["Mainnet"] = 1] = "Mainnet";
+  return ChainID2;
+})(ChainID || {});
+var WalletDefaultNetworkConfigurationIds = /* @__PURE__ */ ((WalletDefaultNetworkConfigurationIds2) => {
+  WalletDefaultNetworkConfigurationIds2["mainnet"] = "mainnet";
+  WalletDefaultNetworkConfigurationIds2["testnet"] = "testnet";
+  WalletDefaultNetworkConfigurationIds2["signet"] = "signet";
+  WalletDefaultNetworkConfigurationIds2["sbtcDevenv"] = "sbtcDevenv";
+  WalletDefaultNetworkConfigurationIds2["devnet"] = "devnet";
+  return WalletDefaultNetworkConfigurationIds2;
+})(WalletDefaultNetworkConfigurationIds || {});
+var networkMainnet = {
+  id: "mainnet" /* mainnet */,
+  name: "Mainnet",
+  chain: {
+    stacks: {
+      blockchain: "stacks",
+      chainId: 1 /* Mainnet */,
+      url: HIRO_API_BASE_URL_MAINNET
+    },
+    bitcoin: {
+      blockchain: "bitcoin",
+      bitcoinNetwork: "mainnet",
+      bitcoinUrl: BITCOIN_API_BASE_URL_MAINNET
+    }
+  }
+};
+var networkTestnet = {
+  id: "testnet" /* testnet */,
+  name: "Testnet",
+  chain: {
+    stacks: {
+      blockchain: "stacks",
+      chainId: 2147483648 /* Testnet */,
+      url: HIRO_API_BASE_URL_TESTNET
+    },
+    bitcoin: {
+      blockchain: "bitcoin",
+      bitcoinNetwork: "testnet",
+      bitcoinUrl: BITCOIN_API_BASE_URL_TESTNET
+    }
+  }
+};
+var networkSignet = {
+  id: "signet" /* signet */,
+  name: "Signet",
+  chain: {
+    stacks: {
+      blockchain: "stacks",
+      chainId: 2147483648 /* Testnet */,
+      url: HIRO_API_BASE_URL_TESTNET
+    },
+    bitcoin: {
+      blockchain: "bitcoin",
+      bitcoinNetwork: "signet",
+      bitcoinUrl: BITCOIN_API_BASE_URL_SIGNET
+    }
+  }
+};
+var networkSbtcDevenv = {
+  id: "sbtcDevenv" /* sbtcDevenv */,
+  name: "sBTC Devenv",
+  chain: {
+    stacks: {
+      blockchain: "stacks",
+      chainId: 2147483648 /* Testnet */,
+      url: "http://localhost:3999"
+    },
+    bitcoin: {
+      blockchain: "bitcoin",
+      bitcoinNetwork: "regtest",
+      bitcoinUrl: "http://localhost:8999/api"
+    }
+  }
+};
+var networkDevnet = {
+  id: "devnet" /* devnet */,
+  name: "Devnet",
+  chain: {
+    stacks: {
+      blockchain: "stacks",
+      chainId: 2147483648 /* Testnet */,
+      url: "http://localhost:3999"
+    },
+    bitcoin: {
+      blockchain: "bitcoin",
+      bitcoinNetwork: "regtest",
+      bitcoinUrl: "http://localhost:18443"
+    }
+  }
+};
+var defaultCurrentNetwork = networkMainnet;
+var defaultNetworksKeyedById = {
+  ["mainnet" /* mainnet */]: networkMainnet,
+  ["testnet" /* testnet */]: networkTestnet,
+  ["signet" /* signet */]: networkSignet,
+  ["sbtcDevenv" /* sbtcDevenv */]: networkSbtcDevenv,
+  ["devnet" /* devnet */]: networkDevnet
+};
+
+// src/crypto-assets/bitcoin/inscription.model.ts
+function whenInscriptionMimeType(mimeType, branches) {
+  if (mimeType.startsWith("audio/") && branches.audio) {
+    return branches.audio();
+  }
+  if (mimeType.startsWith("text/html") && branches.html) {
+    return branches.html();
+  }
+  if (mimeType.startsWith("image/svg") && branches.svg) {
+    return branches.svg();
+  }
+  if (mimeType.startsWith("image/") && branches.image) {
+    return branches.image();
+  }
+  if (mimeType.startsWith("text") && branches.text) {
+    return branches.text();
+  }
+  if (mimeType.startsWith("video/") && branches.video) {
+    return branches.video();
+  }
+  if (mimeType.startsWith("model/gltf") && branches.gltf) {
+    return branches.gltf();
+  }
+  if (branches.other) return branches.other();
+  throw new Error("Unhandled inscription type");
+}
+function createInscription(inscription) {
+  const contentSrc = `${HIRO_INSCRIPTIONS_API_URL}/${inscription.id}/content`;
+  const iframeSrc = `https://ordinals.com/preview/${inscription.id}`;
+  const preview = `https://ordinals.hiro.so/inscription/${inscription.id}`;
+  const title = `Inscription ${inscription.number}`;
+  const sharedInfo = {
+    id: inscription.id,
+    number: inscription.number,
+    output: inscription.output,
+    txid: inscription.txid,
+    offset: inscription.offset,
+    address: inscription.address,
+    genesisBlockHash: inscription.genesisBlockHash,
+    genesisTimestamp: inscription.genesisTimestamp,
+    genesisBlockHeight: inscription.genesisBlockHeight,
+    value: inscription.value,
+    preview,
+    title
+  };
+  return whenInscriptionMimeType(inscription.contentType, {
+    audio: () => ({
+      ...sharedInfo,
+      mimeType: "audio",
+      name: "inscription",
+      src: iframeSrc
+    }),
+    gltf: () => ({
+      ...sharedInfo,
+      mimeType: "gltf",
+      name: "inscription",
+      src: iframeSrc
+    }),
+    html: () => ({
+      ...sharedInfo,
+      mimeType: "html",
+      name: "inscription",
+      src: iframeSrc
+    }),
+    image: () => ({
+      ...sharedInfo,
+      mimeType: "image",
+      name: "inscription",
+      src: contentSrc
+    }),
+    svg: () => ({
+      ...sharedInfo,
+      mimeType: "svg",
+      name: "inscription",
+      src: iframeSrc
+    }),
+    text: () => ({
+      ...sharedInfo,
+      mimeType: "text",
+      name: "inscription",
+      src: contentSrc
+    }),
+    video: () => ({
+      ...sharedInfo,
+      mimeType: "video",
+      name: "inscription",
+      src: iframeSrc
+    }),
+    other: () => ({
+      ...sharedInfo,
+      mimeType: "other",
+      name: "inscription",
+      src: ""
+    })
+  });
+}
+
+// src/fees/bitcoin-fees.model.ts
+var btcTxTimeMap = {
+  fastestFee: "~10 \u2013 20min",
+  halfHourFee: "~30 min",
+  hourFee: "~1 hour+"
+};
+var BtcFeeType = /* @__PURE__ */ ((BtcFeeType2) => {
+  BtcFeeType2["High"] = "High";
+  BtcFeeType2["Standard"] = "Standard";
+  BtcFeeType2["Low"] = "Low";
+  return BtcFeeType2;
+})(BtcFeeType || {});
+
+// src/fees/fees.model.ts
+var FeeTypes = /* @__PURE__ */ ((FeeTypes2) => {
+  FeeTypes2[FeeTypes2["Low"] = 0] = "Low";
+  FeeTypes2[FeeTypes2["Middle"] = 1] = "Middle";
+  FeeTypes2[FeeTypes2["High"] = 2] = "High";
+  FeeTypes2[FeeTypes2["Custom"] = 3] = "Custom";
+  FeeTypes2[FeeTypes2["Unknown"] = 4] = "Unknown";
+  return FeeTypes2;
+})(FeeTypes || {});
+var FeeCalculationTypes = /* @__PURE__ */ ((FeeCalculationTypes2) => {
+  FeeCalculationTypes2["Api"] = "api";
+  FeeCalculationTypes2["Default"] = "default";
+  FeeCalculationTypes2["DefaultSimulated"] = "default-simulated";
+  FeeCalculationTypes2["FeesCapped"] = "fees-capped";
+  return FeeCalculationTypes2;
+})(FeeCalculationTypes || {});
+
+// src/market.model.ts
+function createMarketPair(base, quote) {
+  return Object.freeze({ base, quote });
+}
+function formatMarketPair({ base, quote }) {
+  return `${base}/${quote}`;
+}
+function createMarketData(pair, price) {
+  if (pair.quote !== price.symbol)
+    throw new Error("Cannot create market data when price does not match quote");
+  return Object.freeze({ pair, price });
+}
+export {
+  BESTINSLOT_API_BASE_URL_MAINNET,
+  BESTINSLOT_API_BASE_URL_TESTNET,
+  BITCOIN_API_BASE_URL_MAINNET,
+  BITCOIN_API_BASE_URL_SIGNET,
+  BITCOIN_API_BASE_URL_TESTNET,
+  BtcFeeType,
+  ChainID,
+  FeeCalculationTypes,
+  FeeTypes,
+  HIRO_API_BASE_URL_MAINNET,
+  HIRO_API_BASE_URL_NAKAMOTO_TESTNET,
+  HIRO_API_BASE_URL_TESTNET,
+  HIRO_INSCRIPTIONS_API_URL,
+  STX20_API_BASE_URL_MAINNET,
+  WalletDefaultNetworkConfigurationIds,
+  btcTxTimeMap,
+  createCryptoAssetBalance,
+  createInscription,
+  createMarketData,
+  createMarketPair,
+  defaultCurrentNetwork,
+  defaultNetworksKeyedById,
+  formatMarketPair,
+  whenInscriptionMimeType
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/crypto-assets/crypto-asset-balance.model.ts","../src/network.model.ts","../src/crypto-assets/bitcoin/inscription.model.ts","../src/fees/bitcoin-fees.model.ts","../src/fees/fees.model.ts","../src/market.model.ts"],"sourcesContent":["import { Money } from '../money.model';\n\nexport interface BaseCryptoAssetBalance {\n  /**\n   * totalBalance after filtering out outboundBalance, protectedBalance, and uneconomicalBalance\n   */\n  readonly availableBalance: Money;\n}\n\nexport interface BtcCryptoAssetBalance extends BaseCryptoAssetBalance {\n  /**\n   * Balance of UTXOs with collectibles\n   */\n  readonly protectedBalance: Money;\n  /**\n   * Balance across UTXOs with need for larger fee than principal by UTXO given standard rate\n   */\n  readonly uneconomicalBalance: Money;\n}\n\nexport interface StxCryptoAssetBalance extends BaseCryptoAssetBalance {\n  /**\n   * availableBalance minus lockedBalance\n   */\n  readonly availableUnlockedBalance: Money;\n  /**\n   * Balance of pending receipt into account given pending transactions\n   */\n  readonly inboundBalance: Money;\n  /**\n   * totalBalance minus total amount locked by contracts\n   */\n  readonly lockedBalance: Money;\n  /**\n   * Balance of pending delivery from account given pending transactions\n   */\n  readonly outboundBalance: Money;\n  /**\n   * totalBalance plus inboundBalance minus outboundBalance\n   */\n  readonly pendingBalance: Money;\n  /**\n   * Balance as confirmed on chain\n   */\n  readonly totalBalance: Money;\n  /**\n   * totalBalance minus lockedBalance\n   */\n  readonly unlockedBalance: Money;\n}\n\nexport type CryptoAssetBalance =\n  | BaseCryptoAssetBalance\n  | BtcCryptoAssetBalance\n  | StxCryptoAssetBalance;\n\nexport function createCryptoAssetBalance(balance: Money): BaseCryptoAssetBalance {\n  return { availableBalance: balance };\n}\n","import { Blockchains } from './types';\n\nexport const HIRO_API_BASE_URL_MAINNET = 'https://api.hiro.so';\nexport const HIRO_API_BASE_URL_TESTNET = 'https://api.testnet.hiro.so';\nexport const HIRO_INSCRIPTIONS_API_URL = 'https://api.hiro.so/ordinals/v1/inscriptions';\nexport const HIRO_API_BASE_URL_NAKAMOTO_TESTNET = 'https://api.nakamoto.testnet.hiro.so';\n\nexport const BITCOIN_API_BASE_URL_MAINNET = 'https://blockstream.info/api';\nexport const BITCOIN_API_BASE_URL_TESTNET = 'https://blockstream.info/testnet/api';\nexport const BITCOIN_API_BASE_URL_SIGNET = 'https://mempool.space/signet/api';\n\nexport const BESTINSLOT_API_BASE_URL_MAINNET = 'https://leatherapi.bestinslot.xyz/v3';\nexport const BESTINSLOT_API_BASE_URL_TESTNET = 'https://leatherapi_testnet.bestinslot.xyz/v3';\n\nexport const STX20_API_BASE_URL_MAINNET = 'https://api.stx20.com/api/v1';\n\n// Copied from @stacks/transactions to avoid dependencies\nexport enum ChainID {\n  Testnet = 2147483648,\n  Mainnet = 1,\n}\n\nexport enum WalletDefaultNetworkConfigurationIds {\n  mainnet = 'mainnet',\n  testnet = 'testnet',\n  signet = 'signet',\n  sbtcDevenv = 'sbtcDevenv',\n  devnet = 'devnet',\n}\n\nexport type DefaultNetworkConfigurations = keyof typeof WalletDefaultNetworkConfigurationIds;\n\nconst supportedBlockchains = ['stacks', 'bitcoin'] as const;\n\nexport type SupportedBlockchains = (typeof supportedBlockchains)[number];\n\nconst networkModes = ['mainnet', 'testnet'] as const;\n\nexport type NetworkModes = (typeof networkModes)[number];\n\ntype BitcoinTestnetModes = 'testnet' | 'regtest' | 'signet';\n\nexport type BitcoinNetworkModes = NetworkModes | BitcoinTestnetModes;\n\ninterface BaseChainConfig {\n  blockchain: Blockchains;\n}\n\nexport interface BitcoinChainConfig extends BaseChainConfig {\n  blockchain: 'bitcoin';\n  bitcoinUrl: string;\n  bitcoinNetwork: BitcoinNetworkModes;\n}\n\nexport interface StacksChainConfig extends BaseChainConfig {\n  blockchain: 'stacks';\n  url: string;\n  /** The chainId of the network (or parent network if this is a subnet) */\n  chainId: ChainID;\n  /** An additional chainId for subnets. Indicated a subnet if defined and is mainly used for signing. */\n  subnetChainId?: ChainID;\n}\n\nexport interface NetworkConfiguration {\n  name: string;\n  id: DefaultNetworkConfigurations;\n  chain: {\n    bitcoin: BitcoinChainConfig;\n    stacks: StacksChainConfig;\n  };\n}\n\nconst networkMainnet: NetworkConfiguration = {\n  id: WalletDefaultNetworkConfigurationIds.mainnet,\n  name: 'Mainnet',\n  chain: {\n    stacks: {\n      blockchain: 'stacks',\n      chainId: ChainID.Mainnet,\n      url: HIRO_API_BASE_URL_MAINNET,\n    },\n    bitcoin: {\n      blockchain: 'bitcoin',\n      bitcoinNetwork: 'mainnet',\n      bitcoinUrl: BITCOIN_API_BASE_URL_MAINNET,\n    },\n  },\n};\n\nconst networkTestnet: NetworkConfiguration = {\n  id: WalletDefaultNetworkConfigurationIds.testnet,\n  name: 'Testnet',\n  chain: {\n    stacks: {\n      blockchain: 'stacks',\n      chainId: ChainID.Testnet,\n      url: HIRO_API_BASE_URL_TESTNET,\n    },\n    bitcoin: {\n      blockchain: 'bitcoin',\n      bitcoinNetwork: 'testnet',\n      bitcoinUrl: BITCOIN_API_BASE_URL_TESTNET,\n    },\n  },\n};\n\nconst networkSignet: NetworkConfiguration = {\n  id: WalletDefaultNetworkConfigurationIds.signet,\n  name: 'Signet',\n  chain: {\n    stacks: {\n      blockchain: 'stacks',\n      chainId: ChainID.Testnet,\n      url: HIRO_API_BASE_URL_TESTNET,\n    },\n    bitcoin: {\n      blockchain: 'bitcoin',\n      bitcoinNetwork: 'signet',\n      bitcoinUrl: BITCOIN_API_BASE_URL_SIGNET,\n    },\n  },\n};\n\nconst networkSbtcDevenv: NetworkConfiguration = {\n  id: WalletDefaultNetworkConfigurationIds.sbtcDevenv,\n  name: 'sBTC Devenv',\n  chain: {\n    stacks: {\n      blockchain: 'stacks',\n      chainId: ChainID.Testnet,\n      url: 'http://localhost:3999',\n    },\n    bitcoin: {\n      blockchain: 'bitcoin',\n      bitcoinNetwork: 'regtest',\n      bitcoinUrl: 'http://localhost:8999/api',\n    },\n  },\n};\n\nconst networkDevnet: NetworkConfiguration = {\n  id: WalletDefaultNetworkConfigurationIds.devnet,\n  name: 'Devnet',\n  chain: {\n    stacks: {\n      blockchain: 'stacks',\n      chainId: ChainID.Testnet,\n      url: 'http://localhost:3999',\n    },\n    bitcoin: {\n      blockchain: 'bitcoin',\n      bitcoinNetwork: 'regtest',\n      bitcoinUrl: 'http://localhost:18443',\n    },\n  },\n};\n\nexport const defaultCurrentNetwork: NetworkConfiguration = networkMainnet;\n\nexport const defaultNetworksKeyedById: Record<\n  WalletDefaultNetworkConfigurationIds,\n  NetworkConfiguration\n> = {\n  [WalletDefaultNetworkConfigurationIds.mainnet]: networkMainnet,\n  [WalletDefaultNetworkConfigurationIds.testnet]: networkTestnet,\n  [WalletDefaultNetworkConfigurationIds.signet]: networkSignet,\n  [WalletDefaultNetworkConfigurationIds.sbtcDevenv]: networkSbtcDevenv,\n  [WalletDefaultNetworkConfigurationIds.devnet]: networkDevnet,\n};\n","import { HIRO_INSCRIPTIONS_API_URL } from '../../network.model';\nimport { InscriptionCryptoAssetInfo } from '../crypto-asset-info.model';\n\n/**\n * Inscriptions contain arbitrary data. When retrieving an inscription, it should be\n * classified into one of the types below, indicating that the app can handle it\n * appropriately and securely. Inscriptions of types not ready to be handled by the\n * app should be classified as \"other\".\n */\nconst inscriptionMimeTypes = [\n  'audio',\n  'gltf',\n  'html',\n  'image',\n  'svg',\n  'text',\n  'video',\n  'other',\n] as const;\n\nexport type InscriptionMimeType = (typeof inscriptionMimeTypes)[number];\n\nexport function whenInscriptionMimeType<T>(\n  mimeType: string,\n  branches: { [k in InscriptionMimeType]?: () => T }\n) {\n  if (mimeType.startsWith('audio/') && branches.audio) {\n    return branches.audio();\n  }\n\n  if (mimeType.startsWith('text/html') && branches.html) {\n    return branches.html();\n  }\n\n  if (mimeType.startsWith('image/svg') && branches.svg) {\n    return branches.svg();\n  }\n\n  if (mimeType.startsWith('image/') && branches.image) {\n    return branches.image();\n  }\n\n  if (mimeType.startsWith('text') && branches.text) {\n    return branches.text();\n  }\n\n  if (mimeType.startsWith('video/') && branches.video) {\n    return branches.video();\n  }\n\n  if (mimeType.startsWith('model/gltf') && branches.gltf) {\n    return branches.gltf();\n  }\n\n  if (branches.other) return branches.other();\n\n  throw new Error('Unhandled inscription type');\n}\nexport interface Inscription extends InscriptionCryptoAssetInfo {\n  preview: string;\n  src: string;\n  title: string;\n  output: string;\n  txid: string;\n  offset: string;\n  address: string;\n  genesisBlockHash: string;\n  genesisTimestamp: number;\n  genesisBlockHeight: number;\n  value: string;\n}\n\ninterface RawInscription {\n  id: string;\n  number: number;\n  output: string;\n  contentType: string;\n  txid: string;\n  offset: string;\n  address: string;\n  genesisBlockHash: string;\n  genesisTimestamp: number;\n  genesisBlockHeight: number;\n  value: string;\n}\n\nexport function createInscription(inscription: RawInscription): Inscription {\n  const contentSrc = `${HIRO_INSCRIPTIONS_API_URL}/${inscription.id}/content`;\n  const iframeSrc = `https://ordinals.com/preview/${inscription.id}`;\n  const preview = `https://ordinals.hiro.so/inscription/${inscription.id}`;\n  const title = `Inscription ${inscription.number}`;\n\n  const sharedInfo = {\n    id: inscription.id,\n    number: inscription.number,\n    output: inscription.output,\n    txid: inscription.txid,\n    offset: inscription.offset,\n    address: inscription.address,\n    genesisBlockHash: inscription.genesisBlockHash,\n    genesisTimestamp: inscription.genesisTimestamp,\n    genesisBlockHeight: inscription.genesisBlockHeight,\n    value: inscription.value,\n    preview,\n    title,\n  };\n\n  return whenInscriptionMimeType<Inscription>(inscription.contentType, {\n    audio: () => ({\n      ...sharedInfo,\n      mimeType: 'audio',\n      name: 'inscription',\n      src: iframeSrc,\n    }),\n    gltf: () => ({\n      ...sharedInfo,\n      mimeType: 'gltf',\n      name: 'inscription',\n      src: iframeSrc,\n    }),\n    html: () => ({\n      ...sharedInfo,\n      mimeType: 'html',\n      name: 'inscription',\n      src: iframeSrc,\n    }),\n    image: () => ({\n      ...sharedInfo,\n      mimeType: 'image',\n      name: 'inscription',\n      src: contentSrc,\n    }),\n    svg: () => ({\n      ...sharedInfo,\n      mimeType: 'svg',\n      name: 'inscription',\n      src: iframeSrc,\n    }),\n    text: () => ({\n      ...sharedInfo,\n      mimeType: 'text',\n      name: 'inscription',\n      src: contentSrc,\n    }),\n    video: () => ({\n      ...sharedInfo,\n      mimeType: 'video',\n      name: 'inscription',\n      src: iframeSrc,\n    }),\n    other: () => ({\n      ...sharedInfo,\n      mimeType: 'other',\n      name: 'inscription',\n      src: '',\n    }),\n  });\n}\n","import type BigNumber from 'bignumber.js';\n\nexport interface AverageBitcoinFeeRates {\n  fastestFee: BigNumber;\n  halfHourFee: BigNumber;\n  hourFee: BigNumber;\n}\n\nexport const btcTxTimeMap: Record<keyof AverageBitcoinFeeRates, string> = {\n  fastestFee: '~10 – 20min',\n  halfHourFee: '~30 min',\n  hourFee: '~1 hour+',\n};\n\nexport enum BtcFeeType {\n  High = 'High',\n  Standard = 'Standard',\n  Low = 'Low',\n}\n","import { Blockchains } from '../types';\nimport { StacksFeeEstimate } from './stacks-fees.model';\n\nexport enum FeeTypes {\n  Low,\n  Middle,\n  High,\n  Custom,\n  Unknown,\n}\n\nexport enum FeeCalculationTypes {\n  Api = 'api',\n  Default = 'default',\n  DefaultSimulated = 'default-simulated',\n  FeesCapped = 'fees-capped',\n}\n\nexport interface Fees {\n  blockchain: Blockchains;\n  estimates: StacksFeeEstimate[];\n  calculation: FeeCalculationTypes;\n}\n","import type { CryptoCurrencies, FiatCurrencies } from './currencies.model';\nimport type { Money } from './money.model';\n\ninterface MarketPair {\n  readonly base: CryptoCurrencies;\n  readonly quote: FiatCurrencies;\n}\n\nexport function createMarketPair(base: CryptoCurrencies, quote: FiatCurrencies): MarketPair {\n  return Object.freeze({ base, quote });\n}\n\nexport function formatMarketPair({ base, quote }: MarketPair) {\n  return `${base}/${quote}`;\n}\n\nexport interface MarketData {\n  readonly pair: MarketPair;\n  readonly price: Money;\n}\n\nexport function createMarketData(pair: MarketPair, price: Money): MarketData {\n  if (pair.quote !== price.symbol)\n    throw new Error('Cannot create market data when price does not match quote');\n  return Object.freeze({ pair, price });\n}\n"],"mappings":";AAwDO,SAAS,yBAAyB,SAAwC;AAC/E,SAAO,EAAE,kBAAkB,QAAQ;AACrC;;;ACxDO,IAAM,4BAA4B;AAClC,IAAM,4BAA4B;AAClC,IAAM,4BAA4B;AAClC,IAAM,qCAAqC;AAE3C,IAAM,+BAA+B;AACrC,IAAM,+BAA+B;AACrC,IAAM,8BAA8B;AAEpC,IAAM,kCAAkC;AACxC,IAAM,kCAAkC;AAExC,IAAM,6BAA6B;AAGnC,IAAK,UAAL,kBAAKA,aAAL;AACL,EAAAA,kBAAA,aAAU,cAAV;AACA,EAAAA,kBAAA,aAAU,KAAV;AAFU,SAAAA;AAAA,GAAA;AAKL,IAAK,uCAAL,kBAAKC,0CAAL;AACL,EAAAA,sCAAA,aAAU;AACV,EAAAA,sCAAA,aAAU;AACV,EAAAA,sCAAA,YAAS;AACT,EAAAA,sCAAA,gBAAa;AACb,EAAAA,sCAAA,YAAS;AALC,SAAAA;AAAA,GAAA;AAkDZ,IAAM,iBAAuC;AAAA,EAC3C,IAAI;AAAA,EACJ,MAAM;AAAA,EACN,OAAO;AAAA,IACL,QAAQ;AAAA,MACN,YAAY;AAAA,MACZ,SAAS;AAAA,MACT,KAAK;AAAA,IACP;AAAA,IACA,SAAS;AAAA,MACP,YAAY;AAAA,MACZ,gBAAgB;AAAA,MAChB,YAAY;AAAA,IACd;AAAA,EACF;AACF;AAEA,IAAM,iBAAuC;AAAA,EAC3C,IAAI;AAAA,EACJ,MAAM;AAAA,EACN,OAAO;AAAA,IACL,QAAQ;AAAA,MACN,YAAY;AAAA,MACZ,SAAS;AAAA,MACT,KAAK;AAAA,IACP;AAAA,IACA,SAAS;AAAA,MACP,YAAY;AAAA,MACZ,gBAAgB;AAAA,MAChB,YAAY;AAAA,IACd;AAAA,EACF;AACF;AAEA,IAAM,gBAAsC;AAAA,EAC1C,IAAI;AAAA,EACJ,MAAM;AAAA,EACN,OAAO;AAAA,IACL,QAAQ;AAAA,MACN,YAAY;AAAA,MACZ,SAAS;AAAA,MACT,KAAK;AAAA,IACP;AAAA,IACA,SAAS;AAAA,MACP,YAAY;AAAA,MACZ,gBAAgB;AAAA,MAChB,YAAY;AAAA,IACd;AAAA,EACF;AACF;AAEA,IAAM,oBAA0C;AAAA,EAC9C,IAAI;AAAA,EACJ,MAAM;AAAA,EACN,OAAO;AAAA,IACL,QAAQ;AAAA,MACN,YAAY;AAAA,MACZ,SAAS;AAAA,MACT,KAAK;AAAA,IACP;AAAA,IACA,SAAS;AAAA,MACP,YAAY;AAAA,MACZ,gBAAgB;AAAA,MAChB,YAAY;AAAA,IACd;AAAA,EACF;AACF;AAEA,IAAM,gBAAsC;AAAA,EAC1C,IAAI;AAAA,EACJ,MAAM;AAAA,EACN,OAAO;AAAA,IACL,QAAQ;AAAA,MACN,YAAY;AAAA,MACZ,SAAS;AAAA,MACT,KAAK;AAAA,IACP;AAAA,IACA,SAAS;AAAA,MACP,YAAY;AAAA,MACZ,gBAAgB;AAAA,MAChB,YAAY;AAAA,IACd;AAAA,EACF;AACF;AAEO,IAAM,wBAA8C;AAEpD,IAAM,2BAGT;AAAA,EACF,CAAC,uBAA4C,GAAG;AAAA,EAChD,CAAC,uBAA4C,GAAG;AAAA,EAChD,CAAC,qBAA2C,GAAG;AAAA,EAC/C,CAAC,6BAA+C,GAAG;AAAA,EACnD,CAAC,qBAA2C,GAAG;AACjD;;;AClJO,SAAS,wBACd,UACA,UACA;AACA,MAAI,SAAS,WAAW,QAAQ,KAAK,SAAS,OAAO;AACnD,WAAO,SAAS,MAAM;AAAA,EACxB;AAEA,MAAI,SAAS,WAAW,WAAW,KAAK,SAAS,MAAM;AACrD,WAAO,SAAS,KAAK;AAAA,EACvB;AAEA,MAAI,SAAS,WAAW,WAAW,KAAK,SAAS,KAAK;AACpD,WAAO,SAAS,IAAI;AAAA,EACtB;AAEA,MAAI,SAAS,WAAW,QAAQ,KAAK,SAAS,OAAO;AACnD,WAAO,SAAS,MAAM;AAAA,EACxB;AAEA,MAAI,SAAS,WAAW,MAAM,KAAK,SAAS,MAAM;AAChD,WAAO,SAAS,KAAK;AAAA,EACvB;AAEA,MAAI,SAAS,WAAW,QAAQ,KAAK,SAAS,OAAO;AACnD,WAAO,SAAS,MAAM;AAAA,EACxB;AAEA,MAAI,SAAS,WAAW,YAAY,KAAK,SAAS,MAAM;AACtD,WAAO,SAAS,KAAK;AAAA,EACvB;AAEA,MAAI,SAAS,MAAO,QAAO,SAAS,MAAM;AAE1C,QAAM,IAAI,MAAM,4BAA4B;AAC9C;AA6BO,SAAS,kBAAkB,aAA0C;AAC1E,QAAM,aAAa,GAAG,yBAAyB,IAAI,YAAY,EAAE;AACjE,QAAM,YAAY,gCAAgC,YAAY,EAAE;AAChE,QAAM,UAAU,wCAAwC,YAAY,EAAE;AACtE,QAAM,QAAQ,eAAe,YAAY,MAAM;AAE/C,QAAM,aAAa;AAAA,IACjB,IAAI,YAAY;AAAA,IAChB,QAAQ,YAAY;AAAA,IACpB,QAAQ,YAAY;AAAA,IACpB,MAAM,YAAY;AAAA,IAClB,QAAQ,YAAY;AAAA,IACpB,SAAS,YAAY;AAAA,IACrB,kBAAkB,YAAY;AAAA,IAC9B,kBAAkB,YAAY;AAAA,IAC9B,oBAAoB,YAAY;AAAA,IAChC,OAAO,YAAY;AAAA,IACnB;AAAA,IACA;AAAA,EACF;AAEA,SAAO,wBAAqC,YAAY,aAAa;AAAA,IACnE,OAAO,OAAO;AAAA,MACZ,GAAG;AAAA,MACH,UAAU;AAAA,MACV,MAAM;AAAA,MACN,KAAK;AAAA,IACP;AAAA,IACA,MAAM,OAAO;AAAA,MACX,GAAG;AAAA,MACH,UAAU;AAAA,MACV,MAAM;AAAA,MACN,KAAK;AAAA,IACP;AAAA,IACA,MAAM,OAAO;AAAA,MACX,GAAG;AAAA,MACH,UAAU;AAAA,MACV,MAAM;AAAA,MACN,KAAK;AAAA,IACP;AAAA,IACA,OAAO,OAAO;AAAA,MACZ,GAAG;AAAA,MACH,UAAU;AAAA,MACV,MAAM;AAAA,MACN,KAAK;AAAA,IACP;AAAA,IACA,KAAK,OAAO;AAAA,MACV,GAAG;AAAA,MACH,UAAU;AAAA,MACV,MAAM;AAAA,MACN,KAAK;AAAA,IACP;AAAA,IACA,MAAM,OAAO;AAAA,MACX,GAAG;AAAA,MACH,UAAU;AAAA,MACV,MAAM;AAAA,MACN,KAAK;AAAA,IACP;AAAA,IACA,OAAO,OAAO;AAAA,MACZ,GAAG;AAAA,MACH,UAAU;AAAA,MACV,MAAM;AAAA,MACN,KAAK;AAAA,IACP;AAAA,IACA,OAAO,OAAO;AAAA,MACZ,GAAG;AAAA,MACH,UAAU;AAAA,MACV,MAAM;AAAA,MACN,KAAK;AAAA,IACP;AAAA,EACF,CAAC;AACH;;;ACrJO,IAAM,eAA6D;AAAA,EACxE,YAAY;AAAA,EACZ,aAAa;AAAA,EACb,SAAS;AACX;AAEO,IAAK,aAAL,kBAAKC,gBAAL;AACL,EAAAA,YAAA,UAAO;AACP,EAAAA,YAAA,cAAW;AACX,EAAAA,YAAA,SAAM;AAHI,SAAAA;AAAA,GAAA;;;ACXL,IAAK,WAAL,kBAAKC,cAAL;AACL,EAAAA,oBAAA;AACA,EAAAA,oBAAA;AACA,EAAAA,oBAAA;AACA,EAAAA,oBAAA;AACA,EAAAA,oBAAA;AALU,SAAAA;AAAA,GAAA;AAQL,IAAK,sBAAL,kBAAKC,yBAAL;AACL,EAAAA,qBAAA,SAAM;AACN,EAAAA,qBAAA,aAAU;AACV,EAAAA,qBAAA,sBAAmB;AACnB,EAAAA,qBAAA,gBAAa;AAJH,SAAAA;AAAA,GAAA;;;ACHL,SAAS,iBAAiB,MAAwB,OAAmC;AAC1F,SAAO,OAAO,OAAO,EAAE,MAAM,MAAM,CAAC;AACtC;AAEO,SAAS,iBAAiB,EAAE,MAAM,MAAM,GAAe;AAC5D,SAAO,GAAG,IAAI,IAAI,KAAK;AACzB;AAOO,SAAS,iBAAiB,MAAkB,OAA0B;AAC3E,MAAI,KAAK,UAAU,MAAM;AACvB,UAAM,IAAI,MAAM,2DAA2D;AAC7E,SAAO,OAAO,OAAO,EAAE,MAAM,MAAM,CAAC;AACtC;","names":["ChainID","WalletDefaultNetworkConfigurationIds","BtcFeeType","FeeTypes","FeeCalculationTypes"]}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@leather.io/models",
+  "author": "Leather.io contact@leather.io",
+  "description": "Leather models and types",
+  "version": "0.10.0",
+  "license": "MIT",
+  "homepage": "https://github.com/leather-io/mono/tree/dev/packages/models",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:leather-io/mono.git",
+    "directory": "packages/models"
+  },
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "bugs": "https://github.com/leather-io/mono/issues",
+  "dependencies": {
+    "@stacks/stacks-blockchain-api-types": "7.8.2",
+    "bignumber.js": "9.1.2"
+  },
+  "devDependencies": {
+    "eslint": "8.53.0",
+    "prettier": "3.3.0",
+    "tsup": "8.1.0",
+    "typescript": "5.4.5",
+    "@leather.io/eslint-config": "0.6.0",
+    "@leather.io/prettier-config": "0.5.0",
+    "@leather.io/tsconfig-config": "0.5.0"
+  },
+  "keywords": [
+    "leather",
+    "leather wallet",
+    "models"
+  ],
+  "prettier": "@leather.io/prettier-config",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "build:watch": "tsup --watch",
+    "format": "prettier . --write --ignore-path ../../.prettierignore",
+    "format:check": "prettier . --check --ignore-path ../../.prettierignore",
+    "lint": "eslint . --ignore-path ../../.eslintignore",
+    "lint:fix": "eslint . --fix --ignore-path ../../.eslintignore",
+    "typecheck": "tsc --noEmit -p ./tsconfig.json"
+  }
+}

package/src/crypto-assets/bitcoin/inscription.model.ts

@@ -0,0 +1,158 @@
+import { HIRO_INSCRIPTIONS_API_URL } from '../../network.model';
+import { InscriptionCryptoAssetInfo } from '../crypto-asset-info.model';
+
+/**
+ * Inscriptions contain arbitrary data. When retrieving an inscription, it should be
+ * classified into one of the types below, indicating that the app can handle it
+ * appropriately and securely. Inscriptions of types not ready to be handled by the
+ * app should be classified as "other".
+ */
+const inscriptionMimeTypes = [
+  'audio',
+  'gltf',
+  'html',
+  'image',
+  'svg',
+  'text',
+  'video',
+  'other',
+] as const;
+
+export type InscriptionMimeType = (typeof inscriptionMimeTypes)[number];
+
+export function whenInscriptionMimeType<T>(
+  mimeType: string,
+  branches: { [k in InscriptionMimeType]?: () => T }
+) {
+  if (mimeType.startsWith('audio/') && branches.audio) {
+    return branches.audio();
+  }
+
+  if (mimeType.startsWith('text/html') && branches.html) {
+    return branches.html();
+  }
+
+  if (mimeType.startsWith('image/svg') && branches.svg) {
+    return branches.svg();
+  }
+
+  if (mimeType.startsWith('image/') && branches.image) {
+    return branches.image();
+  }
+
+  if (mimeType.startsWith('text') && branches.text) {
+    return branches.text();
+  }
+
+  if (mimeType.startsWith('video/') && branches.video) {
+    return branches.video();
+  }
+
+  if (mimeType.startsWith('model/gltf') && branches.gltf) {
+    return branches.gltf();
+  }
+
+  if (branches.other) return branches.other();
+
+  throw new Error('Unhandled inscription type');
+}
+export interface Inscription extends InscriptionCryptoAssetInfo {
+  preview: string;
+  src: string;
+  title: string;
+  output: string;
+  txid: string;
+  offset: string;
+  address: string;
+  genesisBlockHash: string;
+  genesisTimestamp: number;
+  genesisBlockHeight: number;
+  value: string;
+}
+
+interface RawInscription {
+  id: string;
+  number: number;
+  output: string;
+  contentType: string;
+  txid: string;
+  offset: string;
+  address: string;
+  genesisBlockHash: string;
+  genesisTimestamp: number;
+  genesisBlockHeight: number;
+  value: string;
+}
+
+export function createInscription(inscription: RawInscription): Inscription {
+  const contentSrc = `${HIRO_INSCRIPTIONS_API_URL}/${inscription.id}/content`;
+  const iframeSrc = `https://ordinals.com/preview/${inscription.id}`;
+  const preview = `https://ordinals.hiro.so/inscription/${inscription.id}`;
+  const title = `Inscription ${inscription.number}`;
+
+  const sharedInfo = {
+    id: inscription.id,
+    number: inscription.number,
+    output: inscription.output,
+    txid: inscription.txid,
+    offset: inscription.offset,
+    address: inscription.address,
+    genesisBlockHash: inscription.genesisBlockHash,
+    genesisTimestamp: inscription.genesisTimestamp,
+    genesisBlockHeight: inscription.genesisBlockHeight,
+    value: inscription.value,
+    preview,
+    title,
+  };
+
+  return whenInscriptionMimeType<Inscription>(inscription.contentType, {
+    audio: () => ({
+      ...sharedInfo,
+      mimeType: 'audio',
+      name: 'inscription',
+      src: iframeSrc,
+    }),
+    gltf: () => ({
+      ...sharedInfo,
+      mimeType: 'gltf',
+      name: 'inscription',
+      src: iframeSrc,
+    }),
+    html: () => ({
+      ...sharedInfo,
+      mimeType: 'html',
+      name: 'inscription',
+      src: iframeSrc,
+    }),
+    image: () => ({
+      ...sharedInfo,
+      mimeType: 'image',
+      name: 'inscription',
+      src: contentSrc,
+    }),
+    svg: () => ({
+      ...sharedInfo,
+      mimeType: 'svg',
+      name: 'inscription',
+      src: iframeSrc,
+    }),
+    text: () => ({
+      ...sharedInfo,
+      mimeType: 'text',
+      name: 'inscription',
+      src: contentSrc,
+    }),
+    video: () => ({
+      ...sharedInfo,
+      mimeType: 'video',
+      name: 'inscription',
+      src: iframeSrc,
+    }),
+    other: () => ({
+      ...sharedInfo,
+      mimeType: 'other',
+      name: 'inscription',
+      src: '',
+    }),
+  });
+}

package/src/crypto-assets/crypto-asset-balance.model.ts

@@ -0,0 +1,59 @@
+import { Money } from '../money.model';
+
+export interface BaseCryptoAssetBalance {
+  /**
+   * totalBalance after filtering out outboundBalance, protectedBalance, and uneconomicalBalance
+   */
+  readonly availableBalance: Money;
+}
+
+export interface BtcCryptoAssetBalance extends BaseCryptoAssetBalance {
+  /**
+   * Balance of UTXOs with collectibles
+   */
+  readonly protectedBalance: Money;
+  /**
+   * Balance across UTXOs with need for larger fee than principal by UTXO given standard rate
+   */
+  readonly uneconomicalBalance: Money;
+}
+
+export interface StxCryptoAssetBalance extends BaseCryptoAssetBalance {
+  /**
+   * availableBalance minus lockedBalance
+   */
+  readonly availableUnlockedBalance: Money;
+  /**
+   * Balance of pending receipt into account given pending transactions
+   */
+  readonly inboundBalance: Money;
+  /**
+   * totalBalance minus total amount locked by contracts
+   */
+  readonly lockedBalance: Money;
+  /**
+   * Balance of pending delivery from account given pending transactions
+   */
+  readonly outboundBalance: Money;
+  /**
+   * totalBalance plus inboundBalance minus outboundBalance
+   */
+  readonly pendingBalance: Money;
+  /**
+   * Balance as confirmed on chain
+   */
+  readonly totalBalance: Money;
+  /**
+   * totalBalance minus lockedBalance
+   */
+  readonly unlockedBalance: Money;
+}
+
+export type CryptoAssetBalance =
+  | BaseCryptoAssetBalance
+  | BtcCryptoAssetBalance
+  | StxCryptoAssetBalance;
+
+export function createCryptoAssetBalance(balance: Money): BaseCryptoAssetBalance {
+  return { availableBalance: balance };
+}

package/src/crypto-assets/crypto-asset-info.model.ts

@@ -0,0 +1,68 @@
+import { InscriptionMimeType } from './bitcoin/inscription.model';
+
+export interface BaseCryptoAssetInfo {
+  readonly decimals: number;
+  readonly hasMemo: boolean;
+}
+
+export interface BtcCryptoAssetInfo extends BaseCryptoAssetInfo {
+  readonly name: 'bitcoin';
+  readonly symbol: 'BTC';
+}
+
+export interface StxCryptoAssetInfo extends BaseCryptoAssetInfo {
+  readonly name: 'stacks';
+  readonly symbol: 'STX';
+}
+
+// Bitcoin
+export interface Brc20CryptoAssetInfo extends BaseCryptoAssetInfo {
+  readonly name: 'brc-20';
+  readonly symbol: string;
+}
+
+export interface InscriptionCryptoAssetInfo {
+  readonly id: string;
+  readonly mimeType: InscriptionMimeType;
+  readonly name: 'inscription';
+  readonly number: number;
+}
+
+export interface RuneCryptoAssetInfo extends BaseCryptoAssetInfo {
+  readonly name: 'rune';
+  readonly spacedRuneName: string;
+  readonly runeName: string;
+  readonly symbol: string;
+}
+
+export interface StampCryptoAssetInfo {
+  readonly name: 'stamp';
+  readonly stamp: number;
+  readonly stampUrl: string;
+}
+
+export interface Src20CryptoAssetInfo extends BaseCryptoAssetInfo {
+  readonly id: string;
+  readonly name: 'src-20';
+  readonly symbol: string;
+}
+
+// Stacks
+export interface Sip9CryptoAssetInfo {
+  readonly contractId: string;
+  readonly imageCanonicalUri: string;
+  readonly name: string;
+}
+
+export interface Sip10CryptoAssetInfo extends BaseCryptoAssetInfo {
+  readonly canTransfer: boolean;
+  readonly contractId: string;
+  readonly imageCanonicalUri: string;
+  readonly name: string;
+  readonly symbol: string;
+}
+
+export interface Stx20CryptoAssetInfo {
+  readonly name: 'stx-20';
+  readonly symbol: string;
+}

package/src/currencies.model.ts

@@ -0,0 +1,7 @@
+import { LiteralUnion } from './types.utils';
+
+export type CryptoCurrencies = LiteralUnion<'BTC' | 'STX', string>;
+
+export type FiatCurrencies = 'USD' | string;
+
+export type Currencies = CryptoCurrencies | FiatCurrencies;

package/src/decoded-auth-request.ts

@@ -0,0 +1,14 @@
+export interface DecodedAuthRequest {
+  public_keys: string;
+  domain_name: string;
+  manifest_uri: string;
+  redirect_uri: string;
+  scopes: string[];
+  sendToSignIn: boolean;
+  appDetails?: {
+    name: string;
+    icon: string;
+  };
+  client?: string;
+  connectVersion?: string;
+}