starknet 3.7.0 → 3.10.0

package/src/utils/stark.ts

@@ -1,10 +1,11 @@
+import BN from 'bn.js';
 import { gzip } from 'pako';
 
 import { Calldata, CompressedProgram, Program, RawArgs, Signature } from '../types';
 import { genKeyPair, getStarkKey } from './ellipticCurve';
 import { addHexPrefix, btoaUniversal } from './encode';
 import { stringify } from './json';
-import { toBN } from './number';
+import { BigNumberish, toBN } from './number';
 
 /**
  * Function to compress compiled cairo program
@@ -48,3 +49,9 @@ export function compileCalldata(args: RawArgs): Calldata {
     return toBN(value).toString();
   });
 }
+
+export function estimatedFeeToMaxFee(estimatedFee: BigNumberish, overhead: number = 0.15): BN {
+  // BN can only handle Integers, so we need to do all calulations with integers
+  const overHeadPercent = Math.round((1 + overhead) * 100);
+  return toBN(estimatedFee).mul(toBN(overHeadPercent)).div(toBN(100));
+}

package/src/utils/transaction.ts

@@ -47,3 +47,10 @@ export const fromCallsToExecuteCalldata = (calls: Call[]): string[] => {
     ...calldata,
   ];
 };
+
+export const fromCallsToExecuteCalldataWithNonce = (
+  calls: Call[],
+  nonce: BigNumberish
+): string[] => {
+  return [...fromCallsToExecuteCalldata(calls), toBN(nonce).toString()];
+};

package/types/api.d.ts

@@ -74,7 +74,9 @@ export declare type Endpoints = {
     RESPONSE: CallContractResponse;
   };
   estimate_fee: {
-    QUERY: never;
+    QUERY: {
+      blockIdentifier: BlockIdentifier;
+    };
     REQUEST: CallContractTransaction;
     RESPONSE: EstimateFeeResponse;
   };
@@ -99,6 +101,7 @@ export declare type InvokeFunctionTransaction = {
   calldata?: RawCalldata;
   nonce?: BigNumberish;
   max_fee?: BigNumberish;
+  version?: BigNumberish;
 };
 export declare type InvokeFunctionTrace = {
   caller_address: string;

package/types/lib.d.ts

@@ -19,6 +19,7 @@ export declare type Call = Omit<Invocation, 'signature'>;
 export declare type InvocationsDetails = {
   nonce?: BigNumberish;
   maxFee?: BigNumberish;
+  version?: BigNumberish;
 };
 export declare type Status =
   | 'NOT_RECEIVED'

package/types/signer.d.ts

@@ -1,4 +1,6 @@
+import { StarknetChainId } from '../constants';
 import { InvocationsDetails } from './lib';
 export interface InvocationsSignerDetails extends Required<InvocationsDetails> {
   walletAddress: string;
+  chainId: StarknetChainId;
 }

package/utils/hash.d.ts

@@ -1,9 +1,9 @@
 import BN from 'bn.js';
 
-import { Call } from '../types';
+import { StarknetChainId, TransactionHashPrefix } from '../constants';
 import { BigNumberish } from './number';
-export declare const transactionPrefix: string;
 export declare const transactionVersion = 0;
+export declare const feeTransactionVersion: BN;
 /**
  * Function to get the starknet keccak hash from a string
  *
@@ -22,9 +22,27 @@ export declare function starknetKeccak(value: string): BN;
 export declare function getSelectorFromName(funcName: string): string;
 export declare function pedersen(input: [BigNumberish, BigNumberish]): string;
 export declare function computeHashOnElements(data: BigNumberish[]): string;
-export declare function hashMulticall(
-  account: string,
-  transactions: Call[],
-  nonce: string,
-  maxFee: string
+export declare function calculateTransactionHashCommon(
+  txHashPrefix: TransactionHashPrefix,
+  version: BigNumberish,
+  contractAddress: BigNumberish,
+  entryPointSelector: BigNumberish,
+  calldata: BigNumberish[],
+  maxFee: BigNumberish,
+  chainId: StarknetChainId,
+  additionalData?: BigNumberish[]
+): string;
+export declare function calculateDeployTransactionHash(
+  contractAddress: BigNumberish,
+  constructorCalldata: BigNumberish[],
+  version: BigNumberish,
+  chainId: StarknetChainId
+): string;
+export declare function calculcateTransactionHash(
+  contractAddress: BigNumberish,
+  version: BigNumberish,
+  entryPointSelector: BigNumberish,
+  calldata: BigNumberish[],
+  maxFee: BigNumberish,
+  chainId: StarknetChainId
 ): string;

package/utils/hash.js

@@ -39,13 +39,15 @@ var __importDefault =
     return mod && mod.__esModule ? mod : { default: mod };
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.hashMulticall =
+exports.calculcateTransactionHash =
+  exports.calculateDeployTransactionHash =
+  exports.calculateTransactionHashCommon =
   exports.computeHashOnElements =
   exports.pedersen =
   exports.getSelectorFromName =
   exports.starknetKeccak =
+  exports.feeTransactionVersion =
   exports.transactionVersion =
-  exports.transactionPrefix =
     void 0;
 var keccak_1 = require('ethereum-cryptography/keccak');
 var minimalistic_assert_1 = __importDefault(require('minimalistic-assert'));
@@ -53,9 +55,10 @@ var constants_1 = require('../constants');
 var ellipticCurve_1 = require('./ellipticCurve');
 var encode_1 = require('./encode');
 var number_1 = require('./number');
-var shortString_1 = require('./shortString');
-exports.transactionPrefix = (0, shortString_1.encodeShortString)('StarkNet Transaction');
 exports.transactionVersion = 0;
+exports.feeTransactionVersion = (0, number_1.toBN)(2)
+  .pow((0, number_1.toBN)(128))
+  .add((0, number_1.toBN)(exports.transactionVersion));
 function keccakHex(value) {
   return (0, encode_1.addHexPrefix)(
     (0, encode_1.buf2hex)((0, keccak_1.keccak256)((0, encode_1.utf8ToArray)(value)))
@@ -116,27 +119,58 @@ function computeHashOnElements(data) {
     .toString();
 }
 exports.computeHashOnElements = computeHashOnElements;
-function hashMulticall(account, transactions, nonce, maxFee) {
-  var hashArray = transactions
-    .map(function (_a) {
-      var contractAddress = _a.contractAddress,
-        entrypoint = _a.entrypoint,
-        calldata = _a.calldata;
-      return [
-        contractAddress,
-        getSelectorFromName(entrypoint),
-        computeHashOnElements(calldata || []),
-      ];
-    })
-    .map(number_1.bigNumberishArrayToDecimalStringArray)
-    .map(computeHashOnElements);
-  return computeHashOnElements([
-    exports.transactionPrefix,
-    account,
-    computeHashOnElements(hashArray),
-    nonce,
+// following implementation is based on this python implementation:
+// https://github.com/starkware-libs/cairo-lang/blob/b614d1867c64f3fb2cf4a4879348cfcf87c3a5a7/src/starkware/starknet/core/os/transaction_hash/transaction_hash.py
+function calculateTransactionHashCommon(
+  txHashPrefix,
+  version,
+  contractAddress,
+  entryPointSelector,
+  calldata,
+  maxFee,
+  chainId,
+  additionalData
+) {
+  if (additionalData === void 0) {
+    additionalData = [];
+  }
+  var calldataHash = computeHashOnElements(calldata);
+  var dataToHash = __spreadArray(
+    [txHashPrefix, version, contractAddress, entryPointSelector, calldataHash, maxFee, chainId],
+    __read(additionalData),
+    false
+  );
+  return computeHashOnElements(dataToHash);
+}
+exports.calculateTransactionHashCommon = calculateTransactionHashCommon;
+function calculateDeployTransactionHash(contractAddress, constructorCalldata, version, chainId) {
+  return calculateTransactionHashCommon(
+    constants_1.TransactionHashPrefix.DEPLOY,
+    version,
+    contractAddress,
+    getSelectorFromName('constructor'),
+    constructorCalldata,
+    constants_1.ZERO,
+    chainId
+  );
+}
+exports.calculateDeployTransactionHash = calculateDeployTransactionHash;
+function calculcateTransactionHash(
+  contractAddress,
+  version,
+  entryPointSelector,
+  calldata,
+  maxFee,
+  chainId
+) {
+  return calculateTransactionHashCommon(
+    constants_1.TransactionHashPrefix.INVOKE,
+    version,
+    contractAddress,
+    entryPointSelector,
+    calldata,
     maxFee,
-    exports.transactionVersion,
-  ]);
+    chainId
+  );
 }
-exports.hashMulticall = hashMulticall;
+exports.calculcateTransactionHash = calculcateTransactionHash;

package/utils/stark.d.ts

@@ -1,4 +1,7 @@
+import BN from 'bn.js';
+
 import { Calldata, CompressedProgram, Program, RawArgs, Signature } from '../types';
+import { BigNumberish } from './number';
 /**
  * Function to compress compiled cairo program
  *
@@ -11,3 +14,4 @@ export declare function randomAddress(): string;
 export declare function makeAddress(input: string): string;
 export declare function formatSignature(sig?: Signature): string[];
 export declare function compileCalldata(args: RawArgs): Calldata;
+export declare function estimatedFeeToMaxFee(estimatedFee: BigNumberish, overhead?: number): BN;

package/utils/stark.js

@@ -34,7 +34,8 @@ var __spreadArray =
     return to.concat(ar || Array.prototype.slice.call(from));
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.compileCalldata =
+exports.estimatedFeeToMaxFee =
+  exports.compileCalldata =
   exports.formatSignature =
   exports.makeAddress =
   exports.randomAddress =
@@ -111,3 +112,14 @@ function compileCalldata(args) {
   });
 }
 exports.compileCalldata = compileCalldata;
+function estimatedFeeToMaxFee(estimatedFee, overhead) {
+  if (overhead === void 0) {
+    overhead = 0.15;
+  }
+  // BN can only handle Integers, so we need to do all calulations with integers
+  var overHeadPercent = Math.round((1 + overhead) * 100);
+  return (0, number_1.toBN)(estimatedFee)
+    .mul((0, number_1.toBN)(overHeadPercent))
+    .div((0, number_1.toBN)(100));
+}
+exports.estimatedFeeToMaxFee = estimatedFeeToMaxFee;

package/utils/transaction.d.ts

@@ -1,4 +1,5 @@
 import { Call, ParsedStruct } from '../types';
+import { BigNumberish } from './number';
 /**
  * Transforms a list of Calls, each with their own calldata, into
  * two arrays: one with the entrypoints, and one with the concatenated calldata.
@@ -16,3 +17,7 @@ export declare const transformCallsToMulticallArrays: (calls: Call[]) => {
  * @returns
  */
 export declare const fromCallsToExecuteCalldata: (calls: Call[]) => string[];
+export declare const fromCallsToExecuteCalldataWithNonce: (
+  calls: Call[],
+  nonce: BigNumberish
+) => string[];

package/utils/transaction.js

@@ -34,7 +34,10 @@ var __spreadArray =
     return to.concat(ar || Array.prototype.slice.call(from));
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.fromCallsToExecuteCalldata = exports.transformCallsToMulticallArrays = void 0;
+exports.fromCallsToExecuteCalldataWithNonce =
+  exports.fromCallsToExecuteCalldata =
+  exports.transformCallsToMulticallArrays =
+    void 0;
 var hash_1 = require('./hash');
 var number_1 = require('./number');
 /**
@@ -97,3 +100,11 @@ var fromCallsToExecuteCalldata = function (calls) {
   );
 };
 exports.fromCallsToExecuteCalldata = fromCallsToExecuteCalldata;
+var fromCallsToExecuteCalldataWithNonce = function (calls, nonce) {
+  return __spreadArray(
+    __spreadArray([], __read((0, exports.fromCallsToExecuteCalldata)(calls)), false),
+    [(0, number_1.toBN)(nonce).toString()],
+    false
+  );
+};
+exports.fromCallsToExecuteCalldataWithNonce = fromCallsToExecuteCalldataWithNonce;

package/utils/typedData/index.d.ts

@@ -55,9 +55,9 @@ export declare const encodeData: <
     >;
     primaryType: string;
     domain: {
-      name?: string | undefined;
       version?: string | undefined;
       chainId?: string | number | undefined;
+      name?: string | undefined;
     };
     message: Record<string, unknown>;
   }
@@ -91,9 +91,9 @@ export declare const getStructHash: <
     >;
     primaryType: string;
     domain: {
-      name?: string | undefined;
       version?: string | undefined;
       chainId?: string | number | undefined;
+      name?: string | undefined;
     };
     message: Record<string, unknown>;
   }

package/utils/typedData/types.d.ts

@@ -29,9 +29,9 @@ export declare const STARKNET_TYPE: import('superstruct').Struct<
 export declare type StarkNetType = Infer<typeof STARKNET_TYPE>;
 export declare const STARKNET_DOMAIN_TYPE: import('superstruct').Struct<
   {
-    name?: string | undefined;
     version?: string | undefined;
     chainId?: string | number | undefined;
+    name?: string | undefined;
   },
   {
     name: import('superstruct').Struct<string | undefined, null>;
@@ -59,9 +59,9 @@ export declare const STARKNET_TYPED_DATA_TYPE: import('superstruct').Struct<
     >;
     primaryType: string;
     domain: {
-      name?: string | undefined;
       version?: string | undefined;
       chainId?: string | number | undefined;
+      name?: string | undefined;
     };
     message: Record<string, unknown>;
   },
@@ -84,9 +84,9 @@ export declare const STARKNET_TYPED_DATA_TYPE: import('superstruct').Struct<
     primaryType: import('superstruct').Struct<string, null>;
     domain: import('superstruct').Struct<
       {
-        name?: string | undefined;
         version?: string | undefined;
         chainId?: string | number | undefined;
+        name?: string | undefined;
       },
       {
         name: import('superstruct').Struct<string | undefined, null>;

package/utils/typedData/utils.d.ts

@@ -19,9 +19,9 @@ export declare const validateTypedData: (data: unknown) => data is {
   >;
   primaryType: string;
   domain: {
-    name?: string | undefined;
     version?: string | undefined;
     chainId?: string | number | undefined;
+    name?: string | undefined;
   };
   message: Record<string, unknown>;
 };

package/__tests__/constancts.ts

@@ -1,2 +0,0 @@
-export const ACCOUNT_ADDRESS = '0x4e5f6f6020ffa7e5761cbe96e932b7c1cbbcace70c0fe22767c5f0abf851a17';
-export const PRIVATE_KEY = '0x0529868a6dc774b36342024c207686af16e84fc157c5eeb3a9d31fa13c0d44c5';