Skip to content

Commit

Permalink
regenerate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@leric7
leric7 committed Jan 16, 2025
1 parent 3ddf95c commit fd7c857
Show file tree
Hide file tree
Showing 66 changed files with 289 additions and 1,407 deletions.
6 changes: 0 additions & 6 deletions docs/sdk/python/human_protocol_sdk.operator.operator_utils.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,17 +60,11 @@ A class used to filter leaders.
Initializes a LeaderFilter instance.

* **Parameters:**
<<<<<<< HEAD
* **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Chain Id to request data
* **order_by** (`Optional`[`str`]) – Order by property, “role”
* **order_direction** ([`OrderDirection`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.OrderDirection)) – Order of results, “asc” or “desc”
=======
* **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Chain ID to request data
* **roles** (`Optional`[`str`]) – Roles to filter by
* **min_amount_staked** (`Optional`[`int`]) – Minimum amount staked to filter by
* **order_by** (`Optional`[`str`]) – Property to order by, e.g., “role”
* **order_direction** ([`OrderDirection`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.OrderDirection)) – Order direction of results, “asc” or “desc”
>>>>>>> develop
* **first** (`int`) – Number of items per page
* **skip** (`int`) – Number of items to skip (for pagination)

Expand Down
18 changes: 3 additions & 15 deletions docs/sdk/typescript/base/classes/BaseEthersClient.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,7 @@ The network information required to connect to the contracts

#### Defined in

<<<<<<< HEAD
[base.ts:20](https://github.com/humanprotocol/human-protocol/blob/3ed5fd393b562534f83a6f2f110eb4e3977deb72/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L20)
=======
[base.ts:20](https://github.com/humanprotocol/human-protocol/blob/b190dc1831c2c96fe3d44fd63e915e54011e1ec8/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L20)
>>>>>>> develop
[base.ts:20](https://github.com/humanprotocol/human-protocol/blob/3ddf95c166a160d89d0a36078325a2fc8283f02c/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L20)

## Properties

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

<<<<<<< HEAD
[base.ts:12](https://github.com/humanprotocol/human-protocol/blob/3ed5fd393b562534f83a6f2f110eb4e3977deb72/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
=======
[base.ts:12](https://github.com/humanprotocol/human-protocol/blob/b190dc1831c2c96fe3d44fd63e915e54011e1ec8/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
>>>>>>> develop
[base.ts:12](https://github.com/humanprotocol/human-protocol/blob/3ddf95c166a160d89d0a36078325a2fc8283f02c/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)

***

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

<<<<<<< HEAD
[base.ts:11](https://github.com/humanprotocol/human-protocol/blob/3ed5fd393b562534f83a6f2f110eb4e3977deb72/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)
=======
[base.ts:11](https://github.com/humanprotocol/human-protocol/blob/b190dc1831c2c96fe3d44fd63e915e54011e1ec8/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)
>>>>>>> develop
[base.ts:11](https://github.com/humanprotocol/human-protocol/blob/3ddf95c166a160d89d0a36078325a2fc8283f02c/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)
30 changes: 5 additions & 25 deletions docs/sdk/typescript/encryption/classes/Encryption.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,7 @@ The private key.

#### Defined in

<<<<<<< HEAD
[encryption.ts:62](https://github.com/humanprotocol/human-protocol/blob/3ed5fd393b562534f83a6f2f110eb4e3977deb72/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L62)
=======
[encryption.ts:66](https://github.com/humanprotocol/human-protocol/blob/b190dc1831c2c96fe3d44fd63e915e54011e1ec8/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L66)
>>>>>>> develop
[encryption.ts:66](https://github.com/humanprotocol/human-protocol/blob/3ddf95c166a160d89d0a36078325a2fc8283f02c/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L66)

## Methods

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

#### Defined in

<<<<<<< HEAD
[encryption.ts:190](https://github.com/humanprotocol/human-protocol/blob/3ed5fd393b562534f83a6f2f110eb4e3977deb72/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L190)
=======
[encryption.ts:194](https://github.com/humanprotocol/human-protocol/blob/b190dc1831c2c96fe3d44fd63e915e54011e1ec8/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L194)
>>>>>>> develop
[encryption.ts:194](https://github.com/humanprotocol/human-protocol/blob/3ddf95c166a160d89d0a36078325a2fc8283f02c/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L194)

***

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

#### Defined in

<<<<<<< HEAD
[encryption.ts:247](https://github.com/humanprotocol/human-protocol/blob/3ed5fd393b562534f83a6f2f110eb4e3977deb72/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L247)
=======
[encryption.ts:251](https://github.com/humanprotocol/human-protocol/blob/b190dc1831c2c96fe3d44fd63e915e54011e1ec8/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L251)
>>>>>>> develop
[encryption.ts:251](https://github.com/humanprotocol/human-protocol/blob/3ddf95c166a160d89d0a36078325a2fc8283f02c/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L251)

***

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

#### Defined in

<<<<<<< HEAD
[encryption.ts:138](https://github.com/humanprotocol/human-protocol/blob/3ed5fd393b562534f83a6f2f110eb4e3977deb72/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L138)
=======
[encryption.ts:142](https://github.com/humanprotocol/human-protocol/blob/b190dc1831c2c96fe3d44fd63e915e54011e1ec8/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L142)
>>>>>>> develop
[encryption.ts:142](https://github.com/humanprotocol/human-protocol/blob/3ddf95c166a160d89d0a36078325a2fc8283f02c/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L142)

***

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

#### Defined in

<<<<<<< HEAD
[encryption.ts:73](https://github.com/humanprotocol/human-protocol/blob/3ed5fd393b562534f83a6f2f110eb4e3977deb72/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L73)
=======
[encryption.ts:77](https://github.com/humanprotocol/human-protocol/blob/b190dc1831c2c96fe3d44fd63e915e54011e1ec8/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L77)
>>>>>>> develop
[encryption.ts:77](https://github.com/humanprotocol/human-protocol/blob/3ddf95c166a160d89d0a36078325a2fc8283f02c/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L77)
30 changes: 5 additions & 25 deletions docs/sdk/typescript/encryption/classes/EncryptionUtils.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,11 +103,7 @@ const result = await EncryptionUtils.encrypt('message', publicKeys);

#### Defined in

<<<<<<< HEAD
[encryption.ts:452](https://github.com/humanprotocol/human-protocol/blob/3ed5fd393b562534f83a6f2f110eb4e3977deb72/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L452)
=======
[encryption.ts:444](https://github.com/humanprotocol/human-protocol/blob/b190dc1831c2c96fe3d44fd63e915e54011e1ec8/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L444)
>>>>>>> develop
[encryption.ts:444](https://github.com/humanprotocol/human-protocol/blob/3ddf95c166a160d89d0a36078325a2fc8283f02c/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L444)

***

Expand Down Expand Up @@ -156,11 +152,7 @@ const result = await EncryptionUtils.generateKeyPair(name, email, passphrase);

#### Defined in

<<<<<<< HEAD
[encryption.ts:390](https://github.com/humanprotocol/human-protocol/blob/3ed5fd393b562534f83a6f2f110eb4e3977deb72/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L390)
=======
[encryption.ts:382](https://github.com/humanprotocol/human-protocol/blob/b190dc1831c2c96fe3d44fd63e915e54011e1ec8/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L382)
>>>>>>> develop
[encryption.ts:382](https://github.com/humanprotocol/human-protocol/blob/3ddf95c166a160d89d0a36078325a2fc8283f02c/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L382)

***

Expand Down Expand Up @@ -194,11 +186,7 @@ const signedData = await EncryptionUtils.getSignedData('message');

#### Defined in

<<<<<<< HEAD
[encryption.ts:347](https://github.com/humanprotocol/human-protocol/blob/3ed5fd393b562534f83a6f2f110eb4e3977deb72/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L347)
=======
[encryption.ts:351](https://github.com/humanprotocol/human-protocol/blob/b190dc1831c2c96fe3d44fd63e915e54011e1ec8/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L351)
>>>>>>> develop
[encryption.ts:351](https://github.com/humanprotocol/human-protocol/blob/3ddf95c166a160d89d0a36078325a2fc8283f02c/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L351)

***

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

#### Defined in

<<<<<<< HEAD
[encryption.ts:502](https://github.com/humanprotocol/human-protocol/blob/3ed5fd393b562534f83a6f2f110eb4e3977deb72/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L502)
=======
[encryption.ts:494](https://github.com/humanprotocol/human-protocol/blob/b190dc1831c2c96fe3d44fd63e915e54011e1ec8/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L494)
>>>>>>> develop
[encryption.ts:494](https://github.com/humanprotocol/human-protocol/blob/3ddf95c166a160d89d0a36078325a2fc8283f02c/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L494)

***

Expand Down Expand Up @@ -304,8 +288,4 @@ const result = await EncryptionUtils.verify('message', publicKey);

#### Defined in

<<<<<<< HEAD
[encryption.ts:314](https://github.com/humanprotocol/human-protocol/blob/3ed5fd393b562534f83a6f2f110eb4e3977deb72/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L314)
=======
[encryption.ts:318](https://github.com/humanprotocol/human-protocol/blob/b190dc1831c2c96fe3d44fd63e915e54011e1ec8/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L318)
>>>>>>> develop
[encryption.ts:318](https://github.com/humanprotocol/human-protocol/blob/3ddf95c166a160d89d0a36078325a2fc8283f02c/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L318)
Loading

0 comments on commit fd7c857

Please sign in to comment.