@human-protocol/sdk 2.0.0 → 2.1.0

package/dist/constants.js

@@ -235,7 +235,7 @@ exports.NETWORKS = {
         stakingAddress: '0x9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0',
         rewardPoolAddress: '0xa513E6E4b8f2a923D98304ec87F64353C4D5C853',
         kvstoreAddress: '0x5FC8d32690cc91D4c39d9d3abcBD16989F875707',
-        subgraphUrl: '',
+        subgraphUrl: 'http://localhost:8000/subgraphs/name/humanprotocol/localhost',
         oldSubgraphUrl: '',
         oldFactoryAddress: '',
     },
@@ -243,8 +243,8 @@ exports.NETWORKS = {
 exports.KVStoreKeys = {
     role: 'role',
     fee: 'fee',
-    publicKey: 'publicKey',
-    webhookUrl: 'webhookUrl',
+    publicKey: 'public_key',
+    webhookUrl: 'webhook_url',
     url: 'url',
 };
 exports.Role = {

package/dist/kvstore.d.ts

@@ -141,14 +141,14 @@ export declare class KVStoreClient extends BaseEthersClient {
      * const signer = new Wallet(privateKey, provider);
      * const kvstoreClient = await KVStoreClient.build(signer);
      *
-     * const keys = ['role', 'webhookUrl'];
+     * const keys = ['role', 'webhook_url'];
      * const values = ['RecordingOracle', 'http://localhost'];
      * await kvstoreClient.set(keys, values);
      * ```
      */
     setBulk(keys: string[], values: string[], txOptions?: Overrides): Promise<void>;
     /**
-     * This function sets a URL value for the address that submits the transaction.
+     * Sets a URL value for the address that submits the transaction, and its hash.
      *
      * @param {string} url URL to set
      * @param {string | undefined} urlKey Configurable URL key. `url` by default.
@@ -169,13 +169,13 @@ export declare class KVStoreClient extends BaseEthersClient {
      * const signer = new Wallet(privateKey, provider);
      * const kvstoreClient = await KVStoreClient.build(signer);
      *
-     * await kvstoreClient.setURL('example.com');
-     * await kvstoreClient.setURL('linkedin.com/example', 'linkedinUrl);
+     * await kvstoreClient.setFileUrlAndHash('example.com');
+     * await kvstoreClient.setFileUrlAndHash('linkedin.com/example', 'linkedin_url);
      * ```
      */
-    setURL(url: string, urlKey?: string, txOptions?: Overrides): Promise<void>;
+    setFileUrlAndHash(url: string, urlKey?: string, txOptions?: Overrides): Promise<void>;
     /**
-     * This function returns the value for a specified key and address.
+     * Gets the value of a key-value pair in the contract.
      *
      * @param {string} address Address from which to get the key value.
      * @param {string} key Key to obtain the value.
@@ -200,7 +200,7 @@ export declare class KVStoreClient extends BaseEthersClient {
      */
     get(address: string, key: string): Promise<string>;
     /**
-     * This function returns the URL value for the given entity.
+     * Gets the URL value of the given entity, and verify its hash.
      *
      * @param {string} address Address from which to get the URL value.
      * @param {string} urlKey  Configurable URL key. `url` by default.
@@ -218,13 +218,35 @@ export declare class KVStoreClient extends BaseEthersClient {
      * const provider = new providers.JsonRpcProvider(rpcUrl);
      * const kvstoreClient = await KVStoreClient.build(provider);
      *
-     * const url = await kvstoreClient.getURL('0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266');
-     * const linkedinUrl = await kvstoreClient.getURL(
+     * const url = await kvstoreClient.getFileUrlAndVerifyHash('0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266');
+     * const linkedinUrl = await kvstoreClient.getFileUrlAndVerifyHash(
      *    '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
-     *    'linkedinUrl'
+     *    'linkedin_url'
      * );
      * ```
      */
-    getURL(address: string, urlKey?: string): Promise<string>;
+    getFileUrlAndVerifyHash(address: string, urlKey?: string): Promise<string>;
+    /**
+     * Gets the public key of the given entity, and verify its hash.
+     *
+     * @param {string} address Address from which to get the public key.
+     * @returns {string} Public key for the given address if exists, and the content is valid
+     *
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { providers } from 'ethers';
+     * import { KVStoreClient } from '@human-protocol/sdk';
+     *
+     * const rpcUrl = 'YOUR_RPC_URL';
+     *
+     * const provider = new providers.JsonRpcProvider(rpcUrl);
+     * const kvstoreClient = await KVStoreClient.build(provider);
+     *
+     * const publicKey = await kvstoreClient.getPublicKey('0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266');
+     * ```
+     */
+    getPublicKey(address: string): Promise<string>;
 }
 //# sourceMappingURL=kvstore.d.ts.map

package/dist/kvstore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kvstore.d.ts","sourceRoot":"","sources":["../src/kvstore.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAU,MAAM,QAAQ,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAa1C,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,qBAAa,aAAc,SAAQ,gBAAgB;IACjD,OAAO,CAAC,QAAQ,CAAU;IAE1B;;;;;OAKG;gBACS,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW;IAS5D;;;;;;;;OAQG;WACiB,KAAK,CAAC,MAAM,EAAE,cAAc;IAiBhD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IAEU,GAAG,CACd,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAShB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IAEU,OAAO,CAClB,IAAI,EAAE,MAAM,EAAE,EACd,MAAM,EAAE,MAAM,EAAE,EAChB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAYhB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEU,MAAM,CACjB,GAAG,EAAE,MAAM,EACX,MAAM,SAAQ,EACd,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAwBhB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAa/D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,SAAQ,GAAG,OAAO,CAAC,MAAM,CAAC;CAiCtE"}
+{"version":3,"file":"kvstore.d.ts","sourceRoot":"","sources":["../src/kvstore.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAU,MAAM,QAAQ,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAa1C,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,qBAAa,aAAc,SAAQ,gBAAgB;IACjD,OAAO,CAAC,QAAQ,CAAU;IAE1B;;;;;OAKG;gBACS,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW;IAS5D;;;;;;;;OAQG;WACiB,KAAK,CAAC,MAAM,EAAE,cAAc;IAiBhD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IAEU,GAAG,CACd,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAShB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IAEU,OAAO,CAClB,IAAI,EAAE,MAAM,EAAE,EACd,MAAM,EAAE,MAAM,EAAE,EAChB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAYhB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEU,iBAAiB,CAC5B,GAAG,EAAE,MAAM,EACX,MAAM,SAAQ,EACd,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAwBhB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAa/D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,uBAAuB,CAClC,OAAO,EAAE,MAAM,EACf,MAAM,SAAQ,GACb,OAAO,CAAC,MAAM,CAAC;IAkClB;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAc5D"}

package/dist/kvstore.js

@@ -180,7 +180,7 @@ class KVStoreClient extends base_1.BaseEthersClient {
      * const signer = new Wallet(privateKey, provider);
      * const kvstoreClient = await KVStoreClient.build(signer);
      *
-     * const keys = ['role', 'webhookUrl'];
+     * const keys = ['role', 'webhook_url'];
      * const values = ['RecordingOracle', 'http://localhost'];
      * await kvstoreClient.set(keys, values);
      * ```
@@ -199,7 +199,7 @@ class KVStoreClient extends base_1.BaseEthersClient {
         }
     }
     /**
-     * This function sets a URL value for the address that submits the transaction.
+     * Sets a URL value for the address that submits the transaction, and its hash.
      *
      * @param {string} url URL to set
      * @param {string | undefined} urlKey Configurable URL key. `url` by default.
@@ -220,17 +220,17 @@ class KVStoreClient extends base_1.BaseEthersClient {
      * const signer = new Wallet(privateKey, provider);
      * const kvstoreClient = await KVStoreClient.build(signer);
      *
-     * await kvstoreClient.setURL('example.com');
-     * await kvstoreClient.setURL('linkedin.com/example', 'linkedinUrl);
+     * await kvstoreClient.setFileUrlAndHash('example.com');
+     * await kvstoreClient.setFileUrlAndHash('linkedin.com/example', 'linkedin_url);
      * ```
      */
-    async setURL(url, urlKey = 'url', txOptions = {}) {
+    async setFileUrlAndHash(url, urlKey = 'url', txOptions = {}) {
         if (!(0, utils_1.isValidUrl)(url)) {
             throw error_1.ErrorInvalidUrl;
         }
         const content = await fetch(url).then((res) => res.text());
         const contentHash = ethers_1.ethers.keccak256(ethers_1.ethers.toUtf8Bytes(content));
-        const hashKey = urlKey + 'Hash';
+        const hashKey = urlKey + '_hash';
         try {
             await (await this.contract.setBulk([urlKey, hashKey], [url, contentHash], txOptions)).wait();
         }
@@ -240,7 +240,7 @@ class KVStoreClient extends base_1.BaseEthersClient {
         }
     }
     /**
-     * This function returns the value for a specified key and address.
+     * Gets the value of a key-value pair in the contract.
      *
      * @param {string} address Address from which to get the key value.
      * @param {string} key Key to obtain the value.
@@ -279,7 +279,7 @@ class KVStoreClient extends base_1.BaseEthersClient {
         }
     }
     /**
-     * This function returns the URL value for the given entity.
+     * Gets the URL value of the given entity, and verify its hash.
      *
      * @param {string} address Address from which to get the URL value.
      * @param {string} urlKey  Configurable URL key. `url` by default.
@@ -297,17 +297,17 @@ class KVStoreClient extends base_1.BaseEthersClient {
      * const provider = new providers.JsonRpcProvider(rpcUrl);
      * const kvstoreClient = await KVStoreClient.build(provider);
      *
-     * const url = await kvstoreClient.getURL('0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266');
-     * const linkedinUrl = await kvstoreClient.getURL(
+     * const url = await kvstoreClient.getFileUrlAndVerifyHash('0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266');
+     * const linkedinUrl = await kvstoreClient.getFileUrlAndVerifyHash(
      *    '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
-     *    'linkedinUrl'
+     *    'linkedin_url'
      * );
      * ```
      */
-    async getURL(address, urlKey = 'url') {
+    async getFileUrlAndVerifyHash(address, urlKey = 'url') {
         if (!ethers_1.ethers.isAddress(address))
             throw error_1.ErrorInvalidAddress;
-        const hashKey = urlKey + 'Hash';
+        const hashKey = urlKey + '_hash';
         let url = '', hash = '';
         try {
             url = await this.contract?.get(address, urlKey);
@@ -334,6 +334,35 @@ class KVStoreClient extends base_1.BaseEthersClient {
         }
         return url;
     }
+    /**
+     * Gets the public key of the given entity, and verify its hash.
+     *
+     * @param {string} address Address from which to get the public key.
+     * @returns {string} Public key for the given address if exists, and the content is valid
+     *
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { providers } from 'ethers';
+     * import { KVStoreClient } from '@human-protocol/sdk';
+     *
+     * const rpcUrl = 'YOUR_RPC_URL';
+     *
+     * const provider = new providers.JsonRpcProvider(rpcUrl);
+     * const kvstoreClient = await KVStoreClient.build(provider);
+     *
+     * const publicKey = await kvstoreClient.getPublicKey('0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266');
+     * ```
+     */
+    async getPublicKey(address) {
+        const publicKeyUrl = await this.getFileUrlAndVerifyHash(address, constants_1.KVStoreKeys.publicKey);
+        if (publicKeyUrl === '') {
+            return '';
+        }
+        const publicKey = await fetch(publicKeyUrl).then((res) => res.text());
+        return publicKey;
+    }
 }
 __decorate([
     decorators_1.requiresSigner,
@@ -352,5 +381,5 @@ __decorate([
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [String, Object, Object]),
     __metadata("design:returntype", Promise)
-], KVStoreClient.prototype, "setURL", null);
+], KVStoreClient.prototype, "setFileUrlAndHash", null);
 exports.KVStoreClient = KVStoreClient;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@human-protocol/sdk",
   "description": "Human Protocol SDK",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "files": [
     "src",
     "dist"

package/src/constants.ts

@@ -260,7 +260,7 @@ export const NETWORKS: {
     stakingAddress: '0x9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0',
     rewardPoolAddress: '0xa513E6E4b8f2a923D98304ec87F64353C4D5C853',
     kvstoreAddress: '0x5FC8d32690cc91D4c39d9d3abcBD16989F875707',
-    subgraphUrl: '',
+    subgraphUrl: 'http://localhost:8000/subgraphs/name/humanprotocol/localhost',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
@@ -269,8 +269,8 @@ export const NETWORKS: {
 export const KVStoreKeys = {
   role: 'role',
   fee: 'fee',
-  publicKey: 'publicKey',
-  webhookUrl: 'webhookUrl',
+  publicKey: 'public_key',
+  webhookUrl: 'webhook_url',
   url: 'url',
 };
 

package/src/kvstore.ts

@@ -4,7 +4,7 @@ import {
 } from '@human-protocol/core/typechain-types';
 import { ContractRunner, Overrides, ethers } from 'ethers';
 import { BaseEthersClient } from './base';
-import { NETWORKS } from './constants';
+import { KVStoreKeys, NETWORKS } from './constants';
 import { requiresSigner } from './decorators';
 import { ChainId } from './enums';
 import {
@@ -197,7 +197,7 @@ export class KVStoreClient extends BaseEthersClient {
    * const signer = new Wallet(privateKey, provider);
    * const kvstoreClient = await KVStoreClient.build(signer);
    *
-   * const keys = ['role', 'webhookUrl'];
+   * const keys = ['role', 'webhook_url'];
    * const values = ['RecordingOracle', 'http://localhost'];
    * await kvstoreClient.set(keys, values);
    * ```
@@ -220,7 +220,7 @@ export class KVStoreClient extends BaseEthersClient {
   }
 
   /**
-   * This function sets a URL value for the address that submits the transaction.
+   * Sets a URL value for the address that submits the transaction, and its hash.
    *
    * @param {string} url URL to set
    * @param {string | undefined} urlKey Configurable URL key. `url` by default.
@@ -241,12 +241,12 @@ export class KVStoreClient extends BaseEthersClient {
    * const signer = new Wallet(privateKey, provider);
    * const kvstoreClient = await KVStoreClient.build(signer);
    *
-   * await kvstoreClient.setURL('example.com');
-   * await kvstoreClient.setURL('linkedin.com/example', 'linkedinUrl);
+   * await kvstoreClient.setFileUrlAndHash('example.com');
+   * await kvstoreClient.setFileUrlAndHash('linkedin.com/example', 'linkedin_url);
    * ```
    */
   @requiresSigner
-  public async setURL(
+  public async setFileUrlAndHash(
     url: string,
     urlKey = 'url',
     txOptions: Overrides = {}
@@ -258,7 +258,7 @@ export class KVStoreClient extends BaseEthersClient {
     const content = await fetch(url).then((res) => res.text());
     const contentHash = ethers.keccak256(ethers.toUtf8Bytes(content));
 
-    const hashKey = urlKey + 'Hash';
+    const hashKey = urlKey + '_hash';
 
     try {
       await (
@@ -275,7 +275,7 @@ export class KVStoreClient extends BaseEthersClient {
   }
 
   /**
-   * This function returns the value for a specified key and address.
+   * Gets the value of a key-value pair in the contract.
    *
    * @param {string} address Address from which to get the key value.
    * @param {string} key Key to obtain the value.
@@ -312,7 +312,7 @@ export class KVStoreClient extends BaseEthersClient {
   }
 
   /**
-   * This function returns the URL value for the given entity.
+   * Gets the URL value of the given entity, and verify its hash.
    *
    * @param {string} address Address from which to get the URL value.
    * @param {string} urlKey  Configurable URL key. `url` by default.
@@ -330,16 +330,19 @@ export class KVStoreClient extends BaseEthersClient {
    * const provider = new providers.JsonRpcProvider(rpcUrl);
    * const kvstoreClient = await KVStoreClient.build(provider);
    *
-   * const url = await kvstoreClient.getURL('0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266');
-   * const linkedinUrl = await kvstoreClient.getURL(
+   * const url = await kvstoreClient.getFileUrlAndVerifyHash('0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266');
+   * const linkedinUrl = await kvstoreClient.getFileUrlAndVerifyHash(
    *    '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
-   *    'linkedinUrl'
+   *    'linkedin_url'
    * );
    * ```
    */
-  public async getURL(address: string, urlKey = 'url'): Promise<string> {
+  public async getFileUrlAndVerifyHash(
+    address: string,
+    urlKey = 'url'
+  ): Promise<string> {
     if (!ethers.isAddress(address)) throw ErrorInvalidAddress;
-    const hashKey = urlKey + 'Hash';
+    const hashKey = urlKey + '_hash';
 
     let url = '',
       hash = '';
@@ -370,4 +373,40 @@ export class KVStoreClient extends BaseEthersClient {
 
     return url;
   }
+
+  /**
+   * Gets the public key of the given entity, and verify its hash.
+   *
+   * @param {string} address Address from which to get the public key.
+   * @returns {string} Public key for the given address if exists, and the content is valid
+   *
+   *
+   * **Code example**
+   *
+   * ```ts
+   * import { providers } from 'ethers';
+   * import { KVStoreClient } from '@human-protocol/sdk';
+   *
+   * const rpcUrl = 'YOUR_RPC_URL';
+   *
+   * const provider = new providers.JsonRpcProvider(rpcUrl);
+   * const kvstoreClient = await KVStoreClient.build(provider);
+   *
+   * const publicKey = await kvstoreClient.getPublicKey('0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266');
+   * ```
+   */
+  public async getPublicKey(address: string): Promise<string> {
+    const publicKeyUrl = await this.getFileUrlAndVerifyHash(
+      address,
+      KVStoreKeys.publicKey
+    );
+
+    if (publicKeyUrl === '') {
+      return '';
+    }
+
+    const publicKey = await fetch(publicKeyUrl).then((res) => res.text());
+
+    return publicKey;
+  }
 }