tapass 0.1.0 → 0.2.0

package/dist/tapd_methods/channels/decode_asset_payment_request.js

@@ -0,0 +1,143 @@
+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 { assetChannelRpcError } from '../../tapd_responses/index.js';
+import { rpcAssetPayReqAsRequest } from '../../tapd_responses/index.js';
+const { from } = Buffer;
+const isAssetId = (n) => /^[0-9A-F]{64}$/i.test(n);
+// tapd reads a 32 byte or a 33 byte group key here
+const isGroupKey = (n) => /^(0[23])?[0-9A-F]{64}$/i.test(n);
+const maxMetadataBytes = 32768;
+const method = 'decodeAssetPayReq';
+const type = 'tapchannel';
+/** Decode a payment request and get its amount in units of an asset
+
+  tapd asks its price oracle for the asset rate
+
+  Requires `channels:read` permission
+
+  An `asset_id` or a `group_key` is required, but not both
+
+  {
+    [asset_id]: <Asset Id Hex String>
+    [group_key]: <Asset Group Key Hex String>
+    [price_oracle_metadata]: <Price Oracle Metadata String>
+    request: <BOLT 11 Payment Request String>
+    tapd: <Authenticated tapd API Object>
+  }
+
+  @returns via cbk or Promise
+  {
+    asset: {
+      amount: <Asset Units To Pay Numeric String>
+      [decimal_display]: <Decimal Places To Show Number>
+      [group_key]: <Asset Group Key Hex String>
+      id: <Asset Id Hex String>
+      is_collectible: <Asset Is Collectible Bool>
+      meta_hash: <Asset Metadata Hash Hex String>
+      name: <Asset Name String>
+    }
+    chain_address: <Fallback Chain Address String>
+    [cltv_delta]: <Final CLTV Delta Number>
+    created_at: <Payment Request Created At ISO 8601 Date String>
+    description: <Payment Description String>
+    description_hash: <Payment Longer Description Hash Hex String>
+    destination: <Public Key Hex String>
+    expires_at: <ISO 8601 Date String>
+    features: [{
+      bit: <BOLT 09 Feature Bit Number>
+      is_known: <Feature is Known Bool>
+      is_required: <Feature Support is Required To Pay Bool>
+      type: <Feature Type String>
+    }]
+    id: <Payment Hash Hex String>
+    is_expired: <Invoice is Expired Bool>
+    mtokens: <Requested Millitokens String>
+    [payment]: <Payment Identifier Hex Encoded String>
+    routes: [[{
+      [base_fee_mtokens]: <Base Routing Fee In Millitokens String>
+      [channel]: <Standard Format Channel Id String>
+      [cltv_delta]: <CLTV Blocks Delta Number>
+      [fee_rate]: <Fee Rate In Millitokens Per Million Number>
+      public_key: <Forward Edge Public Key Hex String>
+    }]]
+    safe_tokens: <Requested Tokens Rounded Up Number>
+    tokens: <Requested Tokens Rounded Down Number>
+  }
+*/
+const decodeAssetPaymentRequest = (args, cbk) => {
+    return new Promise((resolve, reject) => {
+        return asyncAuto({
+            // Check arguments
+            validate: cbk => {
+                if (!args.asset_id && !args.group_key) {
+                    return cbk([400, 'ExpectedAssetIdOrGroupKeyToDecodeAssetRequest']);
+                }
+                if (!!args.asset_id && !!args.group_key) {
+                    return cbk([400, 'UnexpectedAssetIdAndGroupKeyToDecodeRequest']);
+                }
+                if (!!args.asset_id && !isAssetId(args.asset_id)) {
+                    return cbk([400, 'ExpectedAssetIdHexToDecodeAssetRequest']);
+                }
+                if (!!args.group_key && !isGroupKey(args.group_key)) {
+                    return cbk([400, 'ExpectedGroupKeyHexToDecodeAssetRequest']);
+                }
+                const metadata = args.price_oracle_metadata || '';
+                if (Buffer.byteLength(metadata) > maxMetadataBytes) {
+                    return cbk([400, 'ExpectedShorterOracleMetadataToDecodeRequest']);
+                }
+                if (!args.request || typeof args.request !== 'string') {
+                    return cbk([400, 'ExpectedPaymentRequestToDecodeAssetRequest']);
+                }
+                if (!isTapd({ method, type, tapd: args.tapd })) {
+                    return cbk([400, 'ExpectedAuthenticatedTapdToDecodeAssetRequest']);
+                }
+                return cbk();
+            },
+            // Decode the payment request
+            decode: [
+                'validate',
+                ({}, cbk) => {
+                    const request = {
+                        asset_id: from(args.asset_id || '', 'hex'),
+                        group_key: from(args.group_key || '', 'hex'),
+                        pay_req_string: args.request,
+                        price_oracle_metadata: args.price_oracle_metadata || '',
+                    };
+                    return args.tapd[type][method](request, (err, res) => {
+                        if (isConnectionFailure({ err })) {
+                            return cbk([503, 'FailedToConnectToTapdToDecodeAssetRequest']);
+                        }
+                        if (isPermissionDenied({ err })) {
+                            return cbk([
+                                403,
+                                'PermissionDeniedToDecodeAssetPaymentRequest',
+                            ]);
+                        }
+                        const knownError = assetChannelRpcError({ err });
+                        if (!!knownError) {
+                            return cbk(knownError);
+                        }
+                        if (!!err) {
+                            return cbk([
+                                503,
+                                'UnexpectedErrorDecodingAssetPaymentRequest',
+                                { err },
+                            ]);
+                        }
+                        try {
+                            return cbk(null, rpcAssetPayReqAsRequest(res));
+                        }
+                        catch (err) {
+                            return cbk([503, err.message]);
+                        }
+                    });
+                },
+            ],
+        }, returnResult({ reject, resolve, of: 'decode' }, cbk));
+    });
+};
+export default decodeAssetPaymentRequest;
+//# sourceMappingURL=decode_asset_payment_request.js.map

package/dist/tapd_methods/channels/decode_asset_payment_request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decode_asset_payment_request.js","sourceRoot":"","sources":["../../../src/tapd_methods/channels/decode_asset_payment_request.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,oBAAoB,EAAC,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAC,uBAAuB,EAAC,MAAM,+BAA+B,CAAC;AAOtE,MAAM,EAAC,IAAI,EAAC,GAAG,MAAM,CAAC;AACtB,MAAM,SAAS,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAC3D,mDAAmD;AACnD,MAAM,UAAU,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACpE,MAAM,gBAAgB,GAAG,KAAK,CAAC;AAC/B,MAAM,MAAM,GAAG,mBAAmB,CAAC;AACnC,MAAM,IAAI,GAAG,YAAY,CAAC;AAoB1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsDE;AACF,MAAM,yBAAyB,GAG3B,CACF,IAAmC,EACnC,GAAmD,EACnD,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,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;oBACtC,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,+CAA+C,CAAC,CAAC,CAAC;gBACrE,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,wCAAwC,CAAC,CAAC,CAAC;gBAC9D,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,yCAAyC,CAAC,CAAC,CAAC;gBAC/D,CAAC;gBAED,MAAM,QAAQ,GAAG,IAAI,CAAC,qBAAqB,IAAI,EAAE,CAAC;gBAElD,IAAI,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,gBAAgB,EAAE,CAAC;oBACnD,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,8CAA8C,CAAC,CAAC,CAAC;gBACpE,CAAC;gBAED,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;oBACtD,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,4CAA4C,CAAC,CAAC,CAAC;gBAClE,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,+CAA+C,CAAC,CAAC,CAAC;gBACrE,CAAC;gBAED,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,6BAA6B;YAC7B,MAAM,EAAE;gBACN,UAAU;gBACV,CAAC,EAAE,EAAE,GAAG,EAAE,EAAE;oBACV,MAAM,OAAO,GAAG;wBACd,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,EAAE,KAAK,CAAC;wBAC1C,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,EAAE,KAAK,CAAC;wBAC5C,cAAc,EAAE,IAAI,CAAC,OAAO;wBAC5B,qBAAqB,EAAE,IAAI,CAAC,qBAAqB,IAAI,EAAE;qBACxD,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,2CAA2C,CAAC,CAAC,CAAC;wBACjE,CAAC;wBAED,IAAI,kBAAkB,CAAC,EAAC,GAAG,EAAC,CAAC,EAAE,CAAC;4BAC9B,OAAO,GAAG,CAAC;gCACT,GAAG;gCACH,6CAA6C;6BAC9C,CAAC,CAAC;wBACL,CAAC;wBAED,MAAM,UAAU,GAAG,oBAAoB,CAAC,EAAC,GAAG,EAAC,CAAC,CAAC;wBAE/C,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;4BACjB,OAAO,GAAG,CAAC,UAAU,CAAC,CAAC;wBACzB,CAAC;wBAED,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC;4BACV,OAAO,GAAG,CAAC;gCACT,GAAG;gCACH,4CAA4C;gCAC5C,EAAC,GAAG,EAAC;6BACN,CAAC,CAAC;wBACL,CAAC;wBAED,IAAI,CAAC;4BACH,OAAO,GAAG,CAAC,IAAI,EAAE,uBAAuB,CAAC,GAAG,CAAC,CAAC,CAAC;wBACjD,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,QAAQ,EAAC,EAAE,GAAG,CAAC,CACnD,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,eAAe,yBAAyB,CAAC"}

package/dist/tapd_methods/channels/emit_asset_payment.d.ts

@@ -0,0 +1,30 @@
+import type { EventEmitter } from 'node:events';
+type Args = {
+    /** RPC Asset Payment Object */
+    data: any;
+    /** Event Emitter Object */
+    emitter: EventEmitter;
+    /** Emit Error Function */
+    emitError: (err: unknown) => void;
+};
+export default _default;
+/** Emit an asset payment update as a lightning payment event
+
+  The events are the same as in lightning subscribeToPastPayment, with the
+  asset amounts of the payment added as `assets`
+
+  {
+    data: {
+      asset_amounts: [<RPC Asset Amount Object>]
+      payment: <RPC lnd Payment Object>
+    }
+    emitter: <Event Emitter Object>
+    emitError: <Emit Error Function>
+  }
+
+  @event 'confirmed'
+  @event 'failed'
+  @event 'paying'
+*/
+declare function _default({ data, emitter, emitError }: Args): void | boolean;
+//# sourceMappingURL=emit_asset_payment.d.ts.map

package/dist/tapd_methods/channels/emit_asset_payment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"emit_asset_payment.d.ts","sourceRoot":"","sources":["../../../src/tapd_methods/channels/emit_asset_payment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAa9C,KAAK,IAAI,GAAG;IACV,+BAA+B;IAC/B,IAAI,EAAE,GAAG,CAAC;IACV,2BAA2B;IAC3B,OAAO,EAAE,YAAY,CAAC;IACtB,0BAA0B;IAC1B,SAAS,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC;CACnC,CAAC;;AAEF;;;;;;;;;;;;;;;;;EAiBE;0BACc,EAAC,IAAI,EAAE,OAAO,EAAE,SAAS,EAAC,EAAE,IAAI"}

package/dist/tapd_methods/channels/emit_asset_payment.js

@@ -0,0 +1,59 @@
+import { confirmedFromPayment } from 'lightning/lnd_responses/index.js';
+import { failureFromPayment } from 'lightning/lnd_responses/index.js';
+import { pendingFromPayment } from 'lightning/lnd_responses/index.js';
+import { rpcAssetAmountAsAmount } from '../../tapd_responses/index.js';
+const confirmedStatus = 'SUCCEEDED';
+const failedStatus = 'FAILED';
+const { isArray } = Array;
+const pendingStatus = 'IN_FLIGHT';
+/** Emit an asset payment update as a lightning payment event
+
+  The events are the same as in lightning subscribeToPastPayment, with the
+  asset amounts of the payment added as `assets`
+
+  {
+    data: {
+      asset_amounts: [<RPC Asset Amount Object>]
+      payment: <RPC lnd Payment Object>
+    }
+    emitter: <Event Emitter Object>
+    emitError: <Emit Error Function>
+  }
+
+  @event 'confirmed'
+  @event 'failed'
+  @event 'paying'
+*/
+export default ({ data, emitter, emitError }) => {
+    try {
+        if (!data || !isArray(data.asset_amounts) || !data.payment) {
+            throw new Error('ExpectedRpcAssetPaymentInPaymentUpdate');
+        }
+        const assets = data.asset_amounts.map(rpcAssetAmountAsAmount);
+        const { payment } = data;
+        switch (payment.status) {
+            case confirmedStatus:
+                return emitter.emit('confirmed', {
+                    ...confirmedFromPayment(payment),
+                    assets,
+                });
+            case failedStatus:
+                return emitter.emit('failed', { ...failureFromPayment(payment), assets });
+            case pendingStatus:
+                // Exit early when no HTLC is in flight
+                if (!isArray(payment.htlcs)) {
+                    return;
+                }
+                if (!payment.htlcs.some((n) => n.status === pendingStatus)) {
+                    return;
+                }
+                return emitter.emit('paying', { ...pendingFromPayment(payment), assets });
+            default:
+                return;
+        }
+    }
+    catch (err) {
+        return emitError([503, err.message]);
+    }
+};
+//# sourceMappingURL=emit_asset_payment.js.map

package/dist/tapd_methods/channels/emit_asset_payment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emit_asset_payment.js","sourceRoot":"","sources":["../../../src/tapd_methods/channels/emit_asset_payment.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,oBAAoB,EAAC,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAC,kBAAkB,EAAC,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAC,kBAAkB,EAAC,MAAM,kCAAkC,CAAC;AAEpE,OAAO,EAAC,sBAAsB,EAAC,MAAM,+BAA+B,CAAC;AAErE,MAAM,eAAe,GAAG,WAAW,CAAC;AACpC,MAAM,YAAY,GAAG,QAAQ,CAAC;AAC9B,MAAM,EAAC,OAAO,EAAC,GAAG,KAAK,CAAC;AACxB,MAAM,aAAa,GAAG,WAAW,CAAC;AAWlC;;;;;;;;;;;;;;;;;EAiBE;AACF,eAAe,CAAC,EAAC,IAAI,EAAE,OAAO,EAAE,SAAS,EAAO,EAAE,EAAE;IAClD,IAAI,CAAC;QACH,IAAI,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAC3D,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;QAC9D,MAAM,EAAC,OAAO,EAAC,GAAG,IAAI,CAAC;QAEvB,QAAQ,OAAO,CAAC,MAAM,EAAE,CAAC;YACvB,KAAK,eAAe;gBAClB,OAAO,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE;oBAC/B,GAAG,oBAAoB,CAAC,OAAO,CAAC;oBAChC,MAAM;iBACP,CAAC,CAAC;YAEL,KAAK,YAAY;gBACf,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,MAAM,EAAC,CAAC,CAAC;YAE1E,KAAK,aAAa;gBAChB,uCAAuC;gBACvC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC5B,OAAO;gBACT,CAAC;gBAED,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,aAAa,CAAC,EAAE,CAAC;oBAChE,OAAO;gBACT,CAAC;gBAED,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,MAAM,EAAC,CAAC,CAAC;YAE1E;gBACE,OAAO;QACX,CAAC;IACH,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,OAAO,SAAS,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;IACvC,CAAC;AACH,CAAC,CAAC"}

package/dist/tapd_methods/channels/encode_asset_custom_records.d.ts

@@ -0,0 +1,51 @@
+import type { AuthenticatedTapdArgs } from '../../typescript/index.js';
+import type { TapdMethod } from '../../typescript/index.js';
+export type EncodeAssetCustomRecordsArgs = AuthenticatedTapdArgs<{
+    assets?: {
+        /** Asset Units Numeric String */
+        amount: string;
+        /** Asset Id Hex String */
+        asset_id: string;
+    }[];
+    /** RFQ Quote Id Hex String */
+    rfq_id?: string;
+}>;
+export type EncodeAssetCustomRecordsResult = {
+    records: {
+        /** Record Type Number String */
+        type: string;
+        /** Record Value Hex */
+        value: string;
+    }[];
+};
+/** Encode the first hop custom records of an asset payment
+
+  Use the records as the first hop custom records of an lnd payment, to pay
+  with assets over an asset channel
+
+  This method does not need a permission
+
+  An `rfq_id` is for a payment that uses an accepted RFQ quote
+
+  `assets` or an `rfq_id` is required
+
+  {
+    [assets]: [{
+      amount: <Asset Units Numeric String>
+      asset_id: <Asset Id Hex String>
+    }]
+    [rfq_id]: <RFQ Quote Id Hex String>
+    tapd: <Authenticated tapd API Object>
+  }
+
+  @returns via cbk or Promise
+  {
+    records: [{
+      type: <Record Type Number String>
+      value: <Record Value Hex String>
+    }]
+  }
+*/
+declare const encodeAssetCustomRecords: TapdMethod<EncodeAssetCustomRecordsArgs, EncodeAssetCustomRecordsResult>;
+export default encodeAssetCustomRecords;
+//# sourceMappingURL=encode_asset_custom_records.d.ts.map

package/dist/tapd_methods/channels/encode_asset_custom_records.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encode_asset_custom_records.d.ts","sourceRoot":"","sources":["../../../src/tapd_methods/channels/encode_asset_custom_records.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAC,qBAAqB,EAAC,MAAM,2BAA2B,CAAC;AAGrE,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,2BAA2B,CAAC;AAa1D,MAAM,MAAM,4BAA4B,GAAG,qBAAqB,CAAC;IAC/D,MAAM,CAAC,EAAE;QACP,iCAAiC;QACjC,MAAM,EAAE,MAAM,CAAC;QACf,0BAA0B;QAC1B,QAAQ,EAAE,MAAM,CAAC;KAClB,EAAE,CAAC;IACJ,8BAA8B;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC,CAAC;AAEH,MAAM,MAAM,8BAA8B,GAAG;IAC3C,OAAO,EAAE;QACP,gCAAgC;QAChC,IAAI,EAAE,MAAM,CAAC;QACb,uBAAuB;QACvB,KAAK,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;CACL,CAAC;AAOF;;;;;;;;;;;;;;;;;;;;;;;;;;;EA2BE;AACF,QAAA,MAAM,wBAAwB,EAAE,UAAU,CACxC,4BAA4B,EAC5B,8BAA8B,CA0G/B,CAAC;eAEa,wBAAwB"}

package/dist/tapd_methods/channels/encode_asset_custom_records.js

@@ -0,0 +1,127 @@
+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 { longKeyAsNumber } from '../../tapd_responses/index.js';
+const { entries } = Object;
+const { fromEntries } = Object;
+const { isArray } = Array;
+const isAssetId = (n) => /^[0-9A-F]{64}$/i.test(String(n));
+const isBuffer = (n) => Buffer.isBuffer(n);
+const isNumeric = (n) => typeof n === 'string' && /^\d+$/.test(n);
+const isPositive = (n) => isNumeric(n) && BigInt(n) > 0;
+const isRfqId = (n) => /^[0-9A-F]{64}$/i.test(n);
+const method = 'encodeCustomRecords';
+const type = 'tapchannel';
+/** Encode the first hop custom records of an asset payment
+
+  Use the records as the first hop custom records of an lnd payment, to pay
+  with assets over an asset channel
+
+  This method does not need a permission
+
+  An `rfq_id` is for a payment that uses an accepted RFQ quote
+
+  `assets` or an `rfq_id` is required
+
+  {
+    [assets]: [{
+      amount: <Asset Units Numeric String>
+      asset_id: <Asset Id Hex String>
+    }]
+    [rfq_id]: <RFQ Quote Id Hex String>
+    tapd: <Authenticated tapd API Object>
+  }
+
+  @returns via cbk or Promise
+  {
+    records: [{
+      type: <Record Type Number String>
+      value: <Record Value Hex String>
+    }]
+  }
+*/
+const encodeAssetCustomRecords = (args, cbk) => {
+    return new Promise((resolve, reject) => {
+        return asyncAuto({
+            // Check arguments
+            validate: cbk => {
+                if (!!args.assets && !isArray(args.assets)) {
+                    return cbk([400, 'ExpectedArrayOfAssetsToEncodeCustomRecords']);
+                }
+                if (!args.assets?.length && !args.rfq_id) {
+                    return cbk([400, 'ExpectedAssetsOrRfqIdToEncodeCustomRecords']);
+                }
+                const assets = args.assets || [];
+                if (assets.some(n => !isAssetId(n?.asset_id))) {
+                    return cbk([400, 'ExpectedAssetIdHexToEncodeCustomRecords']);
+                }
+                if (assets.some(n => !isPositive(n.amount))) {
+                    return cbk([400, 'ExpectedAssetAmountToEncodeCustomRecords']);
+                }
+                const ids = assets.map(n => n.asset_id.toLowerCase());
+                if (new Set(ids).size !== ids.length) {
+                    return cbk([400, 'ExpectedUniqueAssetsToEncodeCustomRecords']);
+                }
+                if (!!args.rfq_id && !isRfqId(args.rfq_id)) {
+                    return cbk([400, 'ExpectedRfqIdHexToEncodeCustomRecords']);
+                }
+                if (!isTapd({ method, type, tapd: args.tapd })) {
+                    return cbk([400, 'ExpectedAuthenticatedTapdToEncodeRecords']);
+                }
+                return cbk();
+            },
+            // Encode the records
+            encode: [
+                'validate',
+                ({}, cbk) => {
+                    const assets = args.assets || [];
+                    const request = {
+                        router_send_payment: {
+                            asset_amounts: fromEntries(assets.map(n => [n.asset_id.toLowerCase(), n.amount])),
+                            rfq_id: Buffer.from(args.rfq_id || '', 'hex'),
+                        },
+                    };
+                    return args.tapd[type][method](request, (err, res) => {
+                        if (isConnectionFailure({ err })) {
+                            return cbk([503, 'FailedToConnectToTapdToEncodeRecords']);
+                        }
+                        if (isPermissionDenied({ err })) {
+                            return cbk([403, 'PermissionDeniedToEncodeAssetCustomRecords']);
+                        }
+                        if (!!err) {
+                            return cbk([
+                                503,
+                                'UnexpectedErrorEncodingAssetCustomRecords',
+                                { err },
+                            ]);
+                        }
+                        if (!res || !res.custom_records) {
+                            return cbk([503, 'ExpectedCustomRecordsInEncodeResponse']);
+                        }
+                        const records = entries(res.custom_records);
+                        if (records.some(([, value]) => !isBuffer(value))) {
+                            return cbk([503, 'ExpectedRecordValuesInEncodeResponse']);
+                        }
+                        try {
+                            return cbk(null, {
+                                records: records
+                                    .map(([recordType, value]) => ({
+                                    type: longKeyAsNumber(recordType),
+                                    value: value.toString('hex'),
+                                }))
+                                    .sort((a, b) => (BigInt(a.type) < BigInt(b.type) ? -1 : 1)),
+                            });
+                        }
+                        catch (err) {
+                            return cbk([503, err.message]);
+                        }
+                    });
+                },
+            ],
+        }, returnResult({ reject, resolve, of: 'encode' }, cbk));
+    });
+};
+export default encodeAssetCustomRecords;
+//# sourceMappingURL=encode_asset_custom_records.js.map

package/dist/tapd_methods/channels/encode_asset_custom_records.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"encode_asset_custom_records.js","sourceRoot":"","sources":["../../../src/tapd_methods/channels/encode_asset_custom_records.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;AAM9D,MAAM,EAAC,OAAO,EAAC,GAAG,MAAM,CAAC;AACzB,MAAM,EAAC,WAAW,EAAC,GAAG,MAAM,CAAC;AAC7B,MAAM,EAAC,OAAO,EAAC,GAAG,KAAK,CAAC;AACxB,MAAM,SAAS,GAAG,CAAC,CAAU,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AACpE,MAAM,QAAQ,GAAG,CAAC,CAAU,EAAe,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;AACjE,MAAM,SAAS,GAAG,CAAC,CAAU,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAC3E,MAAM,UAAU,GAAG,CAAC,CAAU,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,CAAW,CAAC,GAAG,CAAC,CAAC;AAC3E,MAAM,OAAO,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACzD,MAAM,MAAM,GAAG,qBAAqB,CAAC;AACrC,MAAM,IAAI,GAAG,YAAY,CAAC;AA2B1B;;;;;;;;;;;;;;;;;;;;;;;;;;;EA2BE;AACF,MAAM,wBAAwB,GAG1B,CACF,IAAkC,EAClC,GAAkD,EAClD,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,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC3C,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,4CAA4C,CAAC,CAAC,CAAC;gBAClE,CAAC;gBAED,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;oBACzC,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,4CAA4C,CAAC,CAAC,CAAC;gBAClE,CAAC;gBAED,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;gBAEjC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC;oBAC9C,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,yCAAyC,CAAC,CAAC,CAAC;gBAC/D,CAAC;gBAED,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;oBAC5C,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,0CAA0C,CAAC,CAAC,CAAC;gBAChE,CAAC;gBAED,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;gBAEtD,IAAI,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,MAAM,EAAE,CAAC;oBACrC,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,2CAA2C,CAAC,CAAC,CAAC;gBACjE,CAAC;gBAED,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC3C,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,uCAAuC,CAAC,CAAC,CAAC;gBAC7D,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,0CAA0C,CAAC,CAAC,CAAC;gBAChE,CAAC;gBAED,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,qBAAqB;YACrB,MAAM,EAAE;gBACN,UAAU;gBACV,CAAC,EAAE,EAAE,GAAG,EAAE,EAAE;oBACV,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;oBAEjC,MAAM,OAAO,GAAG;wBACd,mBAAmB,EAAE;4BACnB,aAAa,EAAE,WAAW,CACxB,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CACtD;4BACD,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,EAAE,KAAK,CAAC;yBAC9C;qBACF,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,sCAAsC,CAAC,CAAC,CAAC;wBAC5D,CAAC;wBAED,IAAI,kBAAkB,CAAC,EAAC,GAAG,EAAC,CAAC,EAAE,CAAC;4BAC9B,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,4CAA4C,CAAC,CAAC,CAAC;wBAClE,CAAC;wBAED,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC;4BACV,OAAO,GAAG,CAAC;gCACT,GAAG;gCACH,2CAA2C;gCAC3C,EAAC,GAAG,EAAC;6BACN,CAAC,CAAC;wBACL,CAAC;wBAED,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;4BAChC,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,uCAAuC,CAAC,CAAC,CAAC;wBAC7D,CAAC;wBAED,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,cAAwB,CAAC,CAAC;wBAEtD,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;4BAClD,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,sCAAsC,CAAC,CAAC,CAAC;wBAC5D,CAAC;wBAED,IAAI,CAAC;4BACH,OAAO,GAAG,CAAC,IAAI,EAAE;gCACf,OAAO,EAAE,OAAO;qCACb,GAAG,CAAC,CAAC,CAAC,UAAU,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;oCAC7B,IAAI,EAAE,eAAe,CAAC,UAAU,CAAC;oCACjC,KAAK,EAAG,KAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC;iCACzC,CAAC,CAAC;qCACF,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;6BAC9D,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,QAAQ,EAAC,EAAE,GAAG,CAAC,CACnD,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,eAAe,wBAAwB,CAAC"}

package/dist/tapd_methods/channels/get_asset_invoices.d.ts

@@ -0,0 +1,84 @@
+import type { AssetInvoice } from '../../tapd_responses/index.js';
+import type { AuthenticatedTapdArgs } from '../../typescript/index.js';
+import type { TapdMethod } from '../../typescript/index.js';
+export type GetAssetInvoicesArgs = AuthenticatedTapdArgs<{
+    /** Created At or After ISO 8601 Date String */
+    created_after?: string;
+    /** Created At or Before ISO 8601 Date String */
+    created_before?: string;
+    /** Only Unconfirmed Invoices Bool */
+    is_unconfirmed?: boolean;
+    /** Page Result Limit Number */
+    limit?: number;
+    /** Opaque Paging Token String */
+    token?: string;
+}>;
+export type GetAssetInvoicesResult = {
+    invoices: AssetInvoice[];
+    /** Next Opaque Paging Token */
+    next?: string;
+};
+/** Get invoices that received an asset, newest first
+
+  lnd pages over all invoices, then tapd keeps only the asset invoices, so a
+  page can have fewer invoices than the limit. Use `next` until it is empty.
+
+  Requires `channels:read` permission
+
+  This method needs tapd v0.8.1 or later
+
+  The invoice fields are the same as in lightning getInvoices
+
+  {
+    [created_after]: <Created At or After ISO 8601 Date String>
+    [created_before]: <Created At or Before ISO 8601 Date String>
+    [is_unconfirmed]: <Only Unconfirmed Invoices Bool>
+    [limit]: <Page Result Limit Number>
+    tapd: <Authenticated tapd API Object>
+    [token]: <Opaque Paging Token String>
+  }
+
+  @returns via cbk or Promise
+  {
+    invoices: [{
+      assets: [{
+        amount: <Asset Units Numeric String>
+        asset_id: <Asset Id Hex String>
+        [group_key]: <Asset Group Key Hex String>
+      }]
+      [chain_address]: <Fallback Chain Address String>
+      cltv_delta: <Final CLTV Delta Number>
+      [confirmed_at]: <Settled at ISO 8601 Date String>
+      [confirmed_index]: <Confirmed Index Number>
+      created_at: <ISO 8601 Date String>
+      description: <Description String>
+      [description_hash]: <Description Hash Hex String>
+      expires_at: <ISO 8601 Date String>
+      features: [{
+        bit: <BOLT 09 Feature Bit Number>
+        is_known: <Feature is Known Bool>
+        is_required: <Feature Support is Required To Pay Bool>
+        type: <Feature Type String>
+      }]
+      id: <Payment Hash Hex String>
+      index: <Invoice Add Index Number>
+      [is_canceled]: <Invoice is Canceled Bool>
+      is_confirmed: <Invoice is Confirmed Bool>
+      [is_held]: <HTLC is Held Bool>
+      is_private: <Invoice is Private Bool>
+      [is_push]: <Invoice is Push Payment Bool>
+      mtokens: <Millitokens String>
+      [payment]: <Payment Identifying Secret Hex String>
+      payments: [<lightning Invoice Payment Object>]
+      received: <Received Tokens Number>
+      received_mtokens: <Received Millitokens String>
+      [request]: <Bolt 11 Invoice String>
+      secret: <Secret Preimage Hex String>
+      tokens: <Tokens Number>
+    }]
+    [next]: <Next Opaque Paging Token String>
+  }
+*/
+declare const getAssetInvoices: TapdMethod<GetAssetInvoicesArgs, GetAssetInvoicesResult>;
+export default getAssetInvoices;
+//# sourceMappingURL=get_asset_invoices.d.ts.map

package/dist/tapd_methods/channels/get_asset_invoices.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get_asset_invoices.d.ts","sourceRoot":"","sources":["../../../src/tapd_methods/channels/get_asset_invoices.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,+BAA+B,CAAC;AAChE,OAAO,KAAK,EAAC,qBAAqB,EAAC,MAAM,2BAA2B,CAAC;AAGrE,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,2BAA2B,CAAC;AAe1D,MAAM,MAAM,oBAAoB,GAAG,qBAAqB,CAAC;IACvD,+CAA+C;IAC/C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gDAAgD;IAChD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,qCAAqC;IACrC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,+BAA+B;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC,CAAC;AAEH,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,EAAE,YAAY,EAAE,CAAC;IACzB,+BAA+B;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAQF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4DE;AACF,QAAA,MAAM,gBAAgB,EAAE,UAAU,CAChC,oBAAoB,EACpB,sBAAsB,CA2IvB,CAAC;eAEa,gBAAgB"}