@peeramid-labs/sdk 3.7.4 → 3.8.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 (83) hide show
  1. package/cli/cli/commands/blockchain/index.js +9 -0
  2. package/cli/cli/commands/blockchain/index.js.map +1 -0
  3. package/cli/cli/commands/blockchain/mine.js +45 -0
  4. package/cli/cli/commands/blockchain/mine.js.map +1 -0
  5. package/cli/cli/commands/distributions/add.js +55 -31
  6. package/cli/cli/commands/distributions/add.js.map +1 -1
  7. package/cli/cli/commands/fellowship/create.js +96 -60
  8. package/cli/cli/commands/fellowship/create.js.map +1 -1
  9. package/cli/cli/commands/fellowship/game/cancel.js +45 -0
  10. package/cli/cli/commands/fellowship/game/cancel.js.map +1 -0
  11. package/cli/cli/commands/fellowship/game/create.js +91 -0
  12. package/cli/cli/commands/fellowship/game/create.js.map +1 -0
  13. package/cli/cli/commands/fellowship/{endTurn.js → game/end-turn.js} +8 -7
  14. package/cli/cli/commands/fellowship/game/end-turn.js.map +1 -0
  15. package/cli/cli/commands/fellowship/game/index.js +31 -0
  16. package/cli/cli/commands/fellowship/game/index.js.map +1 -0
  17. package/cli/cli/commands/fellowship/game/join.js +131 -0
  18. package/cli/cli/commands/fellowship/game/join.js.map +1 -0
  19. package/cli/cli/commands/fellowship/{games.js → game/list.js} +5 -5
  20. package/cli/cli/commands/fellowship/game/list.js.map +1 -0
  21. package/cli/cli/commands/fellowship/game/propose.js +178 -0
  22. package/cli/cli/commands/fellowship/game/propose.js.map +1 -0
  23. package/cli/cli/commands/fellowship/game/start.js +117 -0
  24. package/cli/cli/commands/fellowship/game/start.js.map +1 -0
  25. package/cli/cli/commands/fellowship/game/vote.js +114 -0
  26. package/cli/cli/commands/fellowship/game/vote.js.map +1 -0
  27. package/cli/cli/commands/fellowship/index.js +3 -5
  28. package/cli/cli/commands/fellowship/index.js.map +1 -1
  29. package/cli/cli/commands/getPk.js +48 -0
  30. package/cli/cli/commands/getPk.js.map +1 -0
  31. package/cli/cli/commands/playbook.js +92 -0
  32. package/cli/cli/commands/playbook.js.map +1 -0
  33. package/cli/cli/getPk.js +62 -0
  34. package/cli/cli/getPk.js.map +1 -0
  35. package/cli/cli/helpers.js +64 -0
  36. package/cli/cli/helpers.js.map +1 -0
  37. package/cli/cli/index.js +6 -0
  38. package/cli/cli/index.js.map +1 -1
  39. package/cli/cli/utils.js +64 -0
  40. package/cli/cli/utils.js.map +1 -0
  41. package/cli/rankify/GameMaster.js +199 -209
  42. package/cli/rankify/GameMaster.js.map +1 -1
  43. package/cli/rankify/InstanceBase.js +60 -36
  44. package/cli/rankify/InstanceBase.js.map +1 -1
  45. package/cli/rankify/Player.js +355 -0
  46. package/cli/rankify/Player.js.map +1 -0
  47. package/cli/utils/blockchain.js +62 -0
  48. package/cli/utils/blockchain.js.map +1 -0
  49. package/docs/classes/GameMaster.md +23 -63
  50. package/docs/classes/InstanceBase.md +21 -27
  51. package/docs/classes/InstancePlayer.md +25 -31
  52. package/docs/docs/classes/GameMaster.md +23 -63
  53. package/docs/docs/classes/InstanceBase.md +21 -27
  54. package/docs/docs/classes/InstancePlayer.md +25 -31
  55. package/docs/docs/index.md +1 -1
  56. package/docs/index.md +1 -1
  57. package/lib.commonjs/rankify/GameMaster.d.ts +26 -33
  58. package/lib.commonjs/rankify/GameMaster.d.ts.map +1 -1
  59. package/lib.commonjs/rankify/GameMaster.js +199 -209
  60. package/lib.commonjs/rankify/GameMaster.js.map +1 -1
  61. package/lib.commonjs/rankify/InstanceBase.d.ts +64 -50
  62. package/lib.commonjs/rankify/InstanceBase.d.ts.map +1 -1
  63. package/lib.commonjs/rankify/InstanceBase.js +60 -36
  64. package/lib.commonjs/rankify/InstanceBase.js.map +1 -1
  65. package/lib.commonjs/utils/blockchain.d.ts +32 -0
  66. package/lib.commonjs/utils/blockchain.d.ts.map +1 -0
  67. package/lib.commonjs/utils/blockchain.js +62 -0
  68. package/lib.commonjs/utils/blockchain.js.map +1 -0
  69. package/lib.esm/rankify/GameMaster.d.ts +26 -33
  70. package/lib.esm/rankify/GameMaster.d.ts.map +1 -1
  71. package/lib.esm/rankify/GameMaster.js +199 -209
  72. package/lib.esm/rankify/GameMaster.js.map +1 -1
  73. package/lib.esm/rankify/InstanceBase.d.ts +64 -50
  74. package/lib.esm/rankify/InstanceBase.d.ts.map +1 -1
  75. package/lib.esm/rankify/InstanceBase.js +60 -36
  76. package/lib.esm/rankify/InstanceBase.js.map +1 -1
  77. package/lib.esm/utils/blockchain.d.ts +32 -0
  78. package/lib.esm/utils/blockchain.d.ts.map +1 -0
  79. package/lib.esm/utils/blockchain.js +58 -0
  80. package/lib.esm/utils/blockchain.js.map +1 -0
  81. package/package.json +1 -1
  82. package/cli/cli/commands/fellowship/endTurn.js.map +0 -1
  83. package/cli/cli/commands/fellowship/games.js.map +0 -1
@@ -27,7 +27,6 @@ Provides core functionality for managing game state and interactions
27
27
 
28
28
  - [getHistoricTurn](InstanceBase.md#gethistoricturn)
29
29
  - [reorganizeVotes](InstanceBase.md#reorganizevotes)
30
- - [reorganizeProposals](InstanceBase.md#reorganizeproposals)
31
30
  - [getCreationBlock](InstanceBase.md#getcreationblock)
32
31
  - [getPreviousTurnStats](InstanceBase.md#getpreviousturnstats)
33
32
  - [getVoting](InstanceBase.md#getvoting)
@@ -41,6 +40,7 @@ Provides core functionality for managing game state and interactions
41
40
  - [getProposalScoresList](InstanceBase.md#getproposalscoreslist)
42
41
  - [getCurrentTurn](InstanceBase.md#getcurrentturn)
43
42
  - [getPlayers](InstanceBase.md#getplayers)
43
+ - [getGameState](InstanceBase.md#getgamestate)
44
44
  - [getGameStateDetails](InstanceBase.md#getgamestatedetails)
45
45
  - [getGameStates](InstanceBase.md#getgamestates)
46
46
  - [getEIP712Domain](InstanceBase.md#geteip712domain)
@@ -112,7 +112,7 @@ ___
112
112
 
113
113
  ### getHistoricTurn
114
114
 
115
- ▸ **getHistoricTurn**(`gameId`, `turnId`): `Promise`\<{}\>
115
+ ▸ **getHistoricTurn**(`gameId`, `turnId`): `Promise`\<(\{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` = ""; `score`: `bigint` ; `scoreList`: `never`[] = []; `blockTimestamp?`: `undefined` } \| \{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` ; `score`: `bigint` ; `scoreList`: \{ `score`: `bigint` ; `player`: \`0x$\{string}\` = proposer }[] ; `blockTimestamp`: `bigint` })[]\>
116
116
 
117
117
  Retrieves the historic turn information for a specific game and turn ID.
118
118
 
@@ -125,7 +125,7 @@ Retrieves the historic turn information for a specific game and turn ID.
125
125
 
126
126
  #### Returns
127
127
 
128
- `Promise`\<{}\>
128
+ `Promise`\<(\{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` = ""; `score`: `bigint` ; `scoreList`: `never`[] = []; `blockTimestamp?`: `undefined` } \| \{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` ; `score`: `bigint` ; `scoreList`: \{ `score`: `bigint` ; `player`: \`0x$\{string}\` = proposer }[] ; `blockTimestamp`: `bigint` })[]\>
129
129
 
130
130
  The historic turn event object.
131
131
 
@@ -156,28 +156,6 @@ Reorganized votes array
156
156
 
157
157
  ___
158
158
 
159
- ### reorganizeProposals
160
-
161
- ▸ **reorganizeProposals**(`proposals`, `turnId`, `gameId`): `Promise`\<readonly `string`[]\>
162
-
163
- Reorganizes proposals array based on proposerIndices mapping
164
-
165
- #### Parameters
166
-
167
- | Name | Type | Description |
168
- | :------ | :------ | :------ |
169
- | `proposals` | readonly `string`[] | Array of proposals for each player |
170
- | `turnId` | `bigint` | - |
171
- | `gameId` | `bigint` | - |
172
-
173
- #### Returns
174
-
175
- `Promise`\<readonly `string`[]\>
176
-
177
- Reorganized proposals array
178
-
179
- ___
180
-
181
159
  ### getCreationBlock
182
160
 
183
161
  ▸ **getCreationBlock**(): `Promise`\<`bigint`\>
@@ -190,7 +168,7 @@ ___
190
168
 
191
169
  ### getPreviousTurnStats
192
170
 
193
- ▸ **getPreviousTurnStats**(`gameId`): `Promise`\<{} \| \{ `players`: `string` = "N/A"; `scores`: `string` = "N/A"; `turnSalt`: `string` = "N/A"; `voters`: `string`[] ; `votesRevealed`: `string`[] }\>
171
+ ▸ **getPreviousTurnStats**(`gameId`): `Promise`\<(\{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` = ""; `score`: `bigint` ; `scoreList`: `never`[] = []; `blockTimestamp?`: `undefined` } \| \{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` ; `score`: `bigint` ; `scoreList`: \{ `score`: `bigint` ; `player`: \`0x$\{string}\` = proposer }[] ; `blockTimestamp`: `bigint` })[] \| \{ `players`: `string` = "N/A"; `scores`: `string` = "N/A"; `turnSalt`: `string` = "N/A"; `voters`: `string`[] ; `votesRevealed`: `string`[] }\>
194
172
 
195
173
  Retrieves the previous turn information for a specific game.
196
174
 
@@ -202,7 +180,7 @@ Retrieves the previous turn information for a specific game.
202
180
 
203
181
  #### Returns
204
182
 
205
- `Promise`\<{} \| \{ `players`: `string` = "N/A"; `scores`: `string` = "N/A"; `turnSalt`: `string` = "N/A"; `voters`: `string`[] ; `votesRevealed`: `string`[] }\>
183
+ `Promise`\<(\{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` = ""; `score`: `bigint` ; `scoreList`: `never`[] = []; `blockTimestamp?`: `undefined` } \| \{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` ; `score`: `bigint` ; `scoreList`: \{ `score`: `bigint` ; `player`: \`0x$\{string}\` = proposer }[] ; `blockTimestamp`: `bigint` })[] \| \{ `players`: `string` = "N/A"; `scores`: `string` = "N/A"; `turnSalt`: `string` = "N/A"; `voters`: `string`[] ; `votesRevealed`: `string`[] }\>
206
184
 
207
185
  The previous turn information for the specified game.
208
186
 
@@ -421,6 +399,22 @@ A Promise that resolves to the player addresses of the game.
421
399
 
422
400
  ___
423
401
 
402
+ ### getGameState
403
+
404
+ ▸ **getGameState**(`gameId`): `Promise`\<\{ `rank`: `bigint` ; `minGameTime`: `bigint` ; `createdBy`: \`0x$\{string}\` ; `numOngoingProposals`: `bigint` ; `numPrevProposals`: `bigint` ; `numCommitments`: `bigint` ; `numVotesThisTurn`: `bigint` ; `numVotesPrevTurn`: `bigint` ; `voting`: \{ `voteCredits`: `bigint` ; `maxQuadraticPoints`: `bigint` ; `minQuadraticPositions`: `bigint` } ; `currentTurn`: `bigint` ; `turnStartedAt`: `bigint` ; `registrationOpenAt`: `bigint` ; `startedAt`: `bigint` ; `hasStarted`: `boolean` ; `hasEnded`: `boolean` ; `numPlayersMadeMove`: `bigint` ; `numActivePlayers`: `bigint` ; `isOvertime`: `boolean` ; `timePerTurn`: `bigint` ; `maxPlayerCnt`: `bigint` ; `minPlayerCnt`: `bigint` ; `timeToJoin`: `bigint` ; `maxTurns`: `bigint` ; `voteCredits`: `bigint` ; `gameMaster`: \`0x$\{string}\` ; `metadata`: `string` }\>
405
+
406
+ #### Parameters
407
+
408
+ | Name | Type |
409
+ | :------ | :------ |
410
+ | `gameId` | `bigint` |
411
+
412
+ #### Returns
413
+
414
+ `Promise`\<\{ `rank`: `bigint` ; `minGameTime`: `bigint` ; `createdBy`: \`0x$\{string}\` ; `numOngoingProposals`: `bigint` ; `numPrevProposals`: `bigint` ; `numCommitments`: `bigint` ; `numVotesThisTurn`: `bigint` ; `numVotesPrevTurn`: `bigint` ; `voting`: \{ `voteCredits`: `bigint` ; `maxQuadraticPoints`: `bigint` ; `minQuadraticPositions`: `bigint` } ; `currentTurn`: `bigint` ; `turnStartedAt`: `bigint` ; `registrationOpenAt`: `bigint` ; `startedAt`: `bigint` ; `hasStarted`: `boolean` ; `hasEnded`: `boolean` ; `numPlayersMadeMove`: `bigint` ; `numActivePlayers`: `bigint` ; `isOvertime`: `boolean` ; `timePerTurn`: `bigint` ; `maxPlayerCnt`: `bigint` ; `minPlayerCnt`: `bigint` ; `timeToJoin`: `bigint` ; `maxTurns`: `bigint` ; `voteCredits`: `bigint` ; `gameMaster`: \`0x$\{string}\` ; `metadata`: `string` }\>
415
+
416
+ ___
417
+
424
418
  ### getGameStateDetails
425
419
 
426
420
  ▸ **getGameStateDetails**(`gameId`): `Promise`\<`GameState`\>
@@ -29,7 +29,6 @@ Provides core functionality for managing game state and interactions
29
29
 
30
30
  - [getHistoricTurn](InstancePlayer.md#gethistoricturn)
31
31
  - [reorganizeVotes](InstancePlayer.md#reorganizevotes)
32
- - [reorganizeProposals](InstancePlayer.md#reorganizeproposals)
33
32
  - [getCreationBlock](InstancePlayer.md#getcreationblock)
34
33
  - [getPreviousTurnStats](InstancePlayer.md#getpreviousturnstats)
35
34
  - [getVoting](InstancePlayer.md#getvoting)
@@ -43,6 +42,7 @@ Provides core functionality for managing game state and interactions
43
42
  - [getProposalScoresList](InstancePlayer.md#getproposalscoreslist)
44
43
  - [getCurrentTurn](InstancePlayer.md#getcurrentturn)
45
44
  - [getPlayers](InstancePlayer.md#getplayers)
45
+ - [getGameState](InstancePlayer.md#getgamestate)
46
46
  - [getGameStateDetails](InstancePlayer.md#getgamestatedetails)
47
47
  - [getGameStates](InstancePlayer.md#getgamestates)
48
48
  - [getEIP712Domain](InstancePlayer.md#geteip712domain)
@@ -160,7 +160,7 @@ ___
160
160
 
161
161
  ### getHistoricTurn
162
162
 
163
- ▸ **getHistoricTurn**(`gameId`, `turnId`): `Promise`\<{}\>
163
+ ▸ **getHistoricTurn**(`gameId`, `turnId`): `Promise`\<(\{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` = ""; `score`: `bigint` ; `scoreList`: `never`[] = []; `blockTimestamp?`: `undefined` } \| \{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` ; `score`: `bigint` ; `scoreList`: \{ `score`: `bigint` ; `player`: \`0x$\{string}\` = proposer }[] ; `blockTimestamp`: `bigint` })[]\>
164
164
 
165
165
  Retrieves the historic turn information for a specific game and turn ID.
166
166
 
@@ -173,7 +173,7 @@ Retrieves the historic turn information for a specific game and turn ID.
173
173
 
174
174
  #### Returns
175
175
 
176
- `Promise`\<{}\>
176
+ `Promise`\<(\{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` = ""; `score`: `bigint` ; `scoreList`: `never`[] = []; `blockTimestamp?`: `undefined` } \| \{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` ; `score`: `bigint` ; `scoreList`: \{ `score`: `bigint` ; `player`: \`0x$\{string}\` = proposer }[] ; `blockTimestamp`: `bigint` })[]\>
177
177
 
178
178
  The historic turn event object.
179
179
 
@@ -212,32 +212,6 @@ Reorganized votes array
212
212
 
213
213
  ___
214
214
 
215
- ### reorganizeProposals
216
-
217
- ▸ **reorganizeProposals**(`proposals`, `turnId`, `gameId`): `Promise`\<readonly `string`[]\>
218
-
219
- Reorganizes proposals array based on proposerIndices mapping
220
-
221
- #### Parameters
222
-
223
- | Name | Type | Description |
224
- | :------ | :------ | :------ |
225
- | `proposals` | readonly `string`[] | Array of proposals for each player |
226
- | `turnId` | `bigint` | - |
227
- | `gameId` | `bigint` | - |
228
-
229
- #### Returns
230
-
231
- `Promise`\<readonly `string`[]\>
232
-
233
- Reorganized proposals array
234
-
235
- #### Inherited from
236
-
237
- [InstanceBase](InstanceBase.md).[reorganizeProposals](InstanceBase.md#reorganizeproposals)
238
-
239
- ___
240
-
241
215
  ### getCreationBlock
242
216
 
243
217
  ▸ **getCreationBlock**(): `Promise`\<`bigint`\>
@@ -254,7 +228,7 @@ ___
254
228
 
255
229
  ### getPreviousTurnStats
256
230
 
257
- ▸ **getPreviousTurnStats**(`gameId`): `Promise`\<{} \| \{ `players`: `string` = "N/A"; `scores`: `string` = "N/A"; `turnSalt`: `string` = "N/A"; `voters`: `string`[] ; `votesRevealed`: `string`[] }\>
231
+ ▸ **getPreviousTurnStats**(`gameId`): `Promise`\<(\{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` = ""; `score`: `bigint` ; `scoreList`: `never`[] = []; `blockTimestamp?`: `undefined` } \| \{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` ; `score`: `bigint` ; `scoreList`: \{ `score`: `bigint` ; `player`: \`0x$\{string}\` = proposer }[] ; `blockTimestamp`: `bigint` })[] \| \{ `players`: `string` = "N/A"; `scores`: `string` = "N/A"; `turnSalt`: `string` = "N/A"; `voters`: `string`[] ; `votesRevealed`: `string`[] }\>
258
232
 
259
233
  Retrieves the previous turn information for a specific game.
260
234
 
@@ -266,7 +240,7 @@ Retrieves the previous turn information for a specific game.
266
240
 
267
241
  #### Returns
268
242
 
269
- `Promise`\<{} \| \{ `players`: `string` = "N/A"; `scores`: `string` = "N/A"; `turnSalt`: `string` = "N/A"; `voters`: `string`[] ; `votesRevealed`: `string`[] }\>
243
+ `Promise`\<(\{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` = ""; `score`: `bigint` ; `scoreList`: `never`[] = []; `blockTimestamp?`: `undefined` } \| \{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` ; `score`: `bigint` ; `scoreList`: \{ `score`: `bigint` ; `player`: \`0x$\{string}\` = proposer }[] ; `blockTimestamp`: `bigint` })[] \| \{ `players`: `string` = "N/A"; `scores`: `string` = "N/A"; `turnSalt`: `string` = "N/A"; `voters`: `string`[] ; `votesRevealed`: `string`[] }\>
270
244
 
271
245
  The previous turn information for the specified game.
272
246
 
@@ -533,6 +507,26 @@ A Promise that resolves to the player addresses of the game.
533
507
 
534
508
  ___
535
509
 
510
+ ### getGameState
511
+
512
+ ▸ **getGameState**(`gameId`): `Promise`\<\{ `rank`: `bigint` ; `minGameTime`: `bigint` ; `createdBy`: \`0x$\{string}\` ; `numOngoingProposals`: `bigint` ; `numPrevProposals`: `bigint` ; `numCommitments`: `bigint` ; `numVotesThisTurn`: `bigint` ; `numVotesPrevTurn`: `bigint` ; `voting`: \{ `voteCredits`: `bigint` ; `maxQuadraticPoints`: `bigint` ; `minQuadraticPositions`: `bigint` } ; `currentTurn`: `bigint` ; `turnStartedAt`: `bigint` ; `registrationOpenAt`: `bigint` ; `startedAt`: `bigint` ; `hasStarted`: `boolean` ; `hasEnded`: `boolean` ; `numPlayersMadeMove`: `bigint` ; `numActivePlayers`: `bigint` ; `isOvertime`: `boolean` ; `timePerTurn`: `bigint` ; `maxPlayerCnt`: `bigint` ; `minPlayerCnt`: `bigint` ; `timeToJoin`: `bigint` ; `maxTurns`: `bigint` ; `voteCredits`: `bigint` ; `gameMaster`: \`0x$\{string}\` ; `metadata`: `string` }\>
513
+
514
+ #### Parameters
515
+
516
+ | Name | Type |
517
+ | :------ | :------ |
518
+ | `gameId` | `bigint` |
519
+
520
+ #### Returns
521
+
522
+ `Promise`\<\{ `rank`: `bigint` ; `minGameTime`: `bigint` ; `createdBy`: \`0x$\{string}\` ; `numOngoingProposals`: `bigint` ; `numPrevProposals`: `bigint` ; `numCommitments`: `bigint` ; `numVotesThisTurn`: `bigint` ; `numVotesPrevTurn`: `bigint` ; `voting`: \{ `voteCredits`: `bigint` ; `maxQuadraticPoints`: `bigint` ; `minQuadraticPositions`: `bigint` } ; `currentTurn`: `bigint` ; `turnStartedAt`: `bigint` ; `registrationOpenAt`: `bigint` ; `startedAt`: `bigint` ; `hasStarted`: `boolean` ; `hasEnded`: `boolean` ; `numPlayersMadeMove`: `bigint` ; `numActivePlayers`: `bigint` ; `isOvertime`: `boolean` ; `timePerTurn`: `bigint` ; `maxPlayerCnt`: `bigint` ; `minPlayerCnt`: `bigint` ; `timeToJoin`: `bigint` ; `maxTurns`: `bigint` ; `voteCredits`: `bigint` ; `gameMaster`: \`0x$\{string}\` ; `metadata`: `string` }\>
523
+
524
+ #### Inherited from
525
+
526
+ [InstanceBase](InstanceBase.md).[getGameState](InstanceBase.md#getgamestate)
527
+
528
+ ___
529
+
536
530
  ### getGameStateDetails
537
531
 
538
532
  ▸ **getGameStateDetails**(`gameId`): `Promise`\<`GameState`\>
@@ -25,7 +25,6 @@ Extends InstanceBase to provide game master specific functionality
25
25
  - [reversePermutation](GameMaster.md#reversepermutation)
26
26
  - [getTurnSalt](GameMaster.md#getturnsalt)
27
27
  - [getTurnPlayersSalt](GameMaster.md#getturnplayerssalt)
28
- - [getProposalsVotedUpon](GameMaster.md#getproposalsvotedupon)
29
28
  - [findPlayerOngoingProposalIndex](GameMaster.md#findplayerongoingproposalindex)
30
29
  - [validateJoinGame](GameMaster.md#validatejoingame)
31
30
  - [signJoiningGame](GameMaster.md#signjoininggame)
@@ -35,7 +34,6 @@ Extends InstanceBase to provide game master specific functionality
35
34
  - [attestProposal](GameMaster.md#attestproposal)
36
35
  - [submitProposal](GameMaster.md#submitproposal)
37
36
  - [decryptTurnVotes](GameMaster.md#decryptturnvotes)
38
- - [decryptVotes](GameMaster.md#decryptvotes)
39
37
  - [canEndTurn](GameMaster.md#canendturn)
40
38
  - [currentTurn](GameMaster.md#currentturn)
41
39
  - [getPlayers](GameMaster.md#getplayers)
@@ -116,23 +114,25 @@ ___
116
114
 
117
115
  ### decryptProposals
118
116
 
119
- ▸ **decryptProposals**(`«destructured»`): `Promise`\<\{ `proposer`: \`0x$\{string}\` = log.args.proposer; `proposal`: `string` }[]\>
117
+ ▸ **decryptProposals**(`«destructured»`): `Promise`\<\{ `proposer`: \`0x$\{string}\` ; `proposal`: `string` }[]\>
120
118
 
121
119
  Decrypts proposals for a specific game turn
122
120
 
123
121
  #### Parameters
124
122
 
125
- | Name | Type |
126
- | :------ | :------ |
127
- | `«destructured»` | `Object` |
128
- | › `instanceAddress` | \`0x$\{string}\` |
129
- | › `gameId` | `bigint` |
130
- | › `turn` | `bigint` |
131
- | › `proposer?` | \`0x$\{string}\` |
123
+ | Name | Type | Default value |
124
+ | :------ | :------ | :------ |
125
+ | `«destructured»` | `Object` | `undefined` |
126
+ | › `instanceAddress` | \`0x$\{string}\` | `undefined` |
127
+ | › `gameId` | `bigint` | `undefined` |
128
+ | › `turn` | `bigint` | `undefined` |
129
+ | › `players` | \`0x$\{string}\`[] | `undefined` |
130
+ | › `padToMaxSize?` | `boolean` | `false` |
131
+ | › `permute?` | `boolean` | `false` |
132
132
 
133
133
  #### Returns
134
134
 
135
- `Promise`\<\{ `proposer`: \`0x$\{string}\` = log.args.proposer; `proposal`: `string` }[]\>
135
+ `Promise`\<\{ `proposer`: \`0x$\{string}\` ; `proposal`: `string` }[]\>
136
136
 
137
137
  Array of decrypted proposals with proposer addresses
138
138
 
@@ -164,7 +164,7 @@ ___
164
164
 
165
165
  ### generateDeterministicPermutation
166
166
 
167
- ▸ **generateDeterministicPermutation**(`«destructured»`): `Promise`\<\{ `permutation`: `number`[] ; `secret`: `bigint` ; `commitment`: `bigint` }\>
167
+ ▸ **generateDeterministicPermutation**(`«destructured»`): `Promise`\<\{ `permutation`: `number`[] ; `turnSalt`: `bigint` ; `commitment`: `bigint` }\>
168
168
 
169
169
  Generates a deterministic permutation for a specific game turn
170
170
 
@@ -180,7 +180,7 @@ Generates a deterministic permutation for a specific game turn
180
180
 
181
181
  #### Returns
182
182
 
183
- `Promise`\<\{ `permutation`: `number`[] ; `secret`: `bigint` ; `commitment`: `bigint` }\>
183
+ `Promise`\<\{ `permutation`: `number`[] ; `turnSalt`: `bigint` ; `commitment`: `bigint` }\>
184
184
 
185
185
  The generated permutation, secret, and commitment
186
186
 
@@ -294,25 +294,6 @@ Generated salt as Hex
294
294
 
295
295
  ___
296
296
 
297
- ### getProposalsVotedUpon
298
-
299
- ▸ **getProposalsVotedUpon**(`«destructured»`): `Promise`\<\{ `proposer`: \`0x$\{string}\` ; `proposal`: `string` }[]\>
300
-
301
- #### Parameters
302
-
303
- | Name | Type |
304
- | :------ | :------ |
305
- | `«destructured»` | `Object` |
306
- | › `instanceAddress` | \`0x$\{string}\` |
307
- | › `gameId` | `bigint` |
308
- | › `turn` | `bigint` |
309
-
310
- #### Returns
311
-
312
- `Promise`\<\{ `proposer`: \`0x$\{string}\` ; `proposal`: `string` }[]\>
313
-
314
- ___
315
-
316
297
  ### findPlayerOngoingProposalIndex
317
298
 
318
299
  ▸ **findPlayerOngoingProposalIndex**(`«destructured»`): `Promise`\<`number`\>
@@ -500,44 +481,23 @@ ___
500
481
 
501
482
  ### decryptTurnVotes
502
483
 
503
- ▸ **decryptTurnVotes**(`«destructured»`): `Promise`\<\{ `player`: \`0x$\{string}\` = event.args.player; `votes`: `bigint`[] = decryptedVotes }[]\>
484
+ ▸ **decryptTurnVotes**(`«destructured»`): `Promise`\<`bigint`[][]\>
504
485
 
505
486
  Decrypts votes for a specific game turn
506
487
 
507
488
  #### Parameters
508
489
 
509
- | Name | Type |
510
- | :------ | :------ |
511
- | `«destructured»` | `Object` |
512
- | › `instanceAddress` | \`0x$\{string}\` |
513
- | › `gameId` | `bigint` |
514
- | › `turn` | `bigint` |
515
-
516
- #### Returns
517
-
518
- `Promise`\<\{ `player`: \`0x$\{string}\` = event.args.player; `votes`: `bigint`[] = decryptedVotes }[]\>
519
-
520
- Array of decrypted votes with player addresses
521
-
522
- ___
523
-
524
- ### decryptVotes
525
-
526
- ▸ **decryptVotes**(`gameId`): `Promise`\<``-1`` \| \{ `player`: \`0x$\{string}\` = event.args.player; `votes`: `bigint`[] = decryptedVotes }[]\>
527
-
528
- Decrypts all votes for the current game turn
529
-
530
- #### Parameters
531
-
532
- | Name | Type | Description |
490
+ | Name | Type | Default value |
533
491
  | :------ | :------ | :------ |
534
- | `gameId` | `Object` | ID of the game |
535
- | `gameId.instanceAddress` | \`0x$\{string}\` | - |
536
- | `gameId.gameId` | `bigint` | - |
492
+ | `«destructured»` | `Object` | `undefined` |
493
+ | › `instanceAddress` | \`0x$\{string}\` | `undefined` |
494
+ | › `gameId` | `bigint` | `undefined` |
495
+ | › `turn` | `bigint` | `undefined` |
496
+ | › `players` | \`0x$\{string}\`[] | `[]` |
537
497
 
538
498
  #### Returns
539
499
 
540
- `Promise`\<``-1`` \| \{ `player`: \`0x$\{string}\` = event.args.player; `votes`: `bigint`[] = decryptedVotes }[]\>
500
+ `Promise`\<`bigint`[][]\>
541
501
 
542
502
  Array of decrypted votes with player addresses
543
503
 
@@ -703,7 +663,7 @@ ___
703
663
 
704
664
  ### generateEndTurnIntegrity
705
665
 
706
- ▸ **generateEndTurnIntegrity**(`params`): `Promise`\<\{ `commitment`: `bigint` = inputs.permutationCommitment; `nullifier`: `bigint` ; `permutation`: `number`[] = permutation; `permutedProposals`: `string`[] ; `a`: readonly [`bigint`, `bigint`] ; `b`: readonly [readonly [`bigint`, `bigint`], readonly [`bigint`, `bigint`]] ; `c`: readonly [`bigint`, `bigint`] }\>
666
+ ▸ **generateEndTurnIntegrity**(`params`): `Promise`\<\{ `commitment`: `bigint` = inputs.permutationCommitment; `prevTurnSalt`: `bigint` ; `prevTurnPermutation`: `number`[] ; `permutedProposals`: `string`[] ; `a`: readonly [`bigint`, `bigint`] ; `b`: readonly [readonly [`bigint`, `bigint`], readonly [`bigint`, `bigint`]] ; `c`: readonly [`bigint`, `bigint`] }\>
707
667
 
708
668
  Generates integrity data for the end of a game turn
709
669
 
@@ -720,7 +680,7 @@ Generates integrity data for the end of a game turn
720
680
 
721
681
  #### Returns
722
682
 
723
- `Promise`\<\{ `commitment`: `bigint` = inputs.permutationCommitment; `nullifier`: `bigint` ; `permutation`: `number`[] = permutation; `permutedProposals`: `string`[] ; `a`: readonly [`bigint`, `bigint`] ; `b`: readonly [readonly [`bigint`, `bigint`], readonly [`bigint`, `bigint`]] ; `c`: readonly [`bigint`, `bigint`] }\>
683
+ `Promise`\<\{ `commitment`: `bigint` = inputs.permutationCommitment; `prevTurnSalt`: `bigint` ; `prevTurnPermutation`: `number`[] ; `permutedProposals`: `string`[] ; `a`: readonly [`bigint`, `bigint`] ; `b`: readonly [readonly [`bigint`, `bigint`], readonly [`bigint`, `bigint`]] ; `c`: readonly [`bigint`, `bigint`] }\>
724
684
 
725
685
  Integrity data including permutation, secret, and proof
726
686
 
@@ -27,7 +27,6 @@ Provides core functionality for managing game state and interactions
27
27
 
28
28
  - [getHistoricTurn](InstanceBase.md#gethistoricturn)
29
29
  - [reorganizeVotes](InstanceBase.md#reorganizevotes)
30
- - [reorganizeProposals](InstanceBase.md#reorganizeproposals)
31
30
  - [getCreationBlock](InstanceBase.md#getcreationblock)
32
31
  - [getPreviousTurnStats](InstanceBase.md#getpreviousturnstats)
33
32
  - [getVoting](InstanceBase.md#getvoting)
@@ -41,6 +40,7 @@ Provides core functionality for managing game state and interactions
41
40
  - [getProposalScoresList](InstanceBase.md#getproposalscoreslist)
42
41
  - [getCurrentTurn](InstanceBase.md#getcurrentturn)
43
42
  - [getPlayers](InstanceBase.md#getplayers)
43
+ - [getGameState](InstanceBase.md#getgamestate)
44
44
  - [getGameStateDetails](InstanceBase.md#getgamestatedetails)
45
45
  - [getGameStates](InstanceBase.md#getgamestates)
46
46
  - [getEIP712Domain](InstanceBase.md#geteip712domain)
@@ -112,7 +112,7 @@ ___
112
112
 
113
113
  ### getHistoricTurn
114
114
 
115
- ▸ **getHistoricTurn**(`gameId`, `turnId`): `Promise`\<{}\>
115
+ ▸ **getHistoricTurn**(`gameId`, `turnId`): `Promise`\<(\{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` = ""; `score`: `bigint` ; `scoreList`: `never`[] = []; `blockTimestamp?`: `undefined` } \| \{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` ; `score`: `bigint` ; `scoreList`: \{ `score`: `bigint` ; `player`: \`0x$\{string}\` = proposer }[] ; `blockTimestamp`: `bigint` })[]\>
116
116
 
117
117
  Retrieves the historic turn information for a specific game and turn ID.
118
118
 
@@ -125,7 +125,7 @@ Retrieves the historic turn information for a specific game and turn ID.
125
125
 
126
126
  #### Returns
127
127
 
128
- `Promise`\<{}\>
128
+ `Promise`\<(\{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` = ""; `score`: `bigint` ; `scoreList`: `never`[] = []; `blockTimestamp?`: `undefined` } \| \{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` ; `score`: `bigint` ; `scoreList`: \{ `score`: `bigint` ; `player`: \`0x$\{string}\` = proposer }[] ; `blockTimestamp`: `bigint` })[]\>
129
129
 
130
130
  The historic turn event object.
131
131
 
@@ -156,28 +156,6 @@ Reorganized votes array
156
156
 
157
157
  ___
158
158
 
159
- ### reorganizeProposals
160
-
161
- ▸ **reorganizeProposals**(`proposals`, `turnId`, `gameId`): `Promise`\<readonly `string`[]\>
162
-
163
- Reorganizes proposals array based on proposerIndices mapping
164
-
165
- #### Parameters
166
-
167
- | Name | Type | Description |
168
- | :------ | :------ | :------ |
169
- | `proposals` | readonly `string`[] | Array of proposals for each player |
170
- | `turnId` | `bigint` | - |
171
- | `gameId` | `bigint` | - |
172
-
173
- #### Returns
174
-
175
- `Promise`\<readonly `string`[]\>
176
-
177
- Reorganized proposals array
178
-
179
- ___
180
-
181
159
  ### getCreationBlock
182
160
 
183
161
  ▸ **getCreationBlock**(): `Promise`\<`bigint`\>
@@ -190,7 +168,7 @@ ___
190
168
 
191
169
  ### getPreviousTurnStats
192
170
 
193
- ▸ **getPreviousTurnStats**(`gameId`): `Promise`\<{} \| \{ `players`: `string` = "N/A"; `scores`: `string` = "N/A"; `turnSalt`: `string` = "N/A"; `voters`: `string`[] ; `votesRevealed`: `string`[] }\>
171
+ ▸ **getPreviousTurnStats**(`gameId`): `Promise`\<(\{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` = ""; `score`: `bigint` ; `scoreList`: `never`[] = []; `blockTimestamp?`: `undefined` } \| \{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` ; `score`: `bigint` ; `scoreList`: \{ `score`: `bigint` ; `player`: \`0x$\{string}\` = proposer }[] ; `blockTimestamp`: `bigint` })[] \| \{ `players`: `string` = "N/A"; `scores`: `string` = "N/A"; `turnSalt`: `string` = "N/A"; `voters`: `string`[] ; `votesRevealed`: `string`[] }\>
194
172
 
195
173
  Retrieves the previous turn information for a specific game.
196
174
 
@@ -202,7 +180,7 @@ Retrieves the previous turn information for a specific game.
202
180
 
203
181
  #### Returns
204
182
 
205
- `Promise`\<{} \| \{ `players`: `string` = "N/A"; `scores`: `string` = "N/A"; `turnSalt`: `string` = "N/A"; `voters`: `string`[] ; `votesRevealed`: `string`[] }\>
183
+ `Promise`\<(\{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` = ""; `score`: `bigint` ; `scoreList`: `never`[] = []; `blockTimestamp?`: `undefined` } \| \{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` ; `score`: `bigint` ; `scoreList`: \{ `score`: `bigint` ; `player`: \`0x$\{string}\` = proposer }[] ; `blockTimestamp`: `bigint` })[] \| \{ `players`: `string` = "N/A"; `scores`: `string` = "N/A"; `turnSalt`: `string` = "N/A"; `voters`: `string`[] ; `votesRevealed`: `string`[] }\>
206
184
 
207
185
  The previous turn information for the specified game.
208
186
 
@@ -421,6 +399,22 @@ A Promise that resolves to the player addresses of the game.
421
399
 
422
400
  ___
423
401
 
402
+ ### getGameState
403
+
404
+ ▸ **getGameState**(`gameId`): `Promise`\<\{ `rank`: `bigint` ; `minGameTime`: `bigint` ; `createdBy`: \`0x$\{string}\` ; `numOngoingProposals`: `bigint` ; `numPrevProposals`: `bigint` ; `numCommitments`: `bigint` ; `numVotesThisTurn`: `bigint` ; `numVotesPrevTurn`: `bigint` ; `voting`: \{ `voteCredits`: `bigint` ; `maxQuadraticPoints`: `bigint` ; `minQuadraticPositions`: `bigint` } ; `currentTurn`: `bigint` ; `turnStartedAt`: `bigint` ; `registrationOpenAt`: `bigint` ; `startedAt`: `bigint` ; `hasStarted`: `boolean` ; `hasEnded`: `boolean` ; `numPlayersMadeMove`: `bigint` ; `numActivePlayers`: `bigint` ; `isOvertime`: `boolean` ; `timePerTurn`: `bigint` ; `maxPlayerCnt`: `bigint` ; `minPlayerCnt`: `bigint` ; `timeToJoin`: `bigint` ; `maxTurns`: `bigint` ; `voteCredits`: `bigint` ; `gameMaster`: \`0x$\{string}\` ; `metadata`: `string` }\>
405
+
406
+ #### Parameters
407
+
408
+ | Name | Type |
409
+ | :------ | :------ |
410
+ | `gameId` | `bigint` |
411
+
412
+ #### Returns
413
+
414
+ `Promise`\<\{ `rank`: `bigint` ; `minGameTime`: `bigint` ; `createdBy`: \`0x$\{string}\` ; `numOngoingProposals`: `bigint` ; `numPrevProposals`: `bigint` ; `numCommitments`: `bigint` ; `numVotesThisTurn`: `bigint` ; `numVotesPrevTurn`: `bigint` ; `voting`: \{ `voteCredits`: `bigint` ; `maxQuadraticPoints`: `bigint` ; `minQuadraticPositions`: `bigint` } ; `currentTurn`: `bigint` ; `turnStartedAt`: `bigint` ; `registrationOpenAt`: `bigint` ; `startedAt`: `bigint` ; `hasStarted`: `boolean` ; `hasEnded`: `boolean` ; `numPlayersMadeMove`: `bigint` ; `numActivePlayers`: `bigint` ; `isOvertime`: `boolean` ; `timePerTurn`: `bigint` ; `maxPlayerCnt`: `bigint` ; `minPlayerCnt`: `bigint` ; `timeToJoin`: `bigint` ; `maxTurns`: `bigint` ; `voteCredits`: `bigint` ; `gameMaster`: \`0x$\{string}\` ; `metadata`: `string` }\>
415
+
416
+ ___
417
+
424
418
  ### getGameStateDetails
425
419
 
426
420
  ▸ **getGameStateDetails**(`gameId`): `Promise`\<`GameState`\>
@@ -29,7 +29,6 @@ Provides core functionality for managing game state and interactions
29
29
 
30
30
  - [getHistoricTurn](InstancePlayer.md#gethistoricturn)
31
31
  - [reorganizeVotes](InstancePlayer.md#reorganizevotes)
32
- - [reorganizeProposals](InstancePlayer.md#reorganizeproposals)
33
32
  - [getCreationBlock](InstancePlayer.md#getcreationblock)
34
33
  - [getPreviousTurnStats](InstancePlayer.md#getpreviousturnstats)
35
34
  - [getVoting](InstancePlayer.md#getvoting)
@@ -43,6 +42,7 @@ Provides core functionality for managing game state and interactions
43
42
  - [getProposalScoresList](InstancePlayer.md#getproposalscoreslist)
44
43
  - [getCurrentTurn](InstancePlayer.md#getcurrentturn)
45
44
  - [getPlayers](InstancePlayer.md#getplayers)
45
+ - [getGameState](InstancePlayer.md#getgamestate)
46
46
  - [getGameStateDetails](InstancePlayer.md#getgamestatedetails)
47
47
  - [getGameStates](InstancePlayer.md#getgamestates)
48
48
  - [getEIP712Domain](InstancePlayer.md#geteip712domain)
@@ -160,7 +160,7 @@ ___
160
160
 
161
161
  ### getHistoricTurn
162
162
 
163
- ▸ **getHistoricTurn**(`gameId`, `turnId`): `Promise`\<{}\>
163
+ ▸ **getHistoricTurn**(`gameId`, `turnId`): `Promise`\<(\{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` = ""; `score`: `bigint` ; `scoreList`: `never`[] = []; `blockTimestamp?`: `undefined` } \| \{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` ; `score`: `bigint` ; `scoreList`: \{ `score`: `bigint` ; `player`: \`0x$\{string}\` = proposer }[] ; `blockTimestamp`: `bigint` })[]\>
164
164
 
165
165
  Retrieves the historic turn information for a specific game and turn ID.
166
166
 
@@ -173,7 +173,7 @@ Retrieves the historic turn information for a specific game and turn ID.
173
173
 
174
174
  #### Returns
175
175
 
176
- `Promise`\<{}\>
176
+ `Promise`\<(\{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` = ""; `score`: `bigint` ; `scoreList`: `never`[] = []; `blockTimestamp?`: `undefined` } \| \{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` ; `score`: `bigint` ; `scoreList`: \{ `score`: `bigint` ; `player`: \`0x$\{string}\` = proposer }[] ; `blockTimestamp`: `bigint` })[]\>
177
177
 
178
178
  The historic turn event object.
179
179
 
@@ -212,32 +212,6 @@ Reorganized votes array
212
212
 
213
213
  ___
214
214
 
215
- ### reorganizeProposals
216
-
217
- ▸ **reorganizeProposals**(`proposals`, `turnId`, `gameId`): `Promise`\<readonly `string`[]\>
218
-
219
- Reorganizes proposals array based on proposerIndices mapping
220
-
221
- #### Parameters
222
-
223
- | Name | Type | Description |
224
- | :------ | :------ | :------ |
225
- | `proposals` | readonly `string`[] | Array of proposals for each player |
226
- | `turnId` | `bigint` | - |
227
- | `gameId` | `bigint` | - |
228
-
229
- #### Returns
230
-
231
- `Promise`\<readonly `string`[]\>
232
-
233
- Reorganized proposals array
234
-
235
- #### Inherited from
236
-
237
- [InstanceBase](InstanceBase.md).[reorganizeProposals](InstanceBase.md#reorganizeproposals)
238
-
239
- ___
240
-
241
215
  ### getCreationBlock
242
216
 
243
217
  ▸ **getCreationBlock**(): `Promise`\<`bigint`\>
@@ -254,7 +228,7 @@ ___
254
228
 
255
229
  ### getPreviousTurnStats
256
230
 
257
- ▸ **getPreviousTurnStats**(`gameId`): `Promise`\<{} \| \{ `players`: `string` = "N/A"; `scores`: `string` = "N/A"; `turnSalt`: `string` = "N/A"; `voters`: `string`[] ; `votesRevealed`: `string`[] }\>
231
+ ▸ **getPreviousTurnStats**(`gameId`): `Promise`\<(\{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` = ""; `score`: `bigint` ; `scoreList`: `never`[] = []; `blockTimestamp?`: `undefined` } \| \{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` ; `score`: `bigint` ; `scoreList`: \{ `score`: `bigint` ; `player`: \`0x$\{string}\` = proposer }[] ; `blockTimestamp`: `bigint` })[] \| \{ `players`: `string` = "N/A"; `scores`: `string` = "N/A"; `turnSalt`: `string` = "N/A"; `voters`: `string`[] ; `votesRevealed`: `string`[] }\>
258
232
 
259
233
  Retrieves the previous turn information for a specific game.
260
234
 
@@ -266,7 +240,7 @@ Retrieves the previous turn information for a specific game.
266
240
 
267
241
  #### Returns
268
242
 
269
- `Promise`\<{} \| \{ `players`: `string` = "N/A"; `scores`: `string` = "N/A"; `turnSalt`: `string` = "N/A"; `voters`: `string`[] ; `votesRevealed`: `string`[] }\>
243
+ `Promise`\<(\{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` = ""; `score`: `bigint` ; `scoreList`: `never`[] = []; `blockTimestamp?`: `undefined` } \| \{ `player`: \`0x$\{string}\` = proposer; `proposal`: `string` ; `score`: `bigint` ; `scoreList`: \{ `score`: `bigint` ; `player`: \`0x$\{string}\` = proposer }[] ; `blockTimestamp`: `bigint` })[] \| \{ `players`: `string` = "N/A"; `scores`: `string` = "N/A"; `turnSalt`: `string` = "N/A"; `voters`: `string`[] ; `votesRevealed`: `string`[] }\>
270
244
 
271
245
  The previous turn information for the specified game.
272
246
 
@@ -533,6 +507,26 @@ A Promise that resolves to the player addresses of the game.
533
507
 
534
508
  ___
535
509
 
510
+ ### getGameState
511
+
512
+ ▸ **getGameState**(`gameId`): `Promise`\<\{ `rank`: `bigint` ; `minGameTime`: `bigint` ; `createdBy`: \`0x$\{string}\` ; `numOngoingProposals`: `bigint` ; `numPrevProposals`: `bigint` ; `numCommitments`: `bigint` ; `numVotesThisTurn`: `bigint` ; `numVotesPrevTurn`: `bigint` ; `voting`: \{ `voteCredits`: `bigint` ; `maxQuadraticPoints`: `bigint` ; `minQuadraticPositions`: `bigint` } ; `currentTurn`: `bigint` ; `turnStartedAt`: `bigint` ; `registrationOpenAt`: `bigint` ; `startedAt`: `bigint` ; `hasStarted`: `boolean` ; `hasEnded`: `boolean` ; `numPlayersMadeMove`: `bigint` ; `numActivePlayers`: `bigint` ; `isOvertime`: `boolean` ; `timePerTurn`: `bigint` ; `maxPlayerCnt`: `bigint` ; `minPlayerCnt`: `bigint` ; `timeToJoin`: `bigint` ; `maxTurns`: `bigint` ; `voteCredits`: `bigint` ; `gameMaster`: \`0x$\{string}\` ; `metadata`: `string` }\>
513
+
514
+ #### Parameters
515
+
516
+ | Name | Type |
517
+ | :------ | :------ |
518
+ | `gameId` | `bigint` |
519
+
520
+ #### Returns
521
+
522
+ `Promise`\<\{ `rank`: `bigint` ; `minGameTime`: `bigint` ; `createdBy`: \`0x$\{string}\` ; `numOngoingProposals`: `bigint` ; `numPrevProposals`: `bigint` ; `numCommitments`: `bigint` ; `numVotesThisTurn`: `bigint` ; `numVotesPrevTurn`: `bigint` ; `voting`: \{ `voteCredits`: `bigint` ; `maxQuadraticPoints`: `bigint` ; `minQuadraticPositions`: `bigint` } ; `currentTurn`: `bigint` ; `turnStartedAt`: `bigint` ; `registrationOpenAt`: `bigint` ; `startedAt`: `bigint` ; `hasStarted`: `boolean` ; `hasEnded`: `boolean` ; `numPlayersMadeMove`: `bigint` ; `numActivePlayers`: `bigint` ; `isOvertime`: `boolean` ; `timePerTurn`: `bigint` ; `maxPlayerCnt`: `bigint` ; `minPlayerCnt`: `bigint` ; `timeToJoin`: `bigint` ; `maxTurns`: `bigint` ; `voteCredits`: `bigint` ; `gameMaster`: \`0x$\{string}\` ; `metadata`: `string` }\>
523
+
524
+ #### Inherited from
525
+
526
+ [InstanceBase](InstanceBase.md).[getGameState](InstanceBase.md#getgamestate)
527
+
528
+ ___
529
+
536
530
  ### getGameStateDetails
537
531
 
538
532
  ▸ **getGameStateDetails**(`gameId`): `Promise`\<`GameState`\>
@@ -1,4 +1,4 @@
1
- # Rankify SDK API Documentation - v3.7.4
1
+ # Rankify SDK API Documentation - v3.8.0
2
2
 
3
3
  ## Table of contents
4
4
 
package/docs/index.md CHANGED
@@ -1,4 +1,4 @@
1
- # Rankify SDK API Documentation - v3.7.4
1
+ # Rankify SDK API Documentation - v3.8.0
2
2
 
3
3
  ## Table of contents
4
4