starknet 3.8.0 → 3.10.1

package/CHANGELOG.md

@@ -1,3 +1,38 @@
+## [3.10.1](https://github.com/seanjameshan/starknet.js/compare/v3.10.0...v3.10.1) (2022-04-20)
+
+### Bug Fixes
+
+- **account:** function documentation fix ([34a9779](https://github.com/seanjameshan/starknet.js/commit/34a977953c2bfea53f9cd1157809919b1dd2ed04))
+- **contractFactory:** wrong prop type ([598bcd0](https://github.com/seanjameshan/starknet.js/commit/598bcd0d589c00e2219522d4a342316598678d4e))
+- **contract:** recursion function name fix ([803b6dc](https://github.com/seanjameshan/starknet.js/commit/803b6dcf5cad5cdfd8258a53e176bcd96300cef3))
+- typings ([1fadf41](https://github.com/seanjameshan/starknet.js/commit/1fadf418b04d96ced8d994b35699f40be9a8c898))
+- **utils:** adding transaction utils to the utils export ([6429179](https://github.com/seanjameshan/starknet.js/commit/642917922a5d5278e8c575a2b4ffd60fff53cf42))
+
+# [3.10.0](https://github.com/seanjameshan/starknet.js/compare/v3.9.0...v3.10.0) (2022-04-20)
+
+### Bug Fixes
+
+- new snapshot for browser test ([3394f11](https://github.com/seanjameshan/starknet.js/commit/3394f1110c715826cbc7c3dff1bef1a5b73e80d8))
+- review ([49b04e2](https://github.com/seanjameshan/starknet.js/commit/49b04e231418ca7d26dc78843a905541985aa176))
+
+### Features
+
+- **account:** new hash formula ([ea4df2c](https://github.com/seanjameshan/starknet.js/commit/ea4df2c77e6559f9689eaca3c57edbbb9324073a))
+
+# [3.9.0](https://github.com/seanjameshan/starknet.js/compare/v3.8.0...v3.9.0) (2022-04-08)
+
+### Bug Fixes
+
+- **account:** adding overhead on estimateFee for maxFee ([ec52f61](https://github.com/seanjameshan/starknet.js/commit/ec52f61aed9a8755491a4b7de73517b075785479))
+- **contract:** override object when invoking a function ([c605151](https://github.com/seanjameshan/starknet.js/commit/c605151c03b544bf62ff9ab2e314e49de3cd562a))
+- estimatedFeeToMaxFee with integers only ([71d19a7](https://github.com/seanjameshan/starknet.js/commit/71d19a7db01630ca0dba55011ff440243d7db992))
+- rename txVersion to version ([2ae36b2](https://github.com/seanjameshan/starknet.js/commit/2ae36b2c075dbee4710abe47770af35478ceba4e))
+- **utils:** remove check for the BN ([50a7951](https://github.com/seanjameshan/starknet.js/commit/50a79514343e303c397358efdba978fec5f93f48))
+
+### Features
+
+- **account:** adding new transaction version for fee estimation ([2f7cb3f](https://github.com/seanjameshan/starknet.js/commit/2f7cb3fe85c973bcff3e39db333a9ed969c550b1))
+
 # [3.8.0](https://github.com/seanjameshan/starknet.js/compare/v3.7.0...v3.8.0) (2022-04-04)
 
 ### Bug Fixes

package/README.md

@@ -40,62 +40,19 @@ Install starknet with `npm`
 
 ```bash
 $ npm install starknet
-# or
+# or for pre-release features:
 $ npm install starknet@next
 ```
 
-Import `starknet` and use the [API](https://www.starknetjs.com/modules.html)
-
-The following code is used to build a [simple AMM example](https://starkfin.netlify.app/) from the [cairo docs](https://www.cairo-lang.org/docs/hello_starknet/amm.html)
-
-```javascript
-import { defaultProvider, stark } from 'starknet';
-const { getSelectorFromName } = stark;
-
-const CONTRACT_ADDRESS =
-  "0x03e19baa6cb2078631bcdb34844f3f7879449a544c9ce722681a54af08cff4b9";
-
-/**
- * invokeFunction() example
-**/
-
-/** Reset the liquidity pool **/
-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);
-
-/**
- * callContract() example
-**/
-
-/** Get the balance of the liquidity pool of token A **/
-const poolBalanceTokenA = await defaultProvider.callContract({
-  contractAddress: CONTRACT_ADDRESS,
-  entrypoint: "get_pool_token_balance",
-  calldata: ["1"],
-});
-const balanceA = poolBalanceTokenA.result[0];
-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({
-  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));
-```
+Import `starknet` and use the [API](https://www.starknetjs.com/docs/API/)
+
+Please refer to the following code example [here](https://github.com/0xs34n/starknet.js-workshop/blob/main/index.js)
+
+Guides can be found [here](https://www.starknetjs.com/guides/intro)
 
 ## 🌐 API
 
-[Click Here](https://www.starknetjs.com/modules.html)
+[Click Here](https://www.starknetjs.com/docs/API/)
 
 ## 🚀 Powered by Starknet.js
 
@@ -105,11 +62,19 @@ console.log('token b liquidity pool balance: ', parseInt(balanceB, 16));
 
 ## ✏️ Contributing
 
-If you consider to contribute to this project please read [CONTRIBUTING.md](https://github.com/seanjameshan/starknet.js/blob/main/CONTRIBUTING.md) first.
+If you consider to contribute to this project please read [CONTRIBUTING.md](https://github.com/0xs34n/starknet.js/blob/main/CONTRIBUTING.md) first.
 
 ## ❤️ Special Thanks
 
-Special thanks to all the [contributors](https://github.com/seanjameshan/starknet.js/graphs/contributors), especially to Janek ([@janek26](https://github.com/janek26)) from [Argent](https://github.com/argentlabs) for driving the development of Starknet.js.
+Special thanks to all the [contributors](https://github.com/0xs34n/starknet.js/graphs/contributors), especially to:
+
+Janek ([@janek26](https://github.com/janek26)) and Axel ([@delaaxe](https://github.com/delaaxe)) from [Argent](https://github.com/argentlabs)
+
+Miljan ([@MilGard91](https://github.com/MilGard91)) from [Shard Labs](https://shardlabs.io/)
+
+Dhruv ([@dhruvkelawala](https://github.com/dhruvkelawala)) from [Jedi Swap](https://twitter.com/jediswap)
+
+and of course the [StarkWare](https://starkware.co/) team for their dedicated support!
 
 This library would not be possible without these rockstars.
 
@@ -117,4 +82,4 @@ This library would not be possible without these rockstars.
 
 Copyright (c) 2022 0xs34n
 
-Licensed under the [MIT license](https://github.com/seanjameshan/starknet.js/blob/main/LICENSE).
+Licensed under the [MIT license](https://github.com/0xs34n/starknet.js/blob/main/LICENSE).