KVStoreClient
@human-protocol/sdk / Modules / kvstore / KVStoreClient
Class: KVStoreClient
kvstore.KVStoreClient
Introduction
This client enables to perform actions on KVStore contract and obtain information from both the contracts and subgraph.
Internally, the SDK will use one network or another according to the network ID of the signerOrProvider
. To use this client, it is recommended to initialize it using the static build
method.
A Signer
or a Provider
should be passed depending on the use case of this module:
Signer: when the user wants to use this model in order to send transactions caling the contract functions.
Provider: when the user wants to use this model in order to get information from the contracts or subgraph.
Installation
npm
yarn
Code example
Signer
Using private key(backend)
Using Wagmi(frontend)
Provider
Hierarchy
↳
KVStoreClient
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new KVStoreClient(signerOrProvider
, networkData
, gasPriceMultiplier?
)
KVStoreClient constructor
Parameters
Name | Type | Description |
---|---|---|
|
| The Signer or Provider object to interact with the Ethereum network |
|
| - |
|
| The multiplier to apply to the gas price |
Overrides
Defined in
Properties
contract
• Private
contract: KVStore
Defined in
gasPriceMultiplier
• Protected
Optional
gasPriceMultiplier: number
Inherited from
BaseEthersClient.gasPriceMultiplier
Defined in
networkData
• networkData: NetworkData
Inherited from
Defined in
signerOrProvider
• Protected
signerOrProvider: Signer
| Provider
Inherited from
BaseEthersClient.signerOrProvider
Defined in
Methods
gasPriceOptions
▸ Protected
gasPriceOptions(): Promise
<Partial
<Overrides
>>
Adjust the gas price, and return as an option to be passed to a transaction
Returns
Promise
<Partial
<Overrides
>>
Returns the gas price options
Inherited from
BaseEthersClient.gasPriceOptions
Defined in
get
▸ get(address
, key
): Promise
<string
>
This function returns the value for a specified key and address.
Parameters
Name | Type | Description |
---|---|---|
|
| Address from which to get the key value. |
|
| Key to obtain the value. |
Returns
Promise
<string
>
Value of the key.
Code example
Need to have available stake.
Defined in
getURL
▸ getURL(address
, urlKey?
): Promise
<string
>
This function returns the URL value for the given entity.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
|
|
| Address from which to get the URL value. |
|
|
| Configurable URL key. |
Returns
Promise
<string
>
URL value for the given address if exists, and the content is valid
Code example
Defined in
set
▸ set(key
, value
): Promise
<void
>
This function sets a key-value pair associated with the address that submits the transaction.
Parameters
Name | Type | Description |
---|---|---|
|
| Key of the key-value pair |
|
| Value of the key-value pair |
Returns
Promise
<void
>
Returns void if successful. Throws error if any.
Code example
Need to have available stake.
Defined in
setBulk
▸ setBulk(keys
, values
): Promise
<void
>
This function sets key-value pairs in bulk associated with the address that submits the transaction.
Parameters
Name | Type | Description |
---|---|---|
|
| Array of keys (keys and value must have the same order) |
|
| Array of values |
Returns
Promise
<void
>
Returns void if successful. Throws error if any.
Code example
Need to have available stake.
Defined in
setURL
▸ setURL(url
, urlKey?
): Promise
<void
>
This function sets a URL value for the address that submits the transaction.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
|
|
| URL to set |
|
|
| Configurable URL key. |
Returns
Promise
<void
>
Returns void if successful. Throws error if any.
Code example
Defined in
build
▸ Static
build(signerOrProvider
, gasPriceMultiplier?
): Promise
<KVStoreClient
>
Creates an instance of KVStoreClient from a Signer or Provider.
Parameters
Name | Type | Description |
---|---|---|
|
| The Signer or Provider object to interact with the Ethereum network |
|
| The multiplier to apply to the gas price |
Returns
Promise
<KVStoreClient
>
An instance of KVStoreClient
Throws
Thrown if the provider does not exist for the provided Signer
Throws
Thrown if the network's chainId is not supported
Defined in
Last updated