starknet 2.9.0 → 3.2.0

package/.eslintrc

@@ -18,7 +18,9 @@
   },
   "plugins": ["@typescript-eslint"],
   "rules": {
+    "class-methods-use-this": 0,
     "import/prefer-default-export": 0,
-    "@typescript-eslint/naming-convention": 0
+    "@typescript-eslint/naming-convention": 0,
+    "@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_" }]
   }
 }

package/CHANGELOG.md

@@ -1,3 +1,47 @@
+# [3.2.0](https://github.com/seanjameshan/starknet.js/compare/v3.1.0...v3.2.0) (2022-03-04)
+
+### Features
+
+- **account:** initial multicall support ([e2e3d61](https://github.com/seanjameshan/starknet.js/commit/e2e3d61dcc5377c2a6603f4740d4420be7a719e1))
+- **signer:** always return string signatures ([0e9dd6c](https://github.com/seanjameshan/starknet.js/commit/0e9dd6c1c35aac6ad3eb3cc2ebb6212e0f5f809a))
+
+# [3.1.0](https://github.com/seanjameshan/starknet.js/compare/v3.0.0...v3.1.0) (2022-02-22)
+
+### Bug Fixes
+
+- **test:** adding tests for type transferormation ([60d5eb6](https://github.com/seanjameshan/starknet.js/commit/60d5eb614721543be7fbaa842e8872a70564ebb2))
+- **tests:** adding multicall contract ([138b29d](https://github.com/seanjameshan/starknet.js/commit/138b29d60cbc1eae6fa8f6f7dbf232bc11975e9a))
+
+### Features
+
+- **contract:** adding jsDocs to the contract class ([d9ec6d3](https://github.com/seanjameshan/starknet.js/commit/d9ec6d3ea3cc0dbf3538fb2fe7b5e1d8a8831490))
+- **contract:** adding parse request data on call and invoke ([e6d46dc](https://github.com/seanjameshan/starknet.js/commit/e6d46dc39f8d7da6ed1bef2c5074377402810eb9))
+- **contract:** parsing response from the contract call ([3f7425f](https://github.com/seanjameshan/starknet.js/commit/3f7425ff0ac29dda2a7c9373856a4aa20002af9b))
+
+# [3.0.0](https://github.com/seanjameshan/starknet.js/compare/v2.9.0...v3.0.0) (2022-02-10)
+
+### Bug Fixes
+
+- **account:** dont allow additional signatures in execute ([ac02d46](https://github.com/seanjameshan/starknet.js/commit/ac02d46c5759904886f56a7b9e7e2686dbf52d4c))
+- comments ([f261120](https://github.com/seanjameshan/starknet.js/commit/f261120e1971710cde8f95bd17a5869860db8160))
+- review comments ([ee93bd6](https://github.com/seanjameshan/starknet.js/commit/ee93bd6e51eabcf3507a77d21c5bdc6fe93d5d1c))
+- **test:** remove only for getTransactionReceipt test ([eb11d3b](https://github.com/seanjameshan/starknet.js/commit/eb11d3b60f434f81390f4d13c0462ad8c7ed7321))
+- **types:** change type of `block_number` from `number` to `BlockNumber` in TransactionReceipt ([7a48ff8](https://github.com/seanjameshan/starknet.js/commit/7a48ff8e15a93a778fec62fdff10f92b1a073dec))
+- **types:** update TransactionReceipt type ([9f9f6a2](https://github.com/seanjameshan/starknet.js/commit/9f9f6a2f4cf3b8bfb438edda06ec38bd1471c03d))
+
+### Features
+
+- **account:** introduce execute method ([0be78c6](https://github.com/seanjameshan/starknet.js/commit/0be78c67a40d0b457c571a57a8b49008f5e423de))
+- **contract:** add an option to pass block identifier ([e34dd86](https://github.com/seanjameshan/starknet.js/commit/e34dd86c07495b7b8c38ee410838e15226a7b8d6))
+- new signer and provider interface ([4b2a71c](https://github.com/seanjameshan/starknet.js/commit/4b2a71c578e363b11abb1c3adb74472bbb9f73fe))
+- **provider:** add getTransactionReceipt() ([4267a5f](https://github.com/seanjameshan/starknet.js/commit/4267a5f5cec77bb4b09b2e8b4979ec0ee611d416))
+- split account and signer ([ca4ad9d](https://github.com/seanjameshan/starknet.js/commit/ca4ad9d62aee8b0637096eb3059e96dd4407f663))
+- update readme ([ed021dc](https://github.com/seanjameshan/starknet.js/commit/ed021dc25a394affec8ea92ed79eed4c68a040d8))
+
+### BREAKING CHANGES
+
+- new provider and signer interfaces
+
 # [2.9.0](https://github.com/seanjameshan/starknet.js/compare/v2.8.0...v2.9.0) (2022-02-04)
 
 ### Bug Fixes

package/README.md

@@ -40,6 +40,8 @@ Install starknet with `npm`
 
 ```bash
 $ npm install starknet
+# or
+$ npm install starknet@next
 ```
 
 Import `starknet` and use the [API](https://www.starknetjs.com/modules.html)
@@ -54,16 +56,18 @@ const CONTRACT_ADDRESS =
   "0x03e19baa6cb2078631bcdb34844f3f7879449a544c9ce722681a54af08cff4b9";
 
 /**
- * addTransaction() example
+ * invokeFunction() example
 **/
 
 /** Reset the liquidity pool **/
-const addTokenResponse = await defaultProvider.addTransaction({
-  type: "INVOKE_FUNCTION",
-  contract_address: CONTRACT_ADDRESS,
-  entry_point_selector: getSelectorFromName("init_pool"),
-  calldata: ["1000000", "1000000"],
-});
+const addTokenResponse = await defaultProvider.invokeFunction(
+  {
+    contractAddress: CONTRACT_ADDRESS,
+    entrypoint: "init_pool",
+    calldata: ["1000000", "1000000"],
+  },
+  abi // for displaying purposes only (default implementation has no display/ui)
+);
 console.log(addTokenResponse);
 
 /**
@@ -72,8 +76,8 @@ console.log(addTokenResponse);
 
 /** Get the balance of the liquidity pool of token A **/
 const poolBalanceTokenA = await defaultProvider.callContract({
-  contract_address: CONTRACT_ADDRESS,
-  entry_point_selector: getSelectorFromName("get_pool_token_balance"),
+  contractAddress: CONTRACT_ADDRESS,
+  entrypoint: "get_pool_token_balance",
   calldata: ["1"],
 });
 const balanceA = poolBalanceTokenA.result[0];
@@ -81,16 +85,14 @@ console.log('token a liquidity pool balance: ', parseInt(balanceA, 16));
 
 /** Get the balance of the liquidity pool of token B **/
 const poolBalanceTokenB = await defaultProvider.callContract({
-  contract_address: CONTRACT_ADDRESS,
-  entry_point_selector: getSelectorFromName("get_pool_token_balance"),
+  contractAddress: CONTRACT_ADDRESS,
+  entrypoint: "get_pool_token_balance",
   calldata: ["2"],
 });
 const balanceB = poolBalanceTokenB.result[0];
 console.log('token b liquidity pool balance: ', parseInt(balanceB, 16));
 ```
 
-For more information about **signing transactions**, please take a look at this [pull request](https://github.com/seanjameshan/starknet.js/pull/51)
-
 ## 🌐 API
 
 [Click Here](https://www.starknetjs.com/modules.html)
@@ -113,6 +115,6 @@ This library would not be possible without these rockstars.
 
 ## 📜 License
 
-Copyright (c) 2021 Sean James Han
+Copyright (c) 2022 0xs34n
 
 Licensed under the [MIT license](https://github.com/seanjameshan/starknet.js/blob/main/LICENSE).