starknet 3.15.2 → 3.15.3

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [3.15.3](https://github.com/0xs34n/starknet.js/compare/v3.15.2...v3.15.3) (2022-06-20)
+
+### Bug Fixes
+
+- **dev:** regenerated package-lock.json ([849cb1e](https://github.com/0xs34n/starknet.js/commit/849cb1ea3ffd7ba10b40b232d0ebc46b6599c7ea))
+- use cross-fetch only for jest ([83be37a](https://github.com/0xs34n/starknet.js/commit/83be37a9e3328a44abd9583b8167c3cb8d882790))
+
 ## [3.15.2](https://github.com/0xs34n/starknet.js/compare/v3.15.1...v3.15.2) (2022-06-18)
 
 ### Bug Fixes

package/__tests__/jest.setup.ts

@@ -1,6 +1,9 @@
 /* eslint-disable no-console */
+import fetch from 'cross-fetch';
 import { register } from 'fetch-intercept';
 
+global.fetch = fetch;
+
 jest.setTimeout(50 * 60 * 1000);
 
 if (process.env.DEBUG === 'true') {

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,7 +190,7 @@ 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,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starknet",
-  "version": "3.15.2",
+  "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,7 +307,7 @@ 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,

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';

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.