tapass 0.1.0 → 0.2.0

package/dist/tapd_methods/rfq/index.d.ts

@@ -0,0 +1,19 @@
+export { default as addAssetBuyOffer } from './add_asset_buy_offer.js';
+export type { AddAssetBuyOfferArgs } from './add_asset_buy_offer.js';
+export { default as addAssetBuyOrder } from './add_asset_buy_order.js';
+export type { AddAssetBuyOrderArgs } from './add_asset_buy_order.js';
+export type { AddAssetBuyOrderResult } from './add_asset_buy_order.js';
+export { default as addAssetSellOffer } from './add_asset_sell_offer.js';
+export type { AddAssetSellOfferArgs } from './add_asset_sell_offer.js';
+export { default as addAssetSellOrder } from './add_asset_sell_order.js';
+export type { AddAssetSellOrderArgs } from './add_asset_sell_order.js';
+export type { AddAssetSellOrderResult } from './add_asset_sell_order.js';
+export { default as getAcceptedQuotes } from './get_accepted_quotes.js';
+export type { GetAcceptedQuotesArgs } from './get_accepted_quotes.js';
+export type { GetAcceptedQuotesResult } from './get_accepted_quotes.js';
+export { default as getAssetForwards } from './get_asset_forwards.js';
+export type { GetAssetForwardsArgs } from './get_asset_forwards.js';
+export type { GetAssetForwardsResult } from './get_asset_forwards.js';
+export { default as subscribeToRfqEvents } from './subscribe_to_rfq_events.js';
+export type { SubscribeToRfqEventsArgs } from './subscribe_to_rfq_events.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/tapd_methods/rfq/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/tapd_methods/rfq/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,IAAI,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AACrE,YAAY,EAAC,oBAAoB,EAAC,MAAM,0BAA0B,CAAC;AACnE,OAAO,EAAC,OAAO,IAAI,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AACrE,YAAY,EAAC,oBAAoB,EAAC,MAAM,0BAA0B,CAAC;AACnE,YAAY,EAAC,sBAAsB,EAAC,MAAM,0BAA0B,CAAC;AACrE,OAAO,EAAC,OAAO,IAAI,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AACvE,YAAY,EAAC,qBAAqB,EAAC,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAC,OAAO,IAAI,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AACvE,YAAY,EAAC,qBAAqB,EAAC,MAAM,2BAA2B,CAAC;AACrE,YAAY,EAAC,uBAAuB,EAAC,MAAM,2BAA2B,CAAC;AACvE,OAAO,EAAC,OAAO,IAAI,iBAAiB,EAAC,MAAM,0BAA0B,CAAC;AACtE,YAAY,EAAC,qBAAqB,EAAC,MAAM,0BAA0B,CAAC;AACpE,YAAY,EAAC,uBAAuB,EAAC,MAAM,0BAA0B,CAAC;AACtE,OAAO,EAAC,OAAO,IAAI,gBAAgB,EAAC,MAAM,yBAAyB,CAAC;AACpE,YAAY,EAAC,oBAAoB,EAAC,MAAM,yBAAyB,CAAC;AAClE,YAAY,EAAC,sBAAsB,EAAC,MAAM,yBAAyB,CAAC;AACpE,OAAO,EAAC,OAAO,IAAI,oBAAoB,EAAC,MAAM,8BAA8B,CAAC;AAC7E,YAAY,EAAC,wBAAwB,EAAC,MAAM,8BAA8B,CAAC"}

package/dist/tapd_methods/rfq/index.js

@@ -0,0 +1,8 @@
+export { default as addAssetBuyOffer } from './add_asset_buy_offer.js';
+export { default as addAssetBuyOrder } from './add_asset_buy_order.js';
+export { default as addAssetSellOffer } from './add_asset_sell_offer.js';
+export { default as addAssetSellOrder } from './add_asset_sell_order.js';
+export { default as getAcceptedQuotes } from './get_accepted_quotes.js';
+export { default as getAssetForwards } from './get_asset_forwards.js';
+export { default as subscribeToRfqEvents } from './subscribe_to_rfq_events.js';
+//# sourceMappingURL=index.js.map

package/dist/tapd_methods/rfq/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/tapd_methods/rfq/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,IAAI,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAErE,OAAO,EAAC,OAAO,IAAI,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAGrE,OAAO,EAAC,OAAO,IAAI,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAEvE,OAAO,EAAC,OAAO,IAAI,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAGvE,OAAO,EAAC,OAAO,IAAI,iBAAiB,EAAC,MAAM,0BAA0B,CAAC;AAGtE,OAAO,EAAC,OAAO,IAAI,gBAAgB,EAAC,MAAM,yBAAyB,CAAC;AAGpE,OAAO,EAAC,OAAO,IAAI,oBAAoB,EAAC,MAAM,8BAA8B,CAAC"}

package/dist/tapd_methods/rfq/subscribe_to_rfq_events.d.ts

@@ -0,0 +1,68 @@
+import { EventEmitter } from 'node:events';
+import type { AuthenticatedTapd } from '../../tapd_grpc/index.js';
+export type SubscribeToRfqEventsArgs = {
+    /** Authenticated tapd API Object */
+    tapd: AuthenticatedTapd;
+};
+export default _default;
+/** Subscribe to RFQ events
+
+  Requires `rfq:read` permission
+
+  A rate is a number of asset units per BTC, as an exact decimal string
+
+  {
+    tapd: <Authenticated tapd API Object>
+  }
+
+  @throws
+  <Error>
+
+  @returns
+  <EventEmitter Object>
+
+  @event 'accepted_buy_quote'
+  {
+    [accepted_max_amount]: <Accepted Maximum Asset Units Numeric String>
+    [asset_id]: <Asset Id Hex String>
+    at: <Event At ISO 8601 Date String>
+    channel: <Channel To Pay Over Standard Format Channel Id String>
+    expires_at: <Quote Expires At ISO 8601 Date String>
+    [group_key]: <Asset Group BIP340 Public Key Hex String>
+    id: <Quote Request Id Hex String>
+    max_amount: <Maximum Asset Units Numeric String>
+    min_transportable_amount: <Minimum Asset Units In One HTLC Numeric String>
+    peer_public_key: <Peer Public Key Hex String>
+    [price_oracle_metadata]: <Price Oracle Metadata String>
+    rate: <Ask Rate Asset Units Per BTC Exact Decimal String>
+  }
+
+  @event 'accepted_htlc'
+  {
+    at: <Event At ISO 8601 Date String>
+    channel: <Payment Standard Format Channel Id String>
+  }
+
+  @event 'accepted_sell_quote'
+  {
+    [accepted_max_mtokens]: <Accepted Maximum Payment Millitokens String>
+    amount: <Asset Units Numeric String>
+    [asset_id]: <Asset Id Hex String>
+    at: <Event At ISO 8601 Date String>
+    channel: <Channel To Pay Over Standard Format Channel Id String>
+    expires_at: <Quote Expires At ISO 8601 Date String>
+    [group_key]: <Asset Group BIP340 Public Key Hex String>
+    id: <Quote Request Id Hex String>
+    min_transportable_mtokens: <Minimum Millitokens To Send One Unit String>
+    peer_public_key: <Peer Public Key Hex String>
+    [price_oracle_metadata]: <Price Oracle Metadata String>
+    rate: <Bid Rate Asset Units Per BTC Exact Decimal String>
+  }
+
+  @event 'end'
+
+  @event 'error'
+  [<Error Code Number>, <Error Message String>, <Error Details Object>]
+*/
+declare function _default({ tapd }: SubscribeToRfqEventsArgs): EventEmitter<[never]>;
+//# sourceMappingURL=subscribe_to_rfq_events.d.ts.map

package/dist/tapd_methods/rfq/subscribe_to_rfq_events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscribe_to_rfq_events.d.ts","sourceRoot":"","sources":["../../../src/tapd_methods/rfq/subscribe_to_rfq_events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAIzC,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,0BAA0B,CAAC;AAWhE,MAAM,MAAM,wBAAwB,GAAG;IACrC,oCAAoC;IACpC,IAAI,EAAE,iBAAiB,CAAC;CACzB,CAAC;;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0DE;0BACc,EAAC,IAAI,EAAC,EAAE,wBAAwB"}

package/dist/tapd_methods/rfq/subscribe_to_rfq_events.js

@@ -0,0 +1,107 @@
+import { EventEmitter } from 'node:events';
+import { emitSubscriptionError } from '../../grpc/index.js';
+import { handleRemoveListener } from '../../grpc/index.js';
+import { isConnectionFailure } from '../../tapd_requests/index.js';
+import { isPermissionDenied } from '../../tapd_requests/index.js';
+import { isTapd } from '../../tapd_requests/index.js';
+import { rpcRfqEventAsEvent } from '../../tapd_responses/index.js';
+const cancelError = 'Cancelled on client';
+const events = ['accepted_buy_quote', 'accepted_htlc', 'accepted_sell_quote'];
+const method = 'subscribeRfqEventNtfns';
+const type = 'rfq';
+/** Subscribe to RFQ events
+
+  Requires `rfq:read` permission
+
+  A rate is a number of asset units per BTC, as an exact decimal string
+
+  {
+    tapd: <Authenticated tapd API Object>
+  }
+
+  @throws
+  <Error>
+
+  @returns
+  <EventEmitter Object>
+
+  @event 'accepted_buy_quote'
+  {
+    [accepted_max_amount]: <Accepted Maximum Asset Units Numeric String>
+    [asset_id]: <Asset Id Hex String>
+    at: <Event At ISO 8601 Date String>
+    channel: <Channel To Pay Over Standard Format Channel Id String>
+    expires_at: <Quote Expires At ISO 8601 Date String>
+    [group_key]: <Asset Group BIP340 Public Key Hex String>
+    id: <Quote Request Id Hex String>
+    max_amount: <Maximum Asset Units Numeric String>
+    min_transportable_amount: <Minimum Asset Units In One HTLC Numeric String>
+    peer_public_key: <Peer Public Key Hex String>
+    [price_oracle_metadata]: <Price Oracle Metadata String>
+    rate: <Ask Rate Asset Units Per BTC Exact Decimal String>
+  }
+
+  @event 'accepted_htlc'
+  {
+    at: <Event At ISO 8601 Date String>
+    channel: <Payment Standard Format Channel Id String>
+  }
+
+  @event 'accepted_sell_quote'
+  {
+    [accepted_max_mtokens]: <Accepted Maximum Payment Millitokens String>
+    amount: <Asset Units Numeric String>
+    [asset_id]: <Asset Id Hex String>
+    at: <Event At ISO 8601 Date String>
+    channel: <Channel To Pay Over Standard Format Channel Id String>
+    expires_at: <Quote Expires At ISO 8601 Date String>
+    [group_key]: <Asset Group BIP340 Public Key Hex String>
+    id: <Quote Request Id Hex String>
+    min_transportable_mtokens: <Minimum Millitokens To Send One Unit String>
+    peer_public_key: <Peer Public Key Hex String>
+    [price_oracle_metadata]: <Price Oracle Metadata String>
+    rate: <Bid Rate Asset Units Per BTC Exact Decimal String>
+  }
+
+  @event 'end'
+
+  @event 'error'
+  [<Error Code Number>, <Error Message String>, <Error Details Object>]
+*/
+export default ({ tapd }) => {
+    if (!isTapd({ method, tapd, type })) {
+        throw new Error('ExpectedAuthenticatedTapdToSubscribeToRfqEvents');
+    }
+    const emitter = new EventEmitter();
+    const subscription = tapd[type][method]({});
+    // The error helper only reads `details` to find a client cancel
+    const emitError = emitSubscriptionError({ emitter, subscription });
+    // Cancel the subscription when all event listeners are removed
+    handleRemoveListener({ emitter, events, subscription });
+    subscription.on('data', (data) => {
+        try {
+            const { data: details, event } = rpcRfqEventAsEvent(data);
+            return emitter.emit(event, details);
+        }
+        catch (err) {
+            return emitError([503, err.message]);
+        }
+    });
+    subscription.on('end', () => emitter.emit('end'));
+    subscription.on('error', (err) => {
+        // Exit early when the client cancelled the subscription
+        if (err?.details === cancelError) {
+            return subscription.removeAllListeners();
+        }
+        if (isConnectionFailure({ err })) {
+            return emitError([503, 'FailedToConnectToTapdToSubscribeToRfqEvents']);
+        }
+        if (isPermissionDenied({ err })) {
+            return emitError([403, 'PermissionDeniedToSubscribeToRfqEvents']);
+        }
+        return emitError([503, 'UnexpectedErrorInRfqEventsSubscription', { err }]);
+    });
+    subscription.on('status', (status) => emitter.emit('status', status));
+    return emitter;
+};
+//# sourceMappingURL=subscribe_to_rfq_events.js.map

package/dist/tapd_methods/rfq/subscribe_to_rfq_events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscribe_to_rfq_events.js","sourceRoot":"","sources":["../../../src/tapd_methods/rfq/subscribe_to_rfq_events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAEzC,OAAO,EAAC,qBAAqB,EAAC,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAC,oBAAoB,EAAC,MAAM,qBAAqB,CAAC;AAEzD,OAAO,EAAC,mBAAmB,EAAC,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAC,kBAAkB,EAAC,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAC,MAAM,EAAC,MAAM,8BAA8B,CAAC;AACpD,OAAO,EAAC,kBAAkB,EAAC,MAAM,+BAA+B,CAAC;AAEjE,MAAM,WAAW,GAAG,qBAAqB,CAAC;AAC1C,MAAM,MAAM,GAAG,CAAC,oBAAoB,EAAE,eAAe,EAAE,qBAAqB,CAAC,CAAC;AAC9E,MAAM,MAAM,GAAG,wBAAwB,CAAC;AACxC,MAAM,IAAI,GAAG,KAAK,CAAC;AAOnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0DE;AACF,eAAe,CAAC,EAAC,IAAI,EAA2B,EAAE,EAAE;IAClD,IAAI,CAAC,MAAM,CAAC,EAAC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAC,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,OAAO,GAAG,IAAI,YAAY,EAAE,CAAC;IACnC,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC;IAE5C,gEAAgE;IAChE,MAAM,SAAS,GAAG,qBAAqB,CAAC,EAAC,OAAO,EAAE,YAAY,EAAC,CAEtD,CAAC;IAEV,+DAA+D;IAC/D,oBAAoB,CAAC,EAAC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAC,CAAC,CAAC;IAEtD,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAa,EAAE,EAAE;QACxC,IAAI,CAAC;YACH,MAAM,EAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAC,GAAG,kBAAkB,CAAC,IAAW,CAAC,CAAC;YAE/D,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACtC,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,OAAO,SAAS,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;QACvC,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAElD,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAQ,EAAE,EAAE;QACpC,wDAAwD;QACxD,IAAI,GAAG,EAAE,OAAO,KAAK,WAAW,EAAE,CAAC;YACjC,OAAO,YAAY,CAAC,kBAAkB,EAAE,CAAC;QAC3C,CAAC;QAED,IAAI,mBAAmB,CAAC,EAAC,GAAG,EAAC,CAAC,EAAE,CAAC;YAC/B,OAAO,SAAS,CAAC,CAAC,GAAG,EAAE,6CAA6C,CAAC,CAAC,CAAC;QACzE,CAAC;QAED,IAAI,kBAAkB,CAAC,EAAC,GAAG,EAAC,CAAC,EAAE,CAAC;YAC9B,OAAO,SAAS,CAAC,CAAC,GAAG,EAAE,wCAAwC,CAAC,CAAC,CAAC;QACpE,CAAC;QAED,OAAO,SAAS,CAAC,CAAC,GAAG,EAAE,wCAAwC,EAAE,EAAC,GAAG,EAAC,CAAC,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,MAAe,EAAE,EAAE,CAC5C,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAC/B,CAAC;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC"}

package/dist/tapd_methods/send/burn_asset.d.ts

@@ -0,0 +1,135 @@
+import type { Asset } from '../../tapd_responses/index.js';
+import type { Transfer } from '../../tapd_responses/index.js';
+import type { AuthenticatedTapdArgs } from '../../typescript/index.js';
+import type { TapdMethod } from '../../typescript/index.js';
+export type BurnAssetArgs = AuthenticatedTapdArgs<{
+    /** Asset Units To Burn Numeric String */
+    amount: string;
+    /** Asset Id Hex String */
+    asset_id?: string;
+    /** Asset Group Key Hex String */
+    group_key?: string;
+    /** The Caller Confirms That the Assets Will Be Destroyed */
+    is_burn_confirmed: boolean;
+    /** Burn Note String */
+    note?: string;
+}>;
+export type BurnAssetResult = {
+    /** Burned Assets */
+    assets: Asset[];
+    /** Burn Transfer */
+    transfer: Transfer;
+};
+/** Burn asset units
+
+  The burned asset units are destroyed and cannot be recovered
+
+  Requires `assets:write` permission
+
+  An `asset_id` or a `group_key` is required, not both. `is_burn_confirmed`
+  must be true.
+
+  A burn with a `group_key` needs tapd v0.8.0 or later
+
+  {
+    amount: <Asset Units To Burn Numeric String>
+    [asset_id]: <Asset Id Hex String>
+    [group_key]: <Asset Group Key Hex String>
+    is_burn_confirmed: <The Caller Confirms That the Assets Will Be Destroyed Bool>
+    [note]: <Burn Note String>
+    tapd: <Authenticated tapd API Object>
+  }
+
+  @returns via cbk or Promise
+  {
+    assets: [{
+      amount: <Asset Units Numeric String>
+      [anchor]: {
+        [block_hash]: <Anchor Block Hash Hex String>
+        [block_height]: <Anchor Block Height Number>
+        [confirmed_at]: <Anchor Confirmed At ISO 8601 Date String>
+        internal_key: <Anchor Internal Key Hex String>
+        merkle_root: <Anchor Taproot Merkle Root Hex String>
+        [tapscript_sibling]: <Tapscript Sibling Preimage Hex String>
+        transaction: <Raw Anchor Transaction Hex String>
+        transaction_id: <Anchor Transaction Id Hex String>
+        transaction_vout: <Anchor Transaction Output Index Number>
+      }
+      asset_id: <Asset Id Hex String>
+      [decimal_display]: <Decimal Places To Show Number>
+      genesis_output_index: <Genesis Commitment Output Index Number>
+      genesis_transaction_id: <Genesis Point Transaction Id Hex String>
+      genesis_transaction_vout: <Genesis Point Transaction Output Index Number>
+      [group]: {
+        key: <Tweaked Group Key Hex String>
+        raw_key: <Raw Group Key Hex String>
+        [tapscript_root]: <Group Tapscript Root Hex String>
+        [witness]: <Group Membership Witness Hex String>
+      }
+      is_burn: <Asset Is Burned Bool>
+      is_collectible: <Asset Is Collectible Bool>
+      is_local: <Script Key Belongs To This Node Bool>
+      is_spent: <Asset Is Spent Bool>
+      [lease_expires_at]: <Lease Expires At ISO 8601 Date String>
+      [lease_owner]: <Lease Owner Id Hex String>
+      [lock_time]: <Lock Time Number>
+      meta_hash: <Asset Metadata Hash Hex String>
+      name: <Asset Name String>
+      [relative_lock_time]: <Relative Lock Time Number>
+      script_key: <Script Key Hex String>
+      script_key_type: <Script Key Type String>
+      script_version: <Script Version Number>
+      version: <Asset Version Number>
+    }]
+    transfer: {
+      [block_hash]: <Anchor Block Hash Hex String>
+      [block_height]: <Anchor Block Height Number>
+      created_at: <Transfer Created At ISO 8601 Date String>
+      fee: <Anchor Transaction Chain Fee Tokens Number>
+      height_hint: <Anchor Transaction Confirmation Height Hint Number>
+      inputs: [{
+        amount: <Asset Units Numeric String>
+        asset_id: <Asset Id Hex String>
+        [group_key]: <Asset Group Key Hex String>
+        is_collectible: <Asset Is Collectible Bool>
+        script_key: <Script Key Hex String>
+        transaction_id: <Spent Anchor Transaction Id Hex String>
+        transaction_vout: <Spent Anchor Transaction Output Index Number>
+      }]
+      [label]: <Transfer Label String>
+      outputs: [{
+        [address]: <Taproot Assets Address Of the Recipient String>
+        amount: <Asset Units Numeric String>
+        anchor: {
+          internal_key: <Anchor Internal Key Hex String>
+          merkle_root: <Anchor Taproot Merkle Root Hex String>
+          output_script: <Output Script Hex String>
+          passive_assets_count: <Count Of Passive Assets In the Anchor Number>
+          taproot_asset_root: <Taproot Asset Root Commitment Hex String>
+          [tapscript_sibling]: <Tapscript Sibling Preimage Hex String>
+          tokens: <Anchor Output Tokens Number>
+          transaction_id: <Anchor Transaction Id Hex String>
+          transaction_vout: <Anchor Transaction Output Index Number>
+        }
+        [asset_id]: <Asset Id Hex String>
+        asset_version: <Asset Version Number>
+        [group_key]: <Asset Group Key Hex String>
+        is_collectible: <Asset Is Collectible Bool>
+        is_local: <Script Key Belongs To This Node Bool>
+        is_split_root: <Output Is the Split Root Bool>
+        [lock_time]: <Lock Time Number>
+        [proof]: <Proof File Hex String>
+        [proof_courier]: <Proof Courier Address String>
+        [proof_delivery]: <Proof Delivery State String> // complete, pending
+        [relative_lock_time]: <Relative Lock Time Number>
+        script_key: <Script Key Hex String>
+        [split_root_hash]: <Split Commitment Root Hash Hex String>
+      }]
+      [transaction]: <Raw Anchor Transaction Hex String>
+      transaction_id: <Anchor Transaction Id Hex String>
+    }
+  }
+*/
+declare const burnAsset: TapdMethod<BurnAssetArgs, BurnAssetResult>;
+export default burnAsset;
+//# sourceMappingURL=burn_asset.d.ts.map

package/dist/tapd_methods/send/burn_asset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"burn_asset.d.ts","sourceRoot":"","sources":["../../../src/tapd_methods/send/burn_asset.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,+BAA+B,CAAC;AACzD,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,EAAC,qBAAqB,EAAC,MAAM,2BAA2B,CAAC;AAGrE,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,2BAA2B,CAAC;AAe1D,MAAM,MAAM,aAAa,GAAG,qBAAqB,CAAC;IAChD,yCAAyC;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iCAAiC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4DAA4D;IAC5D,iBAAiB,EAAE,OAAO,CAAC;IAC3B,uBAAuB;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG;IAC5B,oBAAoB;IACpB,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,oBAAoB;IACpB,QAAQ,EAAE,QAAQ,CAAC;CACpB,CAAC;AAOF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA6GE;AACF,QAAA,MAAM,SAAS,EAAE,UAAU,CAAC,aAAa,EAAE,eAAe,CAkHzD,CAAC;eAEa,SAAS"}

package/dist/tapd_methods/send/burn_asset.js

@@ -0,0 +1,220 @@
+import { auto as asyncAuto } from 'async';
+import { returnResult } from 'asyncjs-util';
+import { isConnectionFailure } from '../../tapd_requests/index.js';
+import { isPermissionDenied } from '../../tapd_requests/index.js';
+import { isTapd } from '../../tapd_requests/index.js';
+import { rpcAssetAsAsset } from '../../tapd_responses/index.js';
+import { rpcTransferAsTransfer } from '../../tapd_responses/index.js';
+const confirmationText = 'assets will be destroyed';
+const { from } = Buffer;
+const insufficientError = 'failed to find coin(s) that satisfy given constraints';
+const { isArray } = Array;
+const isAssetId = (n) => /^[0-9A-F]{64}$/i.test(n);
+const isGroupKey = (n) => /^0[23][0-9A-F]{64}$/i.test(n);
+const isPositive = (n) => typeof n === 'string' && /^[1-9]\d*$/.test(n);
+const method = 'burnAsset';
+const noAssetIdError = 'asset ID must be specified';
+const type = 'default';
+/** Burn asset units
+
+  The burned asset units are destroyed and cannot be recovered
+
+  Requires `assets:write` permission
+
+  An `asset_id` or a `group_key` is required, not both. `is_burn_confirmed`
+  must be true.
+
+  A burn with a `group_key` needs tapd v0.8.0 or later
+
+  {
+    amount: <Asset Units To Burn Numeric String>
+    [asset_id]: <Asset Id Hex String>
+    [group_key]: <Asset Group Key Hex String>
+    is_burn_confirmed: <The Caller Confirms That the Assets Will Be Destroyed Bool>
+    [note]: <Burn Note String>
+    tapd: <Authenticated tapd API Object>
+  }
+
+  @returns via cbk or Promise
+  {
+    assets: [{
+      amount: <Asset Units Numeric String>
+      [anchor]: {
+        [block_hash]: <Anchor Block Hash Hex String>
+        [block_height]: <Anchor Block Height Number>
+        [confirmed_at]: <Anchor Confirmed At ISO 8601 Date String>
+        internal_key: <Anchor Internal Key Hex String>
+        merkle_root: <Anchor Taproot Merkle Root Hex String>
+        [tapscript_sibling]: <Tapscript Sibling Preimage Hex String>
+        transaction: <Raw Anchor Transaction Hex String>
+        transaction_id: <Anchor Transaction Id Hex String>
+        transaction_vout: <Anchor Transaction Output Index Number>
+      }
+      asset_id: <Asset Id Hex String>
+      [decimal_display]: <Decimal Places To Show Number>
+      genesis_output_index: <Genesis Commitment Output Index Number>
+      genesis_transaction_id: <Genesis Point Transaction Id Hex String>
+      genesis_transaction_vout: <Genesis Point Transaction Output Index Number>
+      [group]: {
+        key: <Tweaked Group Key Hex String>
+        raw_key: <Raw Group Key Hex String>
+        [tapscript_root]: <Group Tapscript Root Hex String>
+        [witness]: <Group Membership Witness Hex String>
+      }
+      is_burn: <Asset Is Burned Bool>
+      is_collectible: <Asset Is Collectible Bool>
+      is_local: <Script Key Belongs To This Node Bool>
+      is_spent: <Asset Is Spent Bool>
+      [lease_expires_at]: <Lease Expires At ISO 8601 Date String>
+      [lease_owner]: <Lease Owner Id Hex String>
+      [lock_time]: <Lock Time Number>
+      meta_hash: <Asset Metadata Hash Hex String>
+      name: <Asset Name String>
+      [relative_lock_time]: <Relative Lock Time Number>
+      script_key: <Script Key Hex String>
+      script_key_type: <Script Key Type String>
+      script_version: <Script Version Number>
+      version: <Asset Version Number>
+    }]
+    transfer: {
+      [block_hash]: <Anchor Block Hash Hex String>
+      [block_height]: <Anchor Block Height Number>
+      created_at: <Transfer Created At ISO 8601 Date String>
+      fee: <Anchor Transaction Chain Fee Tokens Number>
+      height_hint: <Anchor Transaction Confirmation Height Hint Number>
+      inputs: [{
+        amount: <Asset Units Numeric String>
+        asset_id: <Asset Id Hex String>
+        [group_key]: <Asset Group Key Hex String>
+        is_collectible: <Asset Is Collectible Bool>
+        script_key: <Script Key Hex String>
+        transaction_id: <Spent Anchor Transaction Id Hex String>
+        transaction_vout: <Spent Anchor Transaction Output Index Number>
+      }]
+      [label]: <Transfer Label String>
+      outputs: [{
+        [address]: <Taproot Assets Address Of the Recipient String>
+        amount: <Asset Units Numeric String>
+        anchor: {
+          internal_key: <Anchor Internal Key Hex String>
+          merkle_root: <Anchor Taproot Merkle Root Hex String>
+          output_script: <Output Script Hex String>
+          passive_assets_count: <Count Of Passive Assets In the Anchor Number>
+          taproot_asset_root: <Taproot Asset Root Commitment Hex String>
+          [tapscript_sibling]: <Tapscript Sibling Preimage Hex String>
+          tokens: <Anchor Output Tokens Number>
+          transaction_id: <Anchor Transaction Id Hex String>
+          transaction_vout: <Anchor Transaction Output Index Number>
+        }
+        [asset_id]: <Asset Id Hex String>
+        asset_version: <Asset Version Number>
+        [group_key]: <Asset Group Key Hex String>
+        is_collectible: <Asset Is Collectible Bool>
+        is_local: <Script Key Belongs To This Node Bool>
+        is_split_root: <Output Is the Split Root Bool>
+        [lock_time]: <Lock Time Number>
+        [proof]: <Proof File Hex String>
+        [proof_courier]: <Proof Courier Address String>
+        [proof_delivery]: <Proof Delivery State String> // complete, pending
+        [relative_lock_time]: <Relative Lock Time Number>
+        script_key: <Script Key Hex String>
+        [split_root_hash]: <Split Commitment Root Hash Hex String>
+      }]
+      [transaction]: <Raw Anchor Transaction Hex String>
+      transaction_id: <Anchor Transaction Id Hex String>
+    }
+  }
+*/
+const burnAsset = (args, cbk) => {
+    return new Promise((resolve, reject) => {
+        return asyncAuto({
+            // Check arguments
+            validate: cbk => {
+                if (!isPositive(args.amount)) {
+                    return cbk([400, 'ExpectedPositiveAmountToBurnAsset']);
+                }
+                if (!args.asset_id && !args.group_key) {
+                    return cbk([400, 'ExpectedAssetIdOrGroupKeyToBurnAsset']);
+                }
+                if (!!args.asset_id && !!args.group_key) {
+                    return cbk([400, 'ExpectedAssetIdOrGroupKeyNotBothToBurnAsset']);
+                }
+                if (!!args.asset_id && !isAssetId(args.asset_id)) {
+                    return cbk([400, 'ExpectedAssetIdHexToBurnAsset']);
+                }
+                if (!!args.group_key && !isGroupKey(args.group_key)) {
+                    return cbk([400, 'ExpectedGroupKeyHexToBurnAsset']);
+                }
+                if (!args.is_burn_confirmed) {
+                    return cbk([400, 'ExpectedConfirmationToBurnAsset']);
+                }
+                if (!isTapd({ method, type, tapd: args.tapd })) {
+                    return cbk([400, 'ExpectedAuthenticatedTapdToBurnAsset']);
+                }
+                return cbk();
+            },
+            // Burn the assets
+            burn: [
+                'validate',
+                ({}, cbk) => {
+                    const assetId = !args.asset_id
+                        ? undefined
+                        : from(args.asset_id, 'hex');
+                    const groupKey = !args.group_key
+                        ? undefined
+                        : from(args.group_key, 'hex');
+                    // tapd before v0.8.0 only reads asset_id, later versions also
+                    // read asset_specifier, which is the only way to burn by group
+                    const request = {
+                        amount_to_burn: args.amount,
+                        asset_id: assetId,
+                        asset_specifier: !!assetId
+                            ? { asset_id: assetId }
+                            : { group_key: groupKey },
+                        confirmation_text: confirmationText,
+                        note: args.note || '',
+                    };
+                    return args.tapd[type][method](request, (err, res) => {
+                        if (isConnectionFailure({ err })) {
+                            return cbk([503, 'FailedToConnectToTapdToBurnAsset']);
+                        }
+                        if (isPermissionDenied({ err })) {
+                            return cbk([403, 'PermissionDeniedToBurnAsset']);
+                        }
+                        const details = String(err?.details);
+                        if (!!err && details.includes(insufficientError)) {
+                            return cbk([400, 'InsufficientAssetsToBurnAsset']);
+                        }
+                        if (!!err && !!groupKey && details.includes(noAssetIdError)) {
+                            return cbk([501, 'ExpectedNewerTapdToBurnAssetByGroupKey']);
+                        }
+                        if (!!err) {
+                            return cbk([503, 'UnexpectedErrorBurningAsset', { err }]);
+                        }
+                        if (!res) {
+                            return cbk([503, 'ExpectedResponseToBurnAssetRequest']);
+                        }
+                        if (!isArray(res.burn_proofs)) {
+                            return cbk([503, 'ExpectedArrayOfBurnProofsInBurnResponse']);
+                        }
+                        // tapd before v0.8.0 only sends the single burn proof
+                        const proofs = !!res.burn_proofs.length
+                            ? res.burn_proofs
+                            : [res.burn_proof].filter(n => !!n);
+                        try {
+                            return cbk(null, {
+                                assets: proofs.map((n) => rpcAssetAsAsset(n.asset)),
+                                transfer: rpcTransferAsTransfer(res.burn_transfer),
+                            });
+                        }
+                        catch (err) {
+                            return cbk([503, err.message]);
+                        }
+                    });
+                },
+            ],
+        }, returnResult({ reject, resolve, of: 'burn' }, cbk));
+    });
+};
+export default burnAsset;
+//# sourceMappingURL=burn_asset.js.map

package/dist/tapd_methods/send/burn_asset.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"burn_asset.js","sourceRoot":"","sources":["../../../src/tapd_methods/send/burn_asset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,IAAI,SAAS,EAAC,MAAM,OAAO,CAAC;AACxC,OAAO,EAAC,YAAY,EAAC,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAC,mBAAmB,EAAC,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAC,kBAAkB,EAAC,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAC,MAAM,EAAC,MAAM,8BAA8B,CAAC;AACpD,OAAO,EAAC,eAAe,EAAC,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAC,qBAAqB,EAAC,MAAM,+BAA+B,CAAC;AAQpE,MAAM,gBAAgB,GAAG,0BAA0B,CAAC;AACpD,MAAM,EAAC,IAAI,EAAC,GAAG,MAAM,CAAC;AACtB,MAAM,iBAAiB,GACrB,uDAAuD,CAAC;AAC1D,MAAM,EAAC,OAAO,EAAC,GAAG,KAAK,CAAC;AACxB,MAAM,SAAS,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAC3D,MAAM,UAAU,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACjE,MAAM,UAAU,GAAG,CAAC,CAAU,EAAE,EAAE,CAChC,OAAO,CAAC,KAAK,QAAQ,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAChD,MAAM,MAAM,GAAG,WAAW,CAAC;AAC3B,MAAM,cAAc,GAAG,4BAA4B,CAAC;AACpD,MAAM,IAAI,GAAG,SAAS,CAAC;AA2BvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA6GE;AACF,MAAM,SAAS,GAA+C,CAC5D,IAAmB,EACnB,GAAmC,EACnC,EAAE;IACF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,OAAO,SAAS,CACd;YACE,kBAAkB;YAClB,QAAQ,EAAE,GAAG,CAAC,EAAE;gBACd,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC7B,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,mCAAmC,CAAC,CAAC,CAAC;gBACzD,CAAC;gBAED,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;oBACtC,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,sCAAsC,CAAC,CAAC,CAAC;gBAC5D,CAAC;gBAED,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;oBACxC,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,6CAA6C,CAAC,CAAC,CAAC;gBACnE,CAAC;gBAED,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACjD,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,+BAA+B,CAAC,CAAC,CAAC;gBACrD,CAAC;gBAED,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;oBACpD,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,gCAAgC,CAAC,CAAC,CAAC;gBACtD,CAAC;gBAED,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;oBAC5B,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,iCAAiC,CAAC,CAAC,CAAC;gBACvD,CAAC;gBAED,IAAI,CAAC,MAAM,CAAC,EAAC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAC,CAAC,EAAE,CAAC;oBAC7C,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,sCAAsC,CAAC,CAAC,CAAC;gBAC5D,CAAC;gBAED,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,kBAAkB;YAClB,IAAI,EAAE;gBACJ,UAAU;gBACV,CAAC,EAAE,EAAE,GAAG,EAAE,EAAE;oBACV,MAAM,OAAO,GAAG,CAAC,IAAI,CAAC,QAAQ;wBAC5B,CAAC,CAAC,SAAS;wBACX,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;oBAC/B,MAAM,QAAQ,GAAG,CAAC,IAAI,CAAC,SAAS;wBAC9B,CAAC,CAAC,SAAS;wBACX,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;oBAEhC,8DAA8D;oBAC9D,+DAA+D;oBAC/D,MAAM,OAAO,GAAG;wBACd,cAAc,EAAE,IAAI,CAAC,MAAM;wBAC3B,QAAQ,EAAE,OAAO;wBACjB,eAAe,EAAE,CAAC,CAAC,OAAO;4BACxB,CAAC,CAAC,EAAC,QAAQ,EAAE,OAAO,EAAC;4BACrB,CAAC,CAAC,EAAC,SAAS,EAAE,QAAQ,EAAC;wBACzB,iBAAiB,EAAE,gBAAgB;wBACnC,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE;qBACtB,CAAC;oBAEF,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,GAAQ,EAAE,GAAQ,EAAE,EAAE;wBAC7D,IAAI,mBAAmB,CAAC,EAAC,GAAG,EAAC,CAAC,EAAE,CAAC;4BAC/B,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,kCAAkC,CAAC,CAAC,CAAC;wBACxD,CAAC;wBAED,IAAI,kBAAkB,CAAC,EAAC,GAAG,EAAC,CAAC,EAAE,CAAC;4BAC9B,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,6BAA6B,CAAC,CAAC,CAAC;wBACnD,CAAC;wBAED,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;wBAErC,IAAI,CAAC,CAAC,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC;4BACjD,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,+BAA+B,CAAC,CAAC,CAAC;wBACrD,CAAC;wBAED,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;4BAC5D,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,wCAAwC,CAAC,CAAC,CAAC;wBAC9D,CAAC;wBAED,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC;4BACV,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,6BAA6B,EAAE,EAAC,GAAG,EAAC,CAAC,CAAC,CAAC;wBAC1D,CAAC;wBAED,IAAI,CAAC,GAAG,EAAE,CAAC;4BACT,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,oCAAoC,CAAC,CAAC,CAAC;wBAC1D,CAAC;wBAED,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;4BAC9B,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,yCAAyC,CAAC,CAAC,CAAC;wBAC/D,CAAC;wBAED,sDAAsD;wBACtD,MAAM,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,MAAM;4BACrC,CAAC,CAAC,GAAG,CAAC,WAAW;4BACjB,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;wBAEtC,IAAI,CAAC;4BACH,OAAO,GAAG,CAAC,IAAI,EAAE;gCACf,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;gCACxD,QAAQ,EAAE,qBAAqB,CAAC,GAAG,CAAC,aAAa,CAAC;6BACnD,CAAC,CAAC;wBACL,CAAC;wBAAC,OAAO,GAAQ,EAAE,CAAC;4BAClB,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;wBACjC,CAAC;oBACH,CAAC,CAAC,CAAC;gBACL,CAAC;aACF;SACF,EACD,YAAY,CAAC,EAAC,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAC,EAAE,GAAG,CAAC,CACjD,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,eAAe,SAAS,CAAC"}