@bitgo/public-types 4.14.0 → 4.15.0

package/dist/src/schema/transactionRequest/intents/substrateBaseIntent.d.ts

@@ -0,0 +1,82 @@
+import * as t from "io-ts";
+export declare const SubstrateBaseIntent: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
+    intentType: t.KeyofC<{
+        payment: t.LiteralC<"payment">;
+        transferToken: t.LiteralC<"transferToken">;
+        consolidate: t.LiteralC<"consolidate">;
+        consolidateToken: t.LiteralC<"consolidateToken">;
+        fanout: t.LiteralC<"fanout">;
+        stake: t.LiteralC<"stake">;
+        unstake: t.LiteralC<"unstake">;
+        delegate: t.LiteralC<"delegate">;
+        undelegate: t.LiteralC<"undelegate">;
+        switchValidator: t.LiteralC<"switchValidator">;
+        claim: t.LiteralC<"claim">;
+        stakeClaimRewards: t.LiteralC<"stakeClaimRewards">;
+        pledge: t.LiteralC<"pledge">;
+        voteDelegation: t.LiteralC<"voteDelegation">;
+        vote: t.LiteralC<"vote">;
+        createAccount: t.LiteralC<"createAccount">;
+        updateAccount: t.LiteralC<"updateAccount">;
+        addTrustLine: t.LiteralC<"addTrustLine">;
+        removeTrustLine: t.LiteralC<"removeTrustLine">;
+        signMessage: t.LiteralC<"signMessage">;
+        signTypedStructuredData: t.LiteralC<"signTypedStructuredData">;
+        enableToken: t.LiteralC<"enableToken">;
+        authorize: t.LiteralC<"authorize">;
+        acceleration: t.LiteralC<"acceleration">;
+        fillNonce: t.LiteralC<"fillNonce">;
+        walletRecovery: t.LiteralC<"walletRecovery">;
+        contractCall: t.LiteralC<"contractCall">;
+        deactivate: t.LiteralC<"deactivate">;
+        customTx: t.LiteralC<"customTx">;
+        closeAssociatedTokenAccount: t.LiteralC<"closeAssociatedTokenAccount">;
+    }>;
+}>, t.PartialC<{
+    sequenceId: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
+    comment: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
+    nonce: t.UnionC<[t.Type<string | number, string | number, unknown>, t.UndefinedC]>;
+}>]>, t.PartialC<{
+    senderAddressIndex: t.UnionC<[t.Type<number, number, unknown>, t.UndefinedC]>;
+    fee: t.UnionC<[t.Type<{
+        amount: string | number;
+    } & {
+        unit?: "baseUnit" | "cpu" | "ram" | undefined;
+        formula?: "fixed" | "feeRate" | "perKB" | "custom" | undefined;
+        type?: "max" | "base" | "tip" | undefined;
+    }, {
+        amount: string | number;
+    } & {
+        unit?: "baseUnit" | "cpu" | "ram" | undefined;
+        formula?: "fixed" | "feeRate" | "perKB" | "custom" | undefined;
+        type?: "max" | "base" | "tip" | undefined;
+    }, unknown>, t.UndefinedC]>;
+    recipients: t.UnionC<[t.Type<({
+        address: {
+            address?: string | undefined;
+            option?: {
+                [x: string]: unknown;
+            } | undefined;
+        };
+        amount: {
+            value: string;
+            symbol: string;
+        };
+    } & {
+        data?: string | undefined;
+    })[], ({
+        address: {
+            address?: string | undefined;
+            option?: {
+                [x: string]: unknown;
+            } | undefined;
+        };
+        amount: {
+            value: string;
+            symbol: string;
+        };
+    } & {
+        data?: string | undefined;
+    })[], unknown>, t.UndefinedC]>;
+}>]>;
+export type DotBaseIntent = t.TypeOf<typeof SubstrateBaseIntent>;

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

@@ -0,0 +1,40 @@
+"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.SubstrateBaseIntent = void 0;
+const t = __importStar(require("io-ts"));
+const utils_1 = require("../../../utils");
+const substrateFeeOptions_1 = require("./substrateFeeOptions");
+const recipientEntry_1 = require("./recipientEntry");
+const baseIntent_1 = require("./baseIntent");
+exports.SubstrateBaseIntent = t.intersection([
+    baseIntent_1.BaseIntent,
+    t.partial({
+        senderAddressIndex: utils_1.optionalNumber,
+        fee: (0, utils_1.Optional)(substrateFeeOptions_1.SubstrateFeeOptions),
+        recipients: (0, utils_1.Optional)(t.array(recipientEntry_1.RecipientEntry)),
+    }),
+]);
+//# sourceMappingURL=substrateBaseIntent.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"substrateBaseIntent.js","sourceRoot":"","sources":["../../../../../src/schema/transactionRequest/intents/substrateBaseIntent.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,0CAA0D;AAC1D,+DAA4D;AAC5D,qDAAkD;AAClD,6CAA0C;AAE7B,QAAA,mBAAmB,GAAG,CAAC,CAAC,YAAY,CAAC;IAChD,uBAAU;IACV,CAAC,CAAC,OAAO,CAAC;QACR,kBAAkB,EAAE,sBAAc;QAClC,GAAG,EAAE,IAAA,gBAAQ,EAAC,yCAAmB,CAAC;QAClC,UAAU,EAAE,IAAA,gBAAQ,EAAC,CAAC,CAAC,KAAK,CAAC,+BAAc,CAAC,CAAC;KAC9C,CAAC;CACH,CAAC,CAAC"}

package/dist/src/schema/transactionRequest/intents/substrateFeeOptionFormula.d.ts

@@ -0,0 +1,14 @@
+import * as t from "io-ts";
+export declare const substrateFeeFormulas: {
+    fixed: t.LiteralC<"fixed">;
+    feeRate: t.LiteralC<"feeRate">;
+    perKB: t.LiteralC<"perKB">;
+    custom: t.LiteralC<"custom">;
+};
+export declare const SubstrateFeeFormulas: t.KeyofC<{
+    fixed: t.LiteralC<"fixed">;
+    feeRate: t.LiteralC<"feeRate">;
+    perKB: t.LiteralC<"perKB">;
+    custom: t.LiteralC<"custom">;
+}>;
+export type SubstrateFeeFormulas = t.TypeOf<typeof SubstrateFeeFormulas>;

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

@@ -0,0 +1,35 @@
+"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.SubstrateFeeFormulas = exports.substrateFeeFormulas = void 0;
+const t = __importStar(require("io-ts"));
+exports.substrateFeeFormulas = {
+    fixed: t.literal("fixed"),
+    feeRate: t.literal("feeRate"),
+    perKB: t.literal("perKB"),
+    custom: t.literal("custom"),
+};
+exports.SubstrateFeeFormulas = t.keyof(exports.substrateFeeFormulas);
+//# sourceMappingURL=substrateFeeOptionFormula.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"substrateFeeOptionFormula.js","sourceRoot":"","sources":["../../../../../src/schema/transactionRequest/intents/substrateFeeOptionFormula.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAEd,QAAA,oBAAoB,GAAG;IAClC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IACzB,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;IAC7B,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IACzB,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;CAC5B,CAAC;AAEW,QAAA,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,4BAAoB,CAAC,CAAC"}

package/dist/src/schema/transactionRequest/intents/substrateFeeOptions.d.ts

@@ -0,0 +1,8 @@
+import * as t from "io-ts";
+export declare const SubstrateFeeOptions: t.IntersectionC<[t.TypeC<{
+    amount: t.UnionC<[t.StringC, t.NumberC]>;
+}>, t.PartialC<{
+    unit: t.UnionC<[t.Type<"baseUnit" | "cpu" | "ram", "baseUnit" | "cpu" | "ram", unknown>, t.UndefinedC]>;
+    formula: t.UnionC<[t.Type<"fixed" | "feeRate" | "perKB" | "custom", "fixed" | "feeRate" | "perKB" | "custom", unknown>, t.UndefinedC]>;
+    type: t.UnionC<[t.Type<"max" | "base" | "tip", "max" | "base" | "tip", unknown>, t.UndefinedC]>;
+}>]>;

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

@@ -0,0 +1,42 @@
+"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.SubstrateFeeOptions = void 0;
+const t = __importStar(require("io-ts"));
+const feeOptionUnit_1 = require("./feeOptionUnit");
+const utils_1 = require("../../../utils");
+const substrateFeeOptionFormula_1 = require("./substrateFeeOptionFormula");
+const feeOptionFeeType_1 = require("./feeOptionFeeType");
+exports.SubstrateFeeOptions = t.intersection([
+    t.type({
+        amount: t.union([t.string, t.number]),
+    }),
+    t.partial({
+        unit: (0, utils_1.Optional)(feeOptionUnit_1.FeeUnit),
+        formula: (0, utils_1.Optional)(substrateFeeOptionFormula_1.SubstrateFeeFormulas),
+        type: (0, utils_1.Optional)(feeOptionFeeType_1.FeeType),
+    }),
+]);
+//# sourceMappingURL=substrateFeeOptions.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"substrateFeeOptions.js","sourceRoot":"","sources":["../../../../../src/schema/transactionRequest/intents/substrateFeeOptions.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,mDAA0C;AAC1C,0CAA0C;AAC1C,2EAAmE;AACnE,yDAA6C;AAEhC,QAAA,mBAAmB,GAAG,CAAC,CAAC,YAAY,CAAC;IAChD,CAAC,CAAC,IAAI,CAAC;QACL,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;KACtC,CAAC;IACF,CAAC,CAAC,OAAO,CAAC;QACR,IAAI,EAAE,IAAA,gBAAQ,EAAC,uBAAO,CAAC;QACvB,OAAO,EAAE,IAAA,gBAAQ,EAAC,gDAAoB,CAAC;QACvC,IAAI,EAAE,IAAA,gBAAQ,EAAC,0BAAO,CAAC;KACxB,CAAC;CACH,CAAC,CAAC"}

package/package.json

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

package/src/schema/transactionRequest/intents/substrateBaseIntent.ts

@@ -0,0 +1,16 @@
+import * as t from "io-ts";
+import { Optional, optionalNumber } from "../../../utils";
+import { SubstrateFeeOptions } from "./substrateFeeOptions";
+import { RecipientEntry } from "./recipientEntry";
+import { BaseIntent } from "./baseIntent";
+
+export const SubstrateBaseIntent = t.intersection([
+  BaseIntent,
+  t.partial({
+    senderAddressIndex: optionalNumber,
+    fee: Optional(SubstrateFeeOptions),
+    recipients: Optional(t.array(RecipientEntry)),
+  }),
+]);
+
+export type DotBaseIntent = t.TypeOf<typeof SubstrateBaseIntent>;

package/src/schema/transactionRequest/intents/substrateFeeOptionFormula.ts

@@ -0,0 +1,12 @@
+import * as t from "io-ts";
+
+export const substrateFeeFormulas = {
+  fixed: t.literal("fixed"),
+  feeRate: t.literal("feeRate"),
+  perKB: t.literal("perKB"),
+  custom: t.literal("custom"),
+};
+
+export const SubstrateFeeFormulas = t.keyof(substrateFeeFormulas);
+
+export type SubstrateFeeFormulas = t.TypeOf<typeof SubstrateFeeFormulas>;

package/src/schema/transactionRequest/intents/substrateFeeOptions.ts

@@ -0,0 +1,16 @@
+import * as t from "io-ts";
+import { FeeUnit } from "./feeOptionUnit";
+import { Optional } from "../../../utils";
+import { SubstrateFeeFormulas } from "./substrateFeeOptionFormula";
+import { FeeType } from "./feeOptionFeeType";
+
+export const SubstrateFeeOptions = t.intersection([
+  t.type({
+    amount: t.union([t.string, t.number]),
+  }),
+  t.partial({
+    unit: Optional(FeeUnit),
+    formula: Optional(SubstrateFeeFormulas),
+    type: Optional(FeeType),
+  }),
+]);