@bitgo/public-types - npm Package Compare versions

Comparing version 1.1.2 to 1.2.0

dist/src/schema/transactions/sendTransactions.d.ts

@@ -68,2 +68,6 @@ import * as t from 'io-ts';
 export declare type HalfSignedTransaction = t.TypeOf<typeof halfSigned>;
+export declare const memo: t.PartialC<{
+    type: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
+    value: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
+}>;
 export declare const txSendBody: {
@@ -189,3 +193,8 @@ comment: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
     strategyAllowFallback: t.UnionC<[t.Type<boolean, boolean, unknown>, t.UndefinedC]>;
-    fee: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
+    fee: t.UnionC<[t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>, t.PartialC<{
+        amount: t.UnionC<[t.Type<string | number, string | number, unknown>, t.UndefinedC]>;
+        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<"base" | "max" | "tip", "base" | "max" | "tip", unknown>, t.UndefinedC]>;
+    }>]>;
     timeBounds: t.UnionC<[t.Type<{
@@ -253,3 +262,3 @@ minTime?: string | number | undefined;
 };
-export declare const TxSendBody: t.ExactC<t.PartialC<{
+export declare const TxSendBody: t.ExactC<t.IntersectionC<[t.PartialC<{
     comment: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
@@ -374,3 +383,8 @@ consolidateId: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
     strategyAllowFallback: t.UnionC<[t.Type<boolean, boolean, unknown>, t.UndefinedC]>;
-    fee: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
+    fee: t.UnionC<[t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>, t.PartialC<{
+        amount: t.UnionC<[t.Type<string | number, string | number, unknown>, t.UndefinedC]>;
+        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<"base" | "max" | "tip", "base" | "max" | "tip", unknown>, t.UndefinedC]>;
+    }>]>;
     timeBounds: t.UnionC<[t.Type<{
@@ -437,3 +451,36 @@ minTime?: string | number | undefined;
     }>;
-}>>;
+}>, t.PartialC<{
+    locktime: t.UnionC<[t.Type<number, number, unknown>, t.UndefinedC]>;
+    sourceChain: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
+    destinationChain: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
+    unspents: t.UnionC<[t.Type<string[], string[], unknown>, t.UndefinedC]>;
+}>, t.PartialC<{
+    sequenceId: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
+    senderAddressIndex: t.UnionC<[t.Type<number, number, unknown>, t.UndefinedC]>;
+    nonce: t.UnionC<[t.Type<number, number, unknown>, t.UndefinedC]>;
+    proxyType: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
+    forceProxyType: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
+    owner: t.UnionC<[t.Type<{}, {}, unknown>, t.UndefinedC]>;
+    delay: t.UnionC<[t.Type<{}, {}, unknown>, t.UndefinedC]>;
+    index: t.UnionC<[t.Type<{}, {}, unknown>, t.UndefinedC]>;
+    validityWindow: t.UnionC<[t.Type<{}, {}, unknown>, t.UndefinedC]>;
+    version: t.UnionC<[t.Type<{}, {}, unknown>, t.UndefinedC]>;
+    referenceBlock: t.UnionC<[t.Type<{}, {}, unknown>, t.UndefinedC]>;
+    consolidateId: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
+    senderAddress: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
+    type: t.StringC;
+    memo: t.PartialC<{
+        type: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
+        value: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
+    }>;
+    comment: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
+    ledgerSequenceDelta: t.UnionC<[t.Type<number, number, unknown>, t.UndefinedC]>;
+    lastLedgerSequence: t.UnionC<[t.Type<number, number, unknown>, t.UndefinedC]>;
+    feeRate: t.UnionC<[t.Type<string | number, string | number, unknown>, t.UndefinedC]>;
+    messageKey: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
+    previewPendingTxs: t.UnionC<[t.Type<boolean, boolean, unknown>, t.UndefinedC]>;
+    pendingApprovalId: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
+}>, t.PartialC<{
+    tokenName: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
+}>]>>;
 export declare type TxSendBody = t.TypeOf<typeof TxSendBody>;
@@ -440,0 +487,0 @@ export declare const TxSendResponse: t.PartialC<{

dist/src/schema/transactions/sendTransactions.js

@@ -26,24 +26,18 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TxSendResponse = exports.TxSendBody = exports.txSendBody = void 0;
+exports.TxSendResponse = exports.TxSendBody = exports.txSendBody = exports.memo = void 0;
 const t = __importStar(require("io-ts"));
-function Optional(type) {
-    return t.union([type, t.undefined]);
-}
-const optionalString = Optional(t.string);
-const optionalBoolean = Optional(t.boolean);
-const optionalNumber = Optional(t.number);
-const optionalStringOrNumber = Optional(t.union([t.string, t.number]));
-const optionalUnknown = Optional(t.intersection([t.unknown, t.partial({})]));
+const utils_1 = require("~/utils");
+const coinSpecific_1 = require("./coinSpecific");
 const recipient = t.partial({
     address: t.string,
     amount: t.union([t.string, t.number]),
-    feeLimit: optionalString,
-    data: optionalString,
-    memo: optionalString,
-    tokenName: optionalString,
+    feeLimit: utils_1.optionalString,
+    data: utils_1.optionalString,
+    memo: utils_1.optionalString,
+    tokenName: utils_1.optionalString,
 });
 const recipients = t.array(recipient);
 const eip1559 = t.partial({
-    maxPriorityFeePerGas: optionalString,
-    maxFeePerGas: optionalString,
+    maxPriorityFeePerGas: utils_1.optionalString,
+    maxFeePerGas: utils_1.optionalString,
 });
@@ -62,115 +56,131 @@ const lightningPaymentRequest = t.intersection([
 const halfSigned = t.partial({
-    txHex: optionalString,
-    recipients: Optional(recipients),
-    eip1559: Optional(eip1559),
-    isBatch: optionalBoolean,
-    expireTime: optionalNumber,
-    contractSequenceId: optionalNumber,
-    nextContractSequenceId: optionalNumber,
-    operationHash: optionalString,
-    signedChildPsbt: optionalString,
-    signature: optionalString,
-    lightningPaymentRequest: Optional(lightningPaymentRequest),
+    txHex: utils_1.optionalString,
+    recipients: (0, utils_1.Optional)(recipients),
+    eip1559: (0, utils_1.Optional)(eip1559),
+    isBatch: utils_1.optionalBoolean,
+    expireTime: utils_1.optionalNumber,
+    contractSequenceId: utils_1.optionalNumber,
+    nextContractSequenceId: utils_1.optionalNumber,
+    operationHash: utils_1.optionalString,
+    signedChildPsbt: utils_1.optionalString,
+    signature: utils_1.optionalString,
+    lightningPaymentRequest: (0, utils_1.Optional)(lightningPaymentRequest),
 });
-const memo = t.partial({
-    type: optionalString,
-    value: optionalString,
+exports.memo = t.partial({
+    type: utils_1.optionalString,
+    value: utils_1.optionalString,
 });
+const feeOptions = {
+    amount: utils_1.optionalStringOrNumber,
+    unit: (0, utils_1.Optional)(t.union([t.literal('baseUnit'), t.literal('cpu'), t.literal('ram')])),
+    formula: (0, utils_1.Optional)(t.union([
+        t.literal('fixed'),
+        t.literal('feeRate'),
+        t.literal('perKB'),
+        t.literal('custom'),
+    ])),
+    type: (0, utils_1.Optional)(t.union([t.literal('base'), t.literal('max'), t.literal('tip')])),
+};
 exports.txSendBody = {
-    comment: optionalString,
-    consolidateId: optionalString,
-    halfSigned: Optional(halfSigned),
-    invoice: optionalString,
-    memo: Optional(memo),
-    otp: optionalString,
-    recipients: Optional(recipients),
-    suppressBroadcast: optionalBoolean,
-    txHex: optionalString,
-    txRequestId: optionalString,
-    videoApprovers: Optional(t.array(t.string)),
-    numBlocks: optionalNumber,
-    feeRate: optionalNumber,
-    maxFeeRate: optionalNumber,
-    minConfirms: optionalNumber,
-    enforceMinConfirmsForChange: optionalBoolean,
-    targetWalletUnspents: optionalNumber,
-    message: optionalString,
-    minValue: optionalStringOrNumber,
-    maxValue: optionalStringOrNumber,
-    sequenceId: optionalStringOrNumber,
-    lastLedgerSequence: optionalNumber,
-    ledgerSequenceDelta: optionalNumber,
-    gasPrice: optionalNumber,
-    noSplitChange: optionalBoolean,
+    comment: utils_1.optionalString,
+    consolidateId: utils_1.optionalString,
+    halfSigned: (0, utils_1.Optional)(halfSigned),
+    invoice: utils_1.optionalString,
+    memo: (0, utils_1.Optional)(exports.memo),
+    otp: utils_1.optionalString,
+    recipients: (0, utils_1.Optional)(recipients),
+    suppressBroadcast: utils_1.optionalBoolean,
+    txHex: utils_1.optionalString,
+    txRequestId: utils_1.optionalString,
+    videoApprovers: (0, utils_1.Optional)(t.array(t.string)),
+    numBlocks: utils_1.optionalNumber,
+    feeRate: utils_1.optionalNumber,
+    maxFeeRate: utils_1.optionalNumber,
+    minConfirms: utils_1.optionalNumber,
+    enforceMinConfirmsForChange: utils_1.optionalBoolean,
+    targetWalletUnspents: utils_1.optionalNumber,
+    message: utils_1.optionalString,
+    minValue: utils_1.optionalStringOrNumber,
+    maxValue: utils_1.optionalStringOrNumber,
+    sequenceId: utils_1.optionalStringOrNumber,
+    lastLedgerSequence: utils_1.optionalNumber,
+    ledgerSequenceDelta: utils_1.optionalNumber,
+    gasPrice: utils_1.optionalNumber,
+    noSplitChange: utils_1.optionalBoolean,
     unspents: t.array(t.string),
-    changeAddress: optionalString,
-    instant: optionalBoolean,
-    transferId: optionalNumber,
-    gasLimit: optionalNumber,
-    custodianTransactionId: optionalString,
-    cpfpTxIds: Optional(t.array(t.string)),
-    cpfpFeeRate: optionalNumber,
-    noCpfpFeeRate: optionalBoolean,
-    maxFee: optionalNumber,
-    noMaxFee: optionalBoolean,
-    feeMultiplier: optionalNumber,
-    addressType: optionalString,
-    changeAddressType: optionalString,
-    strategy: optionalString,
-    strategyAllowFallback: optionalBoolean,
-    fee: optionalString,
-    timeBounds: Optional(t.partial({
-        minTime: optionalStringOrNumber,
-        maxTime: optionalStringOrNumber,
+    changeAddress: utils_1.optionalString,
+    instant: utils_1.optionalBoolean,
+    transferId: utils_1.optionalNumber,
+    gasLimit: utils_1.optionalNumber,
+    custodianTransactionId: utils_1.optionalString,
+    cpfpTxIds: (0, utils_1.Optional)(t.array(t.string)),
+    cpfpFeeRate: utils_1.optionalNumber,
+    noCpfpFeeRate: utils_1.optionalBoolean,
+    maxFee: utils_1.optionalNumber,
+    noMaxFee: utils_1.optionalBoolean,
+    feeMultiplier: utils_1.optionalNumber,
+    addressType: utils_1.optionalString,
+    changeAddressType: utils_1.optionalString,
+    strategy: utils_1.optionalString,
+    strategyAllowFallback: utils_1.optionalBoolean,
+    fee: t.union([utils_1.optionalString, t.partial(feeOptions)]),
+    timeBounds: (0, utils_1.Optional)(t.partial({
+        minTime: utils_1.optionalStringOrNumber,
+        maxTime: utils_1.optionalStringOrNumber,
     })),
-    idfSignedTimestamp: optionalString,
-    idfVersion: optionalNumber,
-    idfUserId: optionalString,
+    idfSignedTimestamp: utils_1.optionalString,
+    idfVersion: utils_1.optionalNumber,
+    idfUserId: utils_1.optionalString,
     hopParams: t.partial({
-        gasPriceMax: optionalNumber,
-        paymentId: optionalString,
-        userReqSig: optionalString,
+        gasPriceMax: utils_1.optionalNumber,
+        paymentId: utils_1.optionalString,
+        userReqSig: utils_1.optionalString,
     }),
-    validFromBlock: optionalNumber,
-    validToBlock: optionalNumber,
-    type: optionalString,
+    validFromBlock: utils_1.optionalNumber,
+    validToBlock: utils_1.optionalNumber,
+    type: utils_1.optionalString,
     trustlines: t.partial({
-        token: optionalString,
-        action: optionalString,
-        limit: optionalString,
+        token: utils_1.optionalString,
+        action: utils_1.optionalString,
+        limit: utils_1.optionalString,
     }),
     reservation: t.partial({
-        expireTime: optionalString,
-        pendingApprovalId: optionalString,
+        expireTime: utils_1.optionalString,
+        pendingApprovalId: utils_1.optionalString,
     }),
-    delayMs: optionalNumber,
-    messageKey: optionalString,
-    senderAddress: optionalString,
-    startTime: optionalString,
-    nonParticipation: optionalBoolean,
-    keyregTxBase64: optionalString,
-    closeRemainderTo: optionalString,
-    stateProofKey: optionalString,
-    contractName: optionalString,
-    functionName: optionalString,
-    eip1559: Optional(eip1559),
-    maxChangeOutputs: optionalNumber,
-    smallestChangeSplitSize: optionalNumber,
-    emergency: optionalBoolean,
-    sourceChain: optionalString,
-    destinationChain: optionalString,
-    txFormat: optionalString,
-    previewPendingTxs: optionalBoolean,
-    pendingApprovalId: optionalString,
-    stakingOptions: optionalUnknown,
-    unstakingOptions: optionalUnknown,
-    refundOptions: optionalUnknown,
+    delayMs: utils_1.optionalNumber,
+    messageKey: utils_1.optionalString,
+    senderAddress: utils_1.optionalString,
+    startTime: utils_1.optionalString,
+    nonParticipation: utils_1.optionalBoolean,
+    keyregTxBase64: utils_1.optionalString,
+    closeRemainderTo: utils_1.optionalString,
+    stateProofKey: utils_1.optionalString,
+    contractName: utils_1.optionalString,
+    functionName: utils_1.optionalString,
+    eip1559: (0, utils_1.Optional)(eip1559),
+    maxChangeOutputs: utils_1.optionalNumber,
+    smallestChangeSplitSize: utils_1.optionalNumber,
+    emergency: utils_1.optionalBoolean,
+    sourceChain: utils_1.optionalString,
+    destinationChain: utils_1.optionalString,
+    txFormat: utils_1.optionalString,
+    previewPendingTxs: utils_1.optionalBoolean,
+    pendingApprovalId: utils_1.optionalString,
+    stakingOptions: utils_1.optionalUnknown,
+    unstakingOptions: utils_1.optionalUnknown,
+    refundOptions: utils_1.optionalUnknown,
     stakingParams: t.partial({
-        actionType: optionalString,
-        validator: optionalString,
-        coin: optionalString,
-        amount: optionalString,
+        actionType: utils_1.optionalString,
+        validator: utils_1.optionalString,
+        coin: utils_1.optionalString,
+        amount: utils_1.optionalString,
     }),
 };
-exports.TxSendBody = t.exact(t.partial(exports.txSendBody, 'TxSendBody'));
+exports.TxSendBody = t.exact(t.intersection([
+    t.partial(exports.txSendBody, 'TxSendBody'),
+    t.partial(coinSpecific_1.CoinSpecificBuildParams.avaxp),
+    t.partial(coinSpecific_1.CoinSpecificBuildParams.dot),
+    t.partial(coinSpecific_1.CoinSpecificBuildParams.sol),
+]));
 const entry = t.partial({
@@ -177,0 +187,0 @@ address: t.string,

package.json

 {
   "name": "@bitgo/public-types",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "Collection of types exposed externally as part of the BitGo public API",
@@ -25,3 +25,3 @@ "license": "UNLICENSED",
   "devDependencies": {
-    "@types/node": "20.8.10",
+    "@types/node": "20.9.0",
     "@vitest/coverage-v8": "0.34.6",
@@ -28,0 +28,0 @@ "vitest": "0.34.6",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

61305

increased by43.6%

Number of package files

34

increased by88.89%

Lines of code

1025

increased by34.69%

No dependency changes