docs: generate documentation

penovicp · Aug 25, 2023 · 0c15422 · 0c15422
1 parent 0cd26d3
commit 0c15422
Show file tree

Hide file tree

Showing 4 changed files with 68 additions and 71 deletions.
diff --git a/www/docs/API/interfaces/ec.weierstrass.SignatureType.md b/www/docs/API/interfaces/ec.weierstrass.SignatureType.md
@@ -55,7 +55,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:144
 
 ### addRecoveryBit
 
-▸ **addRecoveryBit**(`recovery`): [`SignatureType`](ec.weierstrass.SignatureType.md)
+▸ **addRecoveryBit**(`recovery`): [`RecoveredSignatureType`](../namespaces/ec.weierstrass.md#recoveredsignaturetype)
 
 #### Parameters
 
@@ -65,7 +65,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:144
 
 #### Returns
 
-[`SignatureType`](ec.weierstrass.SignatureType.md)
+[`RecoveredSignatureType`](../namespaces/ec.weierstrass.md#recoveredsignaturetype)
 
 #### Defined in
 

diff --git a/www/docs/API/modules.md b/www/docs/API/modules.md
@@ -1,6 +1,6 @@
 ---
 id: 'modules'
-title: 'Starknet.js API - v5.19.2'
+title: 'Starknet.js API - v5.19.3'
 sidebar_label: 'Exports'
 sidebar_position: 0.5
 custom_edit_url: null

diff --git a/www/docs/API/namespaces/ec.starkCurve.md b/www/docs/API/namespaces/ec.starkCurve.md
@@ -15,9 +15,9 @@ custom_edit_url: null
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:6
+node_modules/@scure/starknet/lib/index.d.ts:6
 
-node_modules/micro-starknet/lib/index.d.ts:44
+node_modules/@scure/starknet/lib/index.d.ts:45
 
 ---
 
@@ -37,7 +37,7 @@ node_modules/micro-starknet/lib/index.d.ts:44
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:63
+node_modules/@scure/starknet/lib/index.d.ts:62
 
 ---
 
@@ -47,17 +47,27 @@ node_modules/micro-starknet/lib/index.d.ts:63
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:70
+node_modules/@scure/starknet/lib/index.d.ts:69
 
 ## Variables
 
+### MAX_VALUE
+
+• `Const` **MAX_VALUE**: `bigint`
+
+#### Defined in
+
+node_modules/@scure/starknet/lib/index.d.ts:7
+
+---
+
 ### \_starkCurve
 
 • `Const` **\_starkCurve**: [`weierstrass`](ec.weierstrass.md)
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:7
+node_modules/@scure/starknet/lib/index.d.ts:8
 
 ---
 
@@ -67,7 +77,7 @@ node_modules/micro-starknet/lib/index.d.ts:7
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:12
+node_modules/@scure/starknet/lib/index.d.ts:13
 
 ---
 
@@ -77,9 +87,9 @@ node_modules/micro-starknet/lib/index.d.ts:12
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:6
+node_modules/@scure/starknet/lib/index.d.ts:6
 
-node_modules/micro-starknet/lib/index.d.ts:44
+node_modules/@scure/starknet/lib/index.d.ts:45
 
 ---
 
@@ -89,7 +99,7 @@ node_modules/micro-starknet/lib/index.d.ts:44
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:44
+node_modules/@scure/starknet/lib/index.d.ts:45
 
 ---
 
@@ -108,17 +118,7 @@ node_modules/micro-starknet/lib/index.d.ts:44
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:44
-
----
-
-### Fp253
-
-• `Const` **Fp253**: `Readonly`<`IField`<`bigint`\> & `Required`<`Pick`<`IField`<`bigint`\>, `"isOdd"`\>\>\>
-
-#### Defined in
-
-node_modules/micro-starknet/lib/index.d.ts:60
+node_modules/@scure/starknet/lib/index.d.ts:45
 
 ---
 
@@ -128,7 +128,7 @@ node_modules/micro-starknet/lib/index.d.ts:60
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:61
+node_modules/@scure/starknet/lib/index.d.ts:60
 
 ## Functions
 
@@ -149,7 +149,7 @@ node_modules/micro-starknet/lib/index.d.ts:61
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:8
+node_modules/@scure/starknet/lib/index.d.ts:9
 
 ---
 
@@ -170,7 +170,7 @@ node_modules/micro-starknet/lib/index.d.ts:8
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:9
+node_modules/@scure/starknet/lib/index.d.ts:10
 
 ---
 
@@ -192,7 +192,7 @@ node_modules/micro-starknet/lib/index.d.ts:9
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:10
+node_modules/@scure/starknet/lib/index.d.ts:11
 
 ---
 
@@ -214,7 +214,7 @@ node_modules/micro-starknet/lib/index.d.ts:10
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:11
+node_modules/@scure/starknet/lib/index.d.ts:12
 
 ---
 
@@ -234,7 +234,7 @@ node_modules/micro-starknet/lib/index.d.ts:11
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:51
+node_modules/@scure/starknet/lib/index.d.ts:52
 
 ---
 
@@ -254,7 +254,7 @@ node_modules/micro-starknet/lib/index.d.ts:51
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:52
+node_modules/@scure/starknet/lib/index.d.ts:53
 
 ---
 
@@ -274,7 +274,7 @@ node_modules/micro-starknet/lib/index.d.ts:52
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:53
+node_modules/@scure/starknet/lib/index.d.ts:54
 
 ---
 
@@ -297,7 +297,7 @@ node_modules/micro-starknet/lib/index.d.ts:53
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:54
+node_modules/@scure/starknet/lib/index.d.ts:55
 
 ---
 
@@ -318,28 +318,7 @@ node_modules/micro-starknet/lib/index.d.ts:54
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:56
-
----
-
-### hashChain
-
-▸ **hashChain**(`data`, `fn?`): `PedersenArg`
-
-#### Parameters
-
-| Name   | Type                                                 |
-| :----- | :--------------------------------------------------- |
-| `data` | `PedersenArg`[]                                      |
-| `fn?`  | (`x`: `PedersenArg`, `y`: `PedersenArg`) => `string` |
-
-#### Returns
-
-`PedersenArg`
-
-#### Defined in
-
-node_modules/micro-starknet/lib/index.d.ts:57
+node_modules/@scure/starknet/lib/index.d.ts:57
 
 ---
 
@@ -362,7 +341,7 @@ node_modules/micro-starknet/lib/index.d.ts:57
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:62
+node_modules/@scure/starknet/lib/index.d.ts:61
 
 ---
 
@@ -383,7 +362,7 @@ node_modules/micro-starknet/lib/index.d.ts:62
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:75
+node_modules/@scure/starknet/lib/index.d.ts:74
 
 ---
 
@@ -404,7 +383,7 @@ node_modules/micro-starknet/lib/index.d.ts:75
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:76
+node_modules/@scure/starknet/lib/index.d.ts:75
 
 ---
 
@@ -426,7 +405,7 @@ node_modules/micro-starknet/lib/index.d.ts:76
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:78
+node_modules/@scure/starknet/lib/index.d.ts:77
 
 ---
 
@@ -448,7 +427,7 @@ node_modules/micro-starknet/lib/index.d.ts:78
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:79
+node_modules/@scure/starknet/lib/index.d.ts:78
 
 ---
 
@@ -469,7 +448,7 @@ node_modules/micro-starknet/lib/index.d.ts:79
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:80
+node_modules/@scure/starknet/lib/index.d.ts:79
 
 ---
 
@@ -490,7 +469,7 @@ node_modules/micro-starknet/lib/index.d.ts:80
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:81
+node_modules/@scure/starknet/lib/index.d.ts:80
 
 ---
 
@@ -511,7 +490,7 @@ node_modules/micro-starknet/lib/index.d.ts:81
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:58
+node_modules/@scure/starknet/lib/index.d.ts:58
 
 ---
 
@@ -531,7 +510,7 @@ node_modules/micro-starknet/lib/index.d.ts:58
 
 #### Defined in
 
-node_modules/micro-starknet/lib/index.d.ts:59
+node_modules/@scure/starknet/lib/index.d.ts:59
 
 ---