@bitgo/public-types 5.32.0 → 5.33.0

package/dist/src/schema/coin/coin.d.ts

@@ -0,0 +1,3 @@
+import * as t from "io-ts";
+export declare const CoinString: t.StringC;
+export type CoinString = t.TypeOf<typeof CoinString>;

package/dist/src/schema/coin/coin.js

@@ -0,0 +1,29 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CoinString = void 0;
+const t = __importStar(require("io-ts"));
+exports.CoinString = t.string;
+//# sourceMappingURL=coin.js.map

package/dist/src/schema/coin/coin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"coin.js","sourceRoot":"","sources":["../../../../src/schema/coin/coin.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAKd,QAAA,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC"}

package/dist/src/schema/wallet/address.d.ts

@@ -0,0 +1,253 @@
+import * as t from "io-ts";
+export declare const AddressLabelString: t.StringC;
+export type AddressLabelString = t.TypeOf<typeof AddressLabelString>;
+export declare const AddressString: t.StringC;
+export type AddressString = t.TypeOf<typeof AddressString>;
+export declare const AddressChain: t.UnionC<[t.LiteralC<0>, t.LiteralC<1>, t.LiteralC<10>, t.LiteralC<11>, t.LiteralC<20>, t.LiteralC<21>, t.LiteralC<30>, t.LiteralC<31>, t.LiteralC<40>, t.LiteralC<41>]>;
+export type AddressChain = t.TypeOf<typeof AddressChain>;
+export declare const AddressChainString: t.UnionC<[t.LiteralC<"0">, t.LiteralC<"1">, t.LiteralC<"10">, t.LiteralC<"11">, t.LiteralC<"20">, t.LiteralC<"21">, t.LiteralC<"30">, t.LiteralC<"31">, t.LiteralC<"40">, t.LiteralC<"41">]>;
+export type AddressChainString = t.TypeOf<typeof AddressChainString>;
+export declare const TrimmedBalance: t.IntersectionC<[t.TypeC<{
+    balanceString: t.StringC;
+    confirmedBalanceString: t.StringC;
+    spendableBalanceString: t.StringC;
+}>, t.PartialC<{
+    updated: t.UnionC<[import("io-ts-types").DateFromISOStringC, import("io-ts-types").DateC, t.UnknownC]>;
+    balance: t.NumberC;
+    lockedBalanceString: t.StringC;
+    reservedBalanceString: t.StringC;
+    totalReceived: t.NumberC;
+    totalSent: t.NumberC;
+    transferCount: t.NumberC;
+    tokens: t.UnknownRecordC;
+    nfts: t.UnknownRecordC;
+    unsupportedNfts: t.UnknownRecordC;
+    type: t.UnknownC;
+    metadata: t.UnknownC;
+}>]>;
+export type TrimmedBalance = t.TypeOf<typeof TrimmedBalance>;
+export declare const BaseWalletAddress: t.PartialC<{
+    id: t.StringC;
+    address: t.StringC;
+    balance: t.UnionC<[t.IntersectionC<[t.TypeC<{
+        balanceString: t.StringC;
+        confirmedBalanceString: t.StringC;
+        spendableBalanceString: t.StringC;
+    }>, t.PartialC<{
+        updated: t.UnionC<[import("io-ts-types").DateFromISOStringC, import("io-ts-types").DateC, t.UnknownC]>;
+        balance: t.NumberC;
+        lockedBalanceString: t.StringC;
+        reservedBalanceString: t.StringC;
+        totalReceived: t.NumberC;
+        totalSent: t.NumberC;
+        transferCount: t.NumberC;
+        tokens: t.UnknownRecordC;
+        nfts: t.UnknownRecordC;
+        unsupportedNfts: t.UnknownRecordC;
+        type: t.UnknownC;
+        metadata: t.UnknownC;
+    }>]>, t.UnknownC]>;
+    coinSpecific: t.UnknownC;
+    label: t.StringC;
+    lastNonce: t.NumberC;
+    token: t.StringC;
+    proof: t.StringC;
+    signature: t.StringC;
+    lastConsolidatedTime: import("io-ts-types").DateC;
+    needsConsolidation: t.BooleanC;
+    tokenConsolidationState: t.UnknownC;
+    tokenAddress: t.UnknownC;
+}>;
+export type BaseWalletAddress = t.TypeOf<typeof BaseWalletAddress>;
+export declare const LightningWalletAddress: t.IntersectionC<[t.PartialC<{
+    id: t.StringC;
+    address: t.StringC;
+    balance: t.UnionC<[t.IntersectionC<[t.TypeC<{
+        balanceString: t.StringC;
+        confirmedBalanceString: t.StringC;
+        spendableBalanceString: t.StringC;
+    }>, t.PartialC<{
+        updated: t.UnionC<[import("io-ts-types").DateFromISOStringC, import("io-ts-types").DateC, t.UnknownC]>;
+        balance: t.NumberC;
+        lockedBalanceString: t.StringC;
+        reservedBalanceString: t.StringC;
+        totalReceived: t.NumberC;
+        totalSent: t.NumberC;
+        transferCount: t.NumberC;
+        tokens: t.UnknownRecordC;
+        nfts: t.UnknownRecordC;
+        unsupportedNfts: t.UnknownRecordC;
+        type: t.UnknownC;
+        metadata: t.UnknownC;
+    }>]>, t.UnknownC]>;
+    coinSpecific: t.UnknownC;
+    label: t.StringC;
+    lastNonce: t.NumberC;
+    token: t.StringC;
+    proof: t.StringC;
+    signature: t.StringC;
+    lastConsolidatedTime: import("io-ts-types").DateC;
+    needsConsolidation: t.BooleanC;
+    tokenConsolidationState: t.UnknownC;
+    tokenAddress: t.UnknownC;
+}>, t.TypeC<{
+    coin: t.StringC;
+    wallet: t.StringC;
+}>]>;
+export type LightningWalletAddress = t.TypeOf<typeof LightningWalletAddress>;
+export declare const WalletAddress: t.IntersectionC<[t.PartialC<{
+    id: t.StringC;
+    address: t.StringC;
+    balance: t.UnionC<[t.IntersectionC<[t.TypeC<{
+        balanceString: t.StringC;
+        confirmedBalanceString: t.StringC;
+        spendableBalanceString: t.StringC;
+    }>, t.PartialC<{
+        updated: t.UnionC<[import("io-ts-types").DateFromISOStringC, import("io-ts-types").DateC, t.UnknownC]>;
+        balance: t.NumberC;
+        lockedBalanceString: t.StringC;
+        reservedBalanceString: t.StringC;
+        totalReceived: t.NumberC;
+        totalSent: t.NumberC;
+        transferCount: t.NumberC;
+        tokens: t.UnknownRecordC;
+        nfts: t.UnknownRecordC;
+        unsupportedNfts: t.UnknownRecordC;
+        type: t.UnknownC;
+        metadata: t.UnknownC;
+    }>]>, t.UnknownC]>;
+    coinSpecific: t.UnknownC;
+    label: t.StringC;
+    lastNonce: t.NumberC;
+    token: t.StringC;
+    proof: t.StringC;
+    signature: t.StringC;
+    lastConsolidatedTime: import("io-ts-types").DateC;
+    needsConsolidation: t.BooleanC;
+    tokenConsolidationState: t.UnknownC;
+    tokenAddress: t.UnknownC;
+}>, t.TypeC<{
+    coin: t.StringC;
+    wallet: t.StringC;
+    chain: t.UnionC<[t.LiteralC<0>, t.LiteralC<1>, t.LiteralC<10>, t.LiteralC<11>, t.LiteralC<20>, t.LiteralC<21>, t.LiteralC<30>, t.LiteralC<31>, t.LiteralC<40>, t.LiteralC<41>]>;
+    index: t.NumberC;
+}>]>;
+export type WalletAddress = t.TypeOf<typeof WalletAddress>;
+export declare const WalletAddressUnion: t.UnionC<[t.IntersectionC<[t.PartialC<{
+    id: t.StringC;
+    address: t.StringC;
+    balance: t.UnionC<[t.IntersectionC<[t.TypeC<{
+        balanceString: t.StringC;
+        confirmedBalanceString: t.StringC;
+        spendableBalanceString: t.StringC;
+    }>, t.PartialC<{
+        updated: t.UnionC<[import("io-ts-types").DateFromISOStringC, import("io-ts-types").DateC, t.UnknownC]>;
+        balance: t.NumberC;
+        lockedBalanceString: t.StringC;
+        reservedBalanceString: t.StringC;
+        totalReceived: t.NumberC;
+        totalSent: t.NumberC;
+        transferCount: t.NumberC;
+        tokens: t.UnknownRecordC;
+        nfts: t.UnknownRecordC;
+        unsupportedNfts: t.UnknownRecordC;
+        type: t.UnknownC;
+        metadata: t.UnknownC;
+    }>]>, t.UnknownC]>;
+    coinSpecific: t.UnknownC;
+    label: t.StringC;
+    lastNonce: t.NumberC;
+    token: t.StringC;
+    proof: t.StringC;
+    signature: t.StringC;
+    lastConsolidatedTime: import("io-ts-types").DateC;
+    needsConsolidation: t.BooleanC;
+    tokenConsolidationState: t.UnknownC;
+    tokenAddress: t.UnknownC;
+}>, t.TypeC<{
+    coin: t.StringC;
+    wallet: t.StringC;
+    chain: t.UnionC<[t.LiteralC<0>, t.LiteralC<1>, t.LiteralC<10>, t.LiteralC<11>, t.LiteralC<20>, t.LiteralC<21>, t.LiteralC<30>, t.LiteralC<31>, t.LiteralC<40>, t.LiteralC<41>]>;
+    index: t.NumberC;
+}>]>, t.IntersectionC<[t.PartialC<{
+    id: t.StringC;
+    address: t.StringC;
+    balance: t.UnionC<[t.IntersectionC<[t.TypeC<{
+        balanceString: t.StringC;
+        confirmedBalanceString: t.StringC;
+        spendableBalanceString: t.StringC;
+    }>, t.PartialC<{
+        updated: t.UnionC<[import("io-ts-types").DateFromISOStringC, import("io-ts-types").DateC, t.UnknownC]>;
+        balance: t.NumberC;
+        lockedBalanceString: t.StringC;
+        reservedBalanceString: t.StringC;
+        totalReceived: t.NumberC;
+        totalSent: t.NumberC;
+        transferCount: t.NumberC;
+        tokens: t.UnknownRecordC;
+        nfts: t.UnknownRecordC;
+        unsupportedNfts: t.UnknownRecordC;
+        type: t.UnknownC;
+        metadata: t.UnknownC;
+    }>]>, t.UnknownC]>;
+    coinSpecific: t.UnknownC;
+    label: t.StringC;
+    lastNonce: t.NumberC;
+    token: t.StringC;
+    proof: t.StringC;
+    signature: t.StringC;
+    lastConsolidatedTime: import("io-ts-types").DateC;
+    needsConsolidation: t.BooleanC;
+    tokenConsolidationState: t.UnknownC;
+    tokenAddress: t.UnknownC;
+}>, t.TypeC<{
+    coin: t.StringC;
+    wallet: t.StringC;
+}>]>]>;
+export type WalletAddressUnion = t.TypeOf<typeof WalletAddressUnion>;
+export declare const AddressQueryResult: t.IntersectionC<[t.TypeC<{
+    coin: t.StringC;
+}>, t.PartialC<{
+    pendingAddressCount: t.NumberC;
+    totalAddressCount: t.NumberC;
+    addresses: t.UnionC<[t.ArrayC<t.IntersectionC<[t.PartialC<{
+        id: t.StringC;
+        address: t.StringC;
+        balance: t.UnionC<[t.IntersectionC<[t.TypeC<{
+            balanceString: t.StringC;
+            confirmedBalanceString: t.StringC;
+            spendableBalanceString: t.StringC;
+        }>, t.PartialC<{
+            updated: t.UnionC<[import("io-ts-types").DateFromISOStringC, import("io-ts-types").DateC, t.UnknownC]>;
+            balance: t.NumberC;
+            lockedBalanceString: t.StringC;
+            reservedBalanceString: t.StringC;
+            totalReceived: t.NumberC;
+            totalSent: t.NumberC;
+            transferCount: t.NumberC;
+            tokens: t.UnknownRecordC;
+            nfts: t.UnknownRecordC;
+            unsupportedNfts: t.UnknownRecordC;
+            type: t.UnknownC;
+            metadata: t.UnknownC;
+        }>]>, t.UnknownC]>;
+        coinSpecific: t.UnknownC;
+        label: t.StringC;
+        lastNonce: t.NumberC;
+        token: t.StringC;
+        proof: t.StringC;
+        signature: t.StringC;
+        lastConsolidatedTime: import("io-ts-types").DateC;
+        needsConsolidation: t.BooleanC;
+        tokenConsolidationState: t.UnknownC;
+        tokenAddress: t.UnknownC;
+    }>, t.TypeC<{
+        coin: t.StringC;
+        wallet: t.StringC;
+        chain: t.UnionC<[t.LiteralC<0>, t.LiteralC<1>, t.LiteralC<10>, t.LiteralC<11>, t.LiteralC<20>, t.LiteralC<21>, t.LiteralC<30>, t.LiteralC<31>, t.LiteralC<40>, t.LiteralC<41>]>;
+        index: t.NumberC;
+    }>]>>, t.UnknownC]>;
+    nextBatchPrevId: t.StringC;
+    count: t.NumberC;
+}>]>;
+export type AddressQueryResult = t.TypeOf<typeof AddressQueryResult>;

package/dist/src/schema/wallet/address.js

@@ -0,0 +1,124 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddressQueryResult = exports.WalletAddressUnion = exports.WalletAddress = exports.LightningWalletAddress = exports.BaseWalletAddress = exports.TrimmedBalance = exports.AddressChainString = exports.AddressChain = exports.AddressString = exports.AddressLabelString = void 0;
+const t = __importStar(require("io-ts"));
+const io_ts_types_1 = require("io-ts-types");
+const coin_1 = require("../coin/coin");
+exports.AddressLabelString = t.string;
+exports.AddressString = t.string;
+exports.AddressChain = t.union([
+    t.literal(0),
+    t.literal(1),
+    t.literal(10),
+    t.literal(11),
+    t.literal(20),
+    t.literal(21),
+    t.literal(30),
+    t.literal(31),
+    t.literal(40),
+    t.literal(41),
+]);
+exports.AddressChainString = t.union([
+    t.literal("0"),
+    t.literal("1"),
+    t.literal("10"),
+    t.literal("11"),
+    t.literal("20"),
+    t.literal("21"),
+    t.literal("30"),
+    t.literal("31"),
+    t.literal("40"),
+    t.literal("41"),
+]);
+exports.TrimmedBalance = t.intersection([
+    t.type({
+        balanceString: t.string,
+        confirmedBalanceString: t.string,
+        spendableBalanceString: t.string,
+    }),
+    t.partial({
+        updated: t.union([io_ts_types_1.DateFromISOString, io_ts_types_1.date, t.unknown]),
+        balance: t.number,
+        lockedBalanceString: t.string,
+        reservedBalanceString: t.string,
+        totalReceived: t.number,
+        totalSent: t.number,
+        transferCount: t.number,
+        tokens: t.UnknownRecord,
+        nfts: t.UnknownRecord,
+        unsupportedNfts: t.UnknownRecord,
+        type: t.unknown,
+        metadata: t.unknown,
+    }),
+]);
+exports.BaseWalletAddress = t.partial({
+    id: t.string,
+    address: exports.AddressString,
+    balance: t.union([exports.TrimmedBalance, t.unknown]),
+    coinSpecific: t.unknown,
+    label: exports.AddressLabelString,
+    lastNonce: t.number,
+    token: t.string,
+    proof: t.string,
+    signature: t.string,
+    lastConsolidatedTime: io_ts_types_1.date,
+    needsConsolidation: t.boolean,
+    tokenConsolidationState: t.unknown,
+    tokenAddress: t.unknown,
+});
+exports.LightningWalletAddress = t.intersection([
+    exports.BaseWalletAddress,
+    t.type({
+        coin: coin_1.CoinString,
+        wallet: t.string,
+    }),
+]);
+exports.WalletAddress = t.intersection([
+    exports.BaseWalletAddress,
+    t.type({
+        coin: coin_1.CoinString,
+        wallet: t.string,
+        chain: exports.AddressChain,
+        index: t.number,
+    }),
+]);
+exports.WalletAddressUnion = t.union([
+    exports.WalletAddress,
+    exports.LightningWalletAddress,
+]);
+exports.AddressQueryResult = t.intersection([
+    t.type({
+        coin: t.string,
+    }),
+    t.partial({
+        pendingAddressCount: t.number,
+        totalAddressCount: t.number,
+        addresses: t.union([t.array(exports.WalletAddress), t.unknown]),
+        nextBatchPrevId: t.string,
+        count: t.number,
+    }),
+]);
+//# sourceMappingURL=address.js.map

package/dist/src/schema/wallet/address.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"address.js","sourceRoot":"","sources":["../../../../src/schema/wallet/address.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,6CAAsD;AACtD,uCAA0C;AAO7B,QAAA,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;AAO9B,QAAA,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;AAMzB,QAAA,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC;IAClC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IACZ,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IACZ,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACb,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACb,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACb,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACb,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACb,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACb,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACb,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;CACd,CAAC,CAAC;AAGU,QAAA,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC;IACxC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC;IACd,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC;IACd,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IACf,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;CAChB,CAAC,CAAC;AAMU,QAAA,cAAc,GAAG,CAAC,CAAC,YAAY,CAAC;IAC3C,CAAC,CAAC,IAAI,CAAC;QAKL,aAAa,EAAE,CAAC,CAAC,MAAM;QAKvB,sBAAsB,EAAE,CAAC,CAAC,MAAM;QAKhC,sBAAsB,EAAE,CAAC,CAAC,MAAM;KACjC,CAAC;IACF,CAAC,CAAC,OAAO,CAAC;QAIR,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,+BAAiB,EAAE,kBAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;QAItD,OAAO,EAAE,CAAC,CAAC,MAAM;QACjB,mBAAmB,EAAE,CAAC,CAAC,MAAM;QAC7B,qBAAqB,EAAE,CAAC,CAAC,MAAM;QAI/B,aAAa,EAAE,CAAC,CAAC,MAAM;QAIvB,SAAS,EAAE,CAAC,CAAC,MAAM;QACnB,aAAa,EAAE,CAAC,CAAC,MAAM;QACvB,MAAM,EAAE,CAAC,CAAC,aAAa;QACvB,IAAI,EAAE,CAAC,CAAC,aAAa;QACrB,eAAe,EAAE,CAAC,CAAC,aAAa;QAChC,IAAI,EAAE,CAAC,CAAC,OAAO;QACf,QAAQ,EAAE,CAAC,CAAC,OAAO;KACpB,CAAC;CACH,CAAC,CAAC;AAMU,QAAA,iBAAiB,GAAG,CAAC,CAAC,OAAO,CAAC;IAMzC,EAAE,EAAE,CAAC,CAAC,MAAM;IACZ,OAAO,EAAE,qBAAa;IACtB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,sBAAc,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;IAK7C,YAAY,EAAE,CAAC,CAAC,OAAO;IACvB,KAAK,EAAE,0BAAkB;IAIzB,SAAS,EAAE,CAAC,CAAC,MAAM;IACnB,KAAK,EAAE,CAAC,CAAC,MAAM;IACf,KAAK,EAAE,CAAC,CAAC,MAAM;IACf,SAAS,EAAE,CAAC,CAAC,MAAM;IACnB,oBAAoB,EAAE,kBAAI;IAC1B,kBAAkB,EAAE,CAAC,CAAC,OAAO;IAC7B,uBAAuB,EAAE,CAAC,CAAC,OAAO;IAClC,YAAY,EAAE,CAAC,CAAC,OAAO;CACxB,CAAC,CAAC;AAMU,QAAA,sBAAsB,GAAG,CAAC,CAAC,YAAY,CAAC;IACnD,yBAAiB;IACjB,CAAC,CAAC,IAAI,CAAC;QACL,IAAI,EAAE,iBAAU;QAChB,MAAM,EAAE,CAAC,CAAC,MAAM;KACjB,CAAC;CACH,CAAC,CAAC;AAMU,QAAA,aAAa,GAAG,CAAC,CAAC,YAAY,CAAC;IAC1C,yBAAiB;IACjB,CAAC,CAAC,IAAI,CAAC;QACL,IAAI,EAAE,iBAAU;QAChB,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,KAAK,EAAE,oBAAY;QACnB,KAAK,EAAE,CAAC,CAAC,MAAM;KAChB,CAAC;CACH,CAAC,CAAC;AAMU,QAAA,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC;IACxC,qBAAa;IACb,8BAAsB;CACvB,CAAC,CAAC;AAMU,QAAA,kBAAkB,GAAG,CAAC,CAAC,YAAY,CAAC;IAC/C,CAAC,CAAC,IAAI,CAAC;QACL,IAAI,EAAE,CAAC,CAAC,MAAM;KACf,CAAC;IACF,CAAC,CAAC,OAAO,CAAC;QAER,mBAAmB,EAAE,CAAC,CAAC,MAAM;QAE7B,iBAAiB,EAAE,CAAC,CAAC,MAAM;QAC3B,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,qBAAa,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;QAKvD,eAAe,EAAE,CAAC,CAAC,MAAM;QAEzB,KAAK,EAAE,CAAC,CAAC,MAAM;KAChB,CAAC;CACH,CAAC,CAAC"}

package/dist/src/schema/wallet/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./wallet";
 export * from "./multisigTypeVersion";
 export * from "./walletTypes";
+export * from "./address";

package/dist/src/schema/wallet/index.js

@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./wallet"), exports);
 __exportStar(require("./multisigTypeVersion"), exports);
 __exportStar(require("./walletTypes"), exports);
+__exportStar(require("./address"), exports);
 //# sourceMappingURL=index.js.map

package/dist/src/schema/wallet/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/schema/wallet/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,wDAAsC;AACtC,gDAA8B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/schema/wallet/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,wDAAsC;AACtC,gDAA8B;AAC9B,4CAA0B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitgo/public-types",
-  "version": "5.32.0",
+  "version": "5.33.0",
   "description": "Collection of types exposed externally as part of the BitGo public API",
   "license": "UNLICENSED",
   "author": "",

package/src/schema/coin/coin.ts

@@ -0,0 +1,7 @@
+import * as t from "io-ts";
+/**
+ * A cryptocurrency symbol or token ticker symbol
+ * @example btc
+ */
+export const CoinString = t.string;
+export type CoinString = t.TypeOf<typeof CoinString>;

package/src/schema/wallet/address.ts

@@ -0,0 +1,190 @@
+import * as t from "io-ts";
+import { date, DateFromISOString } from "io-ts-types";
+import { CoinString } from "../coin/coin";
+
+/**
+ * A human-readable label for the address
+ * @maxLength 250
+ * @example Bob's Hot Wallet Address
+ */
+export const AddressLabelString = t.string;
+export type AddressLabelString = t.TypeOf<typeof AddressLabelString>;
+
+/**
+ * @maxLength 250
+ * @example 2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS
+ */
+export const AddressString = t.string;
+export type AddressString = t.TypeOf<typeof AddressString>;
+
+/**
+ * Address chain identifier
+ */
+export const AddressChain = t.union([
+  t.literal(0),
+  t.literal(1),
+  t.literal(10),
+  t.literal(11),
+  t.literal(20),
+  t.literal(21),
+  t.literal(30),
+  t.literal(31),
+  t.literal(40),
+  t.literal(41),
+]);
+export type AddressChain = t.TypeOf<typeof AddressChain>;
+
+export const AddressChainString = t.union([
+  t.literal("0"),
+  t.literal("1"),
+  t.literal("10"),
+  t.literal("11"),
+  t.literal("20"),
+  t.literal("21"),
+  t.literal("30"),
+  t.literal("31"),
+  t.literal("40"),
+  t.literal("41"),
+]);
+export type AddressChainString = t.TypeOf<typeof AddressChainString>;
+
+/**
+ * Balance information for an address
+ */
+export const TrimmedBalance = t.intersection([
+  t.type({
+    /**
+     * String representation of the balance. Guaranteed to not lose precision.
+     * @example 500000
+     */
+    balanceString: t.string,
+    /**
+     * The total balance of confirmed transactions for the address (in the chain's base unit). Guaranteed to not lose precision.
+     * @example 400000
+     */
+    confirmedBalanceString: t.string,
+    /**
+     * The total balance of the address (in the chain's base unit) which may be used as inputs for creating new transactions in string representation. Guaranteed to not lose precision.
+     * @example 40000
+     */
+    spendableBalanceString: t.string,
+  }),
+  t.partial({
+    /**
+     * The last time a transaction affected the balance of this address
+     */
+    updated: t.union([DateFromISOString, date, t.unknown]),
+    /**
+     * @example 50000
+     */
+    balance: t.number,
+    lockedBalanceString: t.string,
+    reservedBalanceString: t.string,
+    /**
+     * The total amount received on this address (in the chain's base unit)
+     */
+    totalReceived: t.number,
+    /**
+     * The total amount sent from this address (in the chain's base unit)
+     */
+    totalSent: t.number,
+    transferCount: t.number,
+    tokens: t.UnknownRecord,
+    nfts: t.UnknownRecord,
+    unsupportedNfts: t.UnknownRecord,
+    type: t.unknown,
+    metadata: t.unknown,
+  }),
+]);
+export type TrimmedBalance = t.TypeOf<typeof TrimmedBalance>;
+
+/**
+ * Base wallet address with optional fields
+ */
+export const BaseWalletAddress = t.partial({
+  /**
+   * Platform public ID for an address
+   * @example 59cd72485007a239fb00282ed480da1f
+   * @pattern ^[0-9a-f]{32}$
+   */
+  id: t.string,
+  address: AddressString,
+  balance: t.union([TrimmedBalance, t.unknown]),
+  /**
+   * Properties specific to certain coin types
+   */
+  // TODO: Add the coin specific schema
+  coinSpecific: t.unknown,
+  label: AddressLabelString,
+  /**
+   * @default -1
+   */
+  lastNonce: t.number,
+  token: t.string,
+  proof: t.string,
+  signature: t.string,
+  lastConsolidatedTime: date,
+  needsConsolidation: t.boolean,
+  tokenConsolidationState: t.unknown,
+  tokenAddress: t.unknown,
+});
+export type BaseWalletAddress = t.TypeOf<typeof BaseWalletAddress>;
+
+/**
+ * Lightning wallet address
+ */
+export const LightningWalletAddress = t.intersection([
+  BaseWalletAddress,
+  t.type({
+    coin: CoinString,
+    wallet: t.string,
+  }),
+]);
+export type LightningWalletAddress = t.TypeOf<typeof LightningWalletAddress>;
+
+/**
+ * Standard wallet address
+ */
+export const WalletAddress = t.intersection([
+  BaseWalletAddress,
+  t.type({
+    coin: CoinString,
+    wallet: t.string,
+    chain: AddressChain,
+    index: t.number,
+  }),
+]);
+export type WalletAddress = t.TypeOf<typeof WalletAddress>;
+
+/**
+ * Union of wallet address types
+ */
+export const WalletAddressUnion = t.union([
+  WalletAddress,
+  LightningWalletAddress,
+]);
+export type WalletAddressUnion = t.TypeOf<typeof WalletAddressUnion>;
+
+/**
+ * Response type for listing wallet addresses
+ */
+export const AddressQueryResult = t.intersection([
+  t.type({
+    coin: t.string,
+  }),
+  t.partial({
+    /** Total number of addresses pending on-chain initialization on this wallet **Note:** for wallets with many addresses (100,000 or more), this property may be omitted for performance reasons. If the pending address count is needed for a large wallet, the `includeTotalAddressCount` query parameter can be used to force an address count to be returned with the initial page of addresses. */
+    pendingAddressCount: t.number,
+    /** Total number of addresses which match the provided query parameters. **Note:** for wallets with many addresses (100,000 or more), this property may be omitted for performance reasons. If the total address count is needed for a large wallet, the `includeTotalAddressCount` query parameter can be used to force an address count to be returned with the initial page of addresses. */
+    totalAddressCount: t.number,
+    addresses: t.union([t.array(WalletAddress), t.unknown]),
+    /** When a result set is truncated, this field returns the id of the last object in the previous batch.  To get the next batch of results, pass this value via the `prevId` query parameter.
+     * @format uuid
+     * @example 585951a5df8380e0e3063e9f
+     */
+    nextBatchPrevId: t.string,
+    /** Total number of addresses returned in this response */
+    count: t.number,
+  }),
+]);
+export type AddressQueryResult = t.TypeOf<typeof AddressQueryResult>;

package/src/schema/wallet/index.ts

@@ -1,3 +1,4 @@
 export * from "./wallet";
 export * from "./multisigTypeVersion";
 export * from "./walletTypes";
+export * from "./address";