@leather.io/models 0.10.0

package/src/fees/bitcoin-fees.model.ts

@@ -0,0 +1,19 @@
+import type BigNumber from 'bignumber.js';
+
+export interface AverageBitcoinFeeRates {
+  fastestFee: BigNumber;
+  halfHourFee: BigNumber;
+  hourFee: BigNumber;
+}
+
+export const btcTxTimeMap: Record<keyof AverageBitcoinFeeRates, string> = {
+  fastestFee: '~10 – 20min',
+  halfHourFee: '~30 min',
+  hourFee: '~1 hour+',
+};
+
+export enum BtcFeeType {
+  High = 'High',
+  Standard = 'Standard',
+  Low = 'Low',
+}

package/src/fees/fees.model.ts

@@ -0,0 +1,23 @@
+import { Blockchains } from '../types';
+import { StacksFeeEstimate } from './stacks-fees.model';
+
+export enum FeeTypes {
+  Low,
+  Middle,
+  High,
+  Custom,
+  Unknown,
+}
+
+export enum FeeCalculationTypes {
+  Api = 'api',
+  Default = 'default',
+  DefaultSimulated = 'default-simulated',
+  FeesCapped = 'fees-capped',
+}
+
+export interface Fees {
+  blockchain: Blockchains;
+  estimates: StacksFeeEstimate[];
+  calculation: FeeCalculationTypes;
+}

package/src/fees/stacks-fees.model.ts

@@ -0,0 +1,6 @@
+import { Money } from '../money.model';
+
+export interface StacksFeeEstimate {
+  fee: Money;
+  feeRate: number;
+}

package/src/index.ts

@@ -0,0 +1,15 @@
+export * from './crypto-assets/crypto-asset-balance.model';
+export * from './crypto-assets/crypto-asset-info.model';
+export * from './crypto-assets/bitcoin/inscription.model';
+export * from './currencies.model';
+export * from './fees/bitcoin-fees.model';
+export * from './fees/fees.model';
+export * from './fees/stacks-fees.model';
+export * from './market.model';
+export * from './types';
+export * from './types.utils';
+export * from './money.model';
+export * from './network.model';
+export * from './transactions/bitcoin-transaction.model';
+export * from './transactions/stacks-transaction.model';
+export * from './utxo.model';

package/src/market.model.ts

@@ -0,0 +1,26 @@
+import type { CryptoCurrencies, FiatCurrencies } from './currencies.model';
+import type { Money } from './money.model';
+
+interface MarketPair {
+  readonly base: CryptoCurrencies;
+  readonly quote: FiatCurrencies;
+}
+
+export function createMarketPair(base: CryptoCurrencies, quote: FiatCurrencies): MarketPair {
+  return Object.freeze({ base, quote });
+}
+
+export function formatMarketPair({ base, quote }: MarketPair) {
+  return `${base}/${quote}`;
+}
+
+export interface MarketData {
+  readonly pair: MarketPair;
+  readonly price: Money;
+}
+
+export function createMarketData(pair: MarketPair, price: Money): MarketData {
+  if (pair.quote !== price.symbol)
+    throw new Error('Cannot create market data when price does not match quote');
+  return Object.freeze({ pair, price });
+}

package/src/money.model.ts

@@ -0,0 +1,11 @@
+import type BigNumber from 'bignumber.js';
+
+import type { Currencies } from './currencies.model';
+
+export type NumType = BigNumber | bigint | number;
+
+export interface Money {
+  readonly amount: BigNumber;
+  readonly symbol: Currencies;
+  readonly decimals: number;
+}

package/src/network.model.ts

@@ -0,0 +1,169 @@
+import { Blockchains } from './types';
+
+export const HIRO_API_BASE_URL_MAINNET = 'https://api.hiro.so';
+export const HIRO_API_BASE_URL_TESTNET = 'https://api.testnet.hiro.so';
+export const HIRO_INSCRIPTIONS_API_URL = 'https://api.hiro.so/ordinals/v1/inscriptions';
+export const HIRO_API_BASE_URL_NAKAMOTO_TESTNET = 'https://api.nakamoto.testnet.hiro.so';
+
+export const BITCOIN_API_BASE_URL_MAINNET = 'https://blockstream.info/api';
+export const BITCOIN_API_BASE_URL_TESTNET = 'https://blockstream.info/testnet/api';
+export const BITCOIN_API_BASE_URL_SIGNET = 'https://mempool.space/signet/api';
+
+export const BESTINSLOT_API_BASE_URL_MAINNET = 'https://leatherapi.bestinslot.xyz/v3';
+export const BESTINSLOT_API_BASE_URL_TESTNET = 'https://leatherapi_testnet.bestinslot.xyz/v3';
+
+export const STX20_API_BASE_URL_MAINNET = 'https://api.stx20.com/api/v1';
+
+// Copied from @stacks/transactions to avoid dependencies
+export enum ChainID {
+  Testnet = 2147483648,
+  Mainnet = 1,
+}
+
+export enum WalletDefaultNetworkConfigurationIds {
+  mainnet = 'mainnet',
+  testnet = 'testnet',
+  signet = 'signet',
+  sbtcDevenv = 'sbtcDevenv',
+  devnet = 'devnet',
+}
+
+export type DefaultNetworkConfigurations = keyof typeof WalletDefaultNetworkConfigurationIds;
+
+const supportedBlockchains = ['stacks', 'bitcoin'] as const;
+
+export type SupportedBlockchains = (typeof supportedBlockchains)[number];
+
+const networkModes = ['mainnet', 'testnet'] as const;
+
+export type NetworkModes = (typeof networkModes)[number];
+
+type BitcoinTestnetModes = 'testnet' | 'regtest' | 'signet';
+
+export type BitcoinNetworkModes = NetworkModes | BitcoinTestnetModes;
+
+interface BaseChainConfig {
+  blockchain: Blockchains;
+}
+
+export interface BitcoinChainConfig extends BaseChainConfig {
+  blockchain: 'bitcoin';
+  bitcoinUrl: string;
+  bitcoinNetwork: BitcoinNetworkModes;
+}
+
+export interface StacksChainConfig extends BaseChainConfig {
+  blockchain: 'stacks';
+  url: string;
+  /** The chainId of the network (or parent network if this is a subnet) */
+  chainId: ChainID;
+  /** An additional chainId for subnets. Indicated a subnet if defined and is mainly used for signing. */
+  subnetChainId?: ChainID;
+}
+
+export interface NetworkConfiguration {
+  name: string;
+  id: DefaultNetworkConfigurations;
+  chain: {
+    bitcoin: BitcoinChainConfig;
+    stacks: StacksChainConfig;
+  };
+}
+
+const networkMainnet: NetworkConfiguration = {
+  id: WalletDefaultNetworkConfigurationIds.mainnet,
+  name: 'Mainnet',
+  chain: {
+    stacks: {
+      blockchain: 'stacks',
+      chainId: ChainID.Mainnet,
+      url: HIRO_API_BASE_URL_MAINNET,
+    },
+    bitcoin: {
+      blockchain: 'bitcoin',
+      bitcoinNetwork: 'mainnet',
+      bitcoinUrl: BITCOIN_API_BASE_URL_MAINNET,
+    },
+  },
+};
+
+const networkTestnet: NetworkConfiguration = {
+  id: WalletDefaultNetworkConfigurationIds.testnet,
+  name: 'Testnet',
+  chain: {
+    stacks: {
+      blockchain: 'stacks',
+      chainId: ChainID.Testnet,
+      url: HIRO_API_BASE_URL_TESTNET,
+    },
+    bitcoin: {
+      blockchain: 'bitcoin',
+      bitcoinNetwork: 'testnet',
+      bitcoinUrl: BITCOIN_API_BASE_URL_TESTNET,
+    },
+  },
+};
+
+const networkSignet: NetworkConfiguration = {
+  id: WalletDefaultNetworkConfigurationIds.signet,
+  name: 'Signet',
+  chain: {
+    stacks: {
+      blockchain: 'stacks',
+      chainId: ChainID.Testnet,
+      url: HIRO_API_BASE_URL_TESTNET,
+    },
+    bitcoin: {
+      blockchain: 'bitcoin',
+      bitcoinNetwork: 'signet',
+      bitcoinUrl: BITCOIN_API_BASE_URL_SIGNET,
+    },
+  },
+};
+
+const networkSbtcDevenv: NetworkConfiguration = {
+  id: WalletDefaultNetworkConfigurationIds.sbtcDevenv,
+  name: 'sBTC Devenv',
+  chain: {
+    stacks: {
+      blockchain: 'stacks',
+      chainId: ChainID.Testnet,
+      url: 'http://localhost:3999',
+    },
+    bitcoin: {
+      blockchain: 'bitcoin',
+      bitcoinNetwork: 'regtest',
+      bitcoinUrl: 'http://localhost:8999/api',
+    },
+  },
+};
+
+const networkDevnet: NetworkConfiguration = {
+  id: WalletDefaultNetworkConfigurationIds.devnet,
+  name: 'Devnet',
+  chain: {
+    stacks: {
+      blockchain: 'stacks',
+      chainId: ChainID.Testnet,
+      url: 'http://localhost:3999',
+    },
+    bitcoin: {
+      blockchain: 'bitcoin',
+      bitcoinNetwork: 'regtest',
+      bitcoinUrl: 'http://localhost:18443',
+    },
+  },
+};
+
+export const defaultCurrentNetwork: NetworkConfiguration = networkMainnet;
+
+export const defaultNetworksKeyedById: Record<
+  WalletDefaultNetworkConfigurationIds,
+  NetworkConfiguration
+> = {
+  [WalletDefaultNetworkConfigurationIds.mainnet]: networkMainnet,
+  [WalletDefaultNetworkConfigurationIds.testnet]: networkTestnet,
+  [WalletDefaultNetworkConfigurationIds.signet]: networkSignet,
+  [WalletDefaultNetworkConfigurationIds.sbtcDevenv]: networkSbtcDevenv,
+  [WalletDefaultNetworkConfigurationIds.devnet]: networkDevnet,
+};

package/src/transactions/bitcoin-transaction.model.ts

@@ -0,0 +1,66 @@
+// Source: https://github.com/Blockstream/esplora/blob/master/API.md#transaction-format
+interface BitcoinTransactionIssuance {
+  asset_id: string;
+  is_reissuance: boolean;
+  asset_blinding_nonce: number;
+  asset_entropy: number;
+  contract_hash: string;
+  assetamount?: number;
+  assetamountcommitment?: number;
+  tokenamount?: number;
+  tokenamountcommitment?: number;
+}
+
+interface BitcoinTransactionPegOut {
+  genesis_hash: string;
+  scriptpubkey: string;
+  scriptpubkey_asm: string;
+  scriptpubkey_address: string;
+}
+
+interface BitcoinTransactionStatus {
+  confirmed: boolean;
+  block_height?: number | null;
+  block_hash?: string | null;
+  block_time?: number | null;
+}
+
+export interface BitcoinTransactionVectorOutput {
+  scriptpubkey: string;
+  scriptpubkey_asm: string;
+  scriptpubkey_type: string;
+  scriptpubkey_address: string;
+  value: number;
+  valuecommitment?: number;
+  asset?: string;
+  assetcommitment?: number;
+  pegout?: BitcoinTransactionPegOut | null;
+}
+
+export interface BitcoinTransactionVectorInput {
+  inner_redeemscript_asm?: string;
+  inner_witnessscript_asm?: string;
+  is_coinbase: boolean;
+  is_pegin?: boolean;
+  issuance?: BitcoinTransactionIssuance | null;
+  prevout: BitcoinTransactionVectorOutput;
+  scriptsig: string;
+  scriptsig_asm: string;
+  sequence: number;
+  txid: string;
+  vout: number;
+  witness: string[];
+}
+
+export interface BitcoinTx {
+  fee: number;
+  locktime: number;
+  size: number;
+  status: BitcoinTransactionStatus;
+  tx_type?: string;
+  txid: string;
+  version: number;
+  vin: BitcoinTransactionVectorInput[];
+  vout: BitcoinTransactionVectorOutput[];
+  weight: number;
+}

package/src/transactions/stacks-transaction.model.ts

@@ -0,0 +1,17 @@
+import type { MempoolTransaction, Transaction } from '@stacks/stacks-blockchain-api-types';
+
+export type StacksTx = MempoolTransaction | Transaction;
+export type StacksTxStatus = 'failed' | 'pending' | 'success';
+
+export interface StxTransfer {
+  amount: string;
+  sender?: string;
+  recipient?: string;
+}
+
+export interface FtTransfer {
+  asset_identifier: string;
+  amount: string;
+  sender?: string;
+  recipient?: string;
+}

package/src/types.ts

@@ -0,0 +1,15 @@
+import { LiteralUnion } from './types.utils';
+
+export type Blockchains = LiteralUnion<'bitcoin' | 'stacks', string>;
+
+export type CryptoAssetType =
+  | 'btc'
+  | 'stx'
+  | 'brc-20'
+  | 'inscription'
+  | 'rune'
+  | 'sip-9'
+  | 'sip-10'
+  | 'src-20'
+  | 'stamp'
+  | 'stx-20';

package/src/types.utils.ts

@@ -0,0 +1,13 @@
+export type ValueOf<T> = T[keyof T];
+
+export interface AllowAdditionalProperties {
+  [x: string | number | symbol]: unknown;
+}
+
+type Primitive = null | undefined | string | number | boolean | symbol | bigint;
+
+export type LiteralUnion<LiteralType, BaseType extends Primitive> =
+  | LiteralType
+  | (BaseType & Record<never, never>);
+
+export type Entries<T> = { [K in keyof T]: [K, T[K]] }[keyof T][];

package/src/utxo.model.ts

@@ -0,0 +1,11 @@
+export interface UtxoItem {
+  txid: string;
+  vout: number;
+  status: {
+    confirmed: boolean;
+    block_height: number;
+    block_hash: string;
+    block_time: number;
+  };
+  value: number;
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": ["@leather.io/tsconfig-config/tsconfig.base.json"],
+  "include": ["**/*", ".*.ts"],
+  "exclude": ["./dist/"],
+  "compilerOptions": {
+    "outDir": "./dist"
+  }
+}

package/tsup.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from 'tsup';
+
+export default defineConfig({
+  entry: ['src/index.ts'],
+  sourcemap: true,
+  clean: true,
+  dts: true,
+  format: 'esm',
+});