@bitgo/public-types 6.81.0 → 6.82.0

package/dist/src/schema/transactionRequest/transactionRequest.js

@@ -36,6 +36,7 @@ const signatureShare_1 = require("./signatureShare");
 const unsignedTransaction_1 = require("./unsignedTransaction");
 const message_1 = require("./message");
 const transaction_1 = require("./transaction");
+const txChannel_1 = require("./txChannel");
 exports.TransactionRequestId = t.string;
 exports.TransactionRequestIdNonEmptyString = io_ts_types_1.NonEmptyString;
 exports.TransactionRequestBase = t.intersection([
@@ -57,10 +58,14 @@ exports.TransactionRequestBase = t.intersection([
         idempotencyKey: t.string,
         walletType: walletTypes_1.WalletTypes,
         enterpriseId: enterprise_1.EnterpriseIdString,
+        organizationId: t.string,
         intent: t.unknown,
         pendingApprovalId: t.string,
         policiesChecked: t.boolean,
         isCanceled: t.boolean,
+        cancelReason: t.string,
+        initiatedByDAppClient: t.boolean,
+        txChannel: txChannel_1.TxChannel,
     }),
 ]);
 exports.TransactionRequestLite = t.intersection([

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

@@ -1 +1 @@
-{"version":3,"file":"transactionRequest.js","sourceRoot":"","sources":["../../../../src/schema/transactionRequest/transactionRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,6CAAgE;AAChE,sCAA2C;AAC3C,uDAAoD;AACpD,8CAAmD;AACnD,wBAA+D;AAC/D,iFAA8E;AAC9E,uDAAoD;AACpD,qDAAkD;AAClD,+DAA4D;AAC5D,uCAAoC;AACpC,+CAA4C;AAM/B,QAAA,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;AAQhC,QAAA,kCAAkC,GAAG,4BAAc,CAAC;AAMpD,QAAA,sBAAsB,GAAG,CAAC,CAAC,YAAY,CAAC;IAEnD,CAAC,CAAC,IAAI,CAAC;QAEL,WAAW,EAAE,4BAAoB;QAEjC,QAAQ,EAAE,uBAAc;QAExB,OAAO,EAAE,CAAC,CAAC,MAAM;QAEjB,KAAK,EAAE,0BAAuB;QAK9B,IAAI,EAAE,+BAAiB;QAKvB,WAAW,EAAE,+BAAiB;QAE9B,MAAM,EAAE,CAAC,CAAC,MAAM;QAEhB,WAAW,EAAE,CAAC,CAAC,MAAM;QAErB,SAAS,EAAE,CAAC,CAAC,MAAM;QAEnB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC;QAE3B,MAAM,EAAE,CAAC,CAAC,OAAO;KAClB,CAAC;IAEF,CAAC,CAAC,OAAO,CAAC;QAER,UAAU,EAAE,2DAA4B;QAExC,cAAc,EAAE,CAAC,CAAC,MAAM;QAExB,UAAU,EAAE,yBAAW;QAEvB,YAAY,EAAE,+BAAkB;QAEhC,MAAM,EAAE,CAAC,CAAC,OAAO;QAEjB,iBAAiB,EAAE,CAAC,CAAC,MAAM;QAE3B,eAAe,EAAE,CAAC,CAAC,OAAO;QAE1B,UAAU,EAAE,CAAC,CAAC,OAAO;KACtB,CAAC;CACH,CAAC,CAAC;AAEU,QAAA,sBAAsB,GAAG,CAAC,CAAC,YAAY,CAAC;IACnD,8BAAsB;IACtB,CAAC,CAAC,OAAO,CAAC;QAER,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,oBAAiB,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;QAE/C,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,yCAAmB,CAAC;QAEzC,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,+BAAc,CAAC;QAExC,gBAAgB,EAAE,CAAC,CAAC,KAAK,CAAC,iCAAe,CAAC;QAE1C,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;KAC5B,CAAC;CACH,CAAC,CAAC;AAGU,QAAA,sBAAsB,GAAG,CAAC,CAAC,YAAY,CAAC;IACnD,8BAAsB;IACtB,CAAC,CAAC,OAAO,CAAC;QAER,YAAY,EAAE,CAAC,CAAC,KAAK,CAAC,yBAAW,CAAC;QAElC,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,iBAAO,CAAC;KAC3B,CAAC;CACH,CAAC,CAAC;AAGU,QAAA,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC;IACxC,8BAAsB;IACtB,8BAAsB;CACvB,CAAC,CAAC"}
+{"version":3,"file":"transactionRequest.js","sourceRoot":"","sources":["../../../../src/schema/transactionRequest/transactionRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,6CAAgE;AAChE,sCAA2C;AAC3C,uDAAoD;AACpD,8CAAmD;AACnD,wBAA+D;AAC/D,iFAA8E;AAC9E,uDAAoD;AACpD,qDAAkD;AAClD,+DAA4D;AAC5D,uCAAoC;AACpC,+CAA4C;AAC5C,2CAAwC;AAK3B,QAAA,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;AAQhC,QAAA,kCAAkC,GAAG,4BAAc,CAAC;AAMpD,QAAA,sBAAsB,GAAG,CAAC,CAAC,YAAY,CAAC;IAEnD,CAAC,CAAC,IAAI,CAAC;QAEL,WAAW,EAAE,4BAAoB;QAEjC,QAAQ,EAAE,uBAAc;QAExB,OAAO,EAAE,CAAC,CAAC,MAAM;QAEjB,KAAK,EAAE,0BAAuB;QAK9B,IAAI,EAAE,+BAAiB;QAKvB,WAAW,EAAE,+BAAiB;QAE9B,MAAM,EAAE,CAAC,CAAC,MAAM;QAEhB,WAAW,EAAE,CAAC,CAAC,MAAM;QAErB,SAAS,EAAE,CAAC,CAAC,MAAM;QAEnB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC;QAE3B,MAAM,EAAE,CAAC,CAAC,OAAO;KAClB,CAAC;IAEF,CAAC,CAAC,OAAO,CAAC;QAER,UAAU,EAAE,2DAA4B;QAExC,cAAc,EAAE,CAAC,CAAC,MAAM;QAGxB,UAAU,EAAE,yBAAW;QAEvB,YAAY,EAAE,+BAAkB;QAEhC,cAAc,EAAE,CAAC,CAAC,MAAM;QAExB,MAAM,EAAE,CAAC,CAAC,OAAO;QAEjB,iBAAiB,EAAE,CAAC,CAAC,MAAM;QAG3B,eAAe,EAAE,CAAC,CAAC,OAAO;QAE1B,UAAU,EAAE,CAAC,CAAC,OAAO;QAErB,YAAY,EAAE,CAAC,CAAC,MAAM;QAEtB,qBAAqB,EAAE,CAAC,CAAC,OAAO;QAEhC,SAAS,EAAE,qBAAS;KACrB,CAAC;CACH,CAAC,CAAC;AAEU,QAAA,sBAAsB,GAAG,CAAC,CAAC,YAAY,CAAC;IACnD,8BAAsB;IACtB,CAAC,CAAC,OAAO,CAAC;QAER,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,oBAAiB,EAAE,CAAC,CAAC,OAAO,CAAC,CAAoB;QAElE,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,yCAAmB,CAAC;QAEzC,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,+BAAc,CAAC;QAExC,gBAAgB,EAAE,CAAC,CAAC,KAAK,CAAC,iCAAe,CAAC;QAE1C,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;KAC5B,CAAC;CACH,CAAC,CAAC;AAGU,QAAA,sBAAsB,GAAG,CAAC,CAAC,YAAY,CAAC;IACnD,8BAAsB;IACtB,CAAC,CAAC,OAAO,CAAC;QAER,YAAY,EAAE,CAAC,CAAC,KAAK,CAAC,yBAAW,CAAC;QAElC,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,iBAAO,CAAC;KAC3B,CAAC;CACH,CAAC,CAAC;AAGU,QAAA,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC;IACxC,8BAAsB;IACtB,8BAAsB;CACvB,CAAC,CAAC"}

package/dist/src/schema/transactionRequest/txChannel.d.ts

@@ -0,0 +1,55 @@
+import * as t from "io-ts";
+export declare const TxChannelType: t.KeyofC<{
+    defi: number;
+}>;
+export type TxChannelType = t.TypeOf<typeof TxChannelType>;
+export declare const TxChannelSource: t.KeyofC<{
+    internal: number;
+    external: number;
+}>;
+export type TxChannelSource = t.TypeOf<typeof TxChannelSource>;
+export declare const TxChannelConnector: t.KeyofC<{
+    narval: number;
+    walletconnect: number;
+}>;
+export type TxChannelConnector = t.TypeOf<typeof TxChannelConnector>;
+export declare const TxChannelProtocol: t.KeyofC<{
+    morpho: number;
+    aave: number;
+    concrete: number;
+}>;
+export type TxChannelProtocol = t.TypeOf<typeof TxChannelProtocol>;
+export declare const TxChannelDefiAction: t.KeyofC<{
+    approve: number;
+    deposit: number;
+    withdraw: number;
+}>;
+export type TxChannelDefiAction = t.TypeOf<typeof TxChannelDefiAction>;
+export declare const TxChannel: t.IntersectionC<[t.TypeC<{
+    type: t.KeyofC<{
+        defi: number;
+    }>;
+    source: t.KeyofC<{
+        internal: number;
+        external: number;
+    }>;
+}>, t.PartialC<{
+    connector: t.KeyofC<{
+        narval: number;
+        walletconnect: number;
+    }>;
+    protocol: t.KeyofC<{
+        morpho: number;
+        aave: number;
+        concrete: number;
+    }>;
+    defiAction: t.KeyofC<{
+        approve: number;
+        deposit: number;
+        withdraw: number;
+    }>;
+    vaultId: t.StringC;
+    clientId: t.StringC;
+    walletConnectRequestId: t.StringC;
+}>]>;
+export type TxChannel = t.TypeOf<typeof TxChannel>;

package/dist/src/schema/transactionRequest/txChannel.js

@@ -0,0 +1,47 @@
+"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.TxChannel = exports.TxChannelDefiAction = exports.TxChannelProtocol = exports.TxChannelConnector = exports.TxChannelSource = exports.TxChannelType = void 0;
+const t = __importStar(require("io-ts"));
+exports.TxChannelType = t.keyof({ defi: 1 }, "TxChannelType");
+exports.TxChannelSource = t.keyof({ internal: 1, external: 1 }, "TxChannelSource");
+exports.TxChannelConnector = t.keyof({ narval: 1, walletconnect: 1 }, "TxChannelConnector");
+exports.TxChannelProtocol = t.keyof({ morpho: 1, aave: 1, concrete: 1 }, "TxChannelProtocol");
+exports.TxChannelDefiAction = t.keyof({ approve: 1, deposit: 1, withdraw: 1 }, "TxChannelDefiAction");
+exports.TxChannel = t.intersection([
+    t.type({
+        type: exports.TxChannelType,
+        source: exports.TxChannelSource,
+    }),
+    t.partial({
+        connector: exports.TxChannelConnector,
+        protocol: exports.TxChannelProtocol,
+        defiAction: exports.TxChannelDefiAction,
+        vaultId: t.string,
+        clientId: t.string,
+        walletConnectRequestId: t.string,
+    }),
+]);
+//# sourceMappingURL=txChannel.js.map

package/dist/src/schema/transactionRequest/txChannel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"txChannel.js","sourceRoot":"","sources":["../../../../src/schema/transactionRequest/txChannel.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAEd,QAAA,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,eAAe,CAAC,CAAC;AAGtD,QAAA,eAAe,GAAG,CAAC,CAAC,KAAK,CACpC,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAC5B,iBAAiB,CAClB,CAAC;AAGW,QAAA,kBAAkB,GAAG,CAAC,CAAC,KAAK,CACvC,EAAE,MAAM,EAAE,CAAC,EAAE,aAAa,EAAE,CAAC,EAAE,EAC/B,oBAAoB,CACrB,CAAC;AAIW,QAAA,iBAAiB,GAAG,CAAC,CAAC,KAAK,CACtC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EACnC,mBAAmB,CACpB,CAAC;AAGW,QAAA,mBAAmB,GAAG,CAAC,CAAC,KAAK,CACxC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EACvC,qBAAqB,CACtB,CAAC;AAIW,QAAA,SAAS,GAAG,CAAC,CAAC,YAAY,CAAC;IACtC,CAAC,CAAC,IAAI,CAAC;QACL,IAAI,EAAE,qBAAa;QACnB,MAAM,EAAE,uBAAe;KACxB,CAAC;IACF,CAAC,CAAC,OAAO,CAAC;QAER,SAAS,EAAE,0BAAkB;QAE7B,QAAQ,EAAE,yBAAiB;QAC3B,UAAU,EAAE,2BAAmB;QAC/B,OAAO,EAAE,CAAC,CAAC,MAAM;QAEjB,QAAQ,EAAE,CAAC,CAAC,MAAM;QAElB,sBAAsB,EAAE,CAAC,CAAC,MAAM;KACjC,CAAC;CACH,CAAC,CAAC"}

package/package.json

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

package/src/schema/transactionRequest/index.ts

@@ -2,6 +2,7 @@ export * from "./transactionState";
 export * from "./transactionRequestState";
 export * from "./intents";
 export * from "./transactionRequest";
+export * from "./txChannel";
 export * from "./transactionRequestApiVersion";
 export * from "./commitmentShare";
 export * from "./signatureShare";

package/src/schema/transactionRequest/transactionRequest.ts

@@ -10,7 +10,7 @@ import { SignatureShare } from "./signatureShare";
 import { UnsignedTransaction } from "./unsignedTransaction";
 import { Message } from "./message";
 import { Transaction } from "./transaction";
-
+import { TxChannel } from "./txChannel";
 /**
  * @format uuid
  * @example 123e4567-e89b-12d3-a456-426614174000
@@ -67,18 +67,28 @@ export const TransactionRequestBase = t.intersection([
     apiVersion: TransactionRequestApiVersion,
     /** The idempotency key of the transaction request */
     idempotencyKey: t.string,
+    // todo BG-54028: mark as required once this has been backfilled
     /** The type describes who owns the keys to the wallet associated to the TxRequest. */
     walletType: WalletTypes,
     /** If the wallet that owns the TxRequest is owned by an enterprise then this is the Id of said enterprise. */
     enterpriseId: EnterpriseIdString,
+    /** The id of the organization the TxRequest's wallet belongs to. */
+    organizationId: t.string,
     /** The intent of the transaction request */
     intent: t.unknown,
     /** The id of the Pending Approval that was created for the TxRequest if one was required. */
     pendingApprovalId: t.string,
+    // todo BG-54028: mark as required once this has been backfilled
     /** Indicates if the transaction request has been checked against the policies. */
     policiesChecked: t.boolean,
     /** True, if the transaction request is canceled. */
     isCanceled: t.boolean,
+    /** The reason the transaction request was canceled, if applicable. */
+    cancelReason: t.string,
+    /** True when the txRequest was initiated by a dApp OAuth client (e.g. Narval). */
+    initiatedByDAppClient: t.boolean,
+    /** Immutable DeFi / marketplace channel classification (DEFI-300). */
+    txChannel: TxChannel,
   }),
 ]);
 
@@ -86,7 +96,7 @@ export const TransactionRequestLite = t.intersection([
   TransactionRequestBase,
   t.partial({
     /** The intent of the transaction request */
-    intent: t.union([TransactionIntent, t.unknown]),
+    intent: t.union([TransactionIntent, t.unknown]) as t.Type<unknown>,
     /** Holds all unsigned transactions that will be used to fulfill the TxRequest for MPC wallets. */
     unsignedTxs: t.array(UnsignedTransaction),
     /** Only used for MPC coins. This is used to collect signature shares from and exchange them with the user. */

package/src/schema/transactionRequest/txChannel.ts

@@ -0,0 +1,50 @@
+import * as t from "io-ts";
+
+export const TxChannelType = t.keyof({ defi: 1 }, "TxChannelType");
+export type TxChannelType = t.TypeOf<typeof TxChannelType>;
+
+export const TxChannelSource = t.keyof(
+  { internal: 1, external: 1 },
+  "TxChannelSource",
+);
+export type TxChannelSource = t.TypeOf<typeof TxChannelSource>;
+
+export const TxChannelConnector = t.keyof(
+  { narval: 1, walletconnect: 1 },
+  "TxChannelConnector",
+);
+export type TxChannelConnector = t.TypeOf<typeof TxChannelConnector>;
+
+/** DeFi protocol. aave/concrete are forward-compat stubs (not stamped by classifiers yet). */
+export const TxChannelProtocol = t.keyof(
+  { morpho: 1, aave: 1, concrete: 1 },
+  "TxChannelProtocol",
+);
+export type TxChannelProtocol = t.TypeOf<typeof TxChannelProtocol>;
+
+export const TxChannelDefiAction = t.keyof(
+  { approve: 1, deposit: 1, withdraw: 1 },
+  "TxChannelDefiAction",
+);
+export type TxChannelDefiAction = t.TypeOf<typeof TxChannelDefiAction>;
+
+/** Immutable classification of how a txRequest entered BitGo (DEFI-300). */
+export const TxChannel = t.intersection([
+  t.type({
+    type: TxChannelType,
+    source: TxChannelSource,
+  }),
+  t.partial({
+    /** External entry connector (narval, walletconnect). Omitted for internal BitGo flows. */
+    connector: TxChannelConnector,
+    /** DeFi protocol (morpho, aave, concrete). */
+    protocol: TxChannelProtocol,
+    defiAction: TxChannelDefiAction,
+    vaultId: t.string,
+    /** OAuth dApp client id (Narval). */
+    clientId: t.string,
+    /** defi-service walletconnect_requests.id when supplied on the intent. */
+    walletConnectRequestId: t.string,
+  }),
+]);
+export type TxChannel = t.TypeOf<typeof TxChannel>;