starknet 3.15.0 → 3.15.3

package/__tests__/utils/utils.browser.test.ts

@@ -8,21 +8,19 @@ import { constants, json, stark } from '../../src';
 
 const { IS_BROWSER } = constants;
 
-const compiledArgentAccount = json.parse(
-  fs.readFileSync('./__mocks__/ArgentAccount.json').toString('ascii')
-);
+const compiledAccount = json.parse(fs.readFileSync('./__mocks__/Account.json').toString('ascii'));
 
 test('isBrowser', () => {
   expect(IS_BROWSER).toBe(true);
 });
 describe('compressProgram()', () => {
   test('compresses a contract program', () => {
-    const compressed = stark.compressProgram(compiledArgentAccount.program);
+    const compressed = stark.compressProgram(compiledAccount.program);
 
     expect(compressed).toMatchSnapshot();
   });
   test('works with strings', () => {
-    const inputProgram = json.stringify(compiledArgentAccount.program);
+    const inputProgram = json.stringify(compiledAccount.program);
 
     const compressed = stark.compressProgram(inputProgram);
 

package/__tests__/utils/utils.test.ts

@@ -5,23 +5,21 @@ import { pedersen } from '../../src/utils/hash';
 
 const { IS_BROWSER } = constants;
 
-const compiledArgentAccount = json.parse(
-  fs.readFileSync('./__mocks__/ArgentAccount.json').toString('ascii')
-);
+const compiledAccount = json.parse(fs.readFileSync('./__mocks__/Account.json').toString('ascii'));
 
 test('isNode', () => {
   expect(IS_BROWSER).toBe(false);
 });
 describe('compressProgram()', () => {
   test('compresses a contract program', () => {
-    const inputProgram = compiledArgentAccount.program;
+    const inputProgram = compiledAccount.program;
 
     const compressed = stark.compressProgram(inputProgram);
 
     expect(compressed).toMatchSnapshot();
   });
   test('works with strings', () => {
-    const inputProgram = json.stringify(compiledArgentAccount.program);
+    const inputProgram = json.stringify(compiledAccount.program);
 
     const compressed = stark.compressProgram(inputProgram);
 

package/dist/provider/default.js

@@ -67,7 +67,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Provider = void 0;
-var cross_fetch_1 = __importDefault(require("cross-fetch"));
 var url_join_1 = __importDefault(require("url-join"));
 var constants_1 = require("../constants");
 var hash_1 = require("../utils/hash");
@@ -191,12 +190,17 @@ var Provider = /** @class */ (function () {
                 queryString = this.getQueryString(query);
                 headers = this.getHeaders(method);
                 url = (0, url_join_1.default)(baseUrl, endpoint, queryString);
-                return [2 /*return*/, (0, cross_fetch_1.default)(url, {
+                return [2 /*return*/, fetch(url, {
                         method: method,
                         body: (0, json_1.stringify)(request),
                         headers: headers,
                     })
-                        .then(function (res) { return res.text(); })
+                        .then(function (res) {
+                        if (res.status >= 400) {
+                            throw Error(res.statusText);
+                        }
+                        return res.text();
+                    })
                         .then(function (res) {
                         if (endpoint === 'estimate_fee') {
                             return (0, json_1.parse)(res, function (_, v) {
@@ -207,6 +211,9 @@ var Provider = /** @class */ (function () {
                             });
                         }
                         return (0, json_1.parse)(res);
+                    })
+                        .catch(function (err) {
+                        throw Error("Could not ".concat(method, " from endpoint `").concat(url, "`: ").concat(err.message));
                     })];
             });
         });

package/dist/provider/utils.js

@@ -42,7 +42,7 @@ function getBlockIdentifier(blockIdentifier) {
     if (blockIdentifier === 'pending') {
         return { type: 'BLOCK_NUMBER', data: 'pending' };
     }
-    if (typeof blockIdentifier === 'number') {
+    if (typeof blockIdentifier === 'number' || typeof blockIdentifier === 'bigint') {
         return { type: 'BLOCK_NUMBER', data: blockIdentifier };
     }
     if (typeof blockIdentifier === 'string' && blockIdentifier.startsWith('0x')) {

package/dist/types/api.d.ts

@@ -109,6 +109,9 @@ export declare type InvokeFunctionTransaction = {
     max_fee?: BigNumberish;
     version?: BigNumberish;
 };
+export interface InvokeFunctionTransactionResponse extends InvokeFunctionTransaction {
+    transaction_hash: string;
+}
 export declare type InvokeFunctionTrace = {
     caller_address: string;
     contract_address: string;
@@ -135,6 +138,7 @@ export declare type ExecutionResources = {
 };
 export declare type CallContractTransaction = Omit<InvokeFunctionTransaction, 'type' | 'entry_point_type' | 'nonce'>;
 export declare type Transaction = DeclareTransaction | DeployTransaction | InvokeFunctionTransaction;
+export declare type TransactionResponse = DeclareTransaction | DeployTransaction | InvokeFunctionTransactionResponse;
 export declare type CallContractResponse = {
     result: string[];
 };
@@ -143,7 +147,7 @@ export declare type GetBlockResponse = {
     state_root: string;
     block_hash: string;
     transactions: {
-        [txHash: string]: Transaction;
+        [txHash: string]: TransactionResponse;
     };
     timestamp: number;
     transaction_receipts: {
@@ -193,7 +197,7 @@ export declare type GetTransactionTraceResponse = {
 };
 export declare type SuccessfulTransactionResponse = {
     status: Status;
-    transaction: Transaction;
+    transaction: TransactionResponse;
     block_hash: string;
     block_number: BlockNumber;
     transaction_index: number;
@@ -204,7 +208,7 @@ export declare type FailedTransactionResponse = {
         code: string;
         error_message: string;
     };
-    transaction: Transaction;
+    transaction: TransactionResponse;
 };
 export declare type GetTransactionResponse = SuccessfulTransactionResponse | FailedTransactionResponse;
 export declare type AddTransactionResponse = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starknet",
-  "version": "3.15.0",
+  "version": "3.15.3",
   "description": "JavaScript library for StarkNet",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -43,14 +43,17 @@
     "@types/minimalistic-assert": "^1.0.1",
     "@types/pako": "^2.0.0",
     "@types/url-join": "^4.0.1",
+    "@types/whatwg-fetch": "^0.0.33",
     "@typescript-eslint/eslint-plugin": "^5.28.0",
     "@typescript-eslint/parser": "^5.28.0",
+    "cross-fetch": "^3.1.5",
     "eslint": "^8.17.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-airbnb-typescript": "^17.0.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-prettier": "^4.0.0",
+    "fetch-intercept": "^2.4.0",
     "husky": "^8.0.1",
     "import-sort-style-module": "^6.0.0",
     "jest": "^28.1.1",
@@ -68,7 +71,6 @@
     "cross-fetch": "^3.1.5",
     "elliptic": "^6.5.4",
     "ethereum-cryptography": "^1.0.3",
-    "fetch-intercept": "^2.4.0",
     "hash.js": "^1.1.7",
     "json-bigint": "^1.0.0",
     "minimalistic-assert": "^1.0.1",

package/provider/default.js

@@ -173,7 +173,6 @@ var __importDefault =
   };
 Object.defineProperty(exports, '__esModule', { value: true });
 exports.Provider = void 0;
-var cross_fetch_1 = __importDefault(require('cross-fetch'));
 var url_join_1 = __importDefault(require('url-join'));
 var constants_1 = require('../constants');
 var hash_1 = require('../utils/hash');
@@ -308,12 +307,15 @@ var Provider = /** @class */ (function () {
         url = (0, url_join_1.default)(baseUrl, endpoint, queryString);
         return [
           2 /*return*/,
-          (0, cross_fetch_1.default)(url, {
+          fetch(url, {
             method: method,
             body: (0, json_1.stringify)(request),
             headers: headers,
           })
             .then(function (res) {
+              if (res.status >= 400) {
+                throw Error(res.statusText);
+              }
               return res.text();
             })
             .then(function (res) {
@@ -326,6 +328,14 @@ var Provider = /** @class */ (function () {
                 });
               }
               return (0, json_1.parse)(res);
+            })
+            .catch(function (err) {
+              throw Error(
+                'Could not '
+                  .concat(method, ' from endpoint `')
+                  .concat(url, '`: ')
+                  .concat(err.message)
+              );
             }),
         ];
       });

package/provider/utils.js

@@ -45,7 +45,7 @@ function getBlockIdentifier(blockIdentifier) {
   if (blockIdentifier === 'pending') {
     return { type: 'BLOCK_NUMBER', data: 'pending' };
   }
-  if (typeof blockIdentifier === 'number') {
+  if (typeof blockIdentifier === 'number' || typeof blockIdentifier === 'bigint') {
     return { type: 'BLOCK_NUMBER', data: blockIdentifier };
   }
   if (typeof blockIdentifier === 'string' && blockIdentifier.startsWith('0x')) {

package/src/provider/default.ts

@@ -1,4 +1,3 @@
-import fetch from 'cross-fetch';
 import urljoin from 'url-join';
 
 import { ONE, StarknetChainId, ZERO } from '../constants';
@@ -159,7 +158,12 @@ export class Provider implements ProviderInterface {
       body: stringify(request),
       headers,
     })
-      .then((res) => res.text())
+      .then((res) => {
+        if (res.status >= 400) {
+          throw Error(res.statusText);
+        }
+        return res.text();
+      })
       .then((res) => {
         if (endpoint === 'estimate_fee') {
           return parse(res, (_, v) => {
@@ -170,6 +174,9 @@ export class Provider implements ProviderInterface {
           });
         }
         return parse(res) as Endpoints[T]['RESPONSE'];
+      })
+      .catch((err) => {
+        throw Error(`Could not ${method} from endpoint \`${url}\`: ${err.message}`);
       });
   }
 

package/src/provider/utils.ts

@@ -49,7 +49,7 @@ export function getBlockIdentifier(blockIdentifier: BlockIdentifier): BlockIdent
   if (blockIdentifier === 'pending') {
     return { type: 'BLOCK_NUMBER', data: 'pending' };
   }
-  if (typeof blockIdentifier === 'number') {
+  if (typeof blockIdentifier === 'number' || typeof blockIdentifier === 'bigint') {
     return { type: 'BLOCK_NUMBER', data: blockIdentifier };
   }
   if (typeof blockIdentifier === 'string' && blockIdentifier.startsWith('0x')) {

package/src/types/api.ts

@@ -125,6 +125,10 @@ export type InvokeFunctionTransaction = {
   version?: BigNumberish;
 };
 
+export interface InvokeFunctionTransactionResponse extends InvokeFunctionTransaction {
+  transaction_hash: string;
+}
+
 export type InvokeFunctionTrace = {
   caller_address: string;
   contract_address: string;
@@ -157,6 +161,10 @@ export type CallContractTransaction = Omit<
 >;
 
 export type Transaction = DeclareTransaction | DeployTransaction | InvokeFunctionTransaction;
+export type TransactionResponse =
+  | DeclareTransaction
+  | DeployTransaction
+  | InvokeFunctionTransactionResponse;
 
 export type CallContractResponse = {
   result: string[];
@@ -167,7 +175,7 @@ export type GetBlockResponse = {
   state_root: string;
   block_hash: string;
   transactions: {
-    [txHash: string]: Transaction;
+    [txHash: string]: TransactionResponse;
   };
   timestamp: number;
   transaction_receipts: {
@@ -221,7 +229,7 @@ export type GetTransactionTraceResponse = {
 
 export type SuccessfulTransactionResponse = {
   status: Status;
-  transaction: Transaction;
+  transaction: TransactionResponse;
   block_hash: string;
   block_number: BlockNumber;
   transaction_index: number;
@@ -233,7 +241,7 @@ export type FailedTransactionResponse = {
     code: string;
     error_message: string;
   };
-  transaction: Transaction;
+  transaction: TransactionResponse;
 };
 
 export type GetTransactionResponse = SuccessfulTransactionResponse | FailedTransactionResponse;

package/types/api.d.ts

@@ -119,6 +119,9 @@ export declare type InvokeFunctionTransaction = {
   max_fee?: BigNumberish;
   version?: BigNumberish;
 };
+export interface InvokeFunctionTransactionResponse extends InvokeFunctionTransaction {
+  transaction_hash: string;
+}
 export declare type InvokeFunctionTrace = {
   caller_address: string;
   contract_address: string;
@@ -151,6 +154,10 @@ export declare type Transaction =
   | DeclareTransaction
   | DeployTransaction
   | InvokeFunctionTransaction;
+export declare type TransactionResponse =
+  | DeclareTransaction
+  | DeployTransaction
+  | InvokeFunctionTransactionResponse;
 export declare type CallContractResponse = {
   result: string[];
 };
@@ -159,7 +166,7 @@ export declare type GetBlockResponse = {
   state_root: string;
   block_hash: string;
   transactions: {
-    [txHash: string]: Transaction;
+    [txHash: string]: TransactionResponse;
   };
   timestamp: number;
   transaction_receipts: {
@@ -209,7 +216,7 @@ export declare type GetTransactionTraceResponse = {
 };
 export declare type SuccessfulTransactionResponse = {
   status: Status;
-  transaction: Transaction;
+  transaction: TransactionResponse;
   block_hash: string;
   block_number: BlockNumber;
   transaction_index: number;
@@ -220,7 +227,7 @@ export declare type FailedTransactionResponse = {
     code: string;
     error_message: string;
   };
-  transaction: Transaction;
+  transaction: TransactionResponse;
 };
 export declare type GetTransactionResponse =
   | SuccessfulTransactionResponse

package/www/docs/API/utils.md

@@ -14,6 +14,8 @@ the address helpers can be imported using:
 import { address } from 'starknet.js';
 ```
 
+<br/>
+
 ### `getChecksumAddress(address: BigNumberish): string`
 
 This function accepts an address as a `BigNumberish` and returns the checksummed address as a string.
@@ -29,6 +31,235 @@ const checksummedAddress = address.getChecksumAddress(addressToCheck);
 console.log(checksummedAddress); // 0x02FD23D9182193775423497Fc0c472E156C57C69E4089a1967fb288a2D84e914
 ```
 
+<br/>
+
 ### `validateChecksumAddress(address: string): boolean`
 
 This function validates the checksum address. It returns true if the address is valid, false otherwise.
+
+<hr />
+
+## `stark`
+
+Functions for stark specific manipulations.
+
+<br/>
+
+### `compressProgram(jsonProgram: Program | string): CompressedProgram`
+
+Function to compress compiled cairo program. Accepts a json file representing the compiled cairo program and returns a compressed cairo program.
+
+<br/>
+
+### `randomAddress(): string`
+
+Function that generates a random contract address.
+
+<br/>
+
+### `makeAddress(input: string): string`
+
+Function that turns an incompatible address string into stark address format. Returns a string. 
+
+Example: `0xdFD0F27FCe99b50909de0bDD328Aed6eAbe76BC5` -> `0xdfd0f27fce99b50909de0bdd328aed6eabe76bc5`
+
+<br/>
+
+### `formatSignature(sig?: Signature): string[]`
+
+Function that formats a Signature to BigNum and then to string array. Returns a string array.
+
+<br/>
+
+### `compileCalldata(args: RawArgs): Calldata`
+
+Function that creates calldata that gets sent to the contract.
+
+```js
+await this.callContract({
+    contractAddress: this.address,
+    entrypoint: 'is_valid_signature',
+    calldata: compileCalldata({
+        hash: toBN(hash).toString(),
+        signature: signature.map((x) => toBN(x).toString()),
+    }),
+});
+```
+
+<br/>
+
+### `estimatedFeeToMaxFee(estimatedFee: BigNumberish, overhead: number = 0.5): BN`
+
+Function that calculates and returns maximum fee based on the previously estimated one. 
+
+Returns a BN.
+
+<hr />
+
+## `number`
+
+Various number formatting functions.
+
+`BN` is the `BigNum` representation imported from `bn.js` library.
+
+```js
+export type BigNumberish = string | number | BN;
+```
+
+<br/>
+
+### `isHex(hex: string): boolean`
+
+Check if number is in hex format.
+
+<br/>
+
+### `toBN(number: BigNumberish, base?: number | 'hex'): BN`
+
+Converts BigNumberish to BN. Returns a BN.
+
+<br/>
+
+### `toHex(number: BN): string`
+
+Converts BN to hex. Returns a string.
+
+<br/>
+
+### `hexToDecimalString(hex: string): string`
+
+Converts hex string to decimal string.
+
+<br/>
+
+### `toFelt(num: BigNumberish): string`
+
+Converts BN to Felt. Returns a string.
+
+<br/>
+
+### `assertInRange(input: BigNumberish, lowerBound: BigNumberish, upperBound: BigNumberish, inputName = '')`
+
+Asserts input is equal to or greater then `lowerBound` and lower then `upperBound`. Assert message specifies inputName.
+`input`, `lowerBound`, and `upperBound` should be of type BN.
+`inputName` should be a string.
+
+<br/>
+
+### `bigNumberishArrayToDecimalStringArray(rawCalldata: BigNumberish[]): string[]`
+
+Convert BigNumberish array to decimal array. Used for signature conversion.
+
+``` js
+const signature = await this.signer.signTransaction(transactions, signerDetails);
+
+{
+    contract_address: this.address,
+    entry_point_selector: getSelectorFromName('__execute__'),
+    calldata,
+    version: toHex(version),
+    signature: bigNumberishArrayToDecimalStringArray(signature),
+}
+```
+
+<hr />
+
+## `uint256`
+
+```js
+// Represents an integer in the range [0, 2^256).
+export interface Uint256 {
+  // The low 128 bits of the value.
+  low: BigNumberish;
+  // The high 128 bits of the value.
+  high: BigNumberish;
+}
+```
+
+<br/>
+
+### `uint256ToBN(uint256: Uint256): BN`
+
+Function to convert `Uint256` to `BN` (big number), which uses the `bn.js` library.
+
+<br/>
+
+### `isUint256(bn: BigNumberish): boolean`
+
+Function to check if `BN` is smaller or equal to `2**256-1`.
+
+<br/>
+
+### `bnToUint256(bignumber: BigNumberish): Uint256`
+
+Function to convert `BN` to `Uint256`.
+
+<hr />
+
+## `hash`
+
+Various hashing helpers.
+
+### `starknetKeccak(value: string): BN`
+
+Function to get the starknet keccak hash from a string. Returns starknet keccak hash as BigNumber.
+nction to get the starknet keccak hash from a string. Returns starknet keccak hash as BigNumber.
+
+<br/>
+
+### `getSelectorFromName(funcName: string)`
+
+Function to get the hex selector from a given function name. Returns hex selector of given abi function name.
+
+<br/>
+
+### `pedersen(input: [BigNumberish, BigNumberish])`
+
+<br/>
+
+Function to get the Pedersen hash for two arguments. Returns a string.
+
+### `computeHashOnElements(data: BigNumberish[])`
+
+<br/>
+
+Function to compute a Pedersen hash on a array of elements. Returns a string.
+
+<br/>
+
+### `calculateTransactionHashCommon(txHashPrefix: TransactionHashPrefix, version: BigNumberish,contractAddress: BigNumberish, entryPointSelector: BigNumberish, calldata: BigNumberish[], maxFee: BigNumberish, chainId: StarknetChainId, additionalData: BigNumberish[] = []): string`
+
+Calculates the transaction hash in the StarkNet network - a unique identifier of the transaction. 
+
+Called internally in `calculateDeployTransactionHash` and `calculcateTransactionHash`.
+
+<br/>
+
+### `calculateDeployTransactionHash(contractAddress: BigNumberish, constructorCalldata: BigNumberish[], version: BigNumberish, chainId: StarknetChainId): string`
+
+Function that calculates the deployment transaction hash in the StarkNet network.
+
+Internally calls `calculateTransactionHashCommon` with `TransactionHashPrefix.DEPLOY`.
+
+<br/>
+
+### `calculcateTransactionHash(contractAddress: BigNumberish, version: BigNumberish, entryPointSelector: BigNumberish, calldata: BigNumberish[], maxFee: BigNumberish, chainId: StarknetChainId): string`
+
+Function that internally calls `calculateTransactionHashCommon`, with `TransactionHashPrefix.INVOKE`.
+
+```js
+const hashMsg = calculcateTransactionHash(
+  account,
+  transactionVersion,
+  getSelectorFromName('__execute__'),
+  calldata,
+  maxFee,
+  StarknetChainId.TESTNET
+);
+```
+
+<br/>
+
+### `calculateContractAddressFromHash(salt: BigNumberish, classHash: BigNumberish, constructorCalldata: RawCalldata, deployerAddress: BigNumberish)`
+
+Function that calculates contract address from hash. Returns a string.

package/www/guides/account.md

@@ -39,11 +39,11 @@ const starkKeyPub = ec.getStarkKey(starkKeyPair);;
 Deploy the Account contract and wait for it to be verified on StarkNet.
 
 ```javascript
-const compiledArgentAccount = json.parse(
-  fs.readFileSync("./ArgentAccount.json").toString("ascii")
+const compiledAccount = json.parse(
+  fs.readFileSync("./Account.json").toString("ascii")
 );
 const accountResponse = await defaultProvider.deployContract({
-  contract: compiledArgentAccount,
+  contract: compiledAccount,
   addressSalt: starkKeyPub,
 });
 ```
@@ -55,7 +55,7 @@ Wait for the deployment transaction to be accepted and assign the address of the
 ```javascript
 await defaultProvider.waitForTransaction(accountResponse.transaction_hash);
 const accountContract = new Contract(
-  compiledArgentAccount.abi,
+  compiledAccount.abi,
   accountResponse.address
 );
 const initializeResponse = await accountContract.initialize(starkKeyPub, "0");