Skip to content

Commit

Permalink
docs: rebuild docs for ts sdk
Browse files Browse the repository at this point in the history
  • Loading branch information
dnechay committed Jan 9, 2025
1 parent 90708c3 commit cccd4cc
Show file tree
Hide file tree
Showing 64 changed files with 375 additions and 272 deletions.
6 changes: 3 additions & 3 deletions docs/sdk/typescript/base/classes/BaseEthersClient.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The network information required to connect to the contracts

#### Defined in

[base.ts:20](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L20)
[base.ts:20](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L20)

## Properties

Expand All @@ -54,7 +54,7 @@ The network information required to connect to the contracts
#### Defined in

[base.ts:12](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
[base.ts:12](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)

***

Expand All @@ -64,4 +64,4 @@ The network information required to connect to the contracts
#### Defined in

[base.ts:11](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)
[base.ts:11](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)
10 changes: 5 additions & 5 deletions docs/sdk/typescript/encryption/classes/Encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The private key.

#### Defined in

[encryption.ts:62](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L62)
[encryption.ts:62](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L62)

## Methods

Expand Down Expand Up @@ -123,7 +123,7 @@ const resultMessage = await encription.decrypt('message');

#### Defined in

[encryption.ts:190](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L190)
[encryption.ts:190](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L190)

***

Expand Down Expand Up @@ -161,7 +161,7 @@ const resultMessage = await encription.sign('message');

#### Defined in

[encryption.ts:247](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L247)
[encryption.ts:247](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L247)

***

Expand Down Expand Up @@ -230,7 +230,7 @@ const resultMessage = await encription.signAndEncrypt('message', publicKeys);

#### Defined in

[encryption.ts:138](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L138)
[encryption.ts:138](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L138)

***

Expand Down Expand Up @@ -262,4 +262,4 @@ Optional: The passphrase for the private key.

#### Defined in

[encryption.ts:73](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L73)
[encryption.ts:73](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L73)
10 changes: 5 additions & 5 deletions docs/sdk/typescript/encryption/classes/EncryptionUtils.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ const result = await EncriptionUtils.encrypt('message', publicKeys);

#### Defined in

[encryption.ts:452](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L452)
[encryption.ts:452](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L452)

***

Expand Down Expand Up @@ -164,7 +164,7 @@ const result = await EncriptionUtils.generateKeyPair(name, email, passphrase);

#### Defined in

[encryption.ts:390](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L390)
[encryption.ts:390](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L390)

***

Expand Down Expand Up @@ -198,7 +198,7 @@ const signedData = await EncriptionUtils.getSignedData('message');

#### Defined in

[encryption.ts:347](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L347)
[encryption.ts:347](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L347)

***

Expand Down Expand Up @@ -248,7 +248,7 @@ if (isEncrypted) {

#### Defined in

[encryption.ts:502](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L502)
[encryption.ts:502](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L502)

***

Expand Down Expand Up @@ -300,4 +300,4 @@ const result = await EncriptionUtils.verify('message', publicKey);

#### Defined in

[encryption.ts:314](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L314)
[encryption.ts:314](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L314)
38 changes: 19 additions & 19 deletions docs/sdk/typescript/enums/enumerations/ChainId.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
#### Defined in

[enums.ts:2](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L2)
[enums.ts:2](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L2)

***

Expand All @@ -24,7 +24,7 @@
#### Defined in

[enums.ts:15](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L15)
[enums.ts:15](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L15)

***

Expand All @@ -34,7 +34,7 @@
#### Defined in

[enums.ts:14](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L14)
[enums.ts:14](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L14)

***

Expand All @@ -44,7 +44,7 @@
#### Defined in

[enums.ts:7](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L7)
[enums.ts:7](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L7)

***

Expand All @@ -54,7 +54,7 @@
#### Defined in

[enums.ts:8](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L8)
[enums.ts:8](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L8)

***

Expand All @@ -64,7 +64,7 @@
#### Defined in

[enums.ts:16](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L16)
[enums.ts:16](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L16)

***

Expand All @@ -74,7 +74,7 @@
#### Defined in

[enums.ts:17](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L17)
[enums.ts:17](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L17)

***

Expand All @@ -84,7 +84,7 @@
#### Defined in

[enums.ts:5](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L5)
[enums.ts:5](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L5)

***

Expand All @@ -94,7 +94,7 @@
#### Defined in

[enums.ts:19](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L19)
[enums.ts:19](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L19)

***

Expand All @@ -104,7 +104,7 @@
#### Defined in

[enums.ts:3](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L3)
[enums.ts:3](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L3)

***

Expand All @@ -114,7 +114,7 @@
#### Defined in

[enums.ts:13](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L13)
[enums.ts:13](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L13)

***

Expand All @@ -124,7 +124,7 @@
#### Defined in

[enums.ts:12](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L12)
[enums.ts:12](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L12)

***

Expand All @@ -134,7 +134,7 @@
#### Defined in

[enums.ts:9](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L9)
[enums.ts:9](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L9)

***

Expand All @@ -144,7 +144,7 @@
#### Defined in

[enums.ts:11](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L11)
[enums.ts:11](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L11)

***

Expand All @@ -154,7 +154,7 @@
#### Defined in

[enums.ts:10](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L10)
[enums.ts:10](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L10)

***

Expand All @@ -164,7 +164,7 @@
#### Defined in

[enums.ts:4](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L4)
[enums.ts:4](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L4)

***

Expand All @@ -174,7 +174,7 @@
#### Defined in

[enums.ts:6](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L6)
[enums.ts:6](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L6)

***

Expand All @@ -184,7 +184,7 @@
#### Defined in

[enums.ts:20](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L20)
[enums.ts:20](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L20)

***

Expand All @@ -194,4 +194,4 @@
#### Defined in

[enums.ts:18](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L18)
[enums.ts:18](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L18)
4 changes: 2 additions & 2 deletions docs/sdk/typescript/enums/enumerations/OrderDirection.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
#### Defined in

[enums.ts:24](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L24)
[enums.ts:24](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L24)

***

Expand All @@ -24,4 +24,4 @@
#### Defined in

[enums.ts:25](https://github.com/humanprotocol/human-protocol/blob/d09ba07adfea005abceaa4b9fc19ef8d97dfa6cc/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L25)
[enums.ts:25](https://github.com/humanprotocol/human-protocol/blob/90708c31f10beb8c39c0abd078b41cb6cae38b08/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L25)
Loading

0 comments on commit cccd4cc

Please sign in to comment.