@originals/sdk 1.2.0 → 1.4.3

package/tests/unit/bitcoin/BitcoinManager.test.ts

@@ -1,293 +0,0 @@
-import { describe, test, expect } from 'bun:test';
-import { OriginalsSDK } from '../../../src';
-import type { OrdinalsProvider } from '../../../src/adapters';
-import { DUST_LIMIT_SATS } from '../../../src/types';
-// Use global Buffer available in Node test environment
-
-const createMockProvider = () => {
-  const inscriptions: Record<string, { satoshi?: string }> = {};
-  let counter = 0;
-  const provider: OrdinalsProvider = {
-    async createInscription({ data, contentType, feeRate }) {
-      const inscriptionId = counter === 0 ? 'insc-test' : `insc-test-${counter}`;
-      counter += 1;
-      inscriptions[inscriptionId] = { satoshi: '123456789' };
-      return {
-        inscriptionId,
-        revealTxId: 'tx-reveal-1',
-        commitTxId: 'tx-commit-1',
-        satoshi: '123456789',
-        txid: 'tx-output-1',
-        vout: 1,
-        blockHeight: 100,
-        content: data,
-        contentType,
-        feeRate
-      };
-    },
-    async getInscriptionById(id: string) {
-      const info = inscriptions[id];
-      if (!info) return null;
-      return {
-        inscriptionId: id,
-        content: Buffer.from('payload'),
-        contentType: 'application/json',
-        txid: 'tx-output-1',
-        vout: 1,
-        satoshi: info.satoshi,
-        blockHeight: 100
-      };
-    },
-    async transferInscription(inscriptionId, toAddress, options) {
-      if (!inscriptions[inscriptionId]) {
-        throw new Error('unknown inscription');
-      }
-      return {
-        txid: 'tx-transfer-1',
-        vin: [{ txid: 'tx-output-1', vout: 1 }],
-        vout: [{ value: 12_000, scriptPubKey: 'script', address: toAddress }],
-        fee: options?.feeRate ? Math.round(options.feeRate) : 100,
-        satoshi: inscriptions[inscriptionId].satoshi,
-        confirmations: 0
-      };
-    },
-    async getInscriptionsBySatoshi(satoshi: string) {
-      return Object.entries(inscriptions)
-        .filter(([, info]) => info.satoshi === satoshi)
-        .map(([id]) => ({ inscriptionId: id }));
-    },
-    async broadcastTransaction() {
-      return 'tx-broadcast';
-    },
-    async getTransactionStatus() {
-      return { confirmed: false };
-    },
-    async estimateFee(blocks = 1) {
-      return 5 * blocks;
-    }
-  } as OrdinalsProvider;
-
-  return provider;
-};
-
-describe('BitcoinManager integration with providers', () => {
-  test('inscribeData surfaces provider metadata', async () => {
-    const provider = createMockProvider();
-    const sdk = OriginalsSDK.create({
-      network: 'regtest',
-      ordinalsProvider: provider,
-      feeOracle: { estimateFeeRate: async () => 7 }
-    } as any);
-
-    const result = await sdk.bitcoin.inscribeData(Buffer.from('hello'), 'text/plain');
-    expect(result.inscriptionId).toBe('insc-test');
-    expect(result.satoshi).toBe('123456789');
-    expect((result as any).revealTxId).toBe('tx-reveal-1');
-    expect((result as any).feeRate).toBe(7);
-  });
-
-  test('inscribeData resolves satoshi via fallback when provider omits it', async () => {
-    const inscriptions: Record<string, { satoshi?: string }> = {};
-    const provider: OrdinalsProvider = {
-      async createInscription({ data, contentType }) {
-        const inscriptionId = 'insc-no-sat';
-        inscriptions[inscriptionId] = { satoshi: '999888777' };
-        return {
-          inscriptionId,
-          revealTxId: 'tx-reveal-2',
-          txid: 'tx-output-2',
-          vout: 0,
-          content: data,
-          contentType
-        } as any;
-      },
-      async getInscriptionById(id: string) {
-        const satoshi = inscriptions[id]?.satoshi;
-        return satoshi
-          ? {
-              inscriptionId: id,
-              content: Buffer.from('x'),
-              contentType: 'text/plain',
-              txid: 'tx-output-2',
-              vout: 0,
-              satoshi
-            }
-          : null;
-      },
-      async transferInscription() {
-        throw new Error('noop');
-      },
-      async getInscriptionsBySatoshi() {
-        return [];
-      },
-      async broadcastTransaction() {
-        return 'tx';
-      },
-      async getTransactionStatus() {
-        return { confirmed: false };
-      },
-      async estimateFee() {
-        return 3;
-      }
-    } as OrdinalsProvider;
-
-    const sdk = OriginalsSDK.create({ network: 'regtest', ordinalsProvider: provider } as any);
-    const result = await sdk.bitcoin.inscribeData(Buffer.from('x'), 'text/plain');
-    expect(result.satoshi).toBe('999888777');
-  });
-
-  test('inscribeData propagates provider errors', async () => {
-    const provider: OrdinalsProvider = {
-      async createInscription() {
-        throw new Error('boom');
-      },
-      async getInscriptionById() {
-        return null;
-      },
-      async transferInscription() {
-        throw new Error('noop');
-      },
-      async getInscriptionsBySatoshi() {
-        return [];
-      },
-      async broadcastTransaction() {
-        return 'tx';
-      },
-      async getTransactionStatus() {
-        return { confirmed: false };
-      },
-      async estimateFee() {
-        return 1;
-      }
-    };
-
-    const sdk = OriginalsSDK.create({ network: 'regtest', ordinalsProvider: provider } as any);
-    await expect(
-      sdk.bitcoin.inscribeData(Buffer.from('data'), 'text/plain')
-    ).rejects.toThrow('boom');
-  });
-
-  test('trackInscription defers to provider data', async () => {
-    const provider = createMockProvider();
-    const sdk = OriginalsSDK.create({ network: 'regtest', ordinalsProvider: provider } as any);
-    const created = await sdk.bitcoin.inscribeData(Buffer.from('payload'), 'text/plain');
-    const tracked = await sdk.bitcoin.trackInscription(created.inscriptionId);
-    expect(tracked?.txid).toBe('tx-output-1');
-    expect(tracked?.blockHeight).toBe(100);
-  });
-
-  test('transferInscription returns provider transaction shape', async () => {
-    const provider = createMockProvider();
-    const sdk = OriginalsSDK.create({ network: 'regtest', ordinalsProvider: provider } as any);
-    const inscription = await sdk.bitcoin.inscribeData(Buffer.from('payload'), 'text/plain');
-    const tx = await sdk.bitcoin.transferInscription(inscription, 'tb1qw508d6qejxtdg4y5r3zarvary0c5xw7kxpjzsx');
-    expect(tx.txid).toBe('tx-transfer-1');
-    expect(tx.vout[0].address).toBe('tb1qw508d6qejxtdg4y5r3zarvary0c5xw7kxpjzsx');
-  });
-
-  test('transferInscription enforces dust limit on fallback vout', async () => {
-    const provider = createMockProvider();
-    const sdk = OriginalsSDK.create({ network: 'regtest', ordinalsProvider: provider } as any);
-    const inscription = await sdk.bitcoin.inscribeData(Buffer.from('payload'), 'text/plain');
-    // provider returns vout with value 12_000 so skip; force empty vout by using a provider that returns none
-    const provider2: OrdinalsProvider = {
-      ...provider,
-      async transferInscription() {
-        return { txid: 'tx', vin: [{ txid: 'a', vout: 0 }], vout: [], fee: 1 } as any;
-      }
-    } as OrdinalsProvider;
-    const sdk2 = OriginalsSDK.create({ network: 'regtest', ordinalsProvider: provider2 } as any);
-    const tx2 = await sdk2.bitcoin.transferInscription(inscription, 'tb1qrp33g0q5c5txsp9arysrx4k6zdkfs4nce4xj0gdcccefvpysxf3q0sl5k7');
-    expect(tx2.vout[0].value).toBeGreaterThanOrEqual(DUST_LIMIT_SATS);
-    expect(tx2.vout[0].address).toBe('tb1qrp33g0q5c5txsp9arysrx4k6zdkfs4nce4xj0gdcccefvpysxf3q0sl5k7');
-  });
-
-  test('getSatoshiFromInscription returns null when provider missing', async () => {
-    const sdk = OriginalsSDK.create({ network: 'regtest' });
-    expect(await sdk.bitcoin.getSatoshiFromInscription('unknown')).toBeNull();
-  });
-
-  test('validateBTCODID checks provider assignments', async () => {
-    const provider = createMockProvider();
-    const sdk = OriginalsSDK.create({ network: 'regtest', ordinalsProvider: provider } as any);
-    await sdk.bitcoin.inscribeData(Buffer.from('payload'), 'text/plain');
-    await expect(sdk.bitcoin.validateBTCODID('did:btco:123456789')).resolves.toBe(true);
-    await expect(sdk.bitcoin.validateBTCODID('did:btco:999999999')).resolves.toBe(false);
-  });
-
-  test('validateBTCODID rejects invalid network prefixes', async () => {
-    const provider = createMockProvider();
-    const sdk = OriginalsSDK.create({ network: 'regtest', ordinalsProvider: provider } as any);
-    await sdk.bitcoin.inscribeData(Buffer.from('payload'), 'text/plain');
-    
-    // Valid networks should work
-    await expect(sdk.bitcoin.validateBTCODID('did:btco:test:123456789')).resolves.toBe(true);
-    await expect(sdk.bitcoin.validateBTCODID('did:btco:sig:123456789')).resolves.toBe(true);
-    
-    // Invalid network prefix should be rejected
-    await expect(sdk.bitcoin.validateBTCODID('did:btco:invalid:123456789')).resolves.toBe(false);
-    await expect(sdk.bitcoin.validateBTCODID('did:btco:mainnet:123456789')).resolves.toBe(false);
-    await expect(sdk.bitcoin.validateBTCODID('did:btco:regtest:123456789')).resolves.toBe(false);
-  });
-
-  test('preventFrontRunning returns false when multiple inscriptions exist on same satoshi', async () => {
-    const provider = createMockProvider();
-    const sdk = OriginalsSDK.create({ network: 'regtest', ordinalsProvider: provider } as any);
-    await sdk.bitcoin.inscribeData(Buffer.from('payload1'), 'text/plain');
-    await sdk.bitcoin.inscribeData(Buffer.from('payload2'), 'text/plain');
-    const canProceed = await sdk.bitcoin.preventFrontRunning('123456789');
-    expect(canProceed).toBe(false);
-  });
-
-  test('resolveFeeRate prefers feeOracle over provider and provided value', async () => {
-    const provider = createMockProvider();
-    const sdk = OriginalsSDK.create({
-      network: 'regtest',
-      ordinalsProvider: provider,
-      feeOracle: { estimateFeeRate: async () => 9 }
-    } as any);
-    const res: any = await sdk.bitcoin.inscribeData(Buffer.from('hello'), 'text/plain', 2);
-    expect(res.feeRate).toBe(9);
-  });
-
-  test('inscribeData throws ORD_PROVIDER_REQUIRED when provider not configured', async () => {
-    const sdk = OriginalsSDK.create({ network: 'regtest' });
-    try {
-      await sdk.bitcoin.inscribeData(Buffer.from('data'), 'text/plain');
-      throw new Error('Expected error to be thrown');
-    } catch (error: any) {
-      expect(error.code).toBe('ORD_PROVIDER_REQUIRED');
-      expect(error.message).toContain('Ordinals provider must be configured');
-    }
-  });
-
-  test('transferInscription throws ORD_PROVIDER_REQUIRED when provider not configured', async () => {
-    const sdk = OriginalsSDK.create({ network: 'regtest' });
-    const mockInscription = {
-      inscriptionId: 'test-id',
-      satoshi: 'sat-123',
-      content: Buffer.from('test'),
-      contentType: 'text/plain',
-      txid: 'tx-123',
-      vout: 0
-    };
-    try {
-      await sdk.bitcoin.transferInscription(mockInscription, 'tb1qw508d6qejxtdg4y5r3zarvary0c5xw7kxpjzsx');
-      throw new Error('Expected error to be thrown');
-    } catch (error: any) {
-      expect(error.code).toBe('ORD_PROVIDER_REQUIRED');
-      expect(error.message).toContain('Ordinals provider must be configured');
-    }
-  });
-
-  test('validateBitcoinConfig throws when ordinalsProvider not configured', () => {
-    const sdk = OriginalsSDK.create({ network: 'regtest' });
-    expect(() => sdk.validateBitcoinConfig()).toThrow('Bitcoin operations require an ordinalsProvider');
-  });
-
-  test('validateBitcoinConfig passes when ordinalsProvider is configured', () => {
-    const provider = createMockProvider();
-    const sdk = OriginalsSDK.create({ network: 'regtest', ordinalsProvider: provider } as any);
-    expect(() => sdk.validateBitcoinConfig()).not.toThrow();
-  });
-});

package/tests/unit/bitcoin/BroadcastClient.test.ts

@@ -1,52 +0,0 @@
-import { describe, test, expect, mock } from 'bun:test';
-import { BroadcastClient } from '../../../src/bitcoin/BroadcastClient';
-
-describe('BroadcastClient', () => {
-  test('broadcastIdempotent deduplicates by key', async () => {
-    const broadcaster = mock(async (hex: string) => 'txid-1');
-    const status = mock(async (_: string) => ({ confirmed: true, confirmations: 3 }));
-    const bc = new BroadcastClient(broadcaster, status);
-    const fn = () => bc.broadcastIdempotent('k', async () => broadcaster('hex'));
-    const [a, b] = await Promise.all([fn(), fn()]);
-    expect(a).toBe('txid-1');
-    expect(b).toBe('txid-1');
-    expect(broadcaster).toHaveBeenCalledTimes(1);
-  });
-
-  test('broadcastAndConfirm returns immediately when confirmed', async () => {
-    const broadcaster = mock(async (_: string) => 'txid-2');
-    const status = mock(async (_: string) => ({ confirmed: true, confirmations: 2 }));
-    const bc = new BroadcastClient(broadcaster, status);
-    const res = await bc.broadcastAndConfirm('hex', { pollIntervalMs: 1, maxAttempts: 1 });
-    expect(res).toEqual({ txid: 'txid-2', confirmations: 2 });
-  });
-
-  test('broadcastAndConfirm polls until maxAttempts and returns last confirmations', async () => {
-    const broadcaster = mock(async (_: string) => 'txid-3');
-    let calls = 0;
-    const status = mock(async (_: string) => {
-      calls++;
-      return { confirmed: false, confirmations: calls - 1 } as any;
-    });
-    const bc = new BroadcastClient(broadcaster, status);
-    const res = await bc.broadcastAndConfirm('hex', { pollIntervalMs: 1, maxAttempts: 3 });
-    expect(res).toEqual({ txid: 'txid-3', confirmations: expect.any(Number) });
-  });
-
-  test('broadcastAndConfirm returns 0 confirmations when provider omits confirmations', async () => {
-    const broadcaster = mock(async (_: string) => 'txid-4');
-    const status = mock(async (_: string) => ({ confirmed: false }));
-    const bc = new BroadcastClient(broadcaster, status);
-    const res = await bc.broadcastAndConfirm('hex', { pollIntervalMs: 1, maxAttempts: 2 });
-    expect(res).toEqual({ txid: 'txid-4', confirmations: 0 });
-  });
-
-  test('broadcastAndConfirm uses defaults when options not provided', async () => {
-    const broadcaster = mock(async (_: string) => 'txid-5');
-    const status = mock(async (_: string) => ({ confirmed: true, confirmations: undefined as any }));
-    const bc = new BroadcastClient(broadcaster, status);
-    const res = await bc.broadcastAndConfirm('hex');
-    expect(res).toEqual({ txid: 'txid-5', confirmations: 1 });
-  });
-});
-

package/tests/unit/bitcoin/OrdNodeProvider.test.ts

@@ -1,53 +0,0 @@
-import { describe, test, expect } from 'bun:test';
-import { OrdNodeProvider } from '../../../src/bitcoin/providers/OrdNodeProvider';
-
-describe('OrdNodeProvider (stub)', () => {
-  test('constructs and returns defaults', async () => {
-    const p = new OrdNodeProvider({ nodeUrl: 'https://ord.example' });
-    const info = await p.getSatInfo('1');
-    expect(info.inscription_ids).toEqual([]);
-    const insc = await p.resolveInscription('abc');
-    expect(insc.content_url).toContain('/content/abc');
-  });
-});
-
-/** Inlined from OrdNodeProvider.more.part.ts */
-
-describe('OrdNodeProvider additional coverage', () => {
-  test('covers constructor and simple methods', async () => {
-    const provider = new OrdNodeProvider({ nodeUrl: 'http://node', timeout: 1234, network: 'signet' });
-
-    const res = await provider.resolve('abc');
-    expect(res).toMatchObject({ id: 'abc', content_url: 'http://node/content/abc' });
-
-    const ins = await provider.resolveInscription('ins-1');
-    expect(ins).toMatchObject({ id: 'ins-1', content_url: 'http://node/content/ins-1' });
-
-    const info = await provider.resolveInfo('rid');
-    expect(info.id).toBe('rid');
-
-    const coll = await provider.resolveCollection('did:btco:1');
-    expect(coll).toEqual([]);
-
-    expect(await provider.getSatInfo('123')).toEqual({ inscription_ids: [] });
-    expect(await provider.getMetadata('ins-1')).toBeNull();
-
-    const gen = provider.getAllResources();
-    const { done } = await gen.next();
-    expect(done).toBe(true);
-
-    const genChrono = provider.getAllResourcesChronological();
-    const { done: done2 } = await genChrono.next();
-    expect(done2).toBe(true);
-
-    expect(await provider.getInscriptionLocationsByAddress('addr')).toEqual([]);
-
-    const ins0 = await provider.getInscriptionByNumber(0);
-    expect(ins0.id).toBe('0');
-
-    expect(await provider.getAddressOutputs('addr')).toEqual([]);
-
-    const out = await provider.getOutputDetails('txid:0');
-    expect(out).toEqual({ value: 0, script_pubkey: '', spent: false, inscriptions: [] });
-  });
-});