Skip to content

Commit

Permalink
change enum kvstore name key to avoid issues with docs
Browse files Browse the repository at this point in the history
  • Loading branch information
portuu3 committed Feb 6, 2025
1 parent b718aa9 commit 8504d3e
Show file tree
Hide file tree
Showing 69 changed files with 291 additions and 288 deletions.
4 changes: 3 additions & 1 deletion docs/sdk/python/human_protocol_sdk.constants.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ Enum for KVStore keys
#### fee *= 'fee'*

#### job_types *= 'job_types'*
#### name *= 'name'*

#### operator_name *= 'name'*

#### public_key *= 'public_key'*

#### public_key_hash *= 'public_key_hash'*
Expand Down
1 change: 1 addition & 0 deletions docs/sdk/python/human_protocol_sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@
* [`KVStoreKeys.category`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.category)
* [`KVStoreKeys.fee`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.fee)
* [`KVStoreKeys.job_types`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.job_types)
* [`KVStoreKeys.operator_name`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.operator_name)
* [`KVStoreKeys.public_key`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.public_key)
* [`KVStoreKeys.public_key_hash`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.public_key_hash)
* [`KVStoreKeys.registration_instructions`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.registration_instructions)
Expand Down
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/000ef2f7891c6788228277729f8de9c3a0456a70/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L20)
[base.ts:20](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/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/000ef2f7891c6788228277729f8de9c3a0456a70/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
[base.ts:12](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/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/000ef2f7891c6788228277729f8de9c3a0456a70/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)
[base.ts:11](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/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:66](https://github.com/humanprotocol/human-protocol/blob/000ef2f7891c6788228277729f8de9c3a0456a70/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L66)
[encryption.ts:66](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L66)

## Methods

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

#### Defined in

[encryption.ts:194](https://github.com/humanprotocol/human-protocol/blob/000ef2f7891c6788228277729f8de9c3a0456a70/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L194)
[encryption.ts:194](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L194)

***

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

#### Defined in

[encryption.ts:251](https://github.com/humanprotocol/human-protocol/blob/000ef2f7891c6788228277729f8de9c3a0456a70/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L251)
[encryption.ts:251](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L251)

***

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

#### Defined in

[encryption.ts:142](https://github.com/humanprotocol/human-protocol/blob/000ef2f7891c6788228277729f8de9c3a0456a70/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L142)
[encryption.ts:142](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L142)

***

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

#### Defined in

[encryption.ts:77](https://github.com/humanprotocol/human-protocol/blob/000ef2f7891c6788228277729f8de9c3a0456a70/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L77)
[encryption.ts:77](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L77)
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 EncryptionUtils.encrypt('message', publicKeys);

#### Defined in

[encryption.ts:444](https://github.com/humanprotocol/human-protocol/blob/000ef2f7891c6788228277729f8de9c3a0456a70/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L444)
[encryption.ts:444](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L444)

***

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

#### Defined in

[encryption.ts:382](https://github.com/humanprotocol/human-protocol/blob/000ef2f7891c6788228277729f8de9c3a0456a70/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L382)
[encryption.ts:382](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L382)

***

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

#### Defined in

[encryption.ts:351](https://github.com/humanprotocol/human-protocol/blob/000ef2f7891c6788228277729f8de9c3a0456a70/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L351)
[encryption.ts:351](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L351)

***

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

#### Defined in

[encryption.ts:494](https://github.com/humanprotocol/human-protocol/blob/000ef2f7891c6788228277729f8de9c3a0456a70/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L494)
[encryption.ts:494](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L494)

***

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

#### Defined in

[encryption.ts:318](https://github.com/humanprotocol/human-protocol/blob/000ef2f7891c6788228277729f8de9c3a0456a70/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L318)
[encryption.ts:318](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L318)
16 changes: 8 additions & 8 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/000ef2f7891c6788228277729f8de9c3a0456a70/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L2)
[enums.ts:2](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L2)

***

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

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

***

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

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

***

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

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

***

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

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

***

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

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

***

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

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

***

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

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

[enums.ts:18](https://github.com/humanprotocol/human-protocol/blob/000ef2f7891c6788228277729f8de9c3a0456a70/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L18)
[enums.ts:18](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L18)

***

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

[enums.ts:19](https://github.com/humanprotocol/human-protocol/blob/000ef2f7891c6788228277729f8de9c3a0456a70/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L19)
[enums.ts:19](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L19)
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:13](https://github.com/humanprotocol/human-protocol/blob/000ef2f7891c6788228277729f8de9c3a0456a70/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L13)
[enums.ts:13](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L13)

***

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

[enums.ts:14](https://github.com/humanprotocol/human-protocol/blob/000ef2f7891c6788228277729f8de9c3a0456a70/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L14)
[enums.ts:14](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L14)
Loading

0 comments on commit 8504d3e

Please sign in to comment.