starknet 3.5.1 → 3.8.0

package/dist/signer/ledger.js

@@ -0,0 +1,138 @@
+"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());
+    });
+};
+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 };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LedgerBlindSigner = void 0;
+var hw_app_eth_1 = __importDefault(require("@ledgerhq/hw-app-eth"));
+var hw_transport_webhid_1 = __importDefault(require("@ledgerhq/hw-transport-webhid"));
+var encode_1 = require("../utils/encode");
+var hash_1 = require("../utils/hash");
+var typedData_1 = require("../utils/typedData");
+function hexZeroPad(hash, length) {
+    var value = hash;
+    if (value.length > 2 * length + 2) {
+        throw new Error('value out of range');
+    }
+    while (value.length < 2 * length + 2) {
+        value = "0x0" + value.substring(2);
+    }
+    return value;
+}
+var LedgerBlindSigner = /** @class */ (function () {
+    function LedgerBlindSigner() {
+        this.derivationPath = "/2645'/579218131'/1148870696'/0'/0'/0";
+    }
+    LedgerBlindSigner.prototype.getEthApp = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, _b;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (!!this.transport) return [3 /*break*/, 4];
+                        _c.label = 1;
+                    case 1:
+                        _c.trys.push([1, 3, , 4]);
+                        _a = this;
+                        return [4 /*yield*/, hw_transport_webhid_1.default.create()];
+                    case 2:
+                        _a.transport = _c.sent();
+                        return [3 /*break*/, 4];
+                    case 3:
+                        _b = _c.sent();
+                        throw new Error('Device connection error');
+                    case 4: return [2 /*return*/, new hw_app_eth_1.default(this.transport)];
+                }
+            });
+        });
+    };
+    LedgerBlindSigner.prototype.getPubKey = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var eth, response, starkPub;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getEthApp()];
+                    case 1:
+                        eth = _a.sent();
+                        return [4 /*yield*/, eth.starkGetPublicKey(this.derivationPath)];
+                    case 2:
+                        response = _a.sent();
+                        starkPub = "0x" + response.slice(1, 1 + 32).toString('hex');
+                        return [2 /*return*/, starkPub];
+                }
+            });
+        });
+    };
+    LedgerBlindSigner.prototype.signTransaction = function (transactions, transactionsDetail) {
+        return __awaiter(this, void 0, void 0, function () {
+            var msgHash;
+            return __generator(this, function (_a) {
+                msgHash = (0, hash_1.hashMulticall)(transactionsDetail.walletAddress, transactions, transactionsDetail.nonce.toString(), transactionsDetail.maxFee.toString());
+                return [2 /*return*/, this.sign(msgHash)];
+            });
+        });
+    };
+    LedgerBlindSigner.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*/, this.sign(msgHash)];
+            });
+        });
+    };
+    LedgerBlindSigner.prototype.sign = function (msgHash) {
+        return __awaiter(this, void 0, void 0, function () {
+            var eth, _a, r, s;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, this.getEthApp()];
+                    case 1:
+                        eth = _b.sent();
+                        return [4 /*yield*/, eth.starkUnsafeSign(this.derivationPath, hexZeroPad(msgHash, 32))];
+                    case 2:
+                        _a = (_b.sent()), r = _a.r, s = _a.s;
+                        return [2 /*return*/, [(0, encode_1.addHexPrefix)(r), (0, encode_1.addHexPrefix)(s)]];
+                }
+            });
+        });
+    };
+    return LedgerBlindSigner;
+}());
+exports.LedgerBlindSigner = LedgerBlindSigner;

package/dist/types/api.d.ts

@@ -26,6 +26,13 @@ export declare type Endpoints = {
         REQUEST: never;
         RESPONSE: GetTransactionStatusResponse;
     };
+    get_transaction_trace: {
+        QUERY: {
+            transactionHash: string;
+        };
+        REQUEST: never;
+        RESPONSE: GetTransactionTraceResponse;
+    };
     get_storage_at: {
         QUERY: {
             contractAddress: string;
@@ -58,8 +65,10 @@ export declare type Endpoints = {
         RESPONSE: CallContractResponse;
     };
     estimate_fee: {
-        QUERY: never;
-        REQUEST: Transaction;
+        QUERY: {
+            blockIdentifier: BlockIdentifier;
+        };
+        REQUEST: CallContractTransaction;
         RESPONSE: EstimateFeeResponse;
     };
 };
@@ -82,6 +91,31 @@ export declare type InvokeFunctionTransaction = {
     entry_point_selector: string;
     calldata?: RawCalldata;
     nonce?: BigNumberish;
+    max_fee?: BigNumberish;
+};
+export declare type InvokeFunctionTrace = {
+    caller_address: string;
+    contract_address: string;
+    code_address: string;
+    selector: string;
+    calldata: RawCalldata;
+    result: Array<any>;
+    execution_resources: ExecutionResources;
+    internal_call: Array<InvokeFunctionTrace>;
+    events: Array<any>;
+    messages: Array<any>;
+};
+export declare type ExecutionResources = {
+    n_steps: number;
+    builtin_instance_counter: {
+        pedersen_builtin: number;
+        range_check_builtin: number;
+        bitwise_builtin: number;
+        output_builtin: number;
+        ecdsa_builtin: number;
+        ec_op_builtin: number;
+    };
+    n_memory_holes: number;
 };
 export declare type CallContractTransaction = Omit<InvokeFunctionTransaction, 'type' | 'entry_point_type' | 'nonce'>;
 export declare type Transaction = DeployTransaction | InvokeFunctionTransaction;
@@ -126,6 +160,21 @@ export declare type GetTransactionStatusResponse = {
         error_message: string;
     };
 };
+export declare type GetTransactionTraceResponse = {
+    function_invocation: {
+        caller_address: string;
+        contract_address: string;
+        code_address: string;
+        selector: string;
+        calldata: RawArgs;
+        result: Array<any>;
+        execution_resources: any;
+        internal_call: Array<any>;
+        events: Array<any>;
+        messages: Array<any>;
+    };
+    signature: Signature;
+};
 export declare type GetTransactionResponse = {
     status: Status;
     transaction: Transaction;
@@ -148,7 +197,10 @@ export declare type TransactionReceipt = {
     l2_to_l1_messages: string[];
     events: string[];
 };
-export declare type EstimateFeeResponse = {};
+export declare type EstimateFeeResponse = {
+    amount: number;
+    unit: string;
+};
 export declare type RawArgs = {
     [inputName: string]: string | string[] | {
         type: 'struct';
@@ -156,3 +208,8 @@ export declare type RawArgs = {
     };
 };
 export declare type Calldata = string[];
+export declare type Overrides = {
+    maxFee?: BigNumberish;
+    nonce?: BigNumberish;
+    signature?: Signature;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starknet",
-  "version": "3.5.1",
+  "version": "3.8.0",
   "description": "JavaScript library for StarkNet",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -11,7 +11,7 @@
     "test": "jest",
     "posttest": "npm run format",
     "test:watch": "jest --watch",
-    "docs": "typedoc",
+    "docs": "cd www && npm run start",
     "format": "prettier --loglevel warn --write \"**/*.{ts,js,md,yml,json}\"",
     "lint": "eslint . --cache --fix --ext .ts"
   },
@@ -61,6 +61,9 @@
     "typescript": "^4.4.4"
   },
   "dependencies": {
+    "@ledgerhq/hw-app-eth": "^6.26.0",
+    "@ledgerhq/hw-transport": "^6.24.1",
+    "@ledgerhq/hw-transport-webhid": "^6.24.1",
     "axios": "^0.23.0",
     "bn.js": "^5.2.0",
     "elliptic": "^6.5.4",

package/provider/default.d.ts

@@ -10,6 +10,7 @@ import {
   GetContractAddressesResponse,
   GetTransactionResponse,
   GetTransactionStatusResponse,
+  GetTransactionTraceResponse,
   Invocation,
   TransactionReceipt,
 } from '../types';
@@ -65,8 +66,10 @@ export declare class Provider implements ProviderInterface {
    */
   callContract(
     { contractAddress, entrypoint, calldata }: Call,
-    options?: {
-      blockIdentifier: BlockIdentifier;
+    {
+      blockIdentifier,
+    }?: {
+      blockIdentifier?: BlockIdentifier;
     }
   ): Promise<CallContractResponse>;
   /**
@@ -140,6 +143,14 @@ export declare class Provider implements ProviderInterface {
    * @returns the transacton object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? }
    */
   getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;
+  /**
+   * Gets the transaction trace from a tx id.
+   *
+   *
+   * @param txHash
+   * @returns the transaction trace
+   */
+  getTransactionTrace(txHash: BigNumberish): Promise<GetTransactionTraceResponse>;
   /**
    * Deploys a given compiled contract (json) to starknet
    *
@@ -157,7 +168,6 @@ export declare class Provider implements ProviderInterface {
    * @returns response from addTransaction
    */
   invokeFunction(invocation: Invocation, _abi?: Abi): Promise<AddTransactionResponse>;
-  estimateFee(invocation: Invocation): Promise<any>;
   waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
   /**
    * @deprecated use `waitForTransaction` instead

package/provider/default.js

@@ -343,24 +343,28 @@ var Provider = /** @class */ (function () {
    * @param blockNumber
    * @returns the result of the function on the smart contract.
    */
-  Provider.prototype.callContract = function (_a, options) {
+  Provider.prototype.callContract = function (_a, _b) {
     var contractAddress = _a.contractAddress,
       entrypoint = _a.entrypoint,
-      _b = _a.calldata,
-      calldata = _b === void 0 ? [] : _b;
-    if (options === void 0) {
-      options = { blockIdentifier: null };
-    }
+      _c = _a.calldata,
+      calldata = _c === void 0 ? [] : _c;
+    var _d = _b === void 0 ? {} : _b,
+      _e = _d.blockIdentifier,
+      blockIdentifier = _e === void 0 ? 'pending' : _e;
     return __awaiter(this, void 0, void 0, function () {
-      return __generator(this, function (_c) {
+      return __generator(this, function (_f) {
         return [
           2 /*return*/,
-          this.fetchEndpoint('call_contract', options, {
-            signature: [],
-            contract_address: contractAddress,
-            entry_point_selector: (0, hash_1.getSelectorFromName)(entrypoint),
-            calldata: calldata,
-          }),
+          this.fetchEndpoint(
+            'call_contract',
+            { blockIdentifier: blockIdentifier },
+            {
+              signature: [],
+              contract_address: contractAddress,
+              entry_point_selector: (0, hash_1.getSelectorFromName)(entrypoint),
+              calldata: calldata,
+            }
+          ),
         ];
       });
     });
@@ -399,7 +403,7 @@ var Provider = /** @class */ (function () {
    */
   Provider.prototype.getCode = function (contractAddress, blockIdentifier) {
     if (blockIdentifier === void 0) {
-      blockIdentifier = null;
+      blockIdentifier = 'pending';
     }
     return __awaiter(this, void 0, void 0, function () {
       return __generator(this, function (_a) {
@@ -427,7 +431,7 @@ var Provider = /** @class */ (function () {
    */
   Provider.prototype.getStorageAt = function (contractAddress, key, blockIdentifier) {
     if (blockIdentifier === void 0) {
-      blockIdentifier = null;
+      blockIdentifier = 'pending';
     }
     return __awaiter(this, void 0, void 0, function () {
       return __generator(this, function (_a) {
@@ -516,6 +520,25 @@ var Provider = /** @class */ (function () {
       });
     });
   };
+  /**
+   * Gets the transaction trace from a tx id.
+   *
+   *
+   * @param txHash
+   * @returns the transaction trace
+   */
+  Provider.prototype.getTransactionTrace = function (txHash) {
+    return __awaiter(this, void 0, void 0, function () {
+      var txHashHex;
+      return __generator(this, function (_a) {
+        txHashHex = (0, number_1.toHex)((0, number_1.toBN)(txHash));
+        return [
+          2 /*return*/,
+          this.fetchEndpoint('get_transaction_trace', { transactionHash: txHashHex }),
+        ];
+      });
+    });
+  };
   /**
    * Deploys a given compiled contract (json) to starknet
    *
@@ -562,48 +585,32 @@ var Provider = /** @class */ (function () {
       ),
     });
   };
-  Provider.prototype.estimateFee = function (invocation) {
-    var _a, _b;
-    return this.fetchEndpoint('estimate_fee', undefined, {
-      // TODO: change the TYPE of the call
-      type: 'INVOKE_FUNCTION',
-      contract_address: invocation.contractAddress,
-      entry_point_selector: (0, hash_1.getSelectorFromName)(invocation.entrypoint),
-      calldata: (0, number_1.bigNumberishArrayToDecimalStringArray)(
-        (_a = invocation.calldata) !== null && _a !== void 0 ? _a : []
-      ),
-      signature: (0, number_1.bigNumberishArrayToDecimalStringArray)(
-        (_b = invocation.signature) !== null && _b !== void 0 ? _b : []
-      ),
-    });
-  };
   Provider.prototype.waitForTransaction = function (txHash, retryInterval) {
     if (retryInterval === void 0) {
       retryInterval = 8000;
     }
     return __awaiter(this, void 0, void 0, function () {
-      var onchain, res, message, error;
+      var onchain, res, successStates, errorStates, message, error;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
             onchain = false;
-            return [4 /*yield*/, wait(retryInterval)];
+            _a.label = 1;
           case 1:
-            _a.sent();
-            _a.label = 2;
-          case 2:
-            if (!!onchain) return [3 /*break*/, 5];
+            if (!!onchain) return [3 /*break*/, 4];
             // eslint-disable-next-line no-await-in-loop
             return [4 /*yield*/, wait(retryInterval)];
-          case 3:
+          case 2:
             // eslint-disable-next-line no-await-in-loop
             _a.sent();
             return [4 /*yield*/, this.getTransactionStatus(txHash)];
-          case 4:
+          case 3:
             res = _a.sent();
-            if (res.tx_status === 'ACCEPTED_ON_L1' || res.tx_status === 'ACCEPTED_ON_L2') {
+            successStates = ['ACCEPTED_ON_L1', 'ACCEPTED_ON_L2', 'PENDING'];
+            errorStates = ['REJECTED', 'NOT_RECEIVED'];
+            if (successStates.includes(res.tx_status)) {
               onchain = true;
-            } else if (res.tx_status === 'REJECTED' || res.tx_status === 'NOT_RECEIVED') {
+            } else if (errorStates.includes(res.tx_status)) {
               message = res.tx_failure_reason
                 ? res.tx_status +
                   ': ' +
@@ -615,8 +622,8 @@ var Provider = /** @class */ (function () {
               error.response = res;
               throw error;
             }
-            return [3 /*break*/, 2];
-          case 5:
+            return [3 /*break*/, 1];
+          case 4:
             return [2 /*return*/];
         }
       });

package/provider/utils.d.ts

@@ -37,8 +37,7 @@ export declare function getBlockIdentifier(blockIdentifier: BlockIdentifier): Bl
  *
  * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L164-L173)
  *
- * @param blockNumber
- * @param blockHash
+ * @param blockIdentifier
  * @returns block identifier for API request
  */
 export declare function getFormattedBlockIdentifier(blockIdentifier?: BlockIdentifier): string;

package/provider/utils.js

@@ -39,6 +39,12 @@ exports.txIdentifier = txIdentifier;
  * @returns block identifier object
  */
 function getBlockIdentifier(blockIdentifier) {
+  if (blockIdentifier === null) {
+    return { type: 'BLOCK_NUMBER', data: null };
+  }
+  if (blockIdentifier === 'pending') {
+    return { type: 'BLOCK_NUMBER', data: 'pending' };
+  }
   if (typeof blockIdentifier === 'number') {
     return { type: 'BLOCK_NUMBER', data: blockIdentifier };
   }
@@ -48,12 +54,6 @@ function getBlockIdentifier(blockIdentifier) {
   if (typeof blockIdentifier === 'string' && !Number.isNaN(parseInt(blockIdentifier, 10))) {
     return { type: 'BLOCK_NUMBER', data: parseInt(blockIdentifier, 10) };
   }
-  if (blockIdentifier === null) {
-    return { type: 'BLOCK_NUMBER', data: null };
-  }
-  if (blockIdentifier === 'pending') {
-    return { type: 'BLOCK_NUMBER', data: 'pending' };
-  }
   if (typeof blockIdentifier === 'string') {
     throw new Error('Invalid block identifier: ' + blockIdentifier);
   }
@@ -65,8 +65,7 @@ exports.getBlockIdentifier = getBlockIdentifier;
  *
  * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L164-L173)
  *
- * @param blockNumber
- * @param blockHash
+ * @param blockIdentifier
  * @returns block identifier for API request
  */
 function getFormattedBlockIdentifier(blockIdentifier) {

package/signer/index.d.ts

@@ -1,2 +1,3 @@
 export * from './interface';
 export * from './default';
+export * from './ledger';

package/signer/index.js

@@ -25,3 +25,4 @@ var __exportStar =
 Object.defineProperty(exports, '__esModule', { value: true });
 __exportStar(require('./interface'), exports);
 __exportStar(require('./default'), exports);
+__exportStar(require('./ledger'), exports);

package/signer/ledger.d.ts

@@ -0,0 +1,15 @@
+import { Invocation, InvocationsSignerDetails, Signature } from '../types';
+import { TypedData } from '../utils/typedData';
+import { SignerInterface } from './interface';
+export declare class LedgerBlindSigner implements SignerInterface {
+  derivationPath: string;
+  private transport;
+  private getEthApp;
+  getPubKey(): Promise<string>;
+  signTransaction(
+    transactions: Invocation[],
+    transactionsDetail: InvocationsSignerDetails
+  ): Promise<Signature>;
+  signMessage(typedData: TypedData, accountAddress: string): Promise<Signature>;
+  protected sign(msgHash: string): Promise<Signature>;
+}