@leather.io/utils 0.48.2 → 0.49.0

package/package.json

@@ -2,7 +2,7 @@
   "name": "@leather.io/utils",
   "author": "Leather.io contact@leather.io",
   "description": "Shared bitcoin utilities",
-  "version": "0.48.2",
+  "version": "0.49.0",
   "license": "MIT",
   "homepage": "https://github.com/leather-io/mono/tree/dev/packages/utils",
   "repository": {
@@ -19,8 +19,8 @@
   "dependencies": {
     "bignumber.js": "9.1.2",
     "dompurify": "3.2.4",
-    "@leather.io/constants": "0.27.4",
-    "@leather.io/models": "0.47.0"
+    "@leather.io/constants": "0.28.0",
+    "@leather.io/models": "0.49.0"
   },
   "devDependencies": {
     "@types/dompurify": "3.0.5",
@@ -28,8 +28,8 @@
     "tsup": "8.4.0",
     "typescript": "5.8.3",
     "vitest": "2.1.9",
-    "@leather.io/prettier-config": "0.9.0",
-    "@leather.io/tsconfig-config": "0.11.0"
+    "@leather.io/tsconfig-config": "0.11.0",
+    "@leather.io/prettier-config": "0.9.0"
   },
   "keywords": [
     "leather",

package/src/assets/asset-id.ts

@@ -4,22 +4,13 @@ import {
   CryptoAssetProtocol,
   CryptoAssetProtocols,
   Sip9Asset,
-  isSip9Asset,
 } from '@leather.io/models';
 
 import { assertUnreachable } from '../index';
 
 export function matchesAssetId(asset: CryptoAsset, assetId: CryptoAssetId) {
-  const protocol = getAssetId(asset).protocol;
-  const id = getAssetId(asset).id;
-  if (isSip9Asset(asset)) {
-    return (
-      protocol === assetId.protocol &&
-      assetId.id === asset.assetId &&
-      assetId.tokenId === asset.tokenId
-    );
-  }
-  return protocol === assetId.protocol && id === assetId.id;
+  const assetIdentifier = getAssetId(asset);
+  return isSameAssetId(assetIdentifier, assetId);
 }
 
 export function isSameAssetId(assetId1: CryptoAssetId, assetId2: CryptoAssetId) {
@@ -87,10 +78,19 @@ export function getAssetId(asset: CryptoAsset): CryptoAssetId {
 export function createSip9AssetId(asset: Sip9Asset): CryptoAssetId {
   return {
     protocol: asset.protocol,
-    id: `${asset.assetId}|${asset.tokenId}`,
+    id: formatSip9IdField(asset),
   };
 }
 
+export function formatSip9IdField(asset: Sip9Asset) {
+  return `${asset.assetId}|${asset.tokenId}`;
+}
+
+export function parseSip9IdField(id: string) {
+  const [assetId, tokenId] = id.split('|');
+  return { assetId, tokenId: Number(tokenId) };
+}
+
 export type SerializedCryptoAssetId = `${string}|${string}`;
 
 export function serializeAssetId(assetId: CryptoAssetId): SerializedCryptoAssetId {
@@ -98,7 +98,8 @@ export function serializeAssetId(assetId: CryptoAssetId): SerializedCryptoAssetI
 }
 
 export function deserializeAssetId(serializedAssetId: SerializedCryptoAssetId): CryptoAssetId {
-  const [protocol, id, tokenId] = serializedAssetId.split('|');
+  const [protocol, ...idParts] = serializedAssetId.split('|');
+  const id = idParts.join('|');
   if (!Object.keys(CryptoAssetProtocols).includes(protocol)) {
     throw new Error(`Unrecognized Asset Protocol: ${protocol}`);
   }
@@ -106,6 +107,5 @@ export function deserializeAssetId(serializedAssetId: SerializedCryptoAssetId):
   return {
     protocol: protocol as CryptoAssetProtocol,
     id,
-    tokenId: tokenId ? parseInt(tokenId, 10) : undefined,
   };
 }

package/src/assets/inscription-helpers.spec.ts

@@ -14,6 +14,7 @@ describe(createInscriptionAsset.name, () => {
     genesisBlockHeight: 100,
     genesisTimestamp: '2025-01-01T12:00:00.000Z',
     outputValue: '1000',
+    thumbnailSrc: 'https://example.com/thumb.png',
   };
 
   it('populates inscription data on asset as expected', () => {
@@ -35,5 +36,29 @@ describe(createInscriptionAsset.name, () => {
     expect(inscription.genesisTimestamp).toEqual(1735732800);
     expect(inscription.value).toEqual(mockCreateInscriptionData.outputValue);
     expect(inscription.mimeType).toEqual('svg');
+    expect(inscription.thumbnailSrc).toEqual(mockCreateInscriptionData.thumbnailSrc);
+  });
+
+  it('falls back to ordinal preview when no content source is provided', () => {
+    const inscription = createInscriptionAsset({
+      ...mockCreateInscriptionData,
+      contentSrc: '',
+    });
+
+    expect(inscription.src).toContain('https://ordinals.com/preview/');
+  });
+
+  it.each([
+    { mimeType: 'text/html', expectedMimeType: 'html' },
+    { mimeType: 'model/gltf+json', expectedMimeType: 'gltf' },
+  ])('uses contentSrc for %s inscriptions', ({ mimeType, expectedMimeType }) => {
+    const inscription = createInscriptionAsset({
+      ...mockCreateInscriptionData,
+      mimeType,
+      contentSrc: 'https://content.bestinslot.xyz/example',
+    });
+
+    expect(inscription.mimeType).toEqual(expectedMimeType);
+    expect(inscription.src).toEqual('https://content.bestinslot.xyz/example');
   });
 });

package/src/assets/inscription-helpers.ts

@@ -1,3 +1,4 @@
+import { ORD_IO_URL } from '@leather.io/constants';
 import {
   CryptoAssetCategories,
   CryptoAssetChains,
@@ -49,10 +50,14 @@ export interface CreateInscriptionData {
   readonly genesisTimestamp: string | number;
   readonly genesisBlockHeight: number;
   readonly outputValue: string;
+  readonly thumbnailSrc?: string;
 }
 
 export function createInscriptionAsset(data: CreateInscriptionData): InscriptionAsset {
-  const iframeSrc = `https://ordinals.com/preview/${data.id}`;
+  const ordinalPreviewSrc = `https://ordinals.com/preview/${data.id}`;
+  const ordIoSrc = `${ORD_IO_URL}/content/${data.id}`;
+  const thumbnailSrc = data.thumbnailSrc ?? ordinalPreviewSrc;
+  const primarySrc = data.contentSrc || ordinalPreviewSrc;
   const preview = `https://ordinals.hiro.so/inscription/${data.id}`;
   const title = `Inscription ${data.number}`;
   const [txid, output, offset] = data.satPoint.split(':');
@@ -73,6 +78,7 @@ export function createInscriptionAsset(data: CreateInscriptionData): Inscription
     genesisBlockHash: data.genesisBlockHash,
     genesisTimestamp: dateToUnixTimestamp(new Date(data.genesisTimestamp)),
     value: data.outputValue,
+    thumbnailSrc,
   };
 
   if (!data.mimeType) {
@@ -88,31 +94,33 @@ export function createInscriptionAsset(data: CreateInscriptionData): Inscription
       ...sharedInfo,
       mimeType: 'audio',
       name: 'inscription',
-      src: iframeSrc,
+      src: primarySrc,
     }),
     gltf: () => ({
       ...sharedInfo,
       mimeType: 'gltf',
       name: 'inscription',
-      src: iframeSrc,
+      src: primarySrc,
     }),
     html: () => ({
       ...sharedInfo,
       mimeType: 'html',
       name: 'inscription',
-      src: iframeSrc,
+      thumbnailSrc: ordIoSrc,
+      src: primarySrc,
     }),
     image: () => ({
       ...sharedInfo,
       mimeType: 'image',
       name: 'inscription',
-      src: data.contentSrc,
+      thumbnailSrc: ordIoSrc,
+      src: primarySrc,
     }),
     svg: () => ({
       ...sharedInfo,
       mimeType: 'svg',
       name: 'inscription',
-      src: iframeSrc,
+      src: primarySrc,
     }),
     text: () => ({
       ...sharedInfo,
@@ -124,13 +132,13 @@ export function createInscriptionAsset(data: CreateInscriptionData): Inscription
       ...sharedInfo,
       mimeType: 'video',
       name: 'inscription',
-      src: iframeSrc,
+      src: primarySrc,
     }),
     other: () => ({
       ...sharedInfo,
       mimeType: 'other',
       name: 'inscription',
-      src: '',
+      src: data.contentSrc ?? '',
     }),
   });
 }

package/src/index.ts

@@ -17,6 +17,7 @@ export * from './time';
 export * from './market-data';
 export * from './currency-formatter/currency-formatter';
 export * from './flatten-object';
+export * from './special-char';
 
 export { spamFilter } from './spam-filter/spam-filter';
 export { extractPhraseFromString } from './extract-phrase-from-string/extract-phrase-from-string';

package/src/special-char.ts

@@ -0,0 +1,3 @@
+// A minus sign is a wider character than a hyphen, and should be used in
+// numerical contexts
+export const minusSign = '−';

package/src/special-chars.spec.ts

@@ -0,0 +1,11 @@
+import { describe, expect, test } from 'vitest';
+
+import { minusSign } from './special-char';
+
+describe('minusSign', () => {
+  test('should be the Unicode minus sign character (U+2212)', () => {
+    expect(minusSign).toBe('−');
+    expect(minusSign.charCodeAt(0)).toBe(0x2212);
+    expect(minusSign).not.toBe('-');
+  });
+});

package/src/swap.ts

@@ -0,0 +1,14 @@
+import BigNumber from 'bignumber.js';
+
+import type { Money } from '@leather.io/models';
+
+import { createMoney } from './money';
+
+export function calculateMinToReceiveAmount(quoteAmount: Money, slippage: number): Money {
+  const minReceiveAmount = quoteAmount.amount.times(BigNumber(1).minus(slippage));
+  return createMoney(
+    minReceiveAmount.integerValue(BigNumber.ROUND_DOWN),
+    quoteAmount.symbol,
+    quoteAmount.decimals
+  );
+}