@nodana/phoenixd-ts 0.1.0

package/dist/es6/types.d.ts

@@ -0,0 +1,287 @@
+export interface LocalParams {
+    nodeId: string;
+    fundingKeyPath: string;
+    dustLimit: number;
+    maxHtlcValueInFlightMsat: number;
+    htlcMinimum: number;
+    toSelfDelay: number;
+    maxAcceptedHtlcs: number;
+    isInitiator: boolean;
+}
+export interface RemoteParams {
+    nodeId: string;
+    dustLimit: number;
+    maxHtlcValueInFlightMsat: number;
+    htlcMinimum: number;
+}
+export interface Commitments {
+    params: {
+        channelId: string;
+        channelConfig: string[];
+        channelFeatures: string[];
+        localParams: LocalParams;
+        remoteParams: RemoteParams;
+        channelFlags: number;
+    };
+}
+export interface ChannelUpdate {
+    signature: string;
+    chainHash: string;
+    shortChannelId: string;
+    timestampSeconds: number;
+    messageFlags: number;
+    channelFlags: number;
+    cltvExpiryDelta: number;
+    htlcMinimumMsat: number;
+    feeBaseMsat: number;
+    feeProportionalMillionths: number;
+    htlcMaximumMsat: number;
+}
+export interface ChannelCompact {
+    state: string;
+    channelId: string;
+    balanceSat: number;
+    inboundLiquiditySat: number;
+    capacitySat: number;
+    fundingTxId: string;
+}
+export interface Channel {
+    type: string;
+    commitments: Commitments;
+    shortChannelId: string;
+    channelUpdate: ChannelUpdate;
+}
+export interface CloseChannelParams {
+    /** identifier of the channel to close */
+    channelId: string;
+    /** bitcoin address where your balance will be sent to */
+    address: string;
+    /** fee rate in satoshi per vbyte */
+    feerateSatByte: number;
+}
+export interface CreateInvoiceParams {
+    /** the description of the invoice (max. 128 characters) */
+    description?: string;
+    /** sha256 hash of a description */
+    descriptionHash?: string;
+    /** the amount requested by the invoice, in satoshi. */
+    amountSat?: number;
+    /** the invoice expiry in seconds, by default 3600 (1 hour). */
+    expirySeconds?: number;
+    /** an optional custom identifier. Use that to link the invoice to an external system. */
+    externalId?: string;
+    /** a webhook url that will be notified when this specific payment has been received. */
+    webhookUrl?: string;
+}
+export interface PayInvoiceParams {
+    /** BOLT11 invoice */
+    invoice: string;
+    /**  optional amount in satoshi. If unset, will pay the amount requested in the invoice */
+    amountSat?: number;
+    /** optional, mutually exclusive with amountSat. Will empty the wallet if there is a single channel. */
+    sendAll?: boolean;
+}
+export interface CreateOfferParams {
+    /** the description of the offer (max. 128 characters) */
+    description?: string;
+    /** the amount requested by the offer, in satoshi. */
+    amountSat?: number;
+}
+export interface PayOfferParams {
+    /** BOLT12 offer */
+    offer: string;
+    /** optional amount in satoshi. If unset, will pay the amount requested in the invoice */
+    amountSat?: number;
+    /** optional, mutually exclusive with amountSat. Will empty the wallet if there is a single channel. */
+    sendAll?: boolean;
+    /** optional message */
+    message?: string;
+}
+export interface PayLnAddressParams {
+    /** email-like Lightning address, based on BIP-353 or LNURL */
+    address: string;
+    /** amount in satoshi. If unset, will pay the amount requested in the invoice */
+    amountSat?: number;
+    /** optional, mutually exclusive with amountSat. Will empty the wallet if there is a single channel. */
+    sendAll?: boolean;
+    /** optional message for the recipient */
+    message?: string;
+}
+export interface SendToAddressParams {
+    /** amount in satoshi */
+    amountSat: number;
+    /** Bitcoin address where funds will be sent */
+    address: string;
+    /** feerate in satoshi per vbyte */
+    feerateSatByte: number;
+}
+export interface BumpFeeParams {
+    /** fee rate in satoshi per vbyte */
+    feerateSatByte: number;
+}
+export interface ListIncomingPaymentsParams {
+    /** start timestamp in millis from epoch, default 0 */
+    from?: Date;
+    /** end timestamp in millis from epoch, default now */
+    to?: Date;
+    /** number of payments in the page, default 20 */
+    limit?: number;
+    /** page offset, default 0 */
+    offset?: number;
+    /** also return unpaid invoices */
+    all?: boolean;
+    /** only include payments that use this external id */
+    externalId?: string;
+}
+export interface ListOutgoingPaymentsParams {
+    /** start timestamp in millis from epoch, default 0 */
+    from?: Date;
+    /** end timestamp in millis from epoch, default now */
+    to?: Date;
+    /** number of payments in the page, default 20 */
+    limit?: number;
+    /** page offset, default 0 */
+    offset?: number;
+    /** also return unpaid invoices */
+    all?: boolean;
+}
+export interface ExportPaymentsParams {
+    /** start timestamp in millis from epoch, default 0 */
+    from?: Date | number;
+    /** end timestamp in millis from epoch, default now */
+    to?: Date | number;
+}
+export interface DecodeInvoiceParams {
+    /** BOLT11 invoice */
+    invoice: string;
+}
+export interface DecodeOfferParams {
+    /** BOLT12 offer */
+    offer: string;
+}
+export interface EstimateLiquidityFeesParams {
+    /** the liquidity amount, in satoshi */
+    amountSat: number;
+}
+export interface lnUrlPayParams {
+    /** amount in satoshi */
+    amountSat?: number;
+    /** optional, mutually exclusive with amountSat. Will empty the wallet if there is a single channel. */
+    sendAll?: boolean;
+    /** the lnurl-pay resource */
+    lnurl: string;
+    /** (optional) a comment for the recipient */
+    message?: string;
+}
+export interface lnUrlWithdrawParams {
+    /** the lnurl-withdraw resource */
+    lnurl: string;
+}
+export interface lnUrlAuthParams {
+    /** the lnurl-auth resource */
+    lnurl: string;
+}
+export interface CreateInvoiceResponse {
+    amountSat: number;
+    paymentHash: string;
+    serialized: string;
+}
+export interface Payment {
+    recipientAmountSat: number;
+    routingFeeSat: number;
+    paymentId: string;
+    paymentHash: string;
+    paymentPreimage: string;
+}
+export interface NodeInfo {
+    nodeId: string;
+    channels: ChannelCompact[];
+}
+export interface Balance {
+    balanceSat: number;
+    feeCreditSat: number;
+}
+export interface LiquidityFeesEstimate {
+    miningFeeSat: number;
+    serviceFeeSat: number;
+}
+export type ListChannelsResponse = Channel[];
+export type IncomingPaymentType = "incoming_payment";
+export type IncomingPaymentSubType = "lightning";
+export interface IncomingPayment {
+    type: IncomingPaymentType;
+    subType: IncomingPaymentSubType;
+    paymentHash: string;
+    preimage: string;
+    externalId?: string | null;
+    description?: string;
+    invoice?: string;
+    isPaid: boolean;
+    isExpired?: boolean;
+    requestedSat?: number;
+    receivedSat: number;
+    fees: number;
+    payerKey?: string;
+    expiresAt?: number;
+    completedAt?: number;
+    createdAt: number;
+}
+export type OutgoingPaymentType = "outgoing_payment";
+export type OutgoingPaymentSubType = "lightning" | "auto_liquidity";
+export interface OutgoingPayment {
+    type: OutgoingPaymentType;
+    subType: OutgoingPaymentSubType;
+    paymentId: string;
+    paymentHash?: string;
+    preimage?: string;
+    txId?: string;
+    isPaid: boolean;
+    sent: number;
+    fees: number;
+    invoice?: string;
+    completedAt?: number;
+    createdAt: number;
+}
+export interface LnUrlWithdrawal {
+    url: string;
+    minWithdrawable: number;
+    maxWithdrawable: number;
+    description: string;
+    k1: string;
+    invoice: string;
+}
+export interface WebsocketPayment {
+    type: "payment_received";
+    amountSat: number;
+    paymentHash: string;
+    externalId?: string | null;
+    payerNote?: string | null;
+    payerKey?: string | null;
+    timestamp?: number;
+}
+export interface PhoenixdClient {
+    createInvoice(params: CreateInvoiceParams): Promise<CreateInvoiceResponse>;
+    payInvoice(params: PayInvoiceParams): Promise<Payment>;
+    createOffer(params?: CreateOfferParams): Promise<string>;
+    payOffer(params: PayOfferParams): Promise<Payment>;
+    payLnAddress(params: PayLnAddressParams): Promise<Payment>;
+    sendToAddress(params: SendToAddressParams): Promise<string>;
+    bumpFee(params: BumpFeeParams): Promise<string>;
+    listIncomingPayments(params?: ListIncomingPaymentsParams): Promise<IncomingPayment[]>;
+    getIncomingPayment(paymentHash: string): Promise<IncomingPayment>;
+    listOutgoingPayments(params?: ListOutgoingPaymentsParams): Promise<OutgoingPayment[]>;
+    getOutgoingPayment(paymentId: string): Promise<OutgoingPayment>;
+    getOutgoingPaymentByHash(paymentHash: string): Promise<OutgoingPayment>;
+    exportPayments(params?: ExportPaymentsParams): Promise<string>;
+    getInfo(): Promise<NodeInfo>;
+    getBalance(): Promise<Balance>;
+    getLightningAddress(): Promise<string>;
+    listChannels(): Promise<ListChannelsResponse>;
+    closeChannel(params: CloseChannelParams): Promise<string>;
+    decodeInvoice(params: DecodeInvoiceParams): Promise<any>;
+    decodeOffer(params: DecodeOfferParams): Promise<any>;
+    estimateLiquidityFees(params: EstimateLiquidityFeesParams): Promise<LiquidityFeesEstimate>;
+    lnUrlPay(params: lnUrlPayParams): Promise<Payment>;
+    lnUrlWithdraw(params: lnUrlWithdrawParams): Promise<LnUrlWithdrawal>;
+    lnUrlAuth(params: lnUrlAuthParams): Promise<string>;
+}

package/dist/es6/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/es6/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}

package/dist/es6/utils.d.ts

@@ -0,0 +1 @@
+export declare function base64Encode(value: string): string;

package/dist/es6/utils.js

@@ -0,0 +1,22 @@
+const BASE64_CHARS = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+function utf8Encode(value) {
+    return encodeURIComponent(value).replace(/%([0-9A-F]{2})/g, (_, hex) => String.fromCharCode(parseInt(hex, 16)));
+}
+export function base64Encode(value) {
+    const bytes = utf8Encode(value);
+    let output = "";
+    for (let i = 0; i < bytes.length; i += 3) {
+        const first = bytes.charCodeAt(i);
+        const second = bytes.charCodeAt(i + 1);
+        const third = bytes.charCodeAt(i + 2);
+        output += BASE64_CHARS[first >> 2];
+        output += BASE64_CHARS[((first & 3) << 4) | (second >> 4)];
+        output +=
+            i + 1 < bytes.length
+                ? BASE64_CHARS[((second & 15) << 2) | (third >> 6)]
+                : "=";
+        output += i + 2 < bytes.length ? BASE64_CHARS[third & 63] : "=";
+    }
+    return output;
+}
+//# sourceMappingURL=utils.js.map

package/dist/es6/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,MAAM,YAAY,GAChB,kEAAkE,CAAC;AAErE,SAAS,UAAU,CAAC,KAAa;IAC/B,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC,OAAO,CACtC,iBAAiB,EACjB,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CACnD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IAChC,IAAI,MAAM,GAAG,EAAE,CAAC;IAEhB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACzC,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAClC,MAAM,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACvC,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAEtC,MAAM,IAAI,YAAY,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;QACnC,MAAM,IAAI,YAAY,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3D,MAAM;YACJ,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM;gBAClB,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;gBACnD,CAAC,CAAC,GAAG,CAAC;QACV,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IAClE,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@nodana/phoenixd-ts",
+  "version": "0.1.0",
+  "description": "A TypeScript client for Phoenixd Lightning nodes",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nodana/phoenixd-ts.git"
+  },
+  "homepage": "https://github.com/nodana/phoenixd-ts#readme",
+  "main": "dist/cjs/index.js",
+  "module": "dist/es6/index.js",
+  "types": "dist/es6/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/es6/index.d.ts",
+      "import": "./dist/es6/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
+  "sideEffects": false,
+  "scripts": {
+    "clean": "rimraf dist",
+    "build:cjs": "tsc",
+    "build:es6": "tsc -p tsconfig.es6.json",
+    "build": "run-s clean && run-p build:*",
+    "prepublishOnly": "run-s test build",
+    "test": "mocha -r ts-node/register 'tests/**/*.ts'"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/chai": "^4.3.16",
+    "@types/mocha": "^10.0.6",
+    "@types/node": "^20.14.2",
+    "@types/sinon": "^17.0.3",
+    "@types/sinon-chai": "^3.2.12",
+    "@types/ws": "^8.5.10",
+    "chai": "^4.4.1",
+    "mocha": "^10.4.0",
+    "npm-run-all": "^4.1.5",
+    "rimraf": "^6.1.3",
+    "sinon": "^18.0.0",
+    "sinon-chai": "^3.7.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.5"
+  },
+  "files": [
+    "dist"
+  ]
+}