@peeramid-labs/sdk 3.0.2 → 3.1.0

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 (103) hide show
  1. package/cli/cli/client.js +6 -5
  2. package/cli/cli/client.js.map +1 -1
  3. package/cli/cli/commands/distributions/index.js +3 -1
  4. package/cli/cli/commands/distributions/index.js.map +1 -1
  5. package/cli/cli/commands/distributions/state.js +38 -0
  6. package/cli/cli/commands/distributions/state.js.map +1 -0
  7. package/cli/cli/commands/eds/index.js +59 -0
  8. package/cli/cli/commands/eds/index.js.map +1 -0
  9. package/cli/eds/Distributor.js +11 -1
  10. package/cli/eds/Distributor.js.map +1 -1
  11. package/cli/multipass/MultipassBase.js +14 -7
  12. package/cli/multipass/MultipassBase.js.map +1 -1
  13. package/cli/rankify/MAODistributor.js +117 -73
  14. package/cli/rankify/MAODistributor.js.map +1 -1
  15. package/cli/rankify/RankToken.js +24 -13
  16. package/cli/rankify/RankToken.js.map +1 -1
  17. package/cli/utils/ApiError.js +33 -0
  18. package/cli/utils/ApiError.js.map +1 -1
  19. package/cli/utils/artifacts.js +31 -2
  20. package/cli/utils/artifacts.js.map +1 -1
  21. package/docs/classes/GameMaster.md +31 -5
  22. package/docs/classes/InstanceBase.md +24 -5
  23. package/docs/classes/InstancePlayer.md +47 -19
  24. package/docs/classes/MAODistributorClient.md +44 -11
  25. package/docs/classes/Multipass.md +11 -0
  26. package/docs/classes/MultipassBase.md +7 -0
  27. package/docs/docs/classes/GameMaster.md +31 -5
  28. package/docs/docs/classes/InstanceBase.md +24 -5
  29. package/docs/docs/classes/InstancePlayer.md +47 -19
  30. package/docs/docs/classes/MAODistributorClient.md +44 -11
  31. package/docs/docs/classes/Multipass.md +11 -0
  32. package/docs/docs/classes/MultipassBase.md +7 -0
  33. package/docs/docs/index.md +42 -1
  34. package/docs/index.md +42 -1
  35. package/lib.commonjs/eds/Distributor.d.ts +4 -1
  36. package/lib.commonjs/eds/Distributor.d.ts.map +1 -1
  37. package/lib.commonjs/eds/Distributor.js +12 -1
  38. package/lib.commonjs/eds/Distributor.js.map +1 -1
  39. package/lib.commonjs/multipass/MultipassBase.d.ts +1 -0
  40. package/lib.commonjs/multipass/MultipassBase.d.ts.map +1 -1
  41. package/lib.commonjs/multipass/MultipassBase.js +15 -7
  42. package/lib.commonjs/multipass/MultipassBase.js.map +1 -1
  43. package/lib.commonjs/rankify/GameMaster.d.ts.map +1 -1
  44. package/lib.commonjs/rankify/GameMaster.js +137 -111
  45. package/lib.commonjs/rankify/GameMaster.js.map +1 -1
  46. package/lib.commonjs/rankify/InstanceBase.d.ts +10 -7
  47. package/lib.commonjs/rankify/InstanceBase.d.ts.map +1 -1
  48. package/lib.commonjs/rankify/InstanceBase.js +222 -169
  49. package/lib.commonjs/rankify/InstanceBase.js.map +1 -1
  50. package/lib.commonjs/rankify/MAODistributor.d.ts +22 -3
  51. package/lib.commonjs/rankify/MAODistributor.d.ts.map +1 -1
  52. package/lib.commonjs/rankify/MAODistributor.js +117 -73
  53. package/lib.commonjs/rankify/MAODistributor.js.map +1 -1
  54. package/lib.commonjs/rankify/Player.d.ts +13 -9
  55. package/lib.commonjs/rankify/Player.d.ts.map +1 -1
  56. package/lib.commonjs/rankify/Player.js +173 -125
  57. package/lib.commonjs/rankify/Player.js.map +1 -1
  58. package/lib.commonjs/rankify/RankToken.d.ts.map +1 -1
  59. package/lib.commonjs/rankify/RankToken.js +24 -13
  60. package/lib.commonjs/rankify/RankToken.js.map +1 -1
  61. package/lib.commonjs/utils/ApiError.d.ts +1 -0
  62. package/lib.commonjs/utils/ApiError.d.ts.map +1 -1
  63. package/lib.commonjs/utils/ApiError.js +33 -0
  64. package/lib.commonjs/utils/ApiError.js.map +1 -1
  65. package/lib.commonjs/utils/artifacts.d.ts +9 -0
  66. package/lib.commonjs/utils/artifacts.d.ts.map +1 -1
  67. package/lib.commonjs/utils/artifacts.js +31 -2
  68. package/lib.commonjs/utils/artifacts.js.map +1 -1
  69. package/lib.esm/eds/Distributor.d.ts +4 -1
  70. package/lib.esm/eds/Distributor.d.ts.map +1 -1
  71. package/lib.esm/eds/Distributor.js +12 -1
  72. package/lib.esm/eds/Distributor.js.map +1 -1
  73. package/lib.esm/multipass/MultipassBase.d.ts +1 -0
  74. package/lib.esm/multipass/MultipassBase.d.ts.map +1 -1
  75. package/lib.esm/multipass/MultipassBase.js +15 -7
  76. package/lib.esm/multipass/MultipassBase.js.map +1 -1
  77. package/lib.esm/rankify/GameMaster.d.ts.map +1 -1
  78. package/lib.esm/rankify/GameMaster.js +137 -111
  79. package/lib.esm/rankify/GameMaster.js.map +1 -1
  80. package/lib.esm/rankify/InstanceBase.d.ts +10 -7
  81. package/lib.esm/rankify/InstanceBase.d.ts.map +1 -1
  82. package/lib.esm/rankify/InstanceBase.js +223 -170
  83. package/lib.esm/rankify/InstanceBase.js.map +1 -1
  84. package/lib.esm/rankify/MAODistributor.d.ts +22 -3
  85. package/lib.esm/rankify/MAODistributor.d.ts.map +1 -1
  86. package/lib.esm/rankify/MAODistributor.js +119 -75
  87. package/lib.esm/rankify/MAODistributor.js.map +1 -1
  88. package/lib.esm/rankify/Player.d.ts +13 -9
  89. package/lib.esm/rankify/Player.d.ts.map +1 -1
  90. package/lib.esm/rankify/Player.js +173 -125
  91. package/lib.esm/rankify/Player.js.map +1 -1
  92. package/lib.esm/rankify/RankToken.d.ts.map +1 -1
  93. package/lib.esm/rankify/RankToken.js +24 -13
  94. package/lib.esm/rankify/RankToken.js.map +1 -1
  95. package/lib.esm/utils/ApiError.d.ts +1 -0
  96. package/lib.esm/utils/ApiError.d.ts.map +1 -1
  97. package/lib.esm/utils/ApiError.js +32 -0
  98. package/lib.esm/utils/ApiError.js.map +1 -1
  99. package/lib.esm/utils/artifacts.d.ts +9 -0
  100. package/lib.esm/utils/artifacts.d.ts.map +1 -1
  101. package/lib.esm/utils/artifacts.js +29 -1
  102. package/lib.esm/utils/artifacts.js.map +1 -1
  103. package/package.json +3 -3
package/docs/classes/MAODistributorClient.md CHANGED
@@ -19,10 +19,12 @@ Handles creation, management and interaction with MAO instances
19
19
 
20
20
  - [publicClient](MAODistributorClient.md#publicclient)
21
21
  - [address](MAODistributorClient.md#address)
22
+ - [createdAtBlock](MAODistributorClient.md#createdatblock)
22
23
  - [walletClient](MAODistributorClient.md#walletclient)
23
24
 
24
25
  ### Methods
25
26
 
27
+ - [getCreationBlock](MAODistributorClient.md#getcreationblock)
26
28
  - [getInstances](MAODistributorClient.md#getinstances)
27
29
  - [getInstance](MAODistributorClient.md#getinstance)
28
30
  - [getNamedDistributionInstances](MAODistributorClient.md#getnameddistributioninstances)
@@ -85,12 +87,36 @@ DistributorClient.address
85
87
 
86
88
  ___
87
89
 
90
+ ### createdAtBlock
91
+
92
+ • `Optional` **createdAtBlock**: `bigint`
93
+
94
+ #### Inherited from
95
+
96
+ DistributorClient.createdAtBlock
97
+
98
+ ___
99
+
88
100
  ### walletClient
89
101
 
90
102
  • `Optional` **walletClient**: `Object`
91
103
 
92
104
  ## Methods
93
105
 
106
+ ### getCreationBlock
107
+
108
+ ▸ **getCreationBlock**(): `Promise`\<`bigint`\>
109
+
110
+ #### Returns
111
+
112
+ `Promise`\<`bigint`\>
113
+
114
+ #### Inherited from
115
+
116
+ DistributorClient.getCreationBlock
117
+
118
+ ___
119
+
94
120
  ### getInstances
95
121
 
96
122
  ▸ **getInstances**(`distributorsId`, `fromBlock?`): `Promise`\<\{ `newInstanceId`: `bigint` ; `version`: `bigint` ; `addresses`: \`0x$\{string}\`[] }[]\>
@@ -201,20 +227,21 @@ ___
201
227
 
202
228
  ### getMAOInstances
203
229
 
204
- ▸ **getMAOInstances**(`namedDistribution?`, `fromBlock?`): `Promise`\<[`MAOInstanceContracts`](../interfaces/MAOInstanceContracts.md)[]\>
230
+ ▸ **getMAOInstances**(`«destructured»?`): `Promise`\<\{ `instances`: [`MAOInstanceContracts`](../interfaces/MAOInstanceContracts.md) ; `maoInstanceId`: `bigint` }[]\>
205
231
 
206
232
  Get MAOInstances instances by distribution name
207
233
 
208
234
  #### Parameters
209
235
 
210
- | Name | Type | Default value | Description |
211
- | :------ | :------ | :------ | :------ |
212
- | `namedDistribution` | `string` | `MAODistributorClient.DEFAULT_NAME` | Distribution name (defaults to "MAO Distribution") |
213
- | `fromBlock` | `bigint` | `undefined` | - |
236
+ | Name | Type | Default value |
237
+ | :------ | :------ | :------ |
238
+ | `«destructured»` | `Object` | `{}` |
239
+ | › `namedDistribution?` | `string` | `MAODistributorClient.DEFAULT_NAME` |
240
+ | › `fromBlock?` | `bigint` | `undefined` |
214
241
 
215
242
  #### Returns
216
243
 
217
- `Promise`\<[`MAOInstanceContracts`](../interfaces/MAOInstanceContracts.md)[]\>
244
+ `Promise`\<\{ `instances`: [`MAOInstanceContracts`](../interfaces/MAOInstanceContracts.md) ; `maoInstanceId`: `bigint` }[]\>
218
245
 
219
246
  Array of MAOInstances contract instances
220
247
 
@@ -271,19 +298,25 @@ ___
271
298
 
272
299
  ### getMAOInstance
273
300
 
274
- ▸ **getMAOInstance**(`name?`, `instanceId`): `Promise`\<[`MAOInstanceContracts`](../interfaces/MAOInstanceContracts.md)\>
301
+ ▸ **getMAOInstance**(`params`): `Promise`\<[`MAOInstanceContracts`](../interfaces/MAOInstanceContracts.md)\>
302
+
303
+ Gets a specific MAO instance by name and instance ID
275
304
 
276
305
  #### Parameters
277
306
 
278
- | Name | Type | Default value |
279
- | :------ | :------ | :------ |
280
- | `name` | `string` | `MAODistributorClient.DEFAULT_NAME` |
281
- | `instanceId` | `bigint` | `undefined` |
307
+ | Name | Type | Default value | Description |
308
+ | :------ | :------ | :------ | :------ |
309
+ | `params` | `Object` | `undefined` | Parameters for getting the instance |
310
+ | `params.name?` | `string` | `MAODistributorClient.DEFAULT_NAME` | The name of the distribution (defaults to DEFAULT_NAME) |
311
+ | `params.instanceId` | `bigint` | `undefined` | The ID of the instance to retrieve |
312
+ | `params.fromBlock?` | `bigint` | `undefined` | Optional block to start searching from (defaults to contract creation block) |
282
313
 
283
314
  #### Returns
284
315
 
285
316
  `Promise`\<[`MAOInstanceContracts`](../interfaces/MAOInstanceContracts.md)\>
286
317
 
318
+ The MAO instance contracts
319
+
287
320
  ___
288
321
 
289
322
  ### getInstantiatePrice
package/docs/classes/Multipass.md CHANGED
@@ -18,6 +18,7 @@ Main Multipass class for handling registrations and queries
18
18
 
19
19
  - [chainId](Multipass.md#chainid)
20
20
  - [publicClient](Multipass.md#publicclient)
21
+ - [creationBlock](Multipass.md#creationblock)
21
22
 
22
23
  ### Methods
23
24
 
@@ -85,6 +86,16 @@ Public client for reading contracts
85
86
 
86
87
  [MultipassBase](MultipassBase.md).[publicClient](MultipassBase.md#publicclient)
87
88
 
89
+ ___
90
+
91
+ ### creationBlock
92
+
93
+ • **creationBlock**: `bigint`
94
+
95
+ #### Inherited from
96
+
97
+ [MultipassBase](MultipassBase.md).[creationBlock](MultipassBase.md#creationblock)
98
+
88
99
  ## Methods
89
100
 
90
101
  ### getRegistrarMessage
package/docs/classes/MultipassBase.md CHANGED
@@ -18,6 +18,7 @@ Base class for Multipass functionality
18
18
 
19
19
  - [chainId](MultipassBase.md#chainid)
20
20
  - [publicClient](MultipassBase.md#publicclient)
21
+ - [creationBlock](MultipassBase.md#creationblock)
21
22
 
22
23
  ### Methods
23
24
 
@@ -71,6 +72,12 @@ ___
71
72
 
72
73
  Public client for reading contracts
73
74
 
75
+ ___
76
+
77
+ ### creationBlock
78
+
79
+ • **creationBlock**: `bigint`
80
+
74
81
  ## Methods
75
82
 
76
83
  ### getDappURL