starknet 3.18.2 → 4.0.1

package/signer/default.js

@@ -1,184 +1,79 @@
-'use strict';
-var __awaiter =
-  (this && this.__awaiter) ||
-  function (thisArg, _arguments, P, generator) {
-    function adopt(value) {
-      return value instanceof P
-        ? value
-        : new P(function (resolve) {
-            resolve(value);
-          });
-    }
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
-      function fulfilled(value) {
-        try {
-          step(generator.next(value));
-        } catch (e) {
-          reject(e);
-        }
-      }
-      function rejected(value) {
-        try {
-          step(generator['throw'](value));
-        } catch (e) {
-          reject(e);
-        }
-      }
-      function step(result) {
-        result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected);
-      }
-      step((generator = generator.apply(thisArg, _arguments || [])).next());
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
-  };
-var __generator =
-  (this && this.__generator) ||
-  function (thisArg, body) {
-    var _ = {
-        label: 0,
-        sent: function () {
-          if (t[0] & 1) throw t[1];
-          return t[1];
-        },
-        trys: [],
-        ops: [],
-      },
-      f,
-      y,
-      t,
-      g;
-    return (
-      (g = { next: verb(0), throw: verb(1), return: verb(2) }),
-      typeof Symbol === 'function' &&
-        (g[Symbol.iterator] = function () {
-          return this;
-        }),
-      g
-    );
-    function verb(n) {
-      return function (v) {
-        return step([n, v]);
-      };
-    }
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
-      if (f) throw new TypeError('Generator is already executing.');
-      while (_)
-        try {
-          if (
-            ((f = 1),
-            y &&
-              (t =
-                op[0] & 2
-                  ? y['return']
-                  : op[0]
-                  ? y['throw'] || ((t = y['return']) && t.call(y), 0)
-                  : y.next) &&
-              !(t = t.call(y, op[1])).done)
-          )
-            return t;
-          if (((y = 0), t)) op = [op[0] & 2, t.value];
-          switch (op[0]) {
-            case 0:
-            case 1:
-              t = op;
-              break;
-            case 4:
-              _.label++;
-              return { value: op[1], done: false };
-            case 5:
-              _.label++;
-              y = op[1];
-              op = [0];
-              continue;
-            case 7:
-              op = _.ops.pop();
-              _.trys.pop();
-              continue;
-            default:
-              if (
-                !((t = _.trys), (t = t.length > 0 && t[t.length - 1])) &&
-                (op[0] === 6 || op[0] === 2)
-              ) {
-                _ = 0;
-                continue;
-              }
-              if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) {
-                _.label = op[1];
-                break;
-              }
-              if (op[0] === 6 && _.label < t[1]) {
-                _.label = t[1];
-                t = op;
-                break;
-              }
-              if (t && _.label < t[2]) {
-                _.label = t[2];
-                _.ops.push(op);
-                break;
-              }
-              if (t[2]) _.ops.pop();
-              _.trys.pop();
-              continue;
-          }
-          op = body.call(thisArg, _);
-        } catch (e) {
-          op = [6, e];
-          y = 0;
-        } finally {
-          f = t = 0;
-        }
-      if (op[0] & 5) throw op[1];
-      return { value: op[0] ? op[1] : void 0, done: true };
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
-  };
-Object.defineProperty(exports, '__esModule', { value: true });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.Signer = void 0;
-var ellipticCurve_1 = require('../utils/ellipticCurve');
-var hash_1 = require('../utils/hash');
-var transaction_1 = require('../utils/transaction');
-var typedData_1 = require('../utils/typedData');
+var ellipticCurve_1 = require("../utils/ellipticCurve");
+var hash_1 = require("../utils/hash");
+var transaction_1 = require("../utils/transaction");
+var typedData_1 = require("../utils/typedData");
 var Signer = /** @class */ (function () {
-  function Signer(keyPair) {
-    this.keyPair = keyPair;
-  }
-  Signer.prototype.getPubKey = function () {
-    return __awaiter(this, void 0, void 0, function () {
-      return __generator(this, function (_a) {
-        return [2 /*return*/, (0, ellipticCurve_1.getStarkKey)(this.keyPair)];
-      });
-    });
-  };
-  Signer.prototype.signTransaction = function (transactions, transactionsDetail, abis) {
-    return __awaiter(this, void 0, void 0, function () {
-      var calldata, msgHash;
-      return __generator(this, function (_a) {
-        if (abis && abis.length !== transactions.length) {
-          throw new Error('ABI must be provided for each transaction or no transaction');
-        }
-        calldata = (0, transaction_1.fromCallsToExecuteCalldataWithNonce)(
-          transactions,
-          transactionsDetail.nonce
-        );
-        msgHash = (0, hash_1.calculcateTransactionHash)(
-          transactionsDetail.walletAddress,
-          transactionsDetail.version,
-          (0, hash_1.getSelectorFromName)('__execute__'),
-          calldata,
-          transactionsDetail.maxFee,
-          transactionsDetail.chainId
-        );
-        return [2 /*return*/, (0, ellipticCurve_1.sign)(this.keyPair, msgHash)];
-      });
-    });
-  };
-  Signer.prototype.signMessage = function (typedData, accountAddress) {
-    return __awaiter(this, void 0, void 0, function () {
-      var msgHash;
-      return __generator(this, function (_a) {
-        msgHash = (0, typedData_1.getMessageHash)(typedData, accountAddress);
-        return [2 /*return*/, (0, ellipticCurve_1.sign)(this.keyPair, msgHash)];
-      });
-    });
-  };
-  return Signer;
-})();
+    function Signer(keyPair) {
+        this.keyPair = keyPair;
+    }
+    Signer.prototype.getPubKey = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, (0, ellipticCurve_1.getStarkKey)(this.keyPair)];
+            });
+        });
+    };
+    Signer.prototype.signTransaction = function (transactions, transactionsDetail, abis) {
+        return __awaiter(this, void 0, void 0, function () {
+            var calldata, msgHash;
+            return __generator(this, function (_a) {
+                if (abis && abis.length !== transactions.length) {
+                    throw new Error('ABI must be provided for each transaction or no transaction');
+                }
+                calldata = (0, transaction_1.fromCallsToExecuteCalldataWithNonce)(transactions, transactionsDetail.nonce);
+                msgHash = (0, hash_1.calculcateTransactionHash)(transactionsDetail.walletAddress, transactionsDetail.version, (0, hash_1.getSelectorFromName)('__execute__'), calldata, transactionsDetail.maxFee, transactionsDetail.chainId);
+                return [2 /*return*/, (0, ellipticCurve_1.sign)(this.keyPair, msgHash)];
+            });
+        });
+    };
+    Signer.prototype.signMessage = function (typedData, accountAddress) {
+        return __awaiter(this, void 0, void 0, function () {
+            var msgHash;
+            return __generator(this, function (_a) {
+                msgHash = (0, typedData_1.getMessageHash)(typedData, accountAddress);
+                return [2 /*return*/, (0, ellipticCurve_1.sign)(this.keyPair, msgHash)];
+            });
+        });
+    };
+    return Signer;
+}());
 exports.Signer = Signer;

package/signer/index.js

@@ -1,31 +1,18 @@
-'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 __exportStar =
-  (this && this.__exportStar) ||
-  function (m, exports) {
-    for (var p in m)
-      if (p !== 'default' && !Object.prototype.hasOwnProperty.call(exports, p))
-        __createBinding(exports, m, p);
-  };
-Object.defineProperty(exports, '__esModule', { value: true });
-__exportStar(require('./interface'), exports);
-__exportStar(require('./default'), exports);
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./interface"), exports);
+__exportStar(require("./default"), exports);

package/signer/interface.d.ts

@@ -1,37 +1,33 @@
 import { Abi, Invocation, InvocationsSignerDetails, Signature } from '../types';
 import { TypedData } from '../utils/typedData';
 export declare abstract class SignerInterface {
-  /**
-   * Method to get the public key of the signer
-   *
-   * @returns public key of signer as hex string with 0x prefix
-   */
-  abstract getPubKey(): Promise<string>;
-  /**
-   * Sign an JSON object for off-chain usage with the starknet private key and return the signature
-   * This adds a message prefix so it cant be interchanged with transactions
-   *
-   * @param typedData - JSON object to be signed
-   * @param accountAddress - account
-   * @returns the signature of the JSON object
-   * @throws {Error} if the JSON object is not a valid JSON
-   */
-  abstract signMessage(typedData: TypedData, accountAddress: string): Promise<Signature>;
-  /**
-   * Signs a transaction with the starknet private key and returns the signature
-   *
-   * @param invocation the invocation object containing:
-   * - contractAddress - the address of the contract
-   * - entrypoint - the entrypoint of the contract
-   * - calldata - (defaults to []) the calldata
-   * - signature - (defaults to []) the signature
-   * @param abi (optional) the abi of the contract for better displaying
-   *
-   * @returns signature
-   */
-  abstract signTransaction(
-    transactions: Invocation[],
-    transactionsDetail: InvocationsSignerDetails,
-    abis?: Abi[]
-  ): Promise<Signature>;
+    /**
+     * Method to get the public key of the signer
+     *
+     * @returns public key of signer as hex string with 0x prefix
+     */
+    abstract getPubKey(): Promise<string>;
+    /**
+     * Sign an JSON object for off-chain usage with the starknet private key and return the signature
+     * This adds a message prefix so it cant be interchanged with transactions
+     *
+     * @param typedData - JSON object to be signed
+     * @param accountAddress - account
+     * @returns the signature of the JSON object
+     * @throws {Error} if the JSON object is not a valid JSON
+     */
+    abstract signMessage(typedData: TypedData, accountAddress: string): Promise<Signature>;
+    /**
+     * Signs a transaction with the starknet private key and returns the signature
+     *
+     * @param invocation the invocation object containing:
+     * - contractAddress - the address of the contract
+     * - entrypoint - the entrypoint of the contract
+     * - calldata - (defaults to []) the calldata
+     * - signature - (defaults to []) the signature
+     * @param abi (optional) the abi of the contract for better displaying
+     *
+     * @returns signature
+     */
+    abstract signTransaction(transactions: Invocation[], transactionsDetail: InvocationsSignerDetails, abis?: Abi[]): Promise<Signature>;
 }

package/signer/interface.js

@@ -1,8 +1,9 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.SignerInterface = void 0;
 var SignerInterface = /** @class */ (function () {
-  function SignerInterface() {}
-  return SignerInterface;
-})();
+    function SignerInterface() {
+    }
+    return SignerInterface;
+}());
 exports.SignerInterface = SignerInterface;

package/src/account/default.ts

@@ -1,48 +1,35 @@
-import assert from 'minimalistic-assert';
-
 import { ZERO } from '../constants';
-import { Provider, ProviderInterface } from '../provider';
+import { ProviderInterface, ProviderOptions } from '../provider';
+import { Provider } from '../provider/default';
 import { Signer, SignerInterface } from '../signer';
 import {
   Abi,
-  AddTransactionResponse,
   Call,
   InvocationsDetails,
   InvocationsSignerDetails,
-  InvokeFunctionTransaction,
+  InvokeFunctionResponse,
   KeyPair,
   Signature,
-  Transaction,
 } from '../types';
 import { EstimateFee, EstimateFeeDetails } from '../types/account';
-import { sign } from '../utils/ellipticCurve';
-import {
-  computeHashOnElements,
-  feeTransactionVersion,
-  getSelectorFromName,
-  transactionVersion,
-} from '../utils/hash';
-import { BigNumberish, bigNumberishArrayToDecimalStringArray, toBN, toHex } from '../utils/number';
-import { encodeShortString } from '../utils/shortString';
+import { feeTransactionVersion, transactionVersion } from '../utils/hash';
+import { BigNumberish, toBN, toHex } from '../utils/number';
 import { compileCalldata, estimatedFeeToMaxFee } from '../utils/stark';
 import { fromCallsToExecuteCalldataWithNonce } from '../utils/transaction';
 import { TypedData, getMessageHash } from '../utils/typedData';
 import { AccountInterface } from './interface';
 
 export class Account extends Provider implements AccountInterface {
-  public address: string;
-
   public signer: SignerInterface;
 
   constructor(
-    provider: ProviderInterface,
-    address: string,
+    providerOrOptions: ProviderOptions | ProviderInterface,
+    public address: string,
     keyPairOrSigner: KeyPair | SignerInterface
   ) {
-    super(provider);
+    super(providerOrOptions);
     this.signer =
       'getPubKey' in keyPairOrSigner ? keyPairOrSigner : new Signer(keyPairOrSigner as KeyPair);
-    this.address = address;
   }
 
   public async getNonce(): Promise<string> {
@@ -55,7 +42,7 @@ export class Account extends Provider implements AccountInterface {
 
   public async estimateFee(
     calls: Call | Call[],
-    { nonce: providedNonce, blockIdentifier = 'pending' }: EstimateFeeDetails = {}
+    { nonce: providedNonce, blockIdentifier }: EstimateFeeDetails = {}
   ): Promise<EstimateFee> {
     const transactions = Array.isArray(calls) ? calls : [calls];
     const nonce = providedNonce ?? (await this.getNonce());
@@ -72,26 +59,16 @@ export class Account extends Provider implements AccountInterface {
     const signature = await this.signer.signTransaction(transactions, signerDetails);
 
     const calldata = fromCallsToExecuteCalldataWithNonce(transactions, nonce);
-    const fetchedEstimate = await this.fetchEndpoint(
-      'estimate_fee',
-      { blockIdentifier },
-      {
-        contract_address: this.address,
-        entry_point_selector: getSelectorFromName('__execute__'),
-        calldata,
-        version: toHex(version),
-        signature: bigNumberishArrayToDecimalStringArray(signature),
-      }
+    const response = await super.getEstimateFee(
+      { contractAddress: this.address, entrypoint: '__execute__', calldata, signature },
+      blockIdentifier,
+      { version }
     );
-    const fee = fetchedEstimate.overall_fee ?? fetchedEstimate.amount;
-    if (fee === undefined) {
-      throw new Error('Expected either amount or overall_fee in estimate_fee response');
-    }
-    const suggestedMaxFee = estimatedFeeToMaxFee(fee);
+
+    const suggestedMaxFee = estimatedFeeToMaxFee(response.overall_fee);
 
     return {
-      amount: fee,
-      unit: fetchedEstimate.unit,
+      ...response,
       suggestedMaxFee,
     };
   }
@@ -110,7 +87,7 @@ export class Account extends Provider implements AccountInterface {
     calls: Call | Call[],
     abis: Abi[] | undefined = undefined,
     transactionsDetail: InvocationsDetails = {}
-  ): Promise<AddTransactionResponse> {
+  ): Promise<InvokeFunctionResponse> {
     const transactions = Array.isArray(calls) ? calls : [calls];
     const nonce = toBN(transactionsDetail.nonce ?? (await this.getNonce()));
     let maxFee: BigNumberish = '0';
@@ -121,124 +98,27 @@ export class Account extends Provider implements AccountInterface {
       maxFee = suggestedMaxFee.toString();
     }
 
+    const version = toBN(transactionVersion);
+
     const signerDetails: InvocationsSignerDetails = {
       walletAddress: this.address,
       nonce,
       maxFee,
-      version: toBN(transactionVersion),
+      version,
       chainId: this.chainId,
     };
 
     const signature = await this.signer.signTransaction(transactions, signerDetails, abis);
 
     const calldata = fromCallsToExecuteCalldataWithNonce(transactions, nonce);
-    return this.fetchEndpoint('add_transaction', undefined, {
-      type: 'INVOKE_FUNCTION',
-      contract_address: this.address,
-      entry_point_selector: getSelectorFromName('__execute__'),
-      calldata,
-      signature: bigNumberishArrayToDecimalStringArray(signature),
-      max_fee: toHex(toBN(maxFee)),
-    });
-  }
-
-  /**
-   * Temporary method to allow dapps on starknet.js v2 to work with Argent X v3
-   * @deprecated to remove ASAP
-   */
-  public async LEGACY_addTransaction(transaction: Transaction): Promise<AddTransactionResponse> {
-    if (transaction.type === 'DEPLOY') throw new Error('No DEPLOYS');
-    if (transaction.type === 'DECLARE') throw new Error('No DECLARES');
 
-    assert(
-      !transaction.signature,
-      "Adding signatures to a signer transaction currently isn't supported"
-    );
-
-    let nonceBn;
-    if (transaction.nonce) {
-      nonceBn = toBN(transaction.nonce);
-    } else {
-      const { result } = await this.callContract({
-        contractAddress: this.address,
-        entrypoint: 'get_nonce',
-      });
-      nonceBn = toBN(result[0]);
-    }
-
-    function hashMulticall(
-      account: string,
-      transactions: InvokeFunctionTransaction[],
-      nonce: string,
-      maxFee: string
-    ) {
-      const hashArray = transactions
-        .map(({ contract_address, entry_point_selector, calldata }) => [
-          contract_address,
-          entry_point_selector,
-          computeHashOnElements(calldata || []),
-        ])
-        .map(bigNumberishArrayToDecimalStringArray)
-        .map(computeHashOnElements);
-
-      return computeHashOnElements([
-        encodeShortString('StarkNet Transaction'),
-        account,
-        computeHashOnElements(hashArray),
-        nonce,
+    return this.invokeFunction(
+      { contractAddress: this.address, entrypoint: '__execute__', calldata, signature },
+      {
         maxFee,
-        transactionVersion,
-      ]);
-    }
-    const msgHash = hashMulticall(this.address, [transaction], nonceBn.toString(), '0');
-    if (!('keyPair' in this.signer)) {
-      throw new Error('No keyPair');
-    }
-    const signature = sign((this.signer as any).keyPair, msgHash);
-
-    const transformCallsToMulticallArrays = (calls: InvokeFunctionTransaction[]) => {
-      const callArray: any[] = [];
-      const calldata: BigNumberish[] = [];
-      calls.forEach((call) => {
-        const data = call.calldata || [];
-        callArray.push({
-          to: toBN(call.contract_address).toString(10),
-          selector: toBN(call.entry_point_selector).toString(10),
-          data_offset: calldata.length.toString(),
-          data_len: data.length.toString(),
-        });
-        calldata.push(...data);
-      });
-      return {
-        callArray,
-        calldata: bigNumberishArrayToDecimalStringArray(calldata),
-      };
-    };
-
-    const fromCallsToExecuteCalldata2 = (calls: InvokeFunctionTransaction[]): string[] => {
-      const { callArray, calldata } = transformCallsToMulticallArrays(calls);
-      return [
-        callArray.length.toString(),
-        ...callArray
-          .map(
-            ({ to, selector, data_offset, data_len }) =>
-              [to, selector, data_offset, data_len] as string[]
-          )
-          .flat(),
-        calldata.length.toString(),
-        ...calldata,
-      ];
-    };
-
-    const calldata = [...fromCallsToExecuteCalldata2([transaction]), nonceBn.toString()];
-
-    return this.fetchEndpoint('add_transaction', undefined, {
-      type: 'INVOKE_FUNCTION',
-      contract_address: this.address,
-      entry_point_selector: getSelectorFromName('__execute__'),
-      calldata,
-      signature: bigNumberishArrayToDecimalStringArray(signature),
-    });
+        version,
+      }
+    );
   }
 
   /**