docs: generate documentation

starknet-io · May 28, 2023 · 730f8cf · 730f8cf
1 parent 643c049
commit 730f8cf
Show file tree

Hide file tree

Showing 6 changed files with 136 additions and 88 deletions.
diff --git a/www/docs/API/interfaces/ec.weierstrass.ProjConstructor.md b/www/docs/API/interfaces/ec.weierstrass.ProjConstructor.md
@@ -39,7 +39,7 @@ GroupConstructor<ProjPointType<T\>\>.constructor
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:74
+node_modules/@noble/curves/abstract/weierstrass.d.ts:76
 
 ## Properties
 
@@ -87,7 +87,7 @@ node_modules/@noble/curves/abstract/curve.d.ts:20
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:75
+node_modules/@noble/curves/abstract/weierstrass.d.ts:77
 
 ---
 
@@ -107,7 +107,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:75
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:76
+node_modules/@noble/curves/abstract/weierstrass.d.ts:78
 
 ---
 
@@ -127,7 +127,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:76
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:77
+node_modules/@noble/curves/abstract/weierstrass.d.ts:79
 
 ---
 
@@ -147,4 +147,4 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:77
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:78
+node_modules/@noble/curves/abstract/weierstrass.d.ts:80
diff --git a/www/docs/API/interfaces/ec.weierstrass.ProjPointType.md b/www/docs/API/interfaces/ec.weierstrass.ProjPointType.md
@@ -67,6 +67,34 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:59
 
 node_modules/@noble/curves/abstract/weierstrass.d.ts:60
 
+## Accessors
+
+### x
+
+• `get` **x**(): `T`
+
+#### Returns
+
+`T`
+
+#### Defined in
+
+node_modules/@noble/curves/abstract/weierstrass.d.ts:61
+
+---
+
+### y
+
+• `get` **y**(): `T`
+
+#### Returns
+
+`T`
+
+#### Defined in
+
+node_modules/@noble/curves/abstract/weierstrass.d.ts:62
+
 ## Methods
 
 ### multiply
@@ -89,7 +117,7 @@ Group.multiply
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:61
+node_modules/@noble/curves/abstract/weierstrass.d.ts:63
 
 ---
 
@@ -109,7 +137,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:61
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:62
+node_modules/@noble/curves/abstract/weierstrass.d.ts:64
 
 ---
 
@@ -123,7 +151,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:62
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:63
+node_modules/@noble/curves/abstract/weierstrass.d.ts:65
 
 ---
 
@@ -137,7 +165,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:63
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:64
+node_modules/@noble/curves/abstract/weierstrass.d.ts:66
 
 ---
 
@@ -151,7 +179,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:64
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:65
+node_modules/@noble/curves/abstract/weierstrass.d.ts:67
 
 ---
 
@@ -165,7 +193,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:65
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:66
+node_modules/@noble/curves/abstract/weierstrass.d.ts:68
 
 ---
 
@@ -185,7 +213,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:66
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:67
+node_modules/@noble/curves/abstract/weierstrass.d.ts:69
 
 ---
 
@@ -205,7 +233,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:67
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:68
+node_modules/@noble/curves/abstract/weierstrass.d.ts:70
 
 ---
 
@@ -225,7 +253,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:68
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:69
+node_modules/@noble/curves/abstract/weierstrass.d.ts:71
 
 ---
 
@@ -247,7 +275,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:69
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:70
+node_modules/@noble/curves/abstract/weierstrass.d.ts:72
 
 ---
 
@@ -267,7 +295,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:70
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:71
+node_modules/@noble/curves/abstract/weierstrass.d.ts:73
 
 ---
 

diff --git a/www/docs/API/interfaces/ec.weierstrass.SignatureType.md b/www/docs/API/interfaces/ec.weierstrass.SignatureType.md
@@ -15,7 +15,7 @@ custom_edit_url: null
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:97
+node_modules/@noble/curves/abstract/weierstrass.d.ts:141
 
 ---
 
@@ -25,7 +25,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:97
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:98
+node_modules/@noble/curves/abstract/weierstrass.d.ts:142
 
 ---
 
@@ -35,7 +35,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:98
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:99
+node_modules/@noble/curves/abstract/weierstrass.d.ts:143
 
 ## Methods
 
@@ -49,7 +49,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:99
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:100
+node_modules/@noble/curves/abstract/weierstrass.d.ts:144
 
 ---
 
@@ -69,7 +69,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:100
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:101
+node_modules/@noble/curves/abstract/weierstrass.d.ts:145
 
 ---
 
@@ -83,7 +83,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:101
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:102
+node_modules/@noble/curves/abstract/weierstrass.d.ts:146
 
 ---
 
@@ -97,7 +97,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:102
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:103
+node_modules/@noble/curves/abstract/weierstrass.d.ts:147
 
 ---
 
@@ -117,7 +117,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:103
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:104
+node_modules/@noble/curves/abstract/weierstrass.d.ts:148
 
 ---
 
@@ -131,7 +131,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:104
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:105
+node_modules/@noble/curves/abstract/weierstrass.d.ts:149
 
 ---
 
@@ -145,7 +145,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:105
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:106
+node_modules/@noble/curves/abstract/weierstrass.d.ts:150
 
 ---
 
@@ -165,7 +165,7 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:106
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:107
+node_modules/@noble/curves/abstract/weierstrass.d.ts:151
 
 ---
 
@@ -185,4 +185,4 @@ node_modules/@noble/curves/abstract/weierstrass.d.ts:107
 
 #### Defined in
 
-node_modules/@noble/curves/abstract/weierstrass.d.ts:108
+node_modules/@noble/curves/abstract/weierstrass.d.ts:152
diff --git a/www/docs/API/namespaces/ec.starkCurve.md b/www/docs/API/namespaces/ec.starkCurve.md
@@ -11,7 +11,7 @@ custom_edit_url: null
 
 ### ProjectivePoint
 
-Ƭ **ProjectivePoint**: `ProjPointType`<`bigint`\>
+Ƭ **ProjectivePoint**: [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`bigint`\>
 
 #### Defined in
 
@@ -43,7 +43,7 @@ node_modules/micro-starknet/lib/index.d.ts:63
 
 ### PoseidonFn
 
-Ƭ **PoseidonFn**: `ReturnType`<typeof `poseidon`\> & { `m`: `number` ; `rate`: `number` ; `capacity`: `number` }
+Ƭ **PoseidonFn**: `ReturnType`<typeof [`poseidon`](hash.poseidon.md#poseidon)\> & { `m`: `number` ; `rate`: `number` ; `capacity`: `number` }
 
 #### Defined in
 
@@ -53,7 +53,7 @@ node_modules/micro-starknet/lib/index.d.ts:70
 
 ### \_starkCurve
 
-• `Const` **\_starkCurve**: `CurveFn`
+• `Const` **\_starkCurve**: [`weierstrass`](ec.weierstrass.md)
 
 #### Defined in
 
@@ -63,7 +63,7 @@ node_modules/micro-starknet/lib/index.d.ts:7
 
 ### CURVE
 
-• `Const` **CURVE**: `Readonly`<{ `nBitLength`: `number` ; `nByteLength`: `number` ; `Fp`: `IField`<`bigint`\> ; `n`: `bigint` ; `h`: `bigint` ; `hEff?`: `bigint` ; `Gx`: `bigint` ; `Gy`: `bigint` ; `allowInfinityPoint?`: `boolean` ; `a`: `bigint` ; `b`: `bigint` ; `allowedPrivateKeyLengths?`: readonly `number`[] ; `wrapPrivateKey?`: `boolean` ; `endo?`: { `beta`: `bigint` ; `splitScalar`: (`k`: `bigint`) => { `k1neg`: `boolean` ; `k1`: `bigint` ; `k2neg`: `boolean` ; `k2`: `bigint` } } ; `isTorsionFree?`: (`c`: `ProjConstructor`, `point`: `ProjPointType`<`bigint`\>) => `boolean` ; `clearCofactor?`: (`c`: `ProjConstructor`, `point`: `ProjPointType`<`bigint`\>) => `ProjPointType`<`bigint`\> ; `hash`: `u.CHash` ; `hmac`: (`key`: `Uint8Array`, ...`messages`: `Uint8Array`[]) => `Uint8Array` ; `randomBytes`: (`bytesLength?`: `number`) => `Uint8Array` ; `lowS`: `boolean` ; `bits2int?`: (`bytes`: `Uint8Array`) => `bigint` ; `bits2int_modN?`: (`bytes`: `Uint8Array`) => `bigint` ; `p`: `bigint` }\>
+• `Const` **CURVE**: `Readonly`<{ `nBitLength`: `number` ; `nByteLength`: `number` ; `Fp`: `IField`<`bigint`\> ; `n`: `bigint` ; `h`: `bigint` ; `hEff?`: `bigint` ; `Gx`: `bigint` ; `Gy`: `bigint` ; `allowInfinityPoint?`: `boolean` ; `a`: `bigint` ; `b`: `bigint` ; `allowedPrivateKeyLengths?`: readonly `number`[] ; `wrapPrivateKey?`: `boolean` ; `endo?`: { `beta`: `bigint` ; `splitScalar`: (`k`: `bigint`) => { `k1neg`: `boolean` ; `k1`: `bigint` ; `k2neg`: `boolean` ; `k2`: `bigint` } } ; `isTorsionFree?`: (`c`: [`weierstrass`](ec.weierstrass.md), `point`: [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`bigint`\>) => `boolean` ; `clearCofactor?`: (`c`: [`weierstrass`](ec.weierstrass.md), `point`: [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`bigint`\>) => [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`bigint`\> ; `hash`: `u.CHash` ; `hmac`: (`key`: `Uint8Array`, ...`messages`: `Uint8Array`[]) => `Uint8Array` ; `randomBytes`: (`bytesLength?`: `number`) => `Uint8Array` ; `lowS`: `boolean` ; `bits2int?`: (`bytes`: `Uint8Array`) => `bigint` ; `bits2int_modN?`: (`bytes`: `Uint8Array`) => `bigint` ; `p`: `bigint` }\>
 
 #### Defined in
 
@@ -73,7 +73,7 @@ node_modules/micro-starknet/lib/index.d.ts:12
 
 ### ProjectivePoint
 
-• **ProjectivePoint**: `ProjConstructor`<`bigint`\>
+• **ProjectivePoint**: [`ProjConstructor`](../interfaces/ec.weierstrass.ProjConstructor.md)<`bigint`\>
 
 #### Defined in
 
@@ -85,7 +85,7 @@ node_modules/micro-starknet/lib/index.d.ts:44
 
 ### Signature
 
-• `Const` **Signature**: `SignatureConstructor`
+• `Const` **Signature**: [`weierstrass`](ec.weierstrass.md)
 
 #### Defined in
 
@@ -99,12 +99,12 @@ node_modules/micro-starknet/lib/index.d.ts:44
 
 #### Type declaration
 
-| Name                     | Type                                                                                          |
-| :----------------------- | :-------------------------------------------------------------------------------------------- |
-| `normPrivateKeyToScalar` | (`key`: `u.PrivKey`) => `bigint`                                                              |
-| `randomPrivateKey`       | () => `Uint8Array`                                                                            |
-| `precompute`             | (`windowSize?`: `number`, `point?`: `ProjPointType`<`bigint`\>) => `ProjPointType`<`bigint`\> |
-| `isValidPrivateKey`      | (`privateKey`: `PrivKey`) => `boolean`                                                        |
+| Name                     | Type                                                                                                                                                                                            |
+| :----------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `normPrivateKeyToScalar` | (`key`: `u.PrivKey`) => `bigint`                                                                                                                                                                |
+| `randomPrivateKey`       | () => `Uint8Array`                                                                                                                                                                              |
+| `precompute`             | (`windowSize?`: `number`, `point?`: [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`bigint`\>) => [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`bigint`\> |
+| `isValidPrivateKey`      | (`privateKey`: `PrivKey`) => `boolean`                                                                                                                                                          |
 
 #### Defined in
 
@@ -176,7 +176,7 @@ node_modules/micro-starknet/lib/index.d.ts:9
 
 ### sign
 
-▸ **sign**(`msgHash`, `privKey`, `opts?`): `SignatureType`
+▸ **sign**(`msgHash`, `privKey`, `opts?`): [`SignatureType`](../interfaces/ec.weierstrass.SignatureType.md)
 
 #### Parameters
 
@@ -188,7 +188,7 @@ node_modules/micro-starknet/lib/index.d.ts:9
 
 #### Returns
 
-`SignatureType`
+[`SignatureType`](../interfaces/ec.weierstrass.SignatureType.md)
 
 #### Defined in
 
@@ -202,11 +202,11 @@ node_modules/micro-starknet/lib/index.d.ts:10
 
 #### Parameters
 
-| Name        | Type                     |
-| :---------- | :----------------------- |
-| `signature` | `Hex` \| `SignatureType` |
-| `msgHash`   | `Hex`                    |
-| `pubKey`    | `Hex`                    |
+| Name        | Type                                                                      |
+| :---------- | :------------------------------------------------------------------------ |
+| `signature` | [`SignatureType`](../interfaces/ec.weierstrass.SignatureType.md) \| `Hex` |
+| `msgHash`   | `Hex`                                                                     |
+| `pubKey`    | `Hex`                                                                     |
 
 #### Returns
 
@@ -551,4 +551,4 @@ node_modules/micro-starknet/lib/index.d.ts:59
 
 #### Defined in
 
-node_modules/micro-starknet/node_modules/@noble/curves/abstract/poseidon.d.ts:27
+node_modules/@noble/curves/abstract/poseidon.d.ts:27