docs: add example to provider.ts in utils #1114

vibenedict · 2024-05-01T22:22:11Z

Motivation and Resolution

Closes #1090
...

RPC version (if applicable)

...

Usage related changes

Change 1.
...

Development related changes

Change 1.
...

Checklist:

Performed a self-review of the code
Rebased to the last commit of the target branch (or merged it into my branch)
Linked the issues which this PR resolves
Documented the changes in code (API docs will be generated automatically)
Updated the tests
All tests are passing

Next version

# [6.8.0](starknet-io/starknet.js@v6.7.0...v6.8.0) (2024-04-23) ### Bug Fixes * starkne types 0.7 ([starknet-io#1087](starknet-io#1087)) ([b038c76](starknet-io@b038c76)) * tslib ([starknet-io#1068](starknet-io#1068)) ([dd7dc10](starknet-io@dd7dc10)) * **utils:** fix block identifier ([starknet-io#1076](starknet-io#1076)) ([0a3499d](starknet-io@0a3499d)) ### Features * add getGasPrice rpc provider method ([starknet-io#1056](starknet-io#1056)) ([d396275](starknet-io@d396275)) * Export function parseCalldataField() ([4d59658](starknet-io@4d59658)) * rpc 0.7.1 ([starknet-io#1071](starknet-io#1071)) ([11dc600](starknet-io@11dc600))

ivpavici · 2024-05-02T12:41:19Z

also, please locally retarget to next-version to resolve conflicts 🙏

vibenedict · 2024-05-02T18:42:18Z

Done

ivpavici · 2024-05-03T09:47:40Z

@vibenedict thanks for resolving conflicts, but my previous comment is not yet addressed, regarding adding missing @param on all functions?

PhilippeR26

As explained in Telegram https://t.me/c/2066195975/59 ,
please follow very rigorously the template of this PR #1100, especially for the examples : result always in a result variable, result displayed in a comment (//);

vibenedict · 2024-05-13T15:39:40Z

@ivpavici @PhilippeR26

ivpavici · 2024-05-14T12:01:50Z

src/utils/provider.ts

@@ -51,6 +76,25 @@ export function createSierraContractClass(contract: CompiledSierra): SierraContr
 * Create Contract Class from a given CompiledContract or string
 *
 * (CompiledContract or string) -> ContractClass
+ * 
+ * @param {CompiledContract | string} contract - Compiled contract or string
+ * 


missing returns

ivpavici · 2024-05-14T12:01:55Z

src/utils/provider.ts

@@ -37,6 +43,25 @@ export function wait(delay: number) {
 * Create Sierra Contract Class from a given Compiled Sierra
 *
 * CompiledSierra -> SierraContractClass
+ * 
+ * @param {CompiledSierra} contract - Compiled sierra code
+ * 


missing returns

ivpavici · 2024-05-14T12:02:25Z

src/utils/provider.ts

@@ -26,6 +26,12 @@ import type { GetTransactionReceiptResponse } from './transactionReceipt';

 /**
 * Helper - Async Sleep for 'delay' time
+ *
+ * @param {number} delay - Number of milliseconds to delay.
+ * @example


missing returns

PhilippeR26

Some work remains.

PhilippeR26 · 2024-05-14T13:08:47Z

src/utils/hash/classHash.ts

@@ -34,7 +34,15 @@ export function computePoseidonHash(a: BigNumberish, b: BigNumberish): string {

 /**
 * Compute pedersen hash from data
+ *
+ * @param {BigNumberish[]} data - Data to compute hash on
 * @returns format: hex-string - pedersen hash


As explained here : https://jsdoc.app/tags-returns
The return format has to be wrapped in {}. Here it was not made properly.
A correct typing is :

@returns {string} Hex string

To be verified everywhere.

PhilippeR26 · 2024-05-14T13:12:59Z

src/utils/hash/classHash.ts

+ *
+ * @example
+ * ```typescript
+ * const result = computeHashOnElements(['0xabc', '0x123', '0xabc123'])


All the functions of this file are accessible only in the hash namespace.
You have to add hash. before each function.

PhilippeR26 · 2024-05-14T13:51:27Z

src/utils/hash/classHash.ts

@@ -89,6 +107,11 @@ function nullSkipReplacer(key: string, value: any) {
 * Format json-string to conform starknet json-string
 * @param json json-string


You have to verify also that parameters types are wrapped in {}.
Here :

@param {string} json

PhilippeR26 · 2024-05-14T13:52:36Z

src/utils/hash/classHash.ts

+ * @example
+ * ```typescript
+ * const result = formatSpaces("{'onchain': true, 'isStarknet': true}")
+ * // result = {'onchain':  true,  'isStarknet':  true}


Here we can think that the result is an object.
To avoid this error, wrap the result in " "

PhilippeR26 · 2024-05-14T13:53:41Z

src/utils/hash/classHash.ts

@@ -89,6 +107,11 @@ function nullSkipReplacer(key: string, value: any) {
 * Format json-string to conform starknet json-string
 * @param json json-string
 * @returns format: json-string
+ * @example
+ * ```typescript
+ * const result = formatSpaces("{'onchain': true, 'isStarknet': true}")


In this project we like to add a ; at the end of TS line of code.
To add everywhere.

PhilippeR26 · 2024-05-14T13:55:47Z

src/utils/hash/classHash.ts

+ * ```typescript
+ * const result = formatSpaces("{'onchain': true, 'isStarknet': true}")
+ * // result = {'onchain':  true,  'isStarknet':  true}
+ * ```


Why other functions until the end haven't been modified?

PhilippeR26 · 2024-05-14T14:01:44Z

src/utils/provider.ts

+ * @param {number} delay - Number of milliseconds to delay.
+ * @example
+ * ```typescript
+ * wait(1000) // 1000 milliseconds == 1 second


It's an async function.
You have to add the await prefix.
All the functions of this file are in the provider space. To correct.

PhilippeR26 · 2024-05-14T14:04:48Z

src/utils/provider.ts

+        "0x65",
+        "0x52616e6765436865636b",...})
+ * // result = {sierra_program: 'H4sIAAAAAAAAA6x9WZbsrI7uVGqd53qgb8ZynwzYY7jDv5JAAmxHZuQ+96yq/L0jIzEINZ8axP/5j/q/+j//+z/wH9f/o/p/zPbh+Iot49+u9v8G3//rTdDhDDF4Z0MKPthQ+m+S2v6n1S//638VvdXW2PQ6RvxuDG+jiybCXKJ7Hef6ZRi9E+Q89WmKLilfqbrsL6PUCf8...}
+ * ```


Last function hasn't been made.

PhilippeR26 · 2024-05-14T14:11:44Z

src/utils/provider.ts

+        "0x65",
+        "0x52616e6765436865636b",...})
+ * // result = {sierra_program: 'H4sIAAAAAAAAA6x9WZbsrI7uVGqd53qgb8ZynwzYY7jDv5JAAmxHZuQ+96yq/L0jIzEINZ8axP/5j/q/+j//+z/wH9f/o/p/zPbh+Iot49+u9v8G3//rTdDhDDF4Z0MKPthQ+m+S2v6n1S//638VvdXW2PQ6RvxuDG+jiybCXKJ7Hef6ZRi9E+Q89WmKLilfqbrsL6PUCf8...}
+ * ```


createSierraContractClass and parseContract are performing the opposite action of the other, but you have the same example and result for both cases.
You should re-test these examples ; you will quickly find your error.

tabaktoni and others added 4 commits April 23, 2024 19:02

Merge pull request starknet-io#1067 from starknet-io/next-version

e946a60

Next version

docs: add example to provider.ts in utils

ecd5ddf

docs: class hash

11a2382

ivpavici changed the base branch from develop to next-version May 2, 2024 12:39

Merge branch 'next-version' into docs

0ae2c21

tabaktoni added the Type: documentation Improvements or additions to documentation label May 3, 2024

docs: add @params to docs examples

ca90ec9

ivpavici requested a review from PhilippeR26 May 6, 2024 13:16

PhilippeR26 requested changes May 7, 2024

View reviewed changes

docs: update functions comment

d49b327

ivpavici requested changes May 14, 2024

View reviewed changes

PhilippeR26 requested changes May 14, 2024

View reviewed changes

ivpavici closed this May 31, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add example to provider.ts in utils #1114

docs: add example to provider.ts in utils #1114

vibenedict commented May 1, 2024 •

edited

Loading

ivpavici commented May 2, 2024

vibenedict commented May 2, 2024

ivpavici commented May 3, 2024 •

edited

Loading

PhilippeR26 left a comment

vibenedict commented May 13, 2024

ivpavici May 14, 2024

ivpavici May 14, 2024

ivpavici May 14, 2024

PhilippeR26 left a comment

PhilippeR26 May 14, 2024

PhilippeR26 May 14, 2024

PhilippeR26 May 14, 2024

PhilippeR26 May 14, 2024

PhilippeR26 May 14, 2024

PhilippeR26 May 14, 2024

PhilippeR26 May 14, 2024

PhilippeR26 May 14, 2024

PhilippeR26 May 14, 2024

		@@ -89,6 +107,11 @@ function nullSkipReplacer(key: string, value: any) {
		* Format json-string to conform starknet json-string
		* @param json json-string

docs: add example to provider.ts in utils #1114

docs: add example to provider.ts in utils #1114

Conversation

vibenedict commented May 1, 2024 • edited Loading

Motivation and Resolution

RPC version (if applicable)

Usage related changes

Development related changes

Checklist:

ivpavici commented May 2, 2024

vibenedict commented May 2, 2024

ivpavici commented May 3, 2024 • edited Loading

PhilippeR26 left a comment

Choose a reason for hiding this comment

vibenedict commented May 13, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PhilippeR26 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vibenedict commented May 1, 2024 •

edited

Loading

ivpavici commented May 3, 2024 •

edited

Loading