docs: generate documentation

starknet-io · Sep 21, 2023 · 52c54c5 · 52c54c5
1 parent 4523780
commit 52c54c5
Show file tree

Hide file tree

Showing 7 changed files with 49 additions and 79 deletions.
diff --git a/www/docs/API/classes/SequencerProvider.md b/www/docs/API/classes/SequencerProvider.md
@@ -134,7 +134,7 @@ custom_edit_url: null
 
 #### Defined in
 
-[src/provider/sequencer.ts:127](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L127)
+[src/provider/sequencer.ts:124](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L124)
 
 ---
 
@@ -154,7 +154,7 @@ custom_edit_url: null
 
 #### Defined in
 
-[src/provider/sequencer.ts:144](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L144)
+[src/provider/sequencer.ts:138](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L138)
 
 ---
 
@@ -174,7 +174,7 @@ custom_edit_url: null
 
 #### Defined in
 
-[src/provider/sequencer.ts:149](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L149)
+[src/provider/sequencer.ts:143](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L143)
 
 ---
 
@@ -194,7 +194,7 @@ custom_edit_url: null
 
 #### Defined in
 
-[src/provider/sequencer.ts:162](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L162)
+[src/provider/sequencer.ts:156](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L156)
 
 ---
 
@@ -214,7 +214,7 @@ custom_edit_url: null
 
 #### Defined in
 
-[src/provider/sequencer.ts:179](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L179)
+[src/provider/sequencer.ts:173](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L173)
 
 ---
 
@@ -241,7 +241,7 @@ custom_edit_url: null
 
 #### Defined in
 
-[src/provider/sequencer.ts:190](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L190)
+[src/provider/sequencer.ts:184](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L184)
 
 ---
 
@@ -265,7 +265,7 @@ custom_edit_url: null
 
 #### Defined in
 
-[src/provider/sequencer.ts:212](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L212)
+[src/provider/sequencer.ts:206](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L206)
 
 ---
 
@@ -287,7 +287,7 @@ the chain Id
 
 #### Defined in
 
-[src/provider/sequencer.ts:253](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L253)
+[src/provider/sequencer.ts:247](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L247)
 
 ---
 
@@ -316,7 +316,7 @@ the result of the function on the smart contract.
 
 #### Defined in
 
-[src/provider/sequencer.ts:257](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L257)
+[src/provider/sequencer.ts:251](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L251)
 
 ---
 
@@ -344,7 +344,7 @@ the block object
 
 #### Defined in
 
-[src/provider/sequencer.ts:275](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L275)
+[src/provider/sequencer.ts:269](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L269)
 
 ---
 
@@ -373,7 +373,7 @@ the hex nonce
 
 #### Defined in
 
-[src/provider/sequencer.ts:283](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L283)
+[src/provider/sequencer.ts:277](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L277)
 
 ---
 
@@ -403,7 +403,7 @@ the value of the storage variable
 
 #### Defined in
 
-[src/provider/sequencer.ts:290](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L290)
+[src/provider/sequencer.ts:284](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L284)
 
 ---
 
@@ -431,7 +431,7 @@ the transaction object { transaction_id, status, transaction, block_number?, blo
 
 #### Defined in
 
-[src/provider/sequencer.ts:303](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L303)
+[src/provider/sequencer.ts:297](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L297)
 
 ---
 
@@ -459,7 +459,7 @@ the transaction receipt object
 
 #### Defined in
 
-[src/provider/sequencer.ts:312](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L312)
+[src/provider/sequencer.ts:306](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L306)
 
 ---
 
@@ -488,7 +488,7 @@ Contract class of compiled contract
 
 #### Defined in
 
-[src/provider/sequencer.ts:319](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L319)
+[src/provider/sequencer.ts:313](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L313)
 
 ---
 
@@ -517,7 +517,7 @@ Class hash
 
 #### Defined in
 
-[src/provider/sequencer.ts:328](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L328)
+[src/provider/sequencer.ts:322](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L322)
 
 ---
 
@@ -546,7 +546,7 @@ Contract class of compiled contract
 
 #### Defined in
 
-[src/provider/sequencer.ts:335](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L335)
+[src/provider/sequencer.ts:329](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L329)
 
 ---
 
@@ -567,7 +567,7 @@ Contract class of compiled contract
 
 #### Defined in
 
-[src/provider/sequencer.ts:344](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L344)
+[src/provider/sequencer.ts:338](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L338)
 
 ---
 
@@ -600,7 +600,7 @@ response from addTransaction
 
 #### Defined in
 
-[src/provider/sequencer.ts:351](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L351)
+[src/provider/sequencer.ts:345](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L345)
 
 ---
 
@@ -629,7 +629,7 @@ a confirmation of sending a transaction on the starknet contract
 
 #### Defined in
 
-[src/provider/sequencer.ts:366](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L366)
+[src/provider/sequencer.ts:360](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L360)
 
 ---
 
@@ -658,7 +658,7 @@ a confirmation of sending a transaction on the starknet contract
 
 #### Defined in
 
-[src/provider/sequencer.ts:382](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L382)
+[src/provider/sequencer.ts:376](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L376)
 
 ---
 
@@ -693,7 +693,7 @@ the estimated fee
 
 #### Defined in
 
-[src/provider/sequencer.ts:410](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L410)
+[src/provider/sequencer.ts:404](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L404)
 
 ---
 
@@ -724,7 +724,7 @@ the estimated fee
 
 #### Defined in
 
-[src/provider/sequencer.ts:419](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L419)
+[src/provider/sequencer.ts:413](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L413)
 
 ---
 
@@ -755,7 +755,7 @@ the estimated fee
 
 #### Defined in
 
-[src/provider/sequencer.ts:438](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L438)
+[src/provider/sequencer.ts:432](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L432)
 
 ---
 
@@ -786,7 +786,7 @@ the estimated fee
 
 #### Defined in
 
-[src/provider/sequencer.ts:457](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L457)
+[src/provider/sequencer.ts:451](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L451)
 
 ---
 
@@ -815,7 +815,7 @@ the estimated fee
 
 #### Defined in
 
-[src/provider/sequencer.ts:476](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L476)
+[src/provider/sequencer.ts:470](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L470)
 
 ---
 
@@ -844,7 +844,7 @@ The method should not be used
 
 #### Defined in
 
-[src/provider/sequencer.ts:488](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L488)
+[src/provider/sequencer.ts:482](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L482)
 
 ---
 
@@ -873,7 +873,7 @@ GetTransactionReceiptResponse
 
 #### Defined in
 
-[src/provider/sequencer.ts:495](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L495)
+[src/provider/sequencer.ts:489](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L489)
 
 ---
 
@@ -897,7 +897,7 @@ GetTransactionStatusResponse - the transaction status object
 
 #### Defined in
 
-[src/provider/sequencer.ts:550](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L550)
+[src/provider/sequencer.ts:544](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L544)
 
 ---
 
@@ -915,7 +915,7 @@ GetContractAddressesResponse - starknet smart contract addresses
 
 #### Defined in
 
-[src/provider/sequencer.ts:559](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L559)
+[src/provider/sequencer.ts:553](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L553)
 
 ---
 
@@ -939,7 +939,7 @@ TransactionTraceResponse - the transaction trace
 
 #### Defined in
 
-[src/provider/sequencer.ts:568](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L568)
+[src/provider/sequencer.ts:562](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L562)
 
 ---
 
@@ -960,7 +960,7 @@ TransactionTraceResponse - the transaction trace
 
 #### Defined in
 
-[src/provider/sequencer.ts:575](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L575)
+[src/provider/sequencer.ts:569](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L569)
 
 ---
 
@@ -988,7 +988,7 @@ WARNING!: Sequencer will process only first element from invocations array
 
 #### Defined in
 
-[src/provider/sequencer.ts:598](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L598)
+[src/provider/sequencer.ts:592](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L592)
 
 ---
 
@@ -1016,7 +1016,7 @@ StateUpdateResponse
 
 #### Defined in
 
-[src/provider/sequencer.ts:625](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L625)
+[src/provider/sequencer.ts:619](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L619)
 
 ---
 
@@ -1036,7 +1036,7 @@ StateUpdateResponse
 
 #### Defined in
 
-[src/provider/sequencer.ts:635](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L635)
+[src/provider/sequencer.ts:629](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L629)
 
 ---
 
@@ -1057,7 +1057,7 @@ StateUpdateResponse
 
 #### Defined in
 
-[src/provider/sequencer.ts:642](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L642)
+[src/provider/sequencer.ts:636](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L636)
 
 ---
 
@@ -1078,7 +1078,7 @@ StateUpdateResponse
 
 #### Defined in
 
-[src/provider/sequencer.ts:646](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L646)
+[src/provider/sequencer.ts:640](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L640)
 
 ---
 
@@ -1103,4 +1103,4 @@ AccountTransactionItem
 
 #### Defined in
 
-[src/provider/sequencer.ts:656](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L656)
+[src/provider/sequencer.ts:650](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L650)
diff --git a/www/docs/API/enums/constants.BaseUrl.md b/www/docs/API/enums/constants.BaseUrl.md
@@ -26,13 +26,3 @@ custom_edit_url: null
 #### Defined in
 
 [src/constants.ts:22](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L22)
-
----
-
-### SN_GOERLI2
-
-• **SN_GOERLI2** = `"https://alpha4-2.starknet.io"`
-
-#### Defined in
-
-[src/constants.ts:23](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L23)
diff --git a/www/docs/API/enums/constants.NetworkName.md b/www/docs/API/enums/constants.NetworkName.md
@@ -15,7 +15,7 @@ custom_edit_url: null
 
 #### Defined in
 
-[src/constants.ts:27](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L27)
+[src/constants.ts:26](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L26)
 
 ---
 
@@ -25,14 +25,4 @@ custom_edit_url: null
 
 #### Defined in
 
-[src/constants.ts:28](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L28)
-
----
-
-### SN_GOERLI2
-
-• **SN_GOERLI2** = `"SN_GOERLI2"`
-
-#### Defined in
-
-[src/constants.ts:29](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L29)
+[src/constants.ts:27](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L27)