starknet 4.2.0 → 4.3.0

package/CHANGELOG.md

@@ -1,3 +1,14 @@
+# [4.3.0](https://github.com/0xs34n/starknet.js/compare/v4.2.0...v4.3.0) (2022-08-09)
+
+### Bug Fixes
+
+- intendations in provider.md ([4a310c6](https://github.com/0xs34n/starknet.js/commit/4a310c6c992c77f9f6729a70c1af14481cd891f7))
+- **sequenceProvider:** feedergatewayUrl and gatewayUrl ([e236d23](https://github.com/0xs34n/starknet.js/commit/e236d2352e3fbb0f78965decac5893217347ceb7))
+
+### Features
+
+- update docs ([28786ed](https://github.com/0xs34n/starknet.js/commit/28786ed550909f6a30b8cb145e93d072ed28a862))
+
 # [4.2.0](https://github.com/0xs34n/starknet.js/compare/v4.1.0...v4.2.0) (2022-08-09)
 
 ### Features

package/__tests__/sequencerProvider.test.ts

@@ -1,4 +1,5 @@
-import { SequencerProvider } from '../src';
+import { Contract, Provider, SequencerProvider, stark } from '../src';
+import { toBN } from '../src/utils/number';
 import {
   compiledErc20,
   describeIfNotDevnet,
@@ -8,9 +9,17 @@ import {
 
 describeIfSequencer('SequencerProvider', () => {
   let provider: SequencerProvider;
+  let customSequencerProvider: Provider;
 
   beforeAll(async () => {
     provider = getTestProvider() as SequencerProvider;
+    customSequencerProvider = new Provider({
+      sequencer: {
+        baseUrl: 'https://alpha4.starknet.io',
+        feederGatewayUrl: 'feeder_gateway',
+        gatewayUrl: 'gateway',
+      }, // Similar to arguements used in docs
+    });
   });
 
   describe('Gateway specific methods', () => {
@@ -42,4 +51,25 @@ describeIfSequencer('SequencerProvider', () => {
       });
     });
   });
+
+  describe('Test calls with Custom Sequencer Provider', () => {
+    let erc20: Contract;
+    const wallet = stark.randomAddress();
+
+    beforeAll(async () => {
+      const { contract_address, transaction_hash } = await customSequencerProvider.deployContract({
+        contract: compiledErc20,
+      });
+
+      await customSequencerProvider.waitForTransaction(transaction_hash);
+      erc20 = new Contract(compiledErc20.abi, contract_address, customSequencerProvider);
+    });
+
+    test('Check ERC20 balance using Custom Sequencer Provider', async () => {
+      const result = await erc20.balance_of(wallet);
+      const [res] = result;
+      expect(res).toStrictEqual(toBN(0));
+      expect(res).toStrictEqual(result.res);
+    });
+  });
 });

package/dist/index.d.ts

@@ -21,3 +21,4 @@ export * as uint256 from './utils/uint256';
 export * as shortString from './utils/shortString';
 export * as typedData from './utils/typedData';
 export * from './utils/address';
+export * from './utils/url';

package/dist/index.js

@@ -50,3 +50,4 @@ exports.uint256 = __importStar(require("./utils/uint256"));
 exports.shortString = __importStar(require("./utils/shortString"));
 exports.typedData = __importStar(require("./utils/typedData"));
 __exportStar(require("./utils/address"), exports);
+__exportStar(require("./utils/url"), exports);

package/dist/provider/sequencer.js

@@ -65,6 +65,7 @@ var number_1 = require("../utils/number");
 var provider_1 = require("../utils/provider");
 var sequencer_1 = require("../utils/responseParser/sequencer");
 var stark_1 = require("../utils/stark");
+var url_1 = require("../utils/url");
 var errors_1 = require("./errors");
 var utils_1 = require("./utils");
 function isEmptyQueryObject(obj) {
@@ -79,7 +80,7 @@ function isEmptyQueryObject(obj) {
 var SequencerProvider = /** @class */ (function () {
     function SequencerProvider(optionsOrProvider) {
         if (optionsOrProvider === void 0) { optionsOrProvider = { network: 'goerli-alpha' }; }
-        var _a, _b, _c;
+        var _a;
         this.responseParser = new sequencer_1.SequencerAPIResponseParser();
         if ('network' in optionsOrProvider) {
             this.baseUrl = SequencerProvider.getNetworkFromName(optionsOrProvider.network);
@@ -89,11 +90,10 @@ var SequencerProvider = /** @class */ (function () {
         }
         else {
             this.baseUrl = optionsOrProvider.baseUrl;
-            this.feederGatewayUrl =
-                (_a = optionsOrProvider.feederGatewayUrl) !== null && _a !== void 0 ? _a : (0, url_join_1.default)(this.baseUrl, 'feeder_gateway');
-            this.gatewayUrl = (_b = optionsOrProvider.gatewayUrl) !== null && _b !== void 0 ? _b : (0, url_join_1.default)(this.baseUrl, 'gateway');
+            this.feederGatewayUrl = (0, url_1.buildUrl)(this.baseUrl, 'feeder_gateway', optionsOrProvider.feederGatewayUrl);
+            this.gatewayUrl = (0, url_1.buildUrl)(this.baseUrl, 'gateway', optionsOrProvider.gatewayUrl);
             this.chainId =
-                (_c = optionsOrProvider.chainId) !== null && _c !== void 0 ? _c : SequencerProvider.getChainIdFromBaseUrl(optionsOrProvider.baseUrl);
+                (_a = optionsOrProvider.chainId) !== null && _a !== void 0 ? _a : SequencerProvider.getChainIdFromBaseUrl(optionsOrProvider.baseUrl);
         }
     }
     SequencerProvider.getNetworkFromName = function (name) {

package/dist/utils/url.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Loosely validate a URL `string`.
+ * @param {String} s
+ * @return {Boolean}
+ */
+export declare function isUrl(s?: string): boolean;
+export declare function buildUrl(baseUrl: string, defaultPath: string, urlOrPath?: string): string;

package/dist/utils/url.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildUrl = exports.isUrl = void 0;
+var url_join_1 = __importDefault(require("url-join"));
+/**
+ * Inspired from https://github.com/segmentio/is-url
+ */
+/**
+ * RegExps.
+ * A URL must match #1 and then at least one of #2/#3.
+ * Use two levels of REs to avoid REDOS.
+ */
+var protocolAndDomainRE = /^(?:\w+:)?\/\/(\S+)$/;
+var localhostDomainRE = /^localhost[:?\d]*(?:[^:?\d]\S*)?$/;
+var nonLocalhostDomainRE = /^[^\s.]+\.\S{2,}$/;
+/**
+ * Loosely validate a URL `string`.
+ * @param {String} s
+ * @return {Boolean}
+ */
+function isUrl(s) {
+    if (!s) {
+        return false;
+    }
+    if (typeof s !== 'string') {
+        return false;
+    }
+    var match = s.match(protocolAndDomainRE);
+    if (!match) {
+        return false;
+    }
+    var everythingAfterProtocol = match[1];
+    if (!everythingAfterProtocol) {
+        return false;
+    }
+    if (localhostDomainRE.test(everythingAfterProtocol) ||
+        nonLocalhostDomainRE.test(everythingAfterProtocol)) {
+        return true;
+    }
+    return false;
+}
+exports.isUrl = isUrl;
+function buildUrl(baseUrl, defaultPath, urlOrPath) {
+    return isUrl(urlOrPath) ? urlOrPath : (0, url_join_1.default)(baseUrl, urlOrPath !== null && urlOrPath !== void 0 ? urlOrPath : defaultPath);
+}
+exports.buildUrl = buildUrl;

package/index.d.ts

@@ -21,3 +21,4 @@ export * as uint256 from './utils/uint256';
 export * as shortString from './utils/shortString';
 export * as typedData from './utils/typedData';
 export * from './utils/address';
+export * from './utils/url';

package/index.js

@@ -50,3 +50,4 @@ exports.uint256 = __importStar(require("./utils/uint256"));
 exports.shortString = __importStar(require("./utils/shortString"));
 exports.typedData = __importStar(require("./utils/typedData"));
 __exportStar(require("./utils/address"), exports);
+__exportStar(require("./utils/url"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starknet",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "description": "JavaScript library for StarkNet",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/provider/sequencer.js

@@ -65,6 +65,7 @@ var number_1 = require("../utils/number");
 var provider_1 = require("../utils/provider");
 var sequencer_1 = require("../utils/responseParser/sequencer");
 var stark_1 = require("../utils/stark");
+var url_1 = require("../utils/url");
 var errors_1 = require("./errors");
 var utils_1 = require("./utils");
 function isEmptyQueryObject(obj) {
@@ -79,7 +80,7 @@ function isEmptyQueryObject(obj) {
 var SequencerProvider = /** @class */ (function () {
     function SequencerProvider(optionsOrProvider) {
         if (optionsOrProvider === void 0) { optionsOrProvider = { network: 'goerli-alpha' }; }
-        var _a, _b, _c;
+        var _a;
         this.responseParser = new sequencer_1.SequencerAPIResponseParser();
         if ('network' in optionsOrProvider) {
             this.baseUrl = SequencerProvider.getNetworkFromName(optionsOrProvider.network);
@@ -89,11 +90,10 @@ var SequencerProvider = /** @class */ (function () {
         }
         else {
             this.baseUrl = optionsOrProvider.baseUrl;
-            this.feederGatewayUrl =
-                (_a = optionsOrProvider.feederGatewayUrl) !== null && _a !== void 0 ? _a : (0, url_join_1.default)(this.baseUrl, 'feeder_gateway');
-            this.gatewayUrl = (_b = optionsOrProvider.gatewayUrl) !== null && _b !== void 0 ? _b : (0, url_join_1.default)(this.baseUrl, 'gateway');
+            this.feederGatewayUrl = (0, url_1.buildUrl)(this.baseUrl, 'feeder_gateway', optionsOrProvider.feederGatewayUrl);
+            this.gatewayUrl = (0, url_1.buildUrl)(this.baseUrl, 'gateway', optionsOrProvider.gatewayUrl);
             this.chainId =
-                (_c = optionsOrProvider.chainId) !== null && _c !== void 0 ? _c : SequencerProvider.getChainIdFromBaseUrl(optionsOrProvider.baseUrl);
+                (_a = optionsOrProvider.chainId) !== null && _a !== void 0 ? _a : SequencerProvider.getChainIdFromBaseUrl(optionsOrProvider.baseUrl);
         }
     }
     SequencerProvider.getNetworkFromName = function (name) {

package/src/index.ts

@@ -22,3 +22,4 @@ export * as uint256 from './utils/uint256';
 export * as shortString from './utils/shortString';
 export * as typedData from './utils/typedData';
 export * from './utils/address';
+export * from './utils/url';

package/src/provider/sequencer.ts

@@ -31,6 +31,7 @@ import { BigNumberish, bigNumberishArrayToDecimalStringArray, toBN, toHex } from
 import { parseContract, wait } from '../utils/provider';
 import { SequencerAPIResponseParser } from '../utils/responseParser/sequencer';
 import { randomAddress } from '../utils/stark';
+import { buildUrl } from '../utils/url';
 import { GatewayError, HttpError } from './errors';
 import { ProviderInterface } from './interface';
 import { BlockIdentifier, getFormattedBlockIdentifier } from './utils';
@@ -74,9 +75,13 @@ export class SequencerProvider implements ProviderInterface {
       this.gatewayUrl = urljoin(this.baseUrl, 'gateway');
     } else {
       this.baseUrl = optionsOrProvider.baseUrl;
-      this.feederGatewayUrl =
-        optionsOrProvider.feederGatewayUrl ?? urljoin(this.baseUrl, 'feeder_gateway');
-      this.gatewayUrl = optionsOrProvider.gatewayUrl ?? urljoin(this.baseUrl, 'gateway');
+      this.feederGatewayUrl = buildUrl(
+        this.baseUrl,
+        'feeder_gateway',
+        optionsOrProvider.feederGatewayUrl
+      );
+      this.gatewayUrl = buildUrl(this.baseUrl, 'gateway', optionsOrProvider.gatewayUrl);
+
       this.chainId =
         optionsOrProvider.chainId ??
         SequencerProvider.getChainIdFromBaseUrl(optionsOrProvider.baseUrl);

package/src/utils/url.ts

@@ -0,0 +1,53 @@
+import urljoin from 'url-join';
+
+/**
+ * Inspired from https://github.com/segmentio/is-url
+ */
+
+/**
+ * RegExps.
+ * A URL must match #1 and then at least one of #2/#3.
+ * Use two levels of REs to avoid REDOS.
+ */
+const protocolAndDomainRE = /^(?:\w+:)?\/\/(\S+)$/;
+
+const localhostDomainRE = /^localhost[:?\d]*(?:[^:?\d]\S*)?$/;
+const nonLocalhostDomainRE = /^[^\s.]+\.\S{2,}$/;
+
+/**
+ * Loosely validate a URL `string`.
+ * @param {String} s
+ * @return {Boolean}
+ */
+export function isUrl(s?: string): boolean {
+  if (!s) {
+    return false;
+  }
+
+  if (typeof s !== 'string') {
+    return false;
+  }
+
+  const match = s.match(protocolAndDomainRE);
+  if (!match) {
+    return false;
+  }
+
+  const everythingAfterProtocol = match[1];
+  if (!everythingAfterProtocol) {
+    return false;
+  }
+
+  if (
+    localhostDomainRE.test(everythingAfterProtocol) ||
+    nonLocalhostDomainRE.test(everythingAfterProtocol)
+  ) {
+    return true;
+  }
+
+  return false;
+}
+
+export function buildUrl(baseUrl: string, defaultPath: string, urlOrPath?: string) {
+  return isUrl(urlOrPath) ? urlOrPath! : urljoin(baseUrl, urlOrPath ?? defaultPath);
+}

package/utils/url.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Loosely validate a URL `string`.
+ * @param {String} s
+ * @return {Boolean}
+ */
+export declare function isUrl(s?: string): boolean;
+export declare function buildUrl(baseUrl: string, defaultPath: string, urlOrPath?: string): string;

package/utils/url.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildUrl = exports.isUrl = void 0;
+var url_join_1 = __importDefault(require("url-join"));
+/**
+ * Inspired from https://github.com/segmentio/is-url
+ */
+/**
+ * RegExps.
+ * A URL must match #1 and then at least one of #2/#3.
+ * Use two levels of REs to avoid REDOS.
+ */
+var protocolAndDomainRE = /^(?:\w+:)?\/\/(\S+)$/;
+var localhostDomainRE = /^localhost[:?\d]*(?:[^:?\d]\S*)?$/;
+var nonLocalhostDomainRE = /^[^\s.]+\.\S{2,}$/;
+/**
+ * Loosely validate a URL `string`.
+ * @param {String} s
+ * @return {Boolean}
+ */
+function isUrl(s) {
+    if (!s) {
+        return false;
+    }
+    if (typeof s !== 'string') {
+        return false;
+    }
+    var match = s.match(protocolAndDomainRE);
+    if (!match) {
+        return false;
+    }
+    var everythingAfterProtocol = match[1];
+    if (!everythingAfterProtocol) {
+        return false;
+    }
+    if (localhostDomainRE.test(everythingAfterProtocol) ||
+        nonLocalhostDomainRE.test(everythingAfterProtocol)) {
+        return true;
+    }
+    return false;
+}
+exports.isUrl = isUrl;
+function buildUrl(baseUrl, defaultPath, urlOrPath) {
+    return isUrl(urlOrPath) ? urlOrPath : (0, url_join_1.default)(baseUrl, urlOrPath !== null && urlOrPath !== void 0 ? urlOrPath : defaultPath);
+}
+exports.buildUrl = buildUrl;

package/www/docs/API/provider.md

@@ -17,19 +17,40 @@ The options for the provider depends from the network. The structure of the opti
 - options.**sequencer** - Options for sequencer provider
 - options.**rpc** - Options for RPC provider
 
-Example:
+The easiest way to get started is:
 
+```typescript
+const provider = new starknet.Provider()
 ```
+
+The above snippet creates a Starknet Provider instance with `goerli-alpha` network.
+
+However, if you want to use `mainnet-alpha` or explicitly declare the network, you can use:
+
+```typescript
 const provider = new starknet.Provider({
   sequencer: {
-    baseUrl: 'https://alpha4.starknet.io',
-    feederGatewayUrl: 'feeder_gateway',
-    gatewayUrl: 'gateway',
+    network: 'mainnet-alpha' // or 'goerli-alpha'
+  }
+ })
+```
+
+If you want to more control:
+
+```typescript
+const provider = new starknet.Provider({
+  sequencer: {
+  baseUrl: 'https://alpha4.starknet.io',
+  feederGatewayUrl: 'feeder_gateway',
+  gatewayUrl: 'gateway',
   }
 })
+
 ```
 
-**This is also default options for the constructor for the **testnet\*\*\*
+\*\*This is also default options for the Provider constructor with `network: 'goerli-alpha'`\*\*\*
+
+\*\*Note: `network` arguement should work in most cases. If you want to use sequencer arguement with `baseUrl`, you will not be able to use `network` field in the object.\*\*\*
 
 ## Methods
 
@@ -47,10 +68,12 @@ The call object structure:
 
 ###### CallContractResponse
 
-```
+```typescript
+
 {
-    result: string[];
+  result: string[];
 }
+
 ```
 
 <hr/>
@@ -61,7 +84,8 @@ Gets the block information.
 
 ###### _GetBlockResponse_
 
-```
+```typescript
+
 {
   accepted_time: number;
   block_hash: string;
@@ -75,6 +99,7 @@ Gets the block information.
   transactions: Array<string>;
   starknet_version?: string;
 }
+
 ```
 
 <hr/>
@@ -85,12 +110,14 @@ Gets the contract class of the deployed contract.
 
 ###### _ContractClass_
 
-```
+```typescript
+
 {
   program: CompressedProgram;
   entry_points_by_type: EntryPointsByType;
   abi?: Abi;
 }
+
 ```
 
 <hr/>
@@ -107,7 +134,8 @@ Gets the status of a transaction.
 
 ###### _GetTransactionReceiptResponse_
 
-```
+```typescript
+
 {
   transaction_hash: string;
   status: 'NOT_RECEIVED' | 'RECEIVED' | 'PENDING' | 'ACCEPTED_ON_L2' | 'ACCEPTED_ON_L1' | 'REJECTED';
@@ -117,6 +145,7 @@ Gets the status of a transaction.
   events?: Array<Event>;
   l1_origin_message?: MessageToL2;
 }
+
 ```
 
 <hr/>
@@ -127,7 +156,8 @@ Gets the transaction information from a tx hash.
 
 ###### _GetTransactionResponse_
 
-```
+```typescript
+
 {
   transaction_hash: string;
   version?: string;
@@ -140,6 +170,7 @@ Gets the transaction information from a tx hash.
   contract_class?: ContractClass;
   sender_address?: string;
 }
+
 ```
 
 <hr/>
@@ -150,7 +181,8 @@ Declares a contract on Starknet
 
 ###### _DeclareContractResponse_
 
-```
+```typescript
+
 {
   transaction_hash: string;
   class_hash: string;
@@ -166,11 +198,13 @@ Deploys a contract on Starknet
 
 ###### _DeployContractResponse_
 
-```
+```typescript
+
 {
   transaction_hash: string;
   contract_address?: string;
 };
+
 ```
 
 <hr/>
@@ -197,12 +231,14 @@ or
 
 Example:
 
-```
+```typescript
+
 const provider = new starknet.Provider({
   baseUrl: 'https://alpha4.starknet.io',
   feederGatewayUrl: 'feeder_gateway',
   gatewayUrl: 'gateway',
 })
+
 ```
 
 ## Methods
@@ -211,11 +247,13 @@ Gets the smart contract address on the network
 
 provider.**getContractAddresses**() => _Promise < GetContractAddressesResponse >_
 
-```
+```typescript
+
 {
   Starknet: string;
   GpsStatementVerifier: string;
 }
+
 ```
 
 <hr/>
@@ -226,7 +264,8 @@ Gets the status of a transaction.
 
 ###### _GetTransactionStatusResponse_
 
-```
+```typescript
+
 {
   tx_status: 'NOT_RECEIVED' | 'RECEIVED' | 'PENDING' | 'ACCEPTED_ON_L2' | 'ACCEPTED_ON_L1' | 'REJECTED';
   block_hash: string;
@@ -236,6 +275,7 @@ Gets the status of a transaction.
     error_message: string;
   }
 }
+
 ```
 
 <hr/>
@@ -246,7 +286,7 @@ Gets the transaction trace from a tx hash.
 
 ###### _GetTransactionTraceResponse_
 
-```
+```typescript
 {
   function_invocation: {
     caller_address: string;
@@ -254,16 +294,17 @@ Gets the transaction trace from a tx hash.
     code_address: string;
     selector: string;
     calldata: {
-        [inputName: string]: string | string[] | { type: 'struct'; [k: string]: BigNumberish };
+      [inputName: string]: string | string[] | { type: 'struct'; [k: string]: BigNumberish };
     };
     result: Array<any>;
     execution_resources: any;
     internal_call: Array<any>;
     events: Array<any>;
     messages: Array<any>;
-  };
+    };
   signature: Signature;
 }
+
 ```
 
 # RpcProvider
@@ -276,10 +317,12 @@ Gets the transaction trace from a tx hash.
 
 Example:
 
-```
+```typescript
+
 const provider = new starknet.RpcProvider({
   nodeUrl: 'URL_TO_STARKNET_RPC_NODE',
 })
+
 ```
 
 ## Methods
@@ -302,7 +345,8 @@ Gets syncing status of the node
 
 ###### GetSyncingStatsResponse
 
-```
+```typescript
+
 boolean |
 {
   starting_block_hash: string;
@@ -312,6 +356,7 @@ boolean |
   highest_block_hash: string;
   highest_block_num: string;
 }
+
 ```
 
 <hr/>
@@ -320,7 +365,8 @@ provider.**getEvents**(eventFilter) => _Promise < GetEventsResponse >_
 
 ##### EventFilter
 
-```
+```typescript
+
 type EventFilter = {
   fromBlock: string;
   toBlock: string;
@@ -329,14 +375,25 @@ type EventFilter = {
   page_size: number;
   page_number: number;
 };
+
 ```
 
 ###### GetSyncingStatsResponse
 
-```
+```typescript
+
 {
   events: StarknetEmittedEvent[];
   page_number: number;
   is_last_page: number;
 }
+
+```
+
+```
+
+```
+
+```
+
 ```