@safe-global/protocol-kit 0.1.0 → 1.0.0

package/dist/src/utils/transactions/utils.d.ts

@@ -1,6 +1,7 @@
-import { EthAdapter, GnosisSafeContract, MetaTransactionData, SafeMultisigTransactionResponse, SafeTransaction, SafeTransactionData, SafeTransactionDataPartial } from '@safe-global/safe-core-sdk-types';
+import { StandardizeSafeTransactionDataProps } from '../../types';
+import { MetaTransactionData, SafeMultisigTransactionResponse, SafeTransaction, SafeTransactionData, SafeTransactionDataPartial } from '@safe-global/safe-core-sdk-types';
 export declare function standardizeMetaTransactionData(tx: SafeTransactionDataPartial): MetaTransactionData;
-export declare function standardizeSafeTransactionData(safeContract: GnosisSafeContract, ethAdapter: EthAdapter, tx: SafeTransactionDataPartial): Promise<SafeTransactionData>;
+export declare function standardizeSafeTransactionData({ safeContract, predictedSafe, ethAdapter, tx }: StandardizeSafeTransactionDataProps): Promise<SafeTransactionData>;
 export declare function encodeMultiSendData(txs: MetaTransactionData[]): string;
 export declare function decodeMultiSendData(encodedData: string): MetaTransactionData[];
 export declare function isMetaTransactionArray(safeTransactions: SafeTransactionDataPartial | MetaTransactionData[]): safeTransactions is MetaTransactionData[];

package/dist/src/utils/transactions/utils.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isSafeMultisigTransactionResponse = exports.isMetaTransactionArray = exports.decodeMultiSendData = exports.encodeMultiSendData = exports.standardizeSafeTransactionData = exports.standardizeMetaTransactionData = void 0;
+const abi_1 = require("@ethersproject/abi");
 const bytes_1 = require("@ethersproject/bytes");
 const solidity_1 = require("@ethersproject/solidity");
-const abi_1 = require("@ethersproject/abi");
-const web3_utils_1 = require("web3-utils");
+const utils_1 = require("../../utils");
+const constants_1 = require("../../utils/constants");
 const safe_core_sdk_types_1 = require("@safe-global/safe-core-sdk-types");
-const utils_1 = require("@safe-global/protocol-kit/utils");
-const constants_1 = require("@safe-global/protocol-kit/utils/constants");
+const web3_utils_1 = require("web3-utils");
 const gas_1 = require("./gas");
 function standardizeMetaTransactionData(tx) {
     var _a;
@@ -18,34 +18,47 @@ function standardizeMetaTransactionData(tx) {
     return standardizedTxs;
 }
 exports.standardizeMetaTransactionData = standardizeMetaTransactionData;
-async function standardizeSafeTransactionData(safeContract, ethAdapter, tx) {
+async function standardizeSafeTransactionData({ safeContract, predictedSafe, ethAdapter, tx }) {
     var _a, _b, _c, _d;
     const standardizedTxs = {
         to: tx.to,
         value: tx.value,
         data: tx.data,
         operation: (_a = tx.operation) !== null && _a !== void 0 ? _a : safe_core_sdk_types_1.OperationType.Call,
-        baseGas: (_b = tx.baseGas) !== null && _b !== void 0 ? _b : 0,
-        gasPrice: (_c = tx.gasPrice) !== null && _c !== void 0 ? _c : 0,
+        baseGas: (_b = tx.baseGas) !== null && _b !== void 0 ? _b : '0',
+        gasPrice: (_c = tx.gasPrice) !== null && _c !== void 0 ? _c : '0',
         gasToken: tx.gasToken || constants_1.ZERO_ADDRESS,
         refundReceiver: tx.refundReceiver || constants_1.ZERO_ADDRESS,
-        nonce: (_d = tx.nonce) !== null && _d !== void 0 ? _d : (await safeContract.getNonce())
+        nonce: (_d = tx.nonce) !== null && _d !== void 0 ? _d : (safeContract ? await safeContract.getNonce() : 0)
     };
-    let safeTxGas;
     if (typeof tx.safeTxGas !== 'undefined') {
         return {
             ...standardizedTxs,
             safeTxGas: tx.safeTxGas
         };
     }
-    const safeVersion = await safeContract.getVersion();
-    if ((0, utils_1.hasSafeFeature)(utils_1.SAFE_FEATURES.SAFE_TX_GAS_OPTIONAL, safeVersion) &&
-        standardizedTxs.gasPrice === 0) {
-        safeTxGas = 0;
+    let safeVersion;
+    if (predictedSafe === null || predictedSafe === void 0 ? void 0 : predictedSafe.safeDeploymentConfig.safeVersion) {
+        safeVersion = predictedSafe === null || predictedSafe === void 0 ? void 0 : predictedSafe.safeDeploymentConfig.safeVersion;
     }
     else {
-        safeTxGas = await (0, gas_1.estimateTxGas)(safeContract, ethAdapter, standardizedTxs.to, standardizedTxs.value, standardizedTxs.data, standardizedTxs.operation);
+        if (!safeContract) {
+            throw new Error('Safe is not deployed');
+        }
+        safeVersion = await safeContract.getVersion();
+    }
+    const hasSafeTxGasOptional = (0, utils_1.hasSafeFeature)(utils_1.SAFE_FEATURES.SAFE_TX_GAS_OPTIONAL, safeVersion);
+    if ((hasSafeTxGasOptional && standardizedTxs.gasPrice === '0') ||
+        (hasSafeTxGasOptional && predictedSafe)) {
+        return {
+            ...standardizedTxs,
+            safeTxGas: '0'
+        };
+    }
+    if (!safeContract) {
+        throw new Error('Safe is not deployed');
     }
+    const safeTxGas = await (0, gas_1.estimateTxGas)(safeContract, ethAdapter, standardizedTxs.to, standardizedTxs.value, standardizedTxs.data, standardizedTxs.operation);
     return {
         ...standardizedTxs,
         safeTxGas

package/dist/src/utils/transactions/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/utils/transactions/utils.ts"],"names":[],"mappings":";;;AAAA,gDAA+C;AAC/C,sDAA8D;AAC9D,4CAA8C;AAC9C,2CAA8E;AAC9E,0EASyC;AACzC,2DAA+E;AAC/E,yEAAwE;AACxE,+BAAqC;AAErC,SAAgB,8BAA8B,CAC5C,EAA8B;;IAE9B,MAAM,eAAe,GAAwB;QAC3C,GAAG,EAAE;QACL,SAAS,EAAE,MAAA,EAAE,CAAC,SAAS,mCAAI,mCAAa,CAAC,IAAI;KAC9C,CAAA;IACD,OAAO,eAAe,CAAA;AACxB,CAAC;AARD,wEAQC;AAEM,KAAK,UAAU,8BAA8B,CAClD,YAAgC,EAChC,UAAsB,EACtB,EAA8B;;IAE9B,MAAM,eAAe,GAAG;QACtB,EAAE,EAAE,EAAE,CAAC,EAAE;QACT,KAAK,EAAE,EAAE,CAAC,KAAK;QACf,IAAI,EAAE,EAAE,CAAC,IAAI;QACb,SAAS,EAAE,MAAA,EAAE,CAAC,SAAS,mCAAI,mCAAa,CAAC,IAAI;QAC7C,OAAO,EAAE,MAAA,EAAE,CAAC,OAAO,mCAAI,CAAC;QACxB,QAAQ,EAAE,MAAA,EAAE,CAAC,QAAQ,mCAAI,CAAC;QAC1B,QAAQ,EAAE,EAAE,CAAC,QAAQ,IAAI,wBAAY;QACrC,cAAc,EAAE,EAAE,CAAC,cAAc,IAAI,wBAAY;QACjD,KAAK,EAAE,MAAA,EAAE,CAAC,KAAK,mCAAI,CAAC,MAAM,YAAY,CAAC,QAAQ,EAAE,CAAC;KACnD,CAAA;IACD,IAAI,SAAiB,CAAA;IAErB,IAAI,OAAO,EAAE,CAAC,SAAS,KAAK,WAAW,EAAE;QACvC,OAAO;YACL,GAAG,eAAe;YAClB,SAAS,EAAE,EAAE,CAAC,SAAS;SACxB,CAAA;KACF;IACD,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,UAAU,EAAE,CAAA;IACnD,IACE,IAAA,sBAAc,EAAC,qBAAa,CAAC,oBAAoB,EAAE,WAAW,CAAC;QAC/D,eAAe,CAAC,QAAQ,KAAK,CAAC,EAC9B;QACA,SAAS,GAAG,CAAC,CAAA;KACd;SAAM;QACL,SAAS,GAAG,MAAM,IAAA,mBAAa,EAC7B,YAAY,EACZ,UAAU,EACV,eAAe,CAAC,EAAE,EAClB,eAAe,CAAC,KAAK,EACrB,eAAe,CAAC,IAAI,EACpB,eAAe,CAAC,SAAS,CAC1B,CAAA;KACF;IACD,OAAO;QACL,GAAG,eAAe;QAClB,SAAS;KACV,CAAA;AACH,CAAC;AA5CD,wEA4CC;AAED,SAAS,qBAAqB,CAAC,EAAuB;IACpD,MAAM,IAAI,GAAG,IAAA,gBAAQ,EAAC,EAAE,CAAC,IAAI,CAAC,CAAA;IAC9B,MAAM,OAAO,GAAG,IAAA,eAAY,EAC1B,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EACnD,CAAC,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CACnD,CAAA;IACD,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;AACzB,CAAC;AAED,SAAgB,mBAAmB,CAAC,GAA0B;IAC5D,OAAO,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;AACnE,CAAC;AAFD,kDAEC;AAED,SAAgB,mBAAmB,CAAC,WAAmB;IACrD,MAAM,kBAAkB,GAAG,IAAI,eAAS,CAAC;QACvC,8DAA8D;KAC/D,CAAC,CAAA;IACF,MAAM,CAAC,WAAW,CAAC,GAAG,kBAAkB,CAAC,kBAAkB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAA;IAErF,MAAM,GAAG,GAA0B,EAAE,CAAA;IAErC,kBAAkB;IAClB,IAAI,KAAK,GAAG,CAAC,CAAA;IAEb,OAAO,KAAK,GAAG,WAAW,CAAC,MAAM,EAAE;QACjC,qFAAqF;QACrF,iEAAiE;QAEjE,MAAM,SAAS,GAAG,KAAK,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAA;QAC/D,MAAM,EAAE,GAAG,KAAK,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,EAAE,CAAA;QACzD,MAAM,KAAK,GAAG,KAAK,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,EAAE,CAAA;QAC5D,MAAM,UAAU,GAAG,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAA;QAC5E,MAAM,IAAI,GAAG,KAAK,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,UAAU,CAAC,CAAC,EAAE,CAAA;QAEnE,GAAG,CAAC,IAAI,CAAC;YACP,SAAS,EAAE,IAAA,wBAAW,EAAC,SAAS,CAAC;YACjC,EAAE,EAAE,IAAA,8BAAiB,EAAC,EAAE,CAAC;YACzB,KAAK,EAAE,IAAA,8BAAiB,EAAC,KAAK,CAAC;YAC/B,IAAI;SACL,CAAC,CAAA;KACH;IAED,OAAO,GAAG,CAAA;AACZ,CAAC;AA9BD,kDA8BC;AAED,SAAgB,sBAAsB,CACpC,gBAAoE;IAEpE,OAAO,CAAC,gBAA0C,aAA1C,gBAAgB,uBAAhB,gBAAgB,CAA4B,MAAM,MAAK,SAAS,CAAA;AAC1E,CAAC;AAJD,wDAIC;AAED,SAAgB,iCAAiC,CAC/C,eAAkE;IAElE,OAAQ,eAAmD,CAAC,UAAU,KAAK,SAAS,CAAA;AACtF,CAAC;AAJD,8EAIC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/utils/transactions/utils.ts"],"names":[],"mappings":";;;AAAA,4CAA8C;AAC9C,gDAA+C;AAC/C,sDAA8D;AAE9D,2DAA+E;AAC/E,yEAAwE;AACxE,0EAQyC;AACzC,2CAA8E;AAC9E,+BAAqC;AAErC,SAAgB,8BAA8B,CAC5C,EAA8B;;IAE9B,MAAM,eAAe,GAAwB;QAC3C,GAAG,EAAE;QACL,SAAS,EAAE,MAAA,EAAE,CAAC,SAAS,mCAAI,mCAAa,CAAC,IAAI;KAC9C,CAAA;IACD,OAAO,eAAe,CAAA;AACxB,CAAC;AARD,wEAQC;AAEM,KAAK,UAAU,8BAA8B,CAAC,EACnD,YAAY,EACZ,aAAa,EACb,UAAU,EACV,EAAE,EACkC;;IACpC,MAAM,eAAe,GAAG;QACtB,EAAE,EAAE,EAAE,CAAC,EAAE;QACT,KAAK,EAAE,EAAE,CAAC,KAAK;QACf,IAAI,EAAE,EAAE,CAAC,IAAI;QACb,SAAS,EAAE,MAAA,EAAE,CAAC,SAAS,mCAAI,mCAAa,CAAC,IAAI;QAC7C,OAAO,EAAE,MAAA,EAAE,CAAC,OAAO,mCAAI,GAAG;QAC1B,QAAQ,EAAE,MAAA,EAAE,CAAC,QAAQ,mCAAI,GAAG;QAC5B,QAAQ,EAAE,EAAE,CAAC,QAAQ,IAAI,wBAAY;QACrC,cAAc,EAAE,EAAE,CAAC,cAAc,IAAI,wBAAY;QACjD,KAAK,EAAE,MAAA,EAAE,CAAC,KAAK,mCAAI,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;KACtE,CAAA;IAED,IAAI,OAAO,EAAE,CAAC,SAAS,KAAK,WAAW,EAAE;QACvC,OAAO;YACL,GAAG,eAAe;YAClB,SAAS,EAAE,EAAE,CAAC,SAAS;SACxB,CAAA;KACF;IAED,IAAI,WAAwB,CAAA;IAC5B,IAAI,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,oBAAoB,CAAC,WAAW,EAAE;QACnD,WAAW,GAAG,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,oBAAoB,CAAC,WAAW,CAAA;KAC9D;SAAM;QACL,IAAI,CAAC,YAAY,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;SACxC;QACD,WAAW,GAAG,MAAM,YAAY,CAAC,UAAU,EAAE,CAAA;KAC9C;IAED,MAAM,oBAAoB,GAAG,IAAA,sBAAc,EAAC,qBAAa,CAAC,oBAAoB,EAAE,WAAW,CAAC,CAAA;IAC5F,IACE,CAAC,oBAAoB,IAAI,eAAe,CAAC,QAAQ,KAAK,GAAG,CAAC;QAC1D,CAAC,oBAAoB,IAAI,aAAa,CAAC,EACvC;QACA,OAAO;YACL,GAAG,eAAe;YAClB,SAAS,EAAE,GAAG;SACf,CAAA;KACF;IAED,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;KACxC;IACD,MAAM,SAAS,GAAG,MAAM,IAAA,mBAAa,EACnC,YAAY,EACZ,UAAU,EACV,eAAe,CAAC,EAAE,EAClB,eAAe,CAAC,KAAK,EACrB,eAAe,CAAC,IAAI,EACpB,eAAe,CAAC,SAAS,CAC1B,CAAA;IACD,OAAO;QACL,GAAG,eAAe;QAClB,SAAS;KACV,CAAA;AACH,CAAC;AA7DD,wEA6DC;AAED,SAAS,qBAAqB,CAAC,EAAuB;IACpD,MAAM,IAAI,GAAG,IAAA,gBAAQ,EAAC,EAAE,CAAC,IAAI,CAAC,CAAA;IAC9B,MAAM,OAAO,GAAG,IAAA,eAAY,EAC1B,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EACnD,CAAC,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CACnD,CAAA;IACD,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;AACzB,CAAC;AAED,SAAgB,mBAAmB,CAAC,GAA0B;IAC5D,OAAO,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;AACnE,CAAC;AAFD,kDAEC;AAED,SAAgB,mBAAmB,CAAC,WAAmB;IACrD,MAAM,kBAAkB,GAAG,IAAI,eAAS,CAAC;QACvC,8DAA8D;KAC/D,CAAC,CAAA;IACF,MAAM,CAAC,WAAW,CAAC,GAAG,kBAAkB,CAAC,kBAAkB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAA;IAErF,MAAM,GAAG,GAA0B,EAAE,CAAA;IAErC,kBAAkB;IAClB,IAAI,KAAK,GAAG,CAAC,CAAA;IAEb,OAAO,KAAK,GAAG,WAAW,CAAC,MAAM,EAAE;QACjC,qFAAqF;QACrF,iEAAiE;QAEjE,MAAM,SAAS,GAAG,KAAK,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAA;QAC/D,MAAM,EAAE,GAAG,KAAK,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,EAAE,CAAA;QACzD,MAAM,KAAK,GAAG,KAAK,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,EAAE,CAAA;QAC5D,MAAM,UAAU,GAAG,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAA;QAC5E,MAAM,IAAI,GAAG,KAAK,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,UAAU,CAAC,CAAC,EAAE,CAAA;QAEnE,GAAG,CAAC,IAAI,CAAC;YACP,SAAS,EAAE,IAAA,wBAAW,EAAC,SAAS,CAAkB;YAClD,EAAE,EAAE,IAAA,8BAAiB,EAAC,EAAE,CAAC;YACzB,KAAK,EAAE,IAAA,8BAAiB,EAAC,KAAK,CAAC;YAC/B,IAAI;SACL,CAAC,CAAA;KACH;IAED,OAAO,GAAG,CAAA;AACZ,CAAC;AA9BD,kDA8BC;AAED,SAAgB,sBAAsB,CACpC,gBAAoE;IAEpE,OAAO,CAAC,gBAA0C,aAA1C,gBAAgB,uBAAhB,gBAAgB,CAA4B,MAAM,MAAK,SAAS,CAAA;AAC1E,CAAC;AAJD,wDAIC;AAED,SAAgB,iCAAiC,CAC/C,eAAkE;IAElE,OAAQ,eAAmD,CAAC,UAAU,KAAK,SAAS,CAAA;AACtF,CAAC;AAJD,8EAIC"}

package/dist/src/utils/types.d.ts

@@ -0,0 +1,2 @@
+import { SafeConfig, SafeConfigWithPredictedSafe } from '../types';
+export declare function isSafeConfigWithPredictedSafe(config: SafeConfig): config is SafeConfigWithPredictedSafe;

package/dist/src/utils/types.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSafeConfigWithPredictedSafe = void 0;
+function isSafeConfigWithPredictedSafe(config) {
+    return config.predictedSafe !== undefined;
+}
+exports.isSafeConfigWithPredictedSafe = isSafeConfigWithPredictedSafe;
+//# sourceMappingURL=types.js.map

package/dist/src/utils/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/utils/types.ts"],"names":[],"mappings":";;;AAEA,SAAgB,6BAA6B,CAC3C,MAAkB;IAElB,OAAQ,MAAiD,CAAC,aAAa,KAAK,SAAS,CAAA;AACvF,CAAC;AAJD,sEAIC"}