starknet 2.7.1 → 3.0.0

package/provider/default.js

@@ -144,6 +144,28 @@ var __generator =
       return { value: op[0] ? op[1] : void 0, done: true };
     }
   };
+var __read =
+  (this && this.__read) ||
+  function (o, n) {
+    var m = typeof Symbol === 'function' && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o),
+      r,
+      ar = [],
+      e;
+    try {
+      while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    } catch (error) {
+      e = { error: error };
+    } finally {
+      try {
+        if (r && !r.done && (m = i['return'])) m.call(i);
+      } finally {
+        if (e) throw e.error;
+      }
+    }
+    return ar;
+  };
 var __importDefault =
   (this && this.__importDefault) ||
   function (mod) {
@@ -162,6 +184,19 @@ function wait(delay) {
     return setTimeout(res, delay);
   });
 }
+function isEmptyQueryObject(obj) {
+  return (
+    obj === undefined ||
+    Object.keys(obj).length === 0 ||
+    (Object.keys(obj).length === 1 &&
+      Object.entries(obj).every(function (_a) {
+        var _b = __read(_a, 2),
+          k = _b[0],
+          v = _b[1];
+        return k === 'blockIdentifier' && v === null;
+      }))
+  );
+}
 var Provider = /** @class */ (function () {
   function Provider(optionsOrProvider) {
     if (optionsOrProvider === void 0) {
@@ -190,6 +225,83 @@ var Provider = /** @class */ (function () {
         return 'https://alpha4.starknet.io';
     }
   };
+  Provider.prototype.getFetchUrl = function (endpoint) {
+    var gatewayUrlEndpoints = ['add_transaction'];
+    return gatewayUrlEndpoints.includes(endpoint) ? this.gatewayUrl : this.feederGatewayUrl;
+  };
+  Provider.prototype.getFetchMethod = function (endpoint) {
+    var postMethodEndpoints = ['add_transaction', 'call_contract'];
+    return postMethodEndpoints.includes(endpoint) ? 'POST' : 'GET';
+  };
+  Provider.prototype.getQueryString = function (query) {
+    if (isEmptyQueryObject(query)) {
+      return '';
+    }
+    var queryString = Object.entries(query)
+      .map(function (_a) {
+        var _b = __read(_a, 2),
+          key = _b[0],
+          value = _b[1];
+        if (key === 'blockIdentifier') {
+          return '' + (0, utils_1.getFormattedBlockIdentifier)(value);
+        }
+        return key + '=' + value;
+      })
+      .join('&');
+    return '?' + queryString;
+  };
+  Provider.prototype.getHeaders = function (method) {
+    if (method === 'POST') {
+      return {
+        'Content-Type': 'application/json',
+      };
+    }
+    return undefined;
+  };
+  // typesafe fetch
+  Provider.prototype.fetchEndpoint = function (endpoint) {
+    // typescript type magiuc to create a nice fitting function interface
+    var _a = []; // 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
+      // typescript type magiuc to create a nice fitting function interface
+      _i < arguments.length; // when both query and request are needed, we cant omit anything
+      // typescript type magiuc to create a nice fitting function interface
+      _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
+    }
+    // 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
+    return __awaiter(this, void 0, void 0, function () {
+      var baseUrl, method, queryString, headers, data;
+      return __generator(this, function (_c) {
+        switch (_c.label) {
+          case 0:
+            baseUrl = this.getFetchUrl(endpoint);
+            method = this.getFetchMethod(endpoint);
+            queryString = this.getQueryString(query);
+            headers = this.getHeaders(method);
+            return [
+              4 /*yield*/,
+              axios_1.default.request({
+                method: method,
+                url: (0, url_join_1.default)(baseUrl, endpoint, queryString),
+                data: (0, json_1.stringify)(request),
+                headers: headers,
+              }),
+            ];
+          case 1:
+            data = _c.sent().data;
+            return [2 /*return*/, data];
+        }
+      });
+    });
+  };
   /**
    * Gets the smart contract address on the goerli testnet.
    *
@@ -198,20 +310,8 @@ var Provider = /** @class */ (function () {
    */
   Provider.prototype.getContractAddresses = function () {
     return __awaiter(this, void 0, void 0, function () {
-      var data;
       return __generator(this, function (_a) {
-        switch (_a.label) {
-          case 0:
-            return [
-              4 /*yield*/,
-              axios_1.default.get(
-                (0, url_join_1.default)(this.feederGatewayUrl, 'get_contract_addresses')
-              ),
-            ];
-          case 1:
-            data = _a.sent().data;
-            return [2 /*return*/, data];
-        }
+        return [2 /*return*/, this.fetchEndpoint('get_contract_addresses')];
       });
     });
   };
@@ -225,34 +325,31 @@ var Provider = /** @class */ (function () {
    * @param blockNumber
    * @returns the result of the function on the smart contract.
    */
-  Provider.prototype.callContract = function (invokeTransaction, blockHash, blockNumber) {
-    if (blockNumber === void 0) {
-      blockNumber = null;
+  Provider.prototype.callContract = function (_a, blockIdentifier) {
+    var contractAddress = _a.contractAddress,
+      entrypoint = _a.entrypoint,
+      _b = _a.calldata,
+      calldata = _b === void 0 ? [] : _b;
+    if (blockIdentifier === void 0) {
+      blockIdentifier = null;
     }
     return __awaiter(this, void 0, void 0, function () {
-      var formattedBlockIdentifier, data;
-      return __generator(this, function (_a) {
-        switch (_a.label) {
-          case 0:
-            formattedBlockIdentifier = (0, utils_1.getFormattedBlockIdentifier)(
-              blockHash,
-              blockNumber
-            );
-            return [
-              4 /*yield*/,
-              axios_1.default.post(
-                (0, url_join_1.default)(
-                  this.feederGatewayUrl,
-                  'call_contract',
-                  formattedBlockIdentifier
-                ),
-                __assign({ signature: [], calldata: [] }, invokeTransaction)
-              ),
-            ];
-          case 1:
-            data = _a.sent().data;
-            return [2 /*return*/, data];
-        }
+      return __generator(this, function (_c) {
+        return [
+          2 /*return*/,
+          this.fetchEndpoint(
+            'call_contract',
+            {
+              blockIdentifier: blockIdentifier,
+            },
+            {
+              signature: [],
+              contract_address: contractAddress,
+              entry_point_selector: (0, stark_1.getSelectorFromName)(entrypoint),
+              calldata: calldata,
+            }
+          ),
+        ];
       });
     });
   };
@@ -265,33 +362,16 @@ var Provider = /** @class */ (function () {
    * @param blockNumber
    * @returns the block object { block_number, previous_block_number, state_root, status, timestamp, transaction_receipts, transactions }
    */
-  Provider.prototype.getBlock = function (blockHash, blockNumber) {
-    if (blockNumber === void 0) {
-      blockNumber = null;
+  Provider.prototype.getBlock = function (blockIdentifier) {
+    if (blockIdentifier === void 0) {
+      blockIdentifier = null;
     }
     return __awaiter(this, void 0, void 0, function () {
-      var formattedBlockIdentifier, data;
       return __generator(this, function (_a) {
-        switch (_a.label) {
-          case 0:
-            formattedBlockIdentifier = (0, utils_1.getFormattedBlockIdentifier)(
-              blockHash,
-              blockNumber
-            );
-            return [
-              4 /*yield*/,
-              axios_1.default.get(
-                (0, url_join_1.default)(
-                  this.feederGatewayUrl,
-                  'get_block',
-                  formattedBlockIdentifier
-                )
-              ),
-            ];
-          case 1:
-            data = _a.sent().data;
-            return [2 /*return*/, data];
-        }
+        return [
+          2 /*return*/,
+          this.fetchEndpoint('get_block', { blockIdentifier: blockIdentifier }),
+        ];
       });
     });
   };
@@ -305,33 +385,19 @@ var Provider = /** @class */ (function () {
    * @param blockNumber
    * @returns Bytecode and ABI of compiled contract
    */
-  Provider.prototype.getCode = function (contractAddress, blockHash, blockNumber) {
-    if (blockNumber === void 0) {
-      blockNumber = null;
+  Provider.prototype.getCode = function (contractAddress, blockIdentifier) {
+    if (blockIdentifier === void 0) {
+      blockIdentifier = null;
     }
     return __awaiter(this, void 0, void 0, function () {
-      var formattedBlockIdentifier, data;
       return __generator(this, function (_a) {
-        switch (_a.label) {
-          case 0:
-            formattedBlockIdentifier = (0, utils_1.getFormattedBlockIdentifier)(
-              blockHash,
-              blockNumber
-            );
-            return [
-              4 /*yield*/,
-              axios_1.default.get(
-                (0, url_join_1.default)(
-                  this.feederGatewayUrl,
-                  'get_code',
-                  '?contractAddress=' + contractAddress + '&' + formattedBlockIdentifier
-                )
-              ),
-            ];
-          case 1:
-            data = _a.sent().data;
-            return [2 /*return*/, data];
-        }
+        return [
+          2 /*return*/,
+          this.fetchEndpoint('get_code', {
+            blockIdentifier: blockIdentifier,
+            contractAddress: contractAddress,
+          }),
+        ];
       });
     });
   };
@@ -347,38 +413,20 @@ var Provider = /** @class */ (function () {
    * @param blockNumber
    * @returns the value of the storage variable
    */
-  Provider.prototype.getStorageAt = function (contractAddress, key, blockHash, blockNumber) {
-    if (blockNumber === void 0) {
-      blockNumber = null;
+  Provider.prototype.getStorageAt = function (contractAddress, key, blockIdentifier) {
+    if (blockIdentifier === void 0) {
+      blockIdentifier = null;
     }
     return __awaiter(this, void 0, void 0, function () {
-      var formattedBlockIdentifier, data;
       return __generator(this, function (_a) {
-        switch (_a.label) {
-          case 0:
-            formattedBlockIdentifier = (0, utils_1.getFormattedBlockIdentifier)(
-              blockHash,
-              blockNumber
-            );
-            return [
-              4 /*yield*/,
-              axios_1.default.get(
-                (0, url_join_1.default)(
-                  this.feederGatewayUrl,
-                  'get_storage_at',
-                  '?contractAddress=' +
-                    contractAddress +
-                    '&key=' +
-                    key +
-                    '&' +
-                    formattedBlockIdentifier
-                )
-              ),
-            ];
-          case 1:
-            data = _a.sent().data;
-            return [2 /*return*/, data];
-        }
+        return [
+          2 /*return*/,
+          this.fetchEndpoint('get_storage_at', {
+            blockIdentifier: blockIdentifier,
+            contractAddress: contractAddress,
+            key: key,
+          }),
+        ];
       });
     });
   };
@@ -392,100 +440,67 @@ var Provider = /** @class */ (function () {
    */
   Provider.prototype.getTransactionStatus = function (txHash) {
     return __awaiter(this, void 0, void 0, function () {
-      var txHashBn, data;
+      var txHashHex;
       return __generator(this, function (_a) {
-        switch (_a.label) {
-          case 0:
-            txHashBn = (0, number_1.toBN)(txHash);
-            return [
-              4 /*yield*/,
-              axios_1.default.get(
-                (0, url_join_1.default)(
-                  this.feederGatewayUrl,
-                  'get_transaction_status',
-                  '?transactionHash=' + (0, number_1.toHex)(txHashBn)
-                )
-              ),
-            ];
-          case 1:
-            data = _a.sent().data;
-            return [2 /*return*/, data];
-        }
+        txHashHex = (0, number_1.toHex)((0, number_1.toBN)(txHash));
+        return [
+          2 /*return*/,
+          this.fetchEndpoint('get_transaction_status', { transactionHash: txHashHex }),
+        ];
       });
     });
   };
   /**
-   * Gets the transaction information from a tx id.
+   * Gets the transaction receipt from a tx hash or tx id.
    *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L54-L58)
+   * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L104-L111)
    *
    * @param txHash
-   * @returns the transacton object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? }
+   * @param txId
+   * @returns the transaction receipt object
    */
-  Provider.prototype.getTransaction = function (txHash) {
+  Provider.prototype.getTransactionReceipt = function (_a) {
+    var txHash = _a.txHash,
+      txId = _a.txId;
     return __awaiter(this, void 0, void 0, function () {
-      var txHashBn, data;
-      return __generator(this, function (_a) {
-        switch (_a.label) {
+      var data;
+      return __generator(this, function (_b) {
+        switch (_b.label) {
           case 0:
-            txHashBn = (0, number_1.toBN)(txHash);
             return [
               4 /*yield*/,
               axios_1.default.get(
                 (0, url_join_1.default)(
                   this.feederGatewayUrl,
-                  'get_transaction',
-                  '?transactionHash=' + (0, number_1.toHex)(txHashBn)
+                  'get_transaction_receipt',
+                  '?' + (0, utils_1.txIdentifier)(txHash, txId)
                 )
               ),
             ];
           case 1:
-            data = _a.sent().data;
+            data = _b.sent().data;
             return [2 /*return*/, data];
         }
       });
     });
   };
   /**
-   * Invoke a function on the starknet contract
+   * Gets the transaction information from a tx id.
    *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/gateway/gateway_client.py#L13-L17)
+   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L54-L58)
    *
-   * @param transaction - transaction to be invoked
-   * @returns a confirmation of invoking a function on the starknet contract
+   * @param txHash
+   * @returns the transacton object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? }
    */
-  Provider.prototype.addTransaction = function (transaction) {
+  Provider.prototype.getTransaction = function (txHash) {
     return __awaiter(this, void 0, void 0, function () {
-      var signature, contract_address_salt, data;
+      var txHashHex;
       return __generator(this, function (_a) {
-        switch (_a.label) {
-          case 0:
-            signature =
-              transaction.type === 'INVOKE_FUNCTION' &&
-              (0, stark_1.formatSignature)(transaction.signature);
-            contract_address_salt =
-              transaction.type === 'DEPLOY' &&
-              (0, number_1.toHex)((0, number_1.toBN)(transaction.contract_address_salt));
-            return [
-              4 /*yield*/,
-              axios_1.default.post(
-                (0, url_join_1.default)(this.gatewayUrl, 'add_transaction'),
-                (0, json_1.stringify)(
-                  __assign(
-                    __assign(
-                      __assign({}, transaction),
-                      Array.isArray(signature) && { signature: signature }
-                    ),
-                    contract_address_salt && { contract_address_salt: contract_address_salt }
-                  )
-                ),
-                { headers: { 'Content-Type': 'application/json' } }
-              ),
-            ];
-          case 1:
-            data = _a.sent().data;
-            return [2 /*return*/, data];
-        }
+        txHashHex = (0, number_1.toHex)((0, number_1.toBN)(txHash));
+        return [
+          2 /*return*/,
+          this.fetchEndpoint('get_transaction', { transactionHash: txHashHex }),
+        ];
       });
     });
   };
@@ -496,26 +511,26 @@ var Provider = /** @class */ (function () {
    * @param address - (optional, defaults to a random address) the address where the contract should be deployed (alpha)
    * @returns a confirmation of sending a transaction on the starknet contract
    */
-  Provider.prototype.deployContract = function (contract, constructorCalldata, addressSalt) {
-    if (constructorCalldata === void 0) {
-      constructorCalldata = [];
-    }
-    if (addressSalt === void 0) {
-      addressSalt = (0, stark_1.randomAddress)();
-    }
-    var parsedContract = typeof contract === 'string' ? (0, json_1.parse)(contract) : contract;
+  Provider.prototype.deployContract = function (payload, _abi) {
+    var _a, _b;
+    var parsedContract =
+      typeof payload.contract === 'string' ? (0, json_1.parse)(payload.contract) : payload.contract;
     var contractDefinition = __assign(__assign({}, parsedContract), {
       program: (0, stark_1.compressProgram)(parsedContract.program),
     });
-    return this.addTransaction({
+    return this.fetchEndpoint('add_transaction', undefined, {
       type: 'DEPLOY',
-      contract_address_salt: addressSalt,
-      constructor_calldata: constructorCalldata,
+      contract_address_salt:
+        (_a = payload.addressSalt) !== null && _a !== void 0 ? _a : (0, stark_1.randomAddress)(),
+      constructor_calldata: (0, number_1.bigNumberishArrayToDecimalStringArray)(
+        (_b = payload.constructorCalldata) !== null && _b !== void 0 ? _b : []
+      ),
       contract_definition: contractDefinition,
     });
   };
   /**
    * 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
@@ -523,18 +538,18 @@ var Provider = /** @class */ (function () {
    * @param signature - (optional) signature to send along
    * @returns response from addTransaction
    */
-  Provider.prototype.invokeFunction = function (
-    contractAddress,
-    entrypointSelector,
-    calldata,
-    signature
-  ) {
-    return this.addTransaction({
+  Provider.prototype.invokeFunction = function (invocation, _abi) {
+    var _a, _b;
+    return this.fetchEndpoint('add_transaction', undefined, {
       type: 'INVOKE_FUNCTION',
-      contract_address: contractAddress,
-      entry_point_selector: entrypointSelector,
-      calldata: calldata,
-      signature: signature,
+      contract_address: invocation.contractAddress,
+      entry_point_selector: (0, stark_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.waitForTx = function (txHash, retryInterval) {