Docs #1176
Closed
Docs #1176
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
V6/v3 transactions
…ed with maxfee and bound props
- update noble-hashes to [1.3.3](https://github.com/paulmillr/noble-hashes/releases/tag/1.3.3) - update noble-curves to [1.3.0](https://github.com/paulmillr/noble-curves/releases/tag/1.3.0)
…removed seqeuncer api
Co-authored-by: Petar Penović <penovicp@gmail.com>
Update noble and scure deps
# [6.0.0-beta.7](v6.0.0-beta.6...v6.0.0-beta.7) (2023-12-14) ### Bug Fixes * provider rpc 0.5-0.6 getTransactionReceipt response standardization ([76b6ab4](76b6ab4)) ### Features * curves ([405de46](405de46)) * **provider:** fix and clean provider response and response parser, removed seqeuncer api ([7ecb069](7ecb069)) * **provider:** pending response discrimination, pending type guards ([013a22b](013a22b))
feat: sepolia
# [5.25.0](v5.24.5...v5.25.0) (2023-12-18) ### Features * sepolia ([26d7044](26d7044))
* feat: provider.getL1MessageHash * docs: add JSDOC example * fix: remaining conflicts
* test: Improve tests performance (#1121) * test: fix transaction retry interval fallback for devnet tests * test: remove test.only * Update _test.yml (#1126) * fix: rename the @param to match the definitions this commit changes the typedoc that do not match the function declaration * fix: add a space before typedoc <br/> so that it catches the name when a @param contains an html tag, it should not be attached to the parameter name otherwise it does consider the tag is part of the name. This commit detaches the name from the tag * fix: improve function declaration so that typedoc matches it this is a specific case when a function has several declarations and the first one does not match the typedoc because the parameter is optional. This commit simplifies the declaration by making the comment optional with a ?. * fix: reintroduce the parameter name change the declaration of a function so that the parameter name appears. To do so it moves the assignement in the function. * fix: remove unused type declaration and export removes a declaration from account that is not used in the code and redundant with the exact same one in the provider file. export the declaration that is the one really used. --------- Co-authored-by: Luka Saric <32763694+lukasaric@users.noreply.github.com> Co-authored-by: Ivan Pavičić <ivan.pavicic@live.com>
Next version
# [6.9.0](v6.8.0...v6.9.0) (2024-05-21) ### Bug Fixes * cannot infer ts2742 types from starknet-types@0.7 ([#1098](#1098)) ([f1c3b8e](f1c3b8e)) * remove [warning] from typedoc for external usage ([#1095](#1095)) ([195186f](195186f)), closes [#1121](#1121) [#1126](#1126) ### Features * add type coverage ([#1120](#1120)) ([eceda5d](eceda5d)) * provider.getL1MessageHash ([#1123](#1123)) ([1489cf2](1489cf2)) ### Reverts * Revert "chore: add examples to JsDoc for transaction.ts file (#1105)" (#1108) ([59eb01e](59eb01e)), closes [#1105](#1105) [#1108](#1108)
* test: add coverage option (#1131) * test: add coverage option * docs: add coverage of a single file * feat: add coverage in automatic test suite * fix: add 'run' to npm test coverage script * docs: jsdoc adds (#1133) * docs: jsdoc for utils-provider and utils-classHash * docs: add jsdoc in utils- stark and starknetid * docs: add jsdoc to utils-shortstring, transaction, uint256 * docs: add jsdoc for signer interface * docs: add @return for class getters * Chore/replace enums with companion pattern approach (#1083) * test: test setup refactor & remove rpc sequencer * fix: enable sequencer tests to run on goerli * chore: format markdowns * fix: remove unnecessary goerli describeIf comment * chore: remove setup verifier & simplify envs check logic * test: naming improvements * test: update test setup data log for testnet * test: change from goerli to sepolia * test: rename from rpc testnet to testnet * test: remove `TEST_PROVIDER_BASE_URL` * chore: replace enums with companion pattern * chore: convert caior option & result enums to consts * chore: add `ValuesType<T>` type helper * test: Improve tests performance (#1121) * test: fix transaction retry interval fallback for devnet tests * test: remove test.only * chore: revert from describeIfNot to describeIf * Update _test.yml (#1126) * chore(release): 6.9.0 [skip ci] # [6.9.0](v6.8.0...v6.9.0) (2024-05-21) ### Bug Fixes * cannot infer ts2742 types from starknet-types@0.7 ([#1098](#1098)) ([f1c3b8e](f1c3b8e)) * remove [warning] from typedoc for external usage ([#1095](#1095)) ([195186f](195186f)), closes [#1121](#1121) [#1126](#1126) ### Features * add type coverage ([#1120](#1120)) ([eceda5d](eceda5d)) * provider.getL1MessageHash ([#1123](#1123)) ([1489cf2](1489cf2)) ### Reverts * Revert "chore: add examples to JsDoc for transaction.ts file (#1105)" (#1108) ([59eb01e](59eb01e)), closes [#1105](#1105) [#1108](#1108) * fix: use proper constants --------- Co-authored-by: Luka Saric <luka.saric@scayle.com> Co-authored-by: Ivan Pavičić <ivan.pavicic@live.com> Co-authored-by: Toni Tabak <tabaktoni@gmail.com> Co-authored-by: semantic-release-bot <semantic-release-bot@martynus.net> * refactor: remove functions useful for deprecated sequencer * refactor: starknetid contracts on sepolia & remove old code (#1139) * test: update starknetid naming mock contract * fix: update starknetId contract addresses on sepolia * refactor: remove unused code from getStarkName & getStarkProfile * docs: update starknetId utils example results * test: fix getStarknetIdContract test on sepolia * fix: remove default from computeHintedClassHash to be able to export (#1142) * fix: remove default from classhash/computeHintedClassHash to be able to export * test: add test for computeHintedClassHash * docs: utils/num docs (#1132) * docs: added jsdocs to utils/num functions * docs: extracted existing util/num tests to a separate file, added tests * chore: num docs small fixes and refactoring * Update src/utils/num.ts --------- Co-authored-by: Ivan Pavičić <ivan.pavicic@live.com> * docs: updated verious util function docs, added tests, refactoring (#1129) * docs: updated verious util function docs, added tests, refactoring * docs: json util jsdocs improvements * chore: typo quickfix * chore: added missing results to jsdoc examples * chore: removed jsdoc from non-exported helper function * chore: utils/json docs fixes and refactoring * fix: export abi types * clanup * fix: types-js (#1147) * fix: types-js * chore: fix upp * Dep/types js (#1153) * fix: types-js * chore: fix upp * fix: types 0.0.7 * docs: merkle and selector docs/tests (#1152) * docs: added docs for merkle and selector utils, moved selector to hash, added happy path tests * chore: added example tag to jsdoc * chore: remove obsolete folder (#1149) * test: Improve tests performance (#1121) * test: fix transaction retry interval fallback for devnet tests * test: remove test.only * Update _test.yml (#1126) * chore(release): 6.9.0 [skip ci] # [6.9.0](v6.8.0...v6.9.0) (2024-05-21) ### Bug Fixes * cannot infer ts2742 types from starknet-types@0.7 ([#1098](#1098)) ([f1c3b8e](f1c3b8e)) * remove [warning] from typedoc for external usage ([#1095](#1095)) ([195186f](195186f)), closes [#1121](#1121) [#1126](#1126) ### Features * add type coverage ([#1120](#1120)) ([eceda5d](eceda5d)) * provider.getL1MessageHash ([#1123](#1123)) ([1489cf2](1489cf2)) ### Reverts * Revert "chore: add examples to JsDoc for transaction.ts file (#1105)" (#1108) ([59eb01e](59eb01e)), closes [#1105](#1105) [#1108](#1108) * Update amm.js * chore: remove obsolete folder --------- Co-authored-by: Luka Saric <32763694+lukasaric@users.noreply.github.com> Co-authored-by: Ivan Pavičić <ivan.pavicic@live.com> Co-authored-by: Toni Tabak <tabaktoni@gmail.com> Co-authored-by: semantic-release-bot <semantic-release-bot@martynus.net> * Fix: public responseParser (#1154) * fix: enable instance parser change * Update __tests__/rpcProvider.test.ts Co-authored-by: Petar Penović <pp@spaceshard.io> * fix: export ResponseParser and RPCResponseParser * chore: noob --------- Co-authored-by: Petar Penović <pp@spaceshard.io> * BUG: Nested events not handled (#1140) * test: eth signer * test: move secp256k1Point tests in a dedicated test file * feat: helper for transaction receipt * simplify extends for account class * feat: handling of cairo u512 type * refactor: change name of variable : GetTxReceiptResponseWithoutHelper * fix: double lines for same imports * fix: solve an error in validate.ts initiated by pr 1007 * fix: correction of a word in guide * docs: validateChecksumAddress * fix: jsdoc correction * docs: add tsdoc in utils/address.ts * test: add extra fees * fix: estimateFeeBulk include skipValidate in accountInvocationsFactory * feat: add type guard to receipt response status methods * fix: repair i128 typed data encoding and add typed data range checks * chore: update left over StarkNet casing * feat: bundle resolution, module, type import for walletacc * feat: bundle resolution, module, type import for walletaccount * chore: fix connect import * chore: add get-starknet-core next as dependencie * chore: import fix * fix: estimateMessageFee - eth address format (#1040) * fix: estimatemessagefee eth address format * fix: implement requests * docs: small guides cleanup (#1048) * docs: fix nodeUrl code typo (#1046) * docs: small guides cleanup --------- Co-authored-by: Joel Mun <hj923@hotmail.com> * fix(RpcProvider): allow client to provide `specVersion` in 0.7 provider this saves an extra call on RPC for optionally-known information (like the `chainId` case). also fixed speck -> spec typo * fix: remove abis parameter from signer and account execute * feat: configure u512 and Secp256k1Point for abiwan * chore: bump dependencies * chore: expose data gas consumed and data gas price for 0.7 rpc * test: Improve tests performance (#1121) * test: fix transaction retry interval fallback for devnet tests * test: remove test.only * Update _test.yml (#1126) * chore(release): 6.9.0 [skip ci] # [6.9.0](v6.8.0...v6.9.0) (2024-05-21) ### Bug Fixes * cannot infer ts2742 types from starknet-types@0.7 ([#1098](#1098)) ([f1c3b8e](f1c3b8e)) * remove [warning] from typedoc for external usage ([#1095](#1095)) ([195186f](195186f)), closes [#1121](#1121) [#1126](#1126) ### Features * add type coverage ([#1120](#1120)) ([eceda5d](eceda5d)) * provider.getL1MessageHash ([#1123](#1123)) ([1489cf2](1489cf2)) ### Reverts * Revert "chore: add examples to JsDoc for transaction.ts file (#1105)" (#1108) ([59eb01e](59eb01e)), closes [#1105](#1105) [#1108](#1108) * fix: handling of events nested in Cairo components * fix: change names of events in tests * refactor: change type names * test: adapt parseUDCEvent to events namespace * refactor: implement reviewer requests * refactor: add spec6 types * Revert "Merge branch 'next-version' into nested-events" This reverts commit 4c65e9b, reversing changes made to 7702d9c. * fix: remove events.ts that came back after merge * refactor: use of external types-js lib for events types --------- Co-authored-by: gregory <10611760+gregoryguillou@users.noreply.github.com> Co-authored-by: Toni Tabak <tabaktoni@gmail.com> Co-authored-by: ivpavici <ivan.pavicic@live.com> Co-authored-by: Petar Penovic <pp@spaceshard.io> Co-authored-by: Joel Mun <hj923@hotmail.com> Co-authored-by: Abraham Makovetsky <avimak@gmail.com> Co-authored-by: Haroune Mohammedi <haroune.mohammedi@quadratic-labs.com> Co-authored-by: Dhruv Kelawala <dhruvrk2000@gmail.com> Co-authored-by: Luka Saric <32763694+lukasaric@users.noreply.github.com> Co-authored-by: semantic-release-bot <semantic-release-bot@martynus.net> * feat: add handling of nonZero type (#1150) * Guide for wallet account (#1156) * docs: walletAccount guide * fix: add all Ivan's proposals, except one --------- Co-authored-by: Philippe ROSTAN <81040730+PhilippeR26@users.noreply.github.com> Co-authored-by: Luka Saric <32763694+lukasaric@users.noreply.github.com> Co-authored-by: Luka Saric <luka.saric@scayle.com> Co-authored-by: Ivan Pavičić <ivan.pavicic@live.com> Co-authored-by: semantic-release-bot <semantic-release-bot@martynus.net> Co-authored-by: PhilippeR26 <philippe.rostan@yahoo.fr> Co-authored-by: Iris <iris.devillars@gmail.com> Co-authored-by: dsperac <dsperac@gmail.com> Co-authored-by: alex <152680487+bodhi-crypo@users.noreply.github.com> Co-authored-by: Petar Penović <pp@spaceshard.io> Co-authored-by: gregory <10611760+gregoryguillou@users.noreply.github.com> Co-authored-by: Joel Mun <hj923@hotmail.com> Co-authored-by: Abraham Makovetsky <avimak@gmail.com> Co-authored-by: Haroune Mohammedi <haroune.mohammedi@quadratic-labs.com> Co-authored-by: Dhruv Kelawala <dhruvrk2000@gmail.com>
# [6.10.0](v6.9.0...v6.10.0) (2024-06-18) ### Features * next-version ([1687dd2](1687dd2))
* feat: install unbuild * chore: update tsup config * chore: update eslint config * feat: add build.config.ts * fix: new lock --------- Co-authored-by: Toni Tabak <tabaktoni@gmail.com>
## [6.10.1](v6.10.0...v6.10.1) (2024-06-28) ### Bug Fixes * change build cjs and mjs to unbuild ([#1163](#1163)) ([bb4a93d](bb4a93d))
## [6.10.2](v6.10.1...v6.10.2) (2024-07-02) ### Bug Fixes * revert enums partially & tsup build ([#1165](#1165)) ([57b2c72](57b2c72))
Main to develop
# [7.0.0](v6.11.0...v7.0.0) (2024-07-03) ### Bug Fixes * acc deploy_acc ([732cd94](732cd94)) * adjust max amount bound calculation for RPC v0.7.0 ([dd34cdb](dd34cdb)) * apply bound for contract address from hash calculation ([6d8c291](6d8c291)) * **beta:** deploy account ([#880](#880)) ([00c58e3](00c58e3)) * byteArray encoding for less than 31 chars ([#1011](#1011)) ([653acc4](653acc4)) * **Calldata.compile:** do not split long `entrypoint` names before calling `getSelectorFromName` ([89715da](89715da)) * **Calldata.compile:** do not split long `entrypoint` names before calling `getSelectorFromName` ([9434bcd](9434bcd)) * cannot infer ts2742 types from starknet-types@0.7 ([#1098](#1098)) ([f1c3b8e](f1c3b8e)) * change build cjs and mjs to unbuild ([#1163](#1163)) ([bb4a93d](bb4a93d)) * drop abi-wan-kanabi-v1 support ([30a4681](30a4681)) * estimateFeeBulk provided version ([da717be](da717be)) * expand encoding type for preset types ([b992446](b992446)) * move abiwan from dev dependencies to regular dependencies ([#925](#925)) ([6b7ee49](6b7ee49)) * next version ([#1024](#1024)) ([07d4a26](07d4a26)) * prioritize error states in waitForTransaction evaluation ([ac54404](ac54404)) * provider rpc 0.5-0.6 getTransactionReceipt response standardization ([76b6ab4](76b6ab4)) * remove [warning] from typedoc for external usage ([#1095](#1095)) ([195186f](195186f)), closes [#1121](#1121) [#1126](#1126) * remove account_deployment_data from deploy Account ([ede83bf](ede83bf)) * repair Cairo 1 nested and enum tuple handling ([ce2e541](ce2e541)) * revert enums partially & tsup build ([#1165](#1165)) ([57b2c72](57b2c72)) * rpc event ([ae3e265](ae3e265)) * **RpcChannel:** allow client to provide `specVersion` ([ae8cf8e](ae8cf8e)) * second option bump semantic release to 0.5 ([c90f9b2](c90f9b2)) * solve wrong response for account.verifyMessage ([05f4095](05f4095)) * starkne types 0.7 ([#1087](#1087)) ([b038c76](b038c76)) * test ci fix ([3a6c924](3a6c924)) * throw on negative param cairo.uint256 and bnToUint256 ([e1ead14](e1ead14)) * tslib ([#1068](#1068)) ([dd7dc10](dd7dc10)) * typos ([#862](#862)) ([b2431d3](b2431d3)) * update fetch-cookie dependency ([518330c](518330c)) * update starknetid sepolia contract addresses ([#1016](#1016)) ([b50a3bd](b50a3bd)) * update to latest get-starknet dev ([017702f](017702f)) * utilize provided resourceBounds value ([65bea53](65bea53)) * **utils:** fix block identifier ([#1076](#1076)) ([0a3499d](0a3499d)) * wallet circular dependency fix ([621ae2d](621ae2d)) ### Features * abi-wan trigger ([c10150a](c10150a)) * abiwan v2 intergation ([87d15d3](87d15d3)) * account preferred transaction version, setup v3 ([5652eb2](5652eb2)) * add getGasPrice rpc provider method ([#1056](#1056)) ([d396275](d396275)) * add provider.decodeParameters ([39595f3](39595f3)) * add provider.decodeParameters ([be6eec9](be6eec9)) * add string types of cairo v2.4.0 ([a8a73c1](a8a73c1)) * add type coverage ([#1120](#1120)) ([eceda5d](eceda5d)) * curves ([405de46](405de46)) * def rpc 0_6, sepolia nodes ([4f59a8f](4f59a8f)) * default account UniversalDetails, rpc spec update, update interface ([8dc9b8a](8dc9b8a)) * dual specification with 0.6 implementation, not yet integrated ([ac8c763](ac8c763)) * enable cairo 2.6.0 contract declaration ([0104c59](0104c59)) * ethereum signer ([8473adb](8473adb)) * ethereum-signer ([f37bfb2](f37bfb2)) * expand structured data hashing in line with SNIP-12 ([#920](#920)) ([cb20590](cb20590)) * Export function parseCalldataField() ([4d59658](4d59658)) * get-starknet-core repacked for mjs, and initial implementation ([ab7fa19](ab7fa19)) * hashes, signer, vip account, types, versions as string enum ([6ceb9e3](6ceb9e3)) * implement RPC v0.7.0-rc2 specification ([de32936](de32936)) * make Abi and CONTRACT_ABI types compatible with abiwan ([9007816](9007816)) * make fee margins configurable ([cedd984](cedd984)) * new CairoUint256 cairo datatype model ([b64abcc](b64abcc)) * next-version ([1687dd2](1687dd2)) * pretty print rpc LibraryError params, make env.DEBUG usefull ([cca723f](cca723f)) * provider.getL1MessageHash ([#1123](#1123)) ([1489cf2](1489cf2)) * **provider:** fix and clean provider response and response parser, removed seqeuncer api ([7ecb069](7ecb069)) * **provider:** pending response discrimination, pending type guards ([013a22b](013a22b)) * readme & trigger release ([5341c42](5341c42)) * remove old version constants, default types api rpc ([ed9cb08](ed9cb08)) * replace in verifyMessage : response by Error ([1abf91f](1abf91f)) * req id counter ([cedd1ea](cedd1ea)) * rpc 0.6 implementation as superset of 0.5 tx ([5b2b299](5b2b299)) * rpc 0.6.0-rc3 implementation ([c2607ed](c2607ed)) * rpc 0.7.1 ([#1071](#1071)) ([11dc600](11dc600)) * rpc provider ([0d9c2e5](0d9c2e5)) * rpcChannel ([181eea3](181eea3)) * sepolia ([26d7044](26d7044)) * sepolia constants, rpc open change ([6de46b5](6de46b5)) * simulate skip validate by default, spec deploy acc fix ([1b3e7ae](1b3e7ae)) * skip signatures when skipValidate is true ([6f784ea](6f784ea)) * the WalletAccount handle changed channel ([73603e1](73603e1)) * trigger release ([fbf983f](fbf983f)) * update default rpc nodes and version ([9b9fe0e](9b9fe0e)) * update starknetId class and add getStarkProfile function ([ae71c97](ae71c97)) * update verson ([5dfe445](5dfe445)) * use fetch-cookie package for cookie based sticky sessions ([5a56485](5a56485)) * v3 transaction hashes ([4fe40a1](4fe40a1)) * v3 tx hashes calculation ([f0e760d](f0e760d)) * v3 wip with est ([b95c462](b95c462)) * wallet deploy contract and patches ([dbf53b6](dbf53b6)) * walletAccount extract methods and update new ones ([0dfb5db](0dfb5db)) ### Reverts * Revert "chore: add examples to JsDoc for transaction.ts file ([#1105](#1105))" ([#1108](#1108)) ([59eb01e](59eb01e)) ### BREAKING CHANGES * v3 transactions
CI documentation version
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Resolution
...
RPC version (if applicable)
...
Usage related changes
Development related changes
Checklist: