starknet 3.0.0 → 3.3.0

package/provider/default.js

@@ -175,6 +175,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 exports.Provider = void 0;
 var axios_1 = __importDefault(require('axios'));
 var url_join_1 = __importDefault(require('url-join'));
+var hash_1 = require('../utils/hash');
 var json_1 = require('../utils/json');
 var number_1 = require('../utils/number');
 var stark_1 = require('../utils/stark');
@@ -260,8 +261,9 @@ var Provider = /** @class */ (function () {
   };
   // typesafe fetch
   Provider.prototype.fetchEndpoint = function (endpoint) {
+    var _a;
     // typescript type magiuc to create a nice fitting function interface
-    var _a = []; // when both query and request are needed, we cant omit anything
+    var _b = []; // when both query and request are needed, we cant omit anything
     for (
       // typescript type magiuc to create a nice fitting function interface
       var _i = 1; // when both query and request are needed, we cant omit anything
@@ -271,21 +273,24 @@ var Provider = /** @class */ (function () {
       _i++ // when both query and request are needed, we cant omit anything
     ) {
       // typescript type magiuc to create a nice fitting function interface
-      _a[_i - 1] = arguments[_i]; // when both query and request are needed, we cant omit anything
+      _b[_i - 1] = arguments[_i]; // when both query and request are needed, we cant omit anything
     }
     // typescript type magiuc to create a nice fitting function interface
-    var _b = __read(_a, 2),
-      query = _b[0],
-      request = _b[1]; // when both query and request are needed, we cant omit anything
+    var _c = __read(_b, 2),
+      query = _c[0],
+      request = _c[1]; // when both query and request are needed, we cant omit anything
     return __awaiter(this, void 0, void 0, function () {
-      var baseUrl, method, queryString, headers, data;
-      return __generator(this, function (_c) {
-        switch (_c.label) {
+      var baseUrl, method, queryString, headers, data, error_1, data;
+      return __generator(this, function (_d) {
+        switch (_d.label) {
           case 0:
             baseUrl = this.getFetchUrl(endpoint);
             method = this.getFetchMethod(endpoint);
             queryString = this.getQueryString(query);
             headers = this.getHeaders(method);
+            _d.label = 1;
+          case 1:
+            _d.trys.push([1, 3, , 4]);
             return [
               4 /*yield*/,
               axios_1.default.request({
@@ -295,9 +300,22 @@ var Provider = /** @class */ (function () {
                 headers: headers,
               }),
             ];
-          case 1:
-            data = _c.sent().data;
+          case 2:
+            data = _d.sent().data;
             return [2 /*return*/, data];
+          case 3:
+            error_1 = _d.sent();
+            data =
+              (_a = error_1 === null || error_1 === void 0 ? void 0 : error_1.response) === null ||
+              _a === void 0
+                ? void 0
+                : _a.data;
+            if (data === null || data === void 0 ? void 0 : data.message) {
+              throw new Error(data.code + ': ' + data.message);
+            }
+            throw error_1;
+          case 4:
+            return [2 /*return*/];
         }
       });
     });
@@ -345,7 +363,7 @@ var Provider = /** @class */ (function () {
             {
               signature: [],
               contract_address: contractAddress,
-              entry_point_selector: (0, stark_1.getSelectorFromName)(entrypoint),
+              entry_point_selector: (0, hash_1.getSelectorFromName)(entrypoint),
               calldata: calldata,
             }
           ),
@@ -532,10 +550,8 @@ var Provider = /** @class */ (function () {
    * Invokes a function on starknet
    * @deprecated This method wont be supported as soon as fees are mandatory
    *
-   * @param contractAddress - target contract address for invoke
-   * @param entrypointSelector - target entrypoint selector for
-   * @param calldata - (optional, default []) calldata
-   * @param signature - (optional) signature to send along
+   * @param invocation
+   * @param _abi - (optional) signature to send along
    * @returns response from addTransaction
    */
   Provider.prototype.invokeFunction = function (invocation, _abi) {
@@ -543,7 +559,7 @@ var Provider = /** @class */ (function () {
     return this.fetchEndpoint('add_transaction', undefined, {
       type: 'INVOKE_FUNCTION',
       contract_address: invocation.contractAddress,
-      entry_point_selector: (0, stark_1.getSelectorFromName)(invocation.entrypoint),
+      entry_point_selector: (0, hash_1.getSelectorFromName)(invocation.entrypoint),
       calldata: (0, number_1.bigNumberishArrayToDecimalStringArray)(
         (_a = invocation.calldata) !== null && _a !== void 0 ? _a : []
       ),
@@ -552,12 +568,40 @@ var Provider = /** @class */ (function () {
       ),
     });
   };
-  Provider.prototype.waitForTx = function (txHash, retryInterval) {
+  /**
+   * Invokes a function on starknet
+   * @deprecated This method wont be supported as soon as fees are mandatory
+   *
+   * @param contractAddress - target contract address for invoke
+   * @param entrypointSelector - target entrypoint selector for
+   * @param calldata - (optional, default []) calldata
+   * @param signature - (optional) signature to send along
+   * @returns response from addTransaction
+   */
+  Provider.prototype.LEGACY_invokeFunction = function (
+    contractAddress,
+    entrypointSelector,
+    calldata,
+    signature
+  ) {
+    return this.fetchEndpoint('add_transaction', undefined, {
+      type: 'INVOKE_FUNCTION',
+      contract_address: contractAddress,
+      entry_point_selector: entrypointSelector,
+      calldata: (0, number_1.bigNumberishArrayToDecimalStringArray)(
+        calldata !== null && calldata !== void 0 ? calldata : []
+      ),
+      signature: (0, number_1.bigNumberishArrayToDecimalStringArray)(
+        signature !== null && signature !== void 0 ? signature : []
+      ),
+    });
+  };
+  Provider.prototype.waitForTransaction = function (txHash, retryInterval) {
     if (retryInterval === void 0) {
       retryInterval = 8000;
     }
     return __awaiter(this, void 0, void 0, function () {
-      var onchain, res, error;
+      var onchain, res, message, error;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
@@ -579,7 +623,14 @@ var Provider = /** @class */ (function () {
             if (res.tx_status === 'ACCEPTED_ON_L1' || res.tx_status === 'ACCEPTED_ON_L2') {
               onchain = true;
             } else if (res.tx_status === 'REJECTED' || res.tx_status === 'NOT_RECEIVED') {
-              error = Error(res.tx_status);
+              message = res.tx_failure_reason
+                ? res.tx_status +
+                  ': ' +
+                  res.tx_failure_reason.code +
+                  '\n' +
+                  res.tx_failure_reason.error_message
+                : res.tx_status;
+              error = new Error(message);
               error.response = res;
               throw error;
             }
@@ -590,6 +641,19 @@ var Provider = /** @class */ (function () {
       });
     });
   };
+  /**
+   * @deprecated use `waitForTransaction` instead
+   */
+  Provider.prototype.waitForTx = function (txHash, retryInterval) {
+    if (retryInterval === void 0) {
+      retryInterval = 8000;
+    }
+    return __awaiter(this, void 0, void 0, function () {
+      return __generator(this, function (_a) {
+        return [2 /*return*/, this.waitForTransaction(txHash, retryInterval)];
+      });
+    });
+  };
   return Provider;
 })();
 exports.Provider = Provider;

package/provider/interface.d.ts

@@ -122,5 +122,9 @@ export declare abstract class ProviderInterface {
    * @returns response from addTransaction
    */
   abstract invokeFunction(invocation: Invocation): Promise<AddTransactionResponse>;
-  abstract waitForTx(txHash: BigNumberish, retryInterval?: number): Promise<void>;
+  abstract waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
+  /**
+   * @deprecated use `waitForTransaction` instead
+   */
+  abstract waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
 }

package/signer/default.d.ts

@@ -10,5 +10,5 @@ export declare class Signer implements SignerInterface {
     transactionsDetail: InvocationsSignerDetails,
     abis?: Abi[]
   ): Promise<Signature>;
-  signMessage(typedData: TypedData, walletAddress: string): Promise<Signature>;
+  signMessage(typedData: TypedData, accountAddress: string): Promise<Signature>;
 }

package/signer/default.js

@@ -133,10 +133,7 @@ var __generator =
 Object.defineProperty(exports, '__esModule', { value: true });
 exports.Signer = void 0;
 var ellipticCurve_1 = require('../utils/ellipticCurve');
-var encode_1 = require('../utils/encode');
 var hash_1 = require('../utils/hash');
-var number_1 = require('../utils/number');
-var stark_1 = require('../utils/stark');
 var typedData_1 = require('../utils/typedData');
 var Signer = /** @class */ (function () {
   function Signer(keyPair) {
@@ -150,58 +147,27 @@ var Signer = /** @class */ (function () {
     });
   };
   Signer.prototype.signTransaction = function (transactions, transactionsDetail, abis) {
-    if (abis === void 0) {
-      abis = [];
-    }
     return __awaiter(this, void 0, void 0, function () {
-      var _a,
-        contractAddress,
-        entrypoint,
-        _b,
-        calldata,
-        nonce,
-        walletAddress,
-        nonceBn,
-        entrypointSelector,
-        calldataDecimal,
-        msgHash;
-      return __generator(this, function (_c) {
-        if (transactions.length !== 1) {
-          throw new Error('Only one transaction at a time is currently supported by this signer');
-        }
-        if (
-          (abis === null || abis === void 0 ? void 0 : abis.length) !== 0 &&
-          abis.length !== transactions.length
-        ) {
+      var 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');
         }
-        (_a = transactions[0]),
-          (contractAddress = _a.contractAddress),
-          (entrypoint = _a.entrypoint),
-          (_b = _a.calldata),
-          (calldata = _b === void 0 ? [] : _b);
-        (nonce = transactionsDetail.nonce), (walletAddress = transactionsDetail.walletAddress);
-        nonceBn = (0, number_1.toBN)(nonce);
-        entrypointSelector = (0, stark_1.getSelectorFromName)(entrypoint);
-        calldataDecimal = (0, number_1.bigNumberishArrayToDecimalStringArray)(calldata);
-        msgHash = (0, encode_1.addHexPrefix)(
-          (0, hash_1.hashMessage)(
-            walletAddress,
-            contractAddress,
-            entrypointSelector,
-            calldataDecimal,
-            nonceBn.toString()
-          )
+        msgHash = (0, hash_1.hashMulticall)(
+          transactionsDetail.walletAddress,
+          transactions,
+          transactionsDetail.nonce.toString(),
+          transactionsDetail.maxFee.toString()
         );
         return [2 /*return*/, (0, ellipticCurve_1.sign)(this.keyPair, msgHash)];
       });
     });
   };
-  Signer.prototype.signMessage = function (typedData, walletAddress) {
+  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, walletAddress);
+        msgHash = (0, typedData_1.getMessageHash)(typedData, accountAddress);
         return [2 /*return*/, (0, ellipticCurve_1.sign)(this.keyPair, msgHash)];
       });
     });

package/signer/interface.d.ts

@@ -11,11 +11,12 @@ export declare abstract class SignerInterface {
    * 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 json - JSON object to be signed
+   * @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, walletAddress: string): Promise<Signature>;
+  abstract signMessage(typedData: TypedData, accountAddress: string): Promise<Signature>;
   /**
    * Signs a transaction with the starknet private key and returns the signature
    *

package/src/account/default.ts

@@ -1,16 +1,17 @@
-import { compileCalldata } from '../contract';
 import { Provider } from '../provider';
 import { Signer, SignerInterface } from '../signer';
 import {
   Abi,
   AddTransactionResponse,
-  ExecuteInvocation,
+  Call,
   InvocationsDetails,
   KeyPair,
   Signature,
 } from '../types';
+import { getSelectorFromName } from '../utils/hash';
 import { BigNumberish, bigNumberishArrayToDecimalStringArray, toBN, toHex } from '../utils/number';
-import { getSelectorFromName } from '../utils/stark';
+import { compileCalldata } from '../utils/stark';
+import { fromCallsToExecuteCalldata } from '../utils/transaction';
 import { TypedData, getMessageHash } from '../utils/typedData';
 import { AccountInterface } from './interface';
 
@@ -42,51 +43,28 @@ export class Account extends Provider implements AccountInterface {
    * @returns a confirmation of invoking a function on the starknet contract
    */
   public async execute(
-    transactions: ExecuteInvocation | ExecuteInvocation[],
-    abis: Abi[] = [],
+    calls: Call | Call[],
+    abis: Abi[] | undefined = undefined,
     transactionsDetail: InvocationsDetails = {}
   ): Promise<AddTransactionResponse> {
-    if (Array.isArray(transactions) && transactions.length !== 1) {
-      throw new Error('Only one transaction at a time is currently supported');
-    }
-
-    const {
-      contractAddress,
-      calldata = [],
-      entrypoint,
-      ...invocation
-    } = Array.isArray(transactions) ? transactions[0] : transactions;
-    const { nonce } = transactionsDetail;
+    const transactions = Array.isArray(calls) ? calls : [calls];
 
-    const nonceBn = toBN(nonce ?? (await this.getNonce()));
-    const calldataDecimal = bigNumberishArrayToDecimalStringArray(calldata);
+    const signerDetails = {
+      walletAddress: this.address,
+      nonce: toBN(transactionsDetail.nonce ?? (await this.getNonce())),
+      maxFee: toBN(transactionsDetail.maxFee ?? '0'),
+    };
 
-    const signature = await this.signer.signTransaction(
-      [
-        {
-          ...invocation,
-          contractAddress,
-          calldata: calldataDecimal,
-          entrypoint,
-        },
-      ],
-      { walletAddress: this.address, nonce: nonceBn },
-      abis
-    );
+    const signature = await this.signer.signTransaction(transactions, signerDetails, abis);
 
-    const entrypointSelector = getSelectorFromName(entrypoint);
+    const calldata = [...fromCallsToExecuteCalldata(transactions), signerDetails.nonce.toString()];
 
-    return super.invokeFunction({
-      contractAddress: this.address,
-      entrypoint: 'execute',
-      calldata: [
-        contractAddress,
-        entrypointSelector,
-        calldataDecimal.length.toString(),
-        ...calldataDecimal,
-        nonceBn.toString(),
-      ],
-      signature,
+    return this.fetchEndpoint('add_transaction', undefined, {
+      type: 'INVOKE_FUNCTION',
+      contract_address: this.address,
+      entry_point_selector: getSelectorFromName('__execute__'),
+      calldata,
+      signature: bigNumberishArrayToDecimalStringArray(signature),
     });
   }
 
@@ -115,7 +93,7 @@ export class Account extends Provider implements AccountInterface {
   /**
    * Verify a signature of a JSON object
    *
-   * @param json - JSON object to be verified
+   * @param hash - JSON object to be verified
    * @param signature - signature of the JSON object
    * @returns true if the signature is valid, false otherwise
    * @throws {Error} if the JSON object is not a valid JSON or the signature is not a valid signature

package/src/account/interface.ts

@@ -2,8 +2,8 @@ import { ProviderInterface } from '../provider';
 import {
   Abi,
   AddTransactionResponse,
+  Call,
   DeployContractPayload,
-  ExecuteInvocation,
   InvocationsDetails,
   Signature,
 } from '../types';
@@ -41,7 +41,7 @@ export abstract class AccountInterface extends ProviderInterface {
    * @returns response from addTransaction
    */
   public abstract execute(
-    transactions: ExecuteInvocation | ExecuteInvocation[],
+    transactions: Call | Call[],
     abis?: Abi[],
     transactionsDetail?: InvocationsDetails
   ): Promise<AddTransactionResponse>;