Merge pull request #5477 from BitGo/BTC-0-add-invoice-codec

feat(sdk-core): add invoice codecs

Author: ericli-bitgo

modules/sdk-core/src/bitgo/lightning/codecs.ts

@@ -2,6 +2,8 @@
 import * as t from 'io-ts';
 import { isIP } from 'net';
 import { NonEmptyString } from 'io-ts-types';
+import { BigIntFromString } from 'io-ts-types/BigIntFromString';
+import { DateFromISOString } from 'io-ts-types/DateFromISOString';
 
 export function getCodecPair<C extends t.Mixed>(
   innerCodec: C
@@ -193,3 +195,93 @@ export const BackupResponse = t.strict(
 );
 
 export type BackupResponse = t.TypeOf<typeof BackupResponse>;
+
+export const InvoiceStatus = t.union(
+  [
+    // Initial state.
+    // Transitions to 'settled' or 'canceled' on LND notification.
+    t.literal('open'),
+    // Final state.
+    t.literal('settled'),
+    // Final state.
+    t.literal('canceled'),
+  ],
+  'InvoiceStatus'
+);
+export type InvoiceStatus = t.TypeOf<typeof InvoiceStatus>;
+
+export const CreateInvoiceBody = t.intersection(
+  [
+    t.type({
+      valueMsat: BigIntFromString,
+    }),
+    t.partial({
+      memo: t.string,
+      expiry: t.number,
+    }),
+  ],
+  'CreateInvoiceBody'
+);
+export type CreateInvoiceBody = t.TypeOf<typeof CreateInvoiceBody>;
+
+/**
+ * A representation of the data tracked by the indexer for an invoice it has
+ * created within lnd.
+ */
+export const Invoice = t.intersection(
+  [
+    t.type({
+      valueMsat: BigIntFromString,
+      paymentHash: t.string,
+      /** The BOLT #11 encoded invoice string */
+      invoice: t.string,
+      /** The public BitGo walletId to which this invoice belongs */
+      walletId: t.string,
+      status: InvoiceStatus,
+      /** A date in ISO format representing when this invoice expires. */
+      expiresAt: t.string,
+    }),
+    t.partial({
+      memo: t.string,
+    }),
+  ],
+  'Invoice'
+);
+export type Invoice = t.TypeOf<typeof Invoice>;
+
+export const InvoiceInfo = t.intersection(
+  [
+    t.type({
+      valueMsat: BigIntFromString,
+      paymentHash: t.string,
+      invoice: t.string,
+      walletId: t.string,
+      status: InvoiceStatus,
+      expiresAt: t.string,
+      createdAt: t.string,
+      updatedAt: t.string,
+    }),
+    t.partial({
+      /**
+       * The number of millisats actually paid to this invoice, this may be greater
+       * than the amount requested by the invoice, since lightning allows overpaying
+       * (but not underpaying) invoices.
+       */
+      amtPaidMsat: BigIntFromString,
+    }),
+  ],
+  'InvoiceInfo'
+);
+export type InvoiceInfo = t.TypeOf<typeof InvoiceInfo>;
+
+export const InvoiceQuery = t.partial(
+  {
+    status: InvoiceStatus,
+    limit: t.string,
+    startDate: DateFromISOString,
+    endDate: DateFromISOString,
+  },
+  'InvoiceQuery'
+);
+
+export type InvoiceQuery = t.TypeOf<typeof InvoiceQuery>;