@human-protocol/sdk 3.0.8 → 4.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/dist/constants.d.ts +4 -1
  2. package/dist/constants.d.ts.map +1 -1
  3. package/dist/constants.js +11 -151
  4. package/dist/decorators.js +1 -1
  5. package/dist/encryption.d.ts +21 -29
  6. package/dist/encryption.d.ts.map +1 -1
  7. package/dist/encryption.js +17 -29
  8. package/dist/enums.d.ts +5 -12
  9. package/dist/enums.d.ts.map +1 -1
  10. package/dist/enums.js +6 -12
  11. package/dist/error.d.ts +31 -28
  12. package/dist/error.d.ts.map +1 -1
  13. package/dist/error.js +36 -33
  14. package/dist/escrow.d.ts +104 -88
  15. package/dist/escrow.d.ts.map +1 -1
  16. package/dist/escrow.js +192 -131
  17. package/dist/graphql/queries/operator.d.ts.map +1 -1
  18. package/dist/graphql/queries/operator.js +15 -5
  19. package/dist/interfaces.d.ts +12 -2
  20. package/dist/interfaces.d.ts.map +1 -1
  21. package/dist/kvstore.d.ts +15 -15
  22. package/dist/kvstore.d.ts.map +1 -1
  23. package/dist/kvstore.js +15 -15
  24. package/dist/operator.d.ts +11 -10
  25. package/dist/operator.d.ts.map +1 -1
  26. package/dist/operator.js +23 -11
  27. package/dist/staking.d.ts +38 -21
  28. package/dist/staking.d.ts.map +1 -1
  29. package/dist/staking.js +62 -21
  30. package/dist/statistics.d.ts +10 -29
  31. package/dist/statistics.d.ts.map +1 -1
  32. package/dist/statistics.js +18 -37
  33. package/dist/storage.d.ts +13 -18
  34. package/dist/storage.d.ts.map +1 -1
  35. package/dist/storage.js +13 -18
  36. package/dist/transaction.d.ts.map +1 -1
  37. package/dist/transaction.js +3 -5
  38. package/dist/types.d.ts +6 -2
  39. package/dist/types.d.ts.map +1 -1
  40. package/dist/types.js +1 -1
  41. package/dist/utils.d.ts +7 -1
  42. package/dist/utils.d.ts.map +1 -1
  43. package/dist/utils.js +11 -2
  44. package/package.json +1 -1
  45. package/src/constants.ts +11 -174
  46. package/src/decorators.ts +1 -1
  47. package/src/encryption.ts +21 -29
  48. package/src/enums.ts +5 -11
  49. package/src/error.ts +39 -37
  50. package/src/escrow.ts +257 -151
  51. package/src/graphql/queries/operator.ts +15 -5
  52. package/src/interfaces.ts +13 -2
  53. package/src/kvstore.ts +16 -16
  54. package/src/operator.ts +26 -12
  55. package/src/staking.ts +71 -22
  56. package/src/statistics.ts +19 -38
  57. package/src/storage.ts +13 -18
  58. package/src/transaction.ts +5 -7
  59. package/src/types.ts +6 -2
  60. package/src/utils.ts +10 -1
@@ -1 +1 @@
1
- {"version":3,"file":"operator.d.ts","sourceRoot":"","sources":["../../../src/graphql/queries/operator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AA0BhD,eAAO,MAAM,iBAAiB,WAAY,cAAc,mCAuBvD,CAAC;AAEF,eAAO,MAAM,4BAA4B,UAAW,MAAM,mCA0BzD,CAAC;AAEF,eAAO,MAAM,gBAAgB,gCAO5B,CAAC"}
1
+ {"version":3,"file":"operator.d.ts","sourceRoot":"","sources":["../../../src/graphql/queries/operator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AA4BhD,eAAO,MAAM,iBAAiB,WAAY,cAAc,mCA+BvD,CAAC;AAEF,eAAO,MAAM,4BAA4B,UAAW,MAAM,mCA0BzD,CAAC;AAEF,eAAO,MAAM,gBAAgB,gCAO5B,CAAC"}
@@ -26,23 +26,33 @@ const LEADER_FRAGMENT = (0, graphql_tag_1.default) `
26
26
  registrationNeeded
27
27
  registrationInstructions
28
28
  reputationNetworks
29
+ name
30
+ category
29
31
  }
30
32
  `;
31
33
  const GET_LEADERS_QUERY = (filter) => {
32
- const { role } = filter;
34
+ const { roles, minAmountStaked } = filter;
33
35
  const WHERE_CLAUSE = `
34
36
  where: {
35
- ${role ? `role: $role` : ''}
37
+ ${minAmountStaked ? `amountStaked_gte: $minAmountStaked` : ''}
38
+ ${roles ? `role_in: $roles` : ''}
36
39
  }
37
40
  `;
38
41
  return (0, graphql_tag_1.default) `
39
42
  query getLeaders(
40
- $role: String
43
+ $minAmountStaked: Int,
44
+ $roles: [String!]
45
+ $first: Int
46
+ $skip: Int
47
+ $orderBy: String
48
+ $orderDirection: String
41
49
  ) {
42
50
  leaders(
43
51
  ${WHERE_CLAUSE}
44
- orderBy: amountStaked,
45
- orderDirection: desc,
52
+ first: $first
53
+ skip: $skip
54
+ orderBy: $orderBy
55
+ orderDirection: $orderDirection
46
56
  ) {
47
57
  ...LeaderFields
48
58
  }
@@ -25,6 +25,8 @@ export interface ILeader {
25
25
  registrationNeeded?: boolean;
26
26
  registrationInstructions?: string;
27
27
  reputationNetworks?: string[];
28
+ name?: string;
29
+ category?: string;
28
30
  }
29
31
  export interface ILeaderSubgraph extends Omit<ILeader, 'jobTypes' | 'reputationNetworks' | 'chainId'> {
30
32
  jobTypes?: string;
@@ -32,9 +34,11 @@ export interface ILeaderSubgraph extends Omit<ILeader, 'jobTypes' | 'reputationN
32
34
  address: string;
33
35
  }[];
34
36
  }
35
- export interface ILeadersFilter {
37
+ export interface ILeadersFilter extends IPagination {
36
38
  chainId: ChainId;
37
- role?: string;
39
+ roles?: string[];
40
+ minAmountStaked?: number;
41
+ orderBy?: string;
38
42
  }
39
43
  export interface IReputationNetwork {
40
44
  id: string;
@@ -135,4 +139,10 @@ export interface IPagination {
135
139
  skip?: number;
136
140
  orderDirection?: OrderDirection;
137
141
  }
142
+ export interface StakerInfo {
143
+ stakedAmount: bigint;
144
+ lockedAmount: bigint;
145
+ lockedUntil: bigint;
146
+ withdrawableAmount: bigint;
147
+ }
138
148
  //# sourceMappingURL=interfaces.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAElD,MAAM,WAAW,OAAO;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB,EAAE,MAAM,CAAC;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,eACf,SAAQ,IAAI,CAAC,OAAO,EAAE,UAAU,GAAG,oBAAoB,GAAG,SAAS,CAAC;IACpE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC5C;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,SAAS,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,0BACf,SAAQ,IAAI,CAAC,kBAAkB,EAAE,WAAW,CAAC;IAC7C,SAAS,EAAE,iBAAiB,EAAE,CAAC;CAChC;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,iBAAkB,SAAQ,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC;IACpE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;IACV,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,QAAQ;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;CACX;AAED,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;CACX;AAED,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oBAAoB,EAAE,mBAAmB,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC"}
1
+ {"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAElD,MAAM,WAAW,OAAO;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB,EAAE,MAAM,CAAC;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,eACf,SAAQ,IAAI,CAAC,OAAO,EAAE,UAAU,GAAG,oBAAoB,GAAG,SAAS,CAAC;IACpE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC5C;AAED,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,SAAS,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,0BACf,SAAQ,IAAI,CAAC,kBAAkB,EAAE,WAAW,CAAC;IAC7C,SAAS,EAAE,iBAAiB,EAAE,CAAC;CAChC;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,iBAAkB,SAAQ,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC;IACpE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;IACV,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,QAAQ;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;CACX;AAED,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;CACX;AAED,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oBAAoB,EAAE,mBAAmB,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED,MAAM,WAAW,UAAU;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;CAC5B"}
package/dist/kvstore.d.ts CHANGED
@@ -6,19 +6,19 @@ import { IKVStore } from './interfaces';
6
6
  /**
7
7
  * ## Introduction
8
8
  *
9
- * This client enables to perform actions on KVStore contract and obtain information from both the contracts and subgraph.
9
+ * This client enables performing actions on KVStore contract and obtaining information from both the contracts and subgraph.
10
10
  *
11
11
  * Internally, the SDK will use one network or another according to the network ID of the `runner`.
12
12
  * To use this client, it is recommended to initialize it using the static `build` method.
13
13
  *
14
14
  * ```ts
15
- * static async build(runner: ContractRunner);
15
+ * static async build(runner: ContractRunner): Promise<KVStoreClient>;
16
16
  * ```
17
17
  *
18
18
  * A `Signer` or a `Provider` should be passed depending on the use case of this module:
19
19
  *
20
- * - **Signer**: when the user wants to use this model in order to send transactions caling the contract functions.
21
- * - **Provider**: when the user wants to use this model in order to get information from the contracts or subgraph.
20
+ * - **Signer**: when the user wants to use this model to send transactions calling the contract functions.
21
+ * - **Provider**: when the user wants to use this model to get information from the contracts or subgraph.
22
22
  *
23
23
  * ## Installation
24
24
  *
@@ -36,21 +36,21 @@ import { IKVStore } from './interfaces';
36
36
  *
37
37
  * ### Signer
38
38
  *
39
- * **Using private key(backend)**
39
+ * **Using private key (backend)**
40
40
  *
41
41
  * ```ts
42
42
  * import { KVStoreClient } from '@human-protocol/sdk';
43
43
  * import { Wallet, providers } from 'ethers';
44
44
  *
45
45
  * const rpcUrl = 'YOUR_RPC_URL';
46
- * const privateKey = 'YOUR_PRIVATE_KEY'
46
+ * const privateKey = 'YOUR_PRIVATE_KEY';
47
47
  *
48
48
  * const provider = new providers.JsonRpcProvider(rpcUrl);
49
49
  * const signer = new Wallet(privateKey, provider);
50
50
  * const kvstoreClient = await KVStoreClient.build(signer);
51
51
  * ```
52
52
  *
53
- * **Using Wagmi(frontend)**
53
+ * **Using Wagmi (frontend)**
54
54
  *
55
55
  * ```ts
56
56
  * import { useSigner, useChainId } from 'wagmi';
@@ -69,7 +69,7 @@ import { IKVStore } from './interfaces';
69
69
  * const rpcUrl = 'YOUR_RPC_URL';
70
70
  *
71
71
  * const provider = new providers.JsonRpcProvider(rpcUrl);
72
- * const kvstoreClient = await KVStoreClient.build(signer);
72
+ * const kvstoreClient = await KVStoreClient.build(provider);
73
73
  * ```
74
74
  */
75
75
  export declare class KVStoreClient extends BaseEthersClient {
@@ -109,7 +109,7 @@ export declare class KVStoreClient extends BaseEthersClient {
109
109
  * import { KVStoreClient } from '@human-protocol/sdk';
110
110
  *
111
111
  * const rpcUrl = 'YOUR_RPC_URL';
112
- * const privateKey = 'YOUR_PRIVATE_KEY'
112
+ * const privateKey = 'YOUR_PRIVATE_KEY';
113
113
  *
114
114
  * const provider = new providers.JsonRpcProvider(rpcUrl);
115
115
  * const signer = new Wallet(privateKey, provider);
@@ -137,7 +137,7 @@ export declare class KVStoreClient extends BaseEthersClient {
137
137
  * import { KVStoreClient } from '@human-protocol/sdk';
138
138
  *
139
139
  * const rpcUrl = 'YOUR_RPC_URL';
140
- * const privateKey = 'YOUR_PRIVATE_KEY'
140
+ * const privateKey = 'YOUR_PRIVATE_KEY';
141
141
  *
142
142
  * const provider = new providers.JsonRpcProvider(rpcUrl);
143
143
  * const signer = new Wallet(privateKey, provider);
@@ -145,7 +145,7 @@ export declare class KVStoreClient extends BaseEthersClient {
145
145
  *
146
146
  * const keys = ['role', 'webhook_url'];
147
147
  * const values = ['RecordingOracle', 'http://localhost'];
148
- * await kvstoreClient.set(keys, values);
148
+ * await kvstoreClient.setBulk(keys, values);
149
149
  * ```
150
150
  */
151
151
  setBulk(keys: string[], values: string[], txOptions?: Overrides): Promise<void>;
@@ -165,14 +165,14 @@ export declare class KVStoreClient extends BaseEthersClient {
165
165
  * import { KVStoreClient } from '@human-protocol/sdk';
166
166
  *
167
167
  * const rpcUrl = 'YOUR_RPC_URL';
168
- * const privateKey = 'YOUR_PRIVATE_KEY'
168
+ * const privateKey = 'YOUR_PRIVATE_KEY';
169
169
  *
170
170
  * const provider = new providers.JsonRpcProvider(rpcUrl);
171
171
  * const signer = new Wallet(privateKey, provider);
172
172
  * const kvstoreClient = await KVStoreClient.build(signer);
173
173
  *
174
174
  * await kvstoreClient.setFileUrlAndHash('example.com');
175
- * await kvstoreClient.setFileUrlAndHash('linkedin.com/example', 'linkedin_url);
175
+ * await kvstoreClient.setFileUrlAndHash('linkedin.com/example', 'linkedin_url');
176
176
  * ```
177
177
  */
178
178
  setFileUrlAndHash(url: string, urlKey?: string, txOptions?: Overrides): Promise<void>;
@@ -203,9 +203,9 @@ export declare class KVStoreClient extends BaseEthersClient {
203
203
  * ```ts
204
204
  * import { ChainId, KVStoreUtils } from '@human-protocol/sdk';
205
205
  *
206
- * const KVStoreAddresses = new KVStoreUtils.getKVStoreData({
206
+ * const KVStoreAddresses = await KVStoreUtils.getKVStoreData(
207
207
  * ChainId.POLYGON_AMOY,
208
- * "0x1234567890123456789012345678901234567890",
208
+ * "0x1234567890123456789012345678901234567890"
209
209
  * );
210
210
  * ```
211
211
  */
@@ -1 +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;AAG1C,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAYlC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAOtC,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AAEH,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;CAuBjB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,qBAAa,YAAY;IACvB;;;;;;;;;;;;;;;;;OAiBG;WACiB,cAAc,CAChC,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,QAAQ,EAAE,CAAC;IAyBtB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;WACiB,GAAG,CACrB,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,MAAM,CAAC;IAuBlB;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,uBAAuB,CACzC,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,MAAM,SAAQ,GACb,OAAO,CAAC,MAAM,CAAC;IAqClB;;;;;;;;;;;;;;;;;;OAkBG;WACiB,YAAY,CAC9B,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,CAAC;CAenB"}
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;AAG1C,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAYlC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAOtC,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AAEH,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,GAAG,OAAO,CAAC,aAAa,CAAC;IAiBzE;;;;;;;;;;;;;;;;;;;;;;;;;;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;CAuBjB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,qBAAa,YAAY;IACvB;;;;;;;;;;;;;;;;;OAiBG;WACiB,cAAc,CAChC,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,QAAQ,EAAE,CAAC;IAyBtB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;WACiB,GAAG,CACrB,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,MAAM,CAAC;IAuBlB;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,uBAAuB,CACzC,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,MAAM,SAAQ,GACb,OAAO,CAAC,MAAM,CAAC;IAqClB;;;;;;;;;;;;;;;;;;OAkBG;WACiB,YAAY,CAC9B,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,CAAC;CAenB"}
package/dist/kvstore.js CHANGED
@@ -25,19 +25,19 @@ const kvstore_1 = require("./graphql/queries/kvstore");
25
25
  /**
26
26
  * ## Introduction
27
27
  *
28
- * This client enables to perform actions on KVStore contract and obtain information from both the contracts and subgraph.
28
+ * This client enables performing actions on KVStore contract and obtaining information from both the contracts and subgraph.
29
29
  *
30
30
  * Internally, the SDK will use one network or another according to the network ID of the `runner`.
31
31
  * To use this client, it is recommended to initialize it using the static `build` method.
32
32
  *
33
33
  * ```ts
34
- * static async build(runner: ContractRunner);
34
+ * static async build(runner: ContractRunner): Promise<KVStoreClient>;
35
35
  * ```
36
36
  *
37
37
  * A `Signer` or a `Provider` should be passed depending on the use case of this module:
38
38
  *
39
- * - **Signer**: when the user wants to use this model in order to send transactions caling the contract functions.
40
- * - **Provider**: when the user wants to use this model in order to get information from the contracts or subgraph.
39
+ * - **Signer**: when the user wants to use this model to send transactions calling the contract functions.
40
+ * - **Provider**: when the user wants to use this model to get information from the contracts or subgraph.
41
41
  *
42
42
  * ## Installation
43
43
  *
@@ -55,21 +55,21 @@ const kvstore_1 = require("./graphql/queries/kvstore");
55
55
  *
56
56
  * ### Signer
57
57
  *
58
- * **Using private key(backend)**
58
+ * **Using private key (backend)**
59
59
  *
60
60
  * ```ts
61
61
  * import { KVStoreClient } from '@human-protocol/sdk';
62
62
  * import { Wallet, providers } from 'ethers';
63
63
  *
64
64
  * const rpcUrl = 'YOUR_RPC_URL';
65
- * const privateKey = 'YOUR_PRIVATE_KEY'
65
+ * const privateKey = 'YOUR_PRIVATE_KEY';
66
66
  *
67
67
  * const provider = new providers.JsonRpcProvider(rpcUrl);
68
68
  * const signer = new Wallet(privateKey, provider);
69
69
  * const kvstoreClient = await KVStoreClient.build(signer);
70
70
  * ```
71
71
  *
72
- * **Using Wagmi(frontend)**
72
+ * **Using Wagmi (frontend)**
73
73
  *
74
74
  * ```ts
75
75
  * import { useSigner, useChainId } from 'wagmi';
@@ -88,7 +88,7 @@ const kvstore_1 = require("./graphql/queries/kvstore");
88
88
  * const rpcUrl = 'YOUR_RPC_URL';
89
89
  *
90
90
  * const provider = new providers.JsonRpcProvider(rpcUrl);
91
- * const kvstoreClient = await KVStoreClient.build(signer);
91
+ * const kvstoreClient = await KVStoreClient.build(provider);
92
92
  * ```
93
93
  */
94
94
  class KVStoreClient extends base_1.BaseEthersClient {
@@ -141,7 +141,7 @@ class KVStoreClient extends base_1.BaseEthersClient {
141
141
  * import { KVStoreClient } from '@human-protocol/sdk';
142
142
  *
143
143
  * const rpcUrl = 'YOUR_RPC_URL';
144
- * const privateKey = 'YOUR_PRIVATE_KEY'
144
+ * const privateKey = 'YOUR_PRIVATE_KEY';
145
145
  *
146
146
  * const provider = new providers.JsonRpcProvider(rpcUrl);
147
147
  * const signer = new Wallet(privateKey, provider);
@@ -179,7 +179,7 @@ class KVStoreClient extends base_1.BaseEthersClient {
179
179
  * import { KVStoreClient } from '@human-protocol/sdk';
180
180
  *
181
181
  * const rpcUrl = 'YOUR_RPC_URL';
182
- * const privateKey = 'YOUR_PRIVATE_KEY'
182
+ * const privateKey = 'YOUR_PRIVATE_KEY';
183
183
  *
184
184
  * const provider = new providers.JsonRpcProvider(rpcUrl);
185
185
  * const signer = new Wallet(privateKey, provider);
@@ -187,7 +187,7 @@ class KVStoreClient extends base_1.BaseEthersClient {
187
187
  *
188
188
  * const keys = ['role', 'webhook_url'];
189
189
  * const values = ['RecordingOracle', 'http://localhost'];
190
- * await kvstoreClient.set(keys, values);
190
+ * await kvstoreClient.setBulk(keys, values);
191
191
  * ```
192
192
  */
193
193
  async setBulk(keys, values, txOptions = {}) {
@@ -219,14 +219,14 @@ class KVStoreClient extends base_1.BaseEthersClient {
219
219
  * import { KVStoreClient } from '@human-protocol/sdk';
220
220
  *
221
221
  * const rpcUrl = 'YOUR_RPC_URL';
222
- * const privateKey = 'YOUR_PRIVATE_KEY'
222
+ * const privateKey = 'YOUR_PRIVATE_KEY';
223
223
  *
224
224
  * const provider = new providers.JsonRpcProvider(rpcUrl);
225
225
  * const signer = new Wallet(privateKey, provider);
226
226
  * const kvstoreClient = await KVStoreClient.build(signer);
227
227
  *
228
228
  * await kvstoreClient.setFileUrlAndHash('example.com');
229
- * await kvstoreClient.setFileUrlAndHash('linkedin.com/example', 'linkedin_url);
229
+ * await kvstoreClient.setFileUrlAndHash('linkedin.com/example', 'linkedin_url');
230
230
  * ```
231
231
  */
232
232
  async setFileUrlAndHash(url, urlKey = 'url', txOptions = {}) {
@@ -290,9 +290,9 @@ __decorate([
290
290
  * ```ts
291
291
  * import { ChainId, KVStoreUtils } from '@human-protocol/sdk';
292
292
  *
293
- * const KVStoreAddresses = new KVStoreUtils.getKVStoreData({
293
+ * const KVStoreAddresses = await KVStoreUtils.getKVStoreData(
294
294
  * ChainId.POLYGON_AMOY,
295
- * "0x1234567890123456789012345678901234567890",
295
+ * "0x1234567890123456789012345678901234567890"
296
296
  * );
297
297
  * ```
298
298
  */
@@ -4,9 +4,9 @@ export declare class OperatorUtils {
4
4
  /**
5
5
  * This function returns the leader data for the given address.
6
6
  *
7
+ * @param {ChainId} chainId Network in which the leader is deployed
7
8
  * @param {string} address Leader address.
8
- * @returns {ILeader} Returns the leader details.
9
- *
9
+ * @returns {Promise<ILeader>} Returns the leader details.
10
10
  *
11
11
  * **Code example**
12
12
  *
@@ -21,13 +21,12 @@ export declare class OperatorUtils {
21
21
  * This function returns all the leader details of the protocol.
22
22
  *
23
23
  * @param {ILeadersFilter} filter Filter for the leaders.
24
- * @returns {ILeader[]} Returns an array with all the leader details.
25
- *
24
+ * @returns {Promise<ILeader[]>} Returns an array with all the leader details.
26
25
  *
27
26
  * **Code example**
28
27
  *
29
28
  * ```ts
30
- * import { OperatorUtils } from '@human-protocol/sdk';
29
+ * import { OperatorUtils, ChainId } from '@human-protocol/sdk';
31
30
  *
32
31
  * const filter: ILeadersFilter = {
33
32
  * chainId: ChainId.POLYGON
@@ -39,12 +38,14 @@ export declare class OperatorUtils {
39
38
  /**
40
39
  * Retrieves the reputation network operators of the specified address.
41
40
  *
42
- * @param {string} address - Address of the reputation oracle.
41
+ * @param {ChainId} chainId Network in which the reputation network is deployed
42
+ * @param {string} address Address of the reputation oracle.
43
43
  * @param {string} [role] - (Optional) Role of the operator.
44
44
  * @returns {Promise<IOperator[]>} - Returns an array of operator details.
45
45
  *
46
- * @example
47
- * ```typescript
46
+ * **Code example**
47
+ *
48
+ * ```ts
48
49
  * import { OperatorUtils, ChainId } from '@human-protocol/sdk';
49
50
  *
50
51
  * const operators = await OperatorUtils.getReputationNetworkOperators(ChainId.POLYGON_AMOY, '0x62dD51230A30401C455c8398d06F85e4EaB6309f');
@@ -54,9 +55,9 @@ export declare class OperatorUtils {
54
55
  /**
55
56
  * This function returns information about the rewards for a given slasher address.
56
57
  *
58
+ * @param {ChainId} chainId Network in which the rewards are deployed
57
59
  * @param {string} slasherAddress Slasher address.
58
- * @returns {IReward[]} Returns an array of Reward objects that contain the rewards earned by the user through slashing other users.
59
- *
60
+ * @returns {Promise<IReward[]>} Returns an array of Reward objects that contain the rewards earned by the user through slashing other users.
60
61
  *
61
62
  * **Code example**
62
63
  *
@@ -1 +1 @@
1
- {"version":3,"file":"operator.d.ts","sourceRoot":"","sources":["../src/operator.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,OAAO,EAEP,cAAc,EACd,SAAS,EAET,OAAO,EACR,MAAM,cAAc,CAAC;AAetB,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAGlC,qBAAa,aAAa;IACxB;;;;;;;;;;;;;;OAcG;WACiB,SAAS,CAC3B,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,OAAO,CAAC;IA2CnB;;;;;;;;;;;;;;;;;OAiBG;WACiB,UAAU,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAkD1E;;;;;;;;;;;;;OAaG;WACiB,6BAA6B,CAC/C,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,SAAS,EAAE,CAAC;IA+BvB;;;;;;;;;;;;;;OAcG;WACiB,UAAU,CAC5B,OAAO,EAAE,OAAO,EAChB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,OAAO,EAAE,CAAC;CAyBtB"}
1
+ {"version":3,"file":"operator.d.ts","sourceRoot":"","sources":["../src/operator.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,OAAO,EAEP,cAAc,EACd,SAAS,EAET,OAAO,EACR,MAAM,cAAc,CAAC;AAetB,OAAO,EAAE,OAAO,EAAkB,MAAM,SAAS,CAAC;AAGlD,qBAAa,aAAa;IACxB;;;;;;;;;;;;;;OAcG;WACiB,SAAS,CAC3B,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,OAAO,CAAC;IA2CnB;;;;;;;;;;;;;;;;OAgBG;WACiB,UAAU,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IA+D1E;;;;;;;;;;;;;;;OAeG;WACiB,6BAA6B,CAC/C,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,SAAS,EAAE,CAAC;IA+BvB;;;;;;;;;;;;;;OAcG;WACiB,UAAU,CAC5B,OAAO,EAAE,OAAO,EAChB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,OAAO,EAAE,CAAC;CAyBtB"}
package/dist/operator.js CHANGED
@@ -11,14 +11,15 @@ const operator_1 = require("./graphql/queries/operator");
11
11
  const ethers_1 = require("ethers");
12
12
  const error_1 = require("./error");
13
13
  const utils_1 = require("./utils");
14
+ const enums_1 = require("./enums");
14
15
  const constants_1 = require("./constants");
15
16
  class OperatorUtils {
16
17
  /**
17
18
  * This function returns the leader data for the given address.
18
19
  *
20
+ * @param {ChainId} chainId Network in which the leader is deployed
19
21
  * @param {string} address Leader address.
20
- * @returns {ILeader} Returns the leader details.
21
- *
22
+ * @returns {Promise<ILeader>} Returns the leader details.
22
23
  *
23
24
  * **Code example**
24
25
  *
@@ -64,13 +65,12 @@ class OperatorUtils {
64
65
  * This function returns all the leader details of the protocol.
65
66
  *
66
67
  * @param {ILeadersFilter} filter Filter for the leaders.
67
- * @returns {ILeader[]} Returns an array with all the leader details.
68
- *
68
+ * @returns {Promise<ILeader[]>} Returns an array with all the leader details.
69
69
  *
70
70
  * **Code example**
71
71
  *
72
72
  * ```ts
73
- * import { OperatorUtils } from '@human-protocol/sdk';
73
+ * import { OperatorUtils, ChainId } from '@human-protocol/sdk';
74
74
  *
75
75
  * const filter: ILeadersFilter = {
76
76
  * chainId: ChainId.POLYGON
@@ -80,12 +80,22 @@ class OperatorUtils {
80
80
  */
81
81
  static async getLeaders(filter) {
82
82
  let leaders_data = [];
83
+ const first = filter.first !== undefined && filter.first > 0
84
+ ? Math.min(filter.first, 1000)
85
+ : 10;
86
+ const skip = filter.skip !== undefined && filter.skip >= 0 ? filter.skip : 0;
87
+ const orderDirection = filter.orderDirection || enums_1.OrderDirection.DESC;
83
88
  const networkData = constants_1.NETWORKS[filter.chainId];
84
89
  if (!networkData) {
85
90
  throw error_1.ErrorUnsupportedChainID;
86
91
  }
87
92
  const { leaders } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), (0, operator_1.GET_LEADERS_QUERY)(filter), {
88
- role: filter?.role,
93
+ minAmountStaked: filter?.minAmountStaked,
94
+ roles: filter?.roles,
95
+ orderBy: filter?.orderBy,
96
+ orderDirection: orderDirection,
97
+ first: first,
98
+ skip: skip,
89
99
  });
90
100
  if (!leaders) {
91
101
  return [];
@@ -115,12 +125,14 @@ class OperatorUtils {
115
125
  /**
116
126
  * Retrieves the reputation network operators of the specified address.
117
127
  *
118
- * @param {string} address - Address of the reputation oracle.
128
+ * @param {ChainId} chainId Network in which the reputation network is deployed
129
+ * @param {string} address Address of the reputation oracle.
119
130
  * @param {string} [role] - (Optional) Role of the operator.
120
131
  * @returns {Promise<IOperator[]>} - Returns an array of operator details.
121
132
  *
122
- * @example
123
- * ```typescript
133
+ * **Code example**
134
+ *
135
+ * ```ts
124
136
  * import { OperatorUtils, ChainId } from '@human-protocol/sdk';
125
137
  *
126
138
  * const operators = await OperatorUtils.getReputationNetworkOperators(ChainId.POLYGON_AMOY, '0x62dD51230A30401C455c8398d06F85e4EaB6309f');
@@ -154,9 +166,9 @@ class OperatorUtils {
154
166
  /**
155
167
  * This function returns information about the rewards for a given slasher address.
156
168
  *
169
+ * @param {ChainId} chainId Network in which the rewards are deployed
157
170
  * @param {string} slasherAddress Slasher address.
158
- * @returns {IReward[]} Returns an array of Reward objects that contain the rewards earned by the user through slashing other users.
159
- *
171
+ * @returns {Promise<IReward[]>} Returns an array of Reward objects that contain the rewards earned by the user through slashing other users.
160
172
  *
161
173
  * **Code example**
162
174
  *