@1sat/wallet-toolbox 0.0.9 → 0.0.10

package/dist/api/ordinals/index.d.ts

@@ -1,16 +1,21 @@
 /**
  * Ordinals Module
  *
- * Functions for managing ordinals/inscriptions.
+ * Skills for managing ordinals/inscriptions.
  * Returns WalletOutput[] directly from the SDK - no custom mapping needed.
  */
-import { type WalletInterface, type WalletOutput, type CreateActionArgs, type ListOutputsArgs } from "@bsv/sdk";
-import type { OneSatServices } from "../../services/OneSatServices";
+import { type WalletOutput, type CreateActionArgs } from "@bsv/sdk";
+import type { Skill, OneSatContext } from "../skills/types";
+type PubKeyHex = string;
 export interface TransferOrdinalRequest {
-    /** Outpoint of the ordinal to transfer (txid_vout or txid.vout format) */
+    /** Outpoint of the ordinal to transfer (txid_vout format) */
     outpoint: string;
-    /** Destination address or paymail */
-    destination: string;
+    /** Recipient's identity public key (preferred) */
+    counterparty?: PubKeyHex;
+    /** Legacy: raw P2PKH address */
+    address?: string;
+    /** Paymail address */
+    paymail?: string;
 }
 export interface ListOrdinalRequest {
     /** Outpoint of ordinal to list */
@@ -19,8 +24,6 @@ export interface ListOrdinalRequest {
     price: number;
     /** Address that receives payment on purchase (BRC-29 receive address) */
     payAddress: string;
-    /** Address that can cancel the listing (optional - derived from CWI if not provided) */
-    cancelAddress?: string;
 }
 export interface PurchaseOrdinalRequest {
     /** Outpoint of listing to purchase */
@@ -29,59 +32,71 @@ export interface PurchaseOrdinalRequest {
     marketplaceAddress?: string;
     /** Marketplace fee rate (0-1) */
     marketplaceRate?: number;
+    /** Optional content type - looked up from ordfs API if not provided */
+    contentType?: string;
+    /** Optional origin outpoint - looked up from ordfs API if not provided */
+    origin?: string;
 }
 export interface OrdinalOperationResponse {
     txid?: string;
     rawtx?: string;
     error?: string;
 }
-/**
- * Derive a cancel address for an ordinal listing.
- * Uses the outpoint as keyID with security level 1 (self-only).
- */
-export declare function deriveCancelAddress(cwi: WalletInterface, outpoint: string): Promise<string>;
-/**
- * List ordinals from the 1sat basket.
- * Returns WalletOutput[] directly - use tags for metadata (origin:, type:, name:, own:, list:).
- */
-export declare function listOrdinals(cwi: WalletInterface, options?: Partial<ListOutputsArgs>): Promise<WalletOutput[]>;
 /**
  * Build CreateActionArgs for transferring an ordinal.
  * Does NOT execute - returns params for createAction.
  */
-export declare function buildTransferOrdinal(cwi: WalletInterface, request: TransferOrdinalRequest): Promise<CreateActionArgs | {
+export declare function buildTransferOrdinal(ctx: OneSatContext, request: TransferOrdinalRequest): Promise<CreateActionArgs | {
     error: string;
 }>;
 /**
  * Build CreateActionArgs for listing an ordinal for sale.
  * Does NOT execute - returns params for createAction.
- * If cancelAddress is not provided, it will be derived from the CWI.
  */
-export declare function buildListOrdinal(cwi: WalletInterface, request: ListOrdinalRequest): Promise<CreateActionArgs | {
+export declare function buildListOrdinal(ctx: OneSatContext, request: ListOrdinalRequest): Promise<CreateActionArgs | {
     error: string;
 }>;
+/** Input for listOrdinals skill */
+export interface ListOrdinalsInput {
+    /** Max number of ordinals to return */
+    limit?: number;
+    /** Offset for pagination */
+    offset?: number;
+}
+/**
+ * List ordinals from the wallet.
+ */
+export declare const listOrdinals: Skill<ListOrdinalsInput, WalletOutput[]>;
+/** Input for deriveCancelAddress skill */
+export interface DeriveCancelAddressInput {
+    /** Outpoint of the ordinal listing */
+    outpoint: string;
+}
+/**
+ * Derive a cancel address for an ordinal listing.
+ */
+export declare const deriveCancelAddress: Skill<DeriveCancelAddressInput, string>;
 /**
- * Transfer an ordinal to a new address.
+ * Transfer an ordinal to a new owner.
  */
-export declare function transferOrdinal(cwi: WalletInterface, request: TransferOrdinalRequest): Promise<OrdinalOperationResponse>;
+export declare const transferOrdinal: Skill<TransferOrdinalRequest, OrdinalOperationResponse>;
 /**
  * List an ordinal for sale on the global orderbook.
  */
-export declare function listOrdinal(cwi: WalletInterface, request: ListOrdinalRequest): Promise<OrdinalOperationResponse>;
+export declare const listOrdinal: Skill<ListOrdinalRequest, OrdinalOperationResponse>;
+/** Input for cancelListing skill */
+export interface CancelListingInput {
+    /** Outpoint of the listing to cancel */
+    outpoint: string;
+}
 /**
  * Cancel an ordinal listing.
- * Uses the origin tag to recover the keyID for signing.
- * Cancel unlock script: <sig> <pubkey> OP_1
  */
-export declare function cancelListing(cwi: WalletInterface, outpoint: string): Promise<OrdinalOperationResponse>;
+export declare const cancelListing: Skill<CancelListingInput, OrdinalOperationResponse>;
 /**
  * Purchase an ordinal from the global orderbook.
- *
- * Flow:
- * 1. Fetch listing BEEF to get the locking script
- * 2. Decode OrdLock to get price and payout
- * 3. Build P2PKH output for buyer
- * 4. Build payment output for seller
- * 5. Build custom OrdLock purchase unlock (preimage only, no signature)
  */
-export declare function purchaseOrdinal(cwi: WalletInterface, request: PurchaseOrdinalRequest, services?: OneSatServices): Promise<OrdinalOperationResponse>;
+export declare const purchaseOrdinal: Skill<PurchaseOrdinalRequest, OrdinalOperationResponse>;
+/** All ordinals skills for registry */
+export declare const ordinalsSkills: (Skill<ListOrdinalsInput, WalletOutput[]> | Skill<DeriveCancelAddressInput, string> | Skill<TransferOrdinalRequest, OrdinalOperationResponse> | Skill<ListOrdinalRequest, OrdinalOperationResponse> | Skill<PurchaseOrdinalRequest, OrdinalOperationResponse>)[];
+export {};