@peeramid-labs/sdk 3.14.0 → 3.16.0

package/docs/classes/InstanceBase.md

@@ -9,6 +9,8 @@ Provides core functionality for managing game state and interactions
 
   ↳ [`InstancePlayer`](InstancePlayer.md)
 
+  ↳ [`InstanceUBI`](InstanceUBI.md)
+
 ## Table of contents
 
 ### Constructors
@@ -42,6 +44,7 @@ Provides core functionality for managing game state and interactions
 - [getCurrentTurn](InstanceBase.md#getcurrentturn)
 - [getPlayers](InstanceBase.md#getplayers)
 - [getGameState](InstanceBase.md#getgamestate)
+- [isWhitelistedGM](InstanceBase.md#iswhitelistedgm)
 - [getGameStateDetails](InstanceBase.md#getgamestatedetails)
 - [getGameStates](InstanceBase.md#getgamestates)
 - [getEIP712Domain](InstanceBase.md#geteip712domain)
@@ -51,6 +54,13 @@ Provides core functionality for managing game state and interactions
 - [isGameMetadata](InstanceBase.md#isgamemetadata)
 - [isPlayerInGame](InstanceBase.md#isplayeringame)
 - [getGameMetadata](InstanceBase.md#getgamemetadata)
+- [getProposalGameScore](InstanceBase.md#getproposalgamescore)
+- [getProposalTurnScore](InstanceBase.md#getproposalturnscore)
+- [getProposalsTurnScores](InstanceBase.md#getproposalsturnscores)
+- [proposalExistsInTurn](InstanceBase.md#proposalexistsinturn)
+- [proposalExistsInGame](InstanceBase.md#proposalexistsingame)
+- [proposalExists](InstanceBase.md#proposalexists)
+- [getProposalTotalScore](InstanceBase.md#getproposaltotalscore)
 
 ## Constructors
 
@@ -320,13 +330,15 @@ ___
 
 ### getContractState
 
-▸ **getContractState**(): `Promise`\<\{ `numGames`: `bigint` ; `contractInitialized`: `boolean` ; `commonParams`: \{ `principalCost`: `bigint` ; `principalTimeConstant`: `bigint` ; `gamePaymentToken`: \`0x$\{string}\` ; `rankTokenAddress`: \`0x$\{string}\` ; `beneficiary`: \`0x$\{string}\` ; `minimumParticipantsInCircle`: `bigint` ; `derivedToken`: \`0x$\{string}\` ; `proposalIntegrityVerifier`: \`0x$\{string}\` ; `poseidon5`: \`0x$\{string}\` ; `poseidon6`: \`0x$\{string}\` ; `poseidon2`: \`0x$\{string}\`  }  }\>
+▸ **getContractState**(): `Promise`\<\{ `numGames`: `bigint` ; `contractInitialized`: `boolean` ; `commonParams`: \{ `principalCost`: `bigint` ; `principalTimeConstant`: `bigint` ; `gamePaymentToken`: \`0x$\{string}\` ; `rankTokenAddress`: \`0x$\{string}\` ; `beneficiary`: \`0x$\{string}\` ; `derivedToken`: \`0x$\{string}\` ; `minimumParticipantsInCircle`: `bigint` ; `proposalIntegrityVerifier`: \`0x$\{string}\` ; `poseidon5`: \`0x$\{string}\` ; `poseidon2`: \`0x$\{string}\`  }  }\>
 
 Retrieves the contract state.
 
 #### Returns
 
-`Promise`\<\{ `numGames`: `bigint` ; `contractInitialized`: `boolean` ; `commonParams`: \{ `principalCost`: `bigint` ; `principalTimeConstant`: `bigint` ; `gamePaymentToken`: \`0x$\{string}\` ; `rankTokenAddress`: \`0x$\{string}\` ; `beneficiary`: \`0x$\{string}\` ; `minimumParticipantsInCircle`: `bigint` ; `derivedToken`: \`0x$\{string}\` ; `proposalIntegrityVerifier`: \`0x$\{string}\` ; `poseidon5`: \`0x$\{string}\` ; `poseidon6`: \`0x$\{string}\` ; `poseidon2`: \`0x$\{string}\`  }  }\>
+`Promise`\<\{ `numGames`: `bigint` ; `contractInitialized`: `boolean` ; `commonParams`: \{ `principalCost`: `bigint` ; `principalTimeConstant`: `bigint` ; `gamePaymentToken`: \`0x$\{string}\` ; `rankTokenAddress`: \`0x$\{string}\` ; `beneficiary`: \`0x$\{string}\` ; `derivedToken`: \`0x$\{string}\` ; `minimumParticipantsInCircle`: `bigint` ; `proposalIntegrityVerifier`: \`0x$\{string}\` ; `poseidon5`: \`0x$\{string}\` ; `poseidon2`: \`0x$\{string}\`  }  }\>
+
+InstanceState object (maintains backward compatibility)
 
 ___
 
@@ -350,7 +362,7 @@ ___
 
 ### getProposalScoresList
 
-▸ **getProposalScoresList**(`gameId`): `Promise`\<\{ `id`: `string` ; `proposalHash`: `string` ; `proposal`: `string` ; `blockTimestamp`: `string` ; `srcAddress`: `string` ; `gameId`: `bigint` ; `turn`: `bigint` ; `roundNumber`: `bigint` ; `score`: `bigint` ; `blockNumber`: `bigint` ; `contractAddress`: \`0x$\{string}\`  }[]\>
+▸ **getProposalScoresList**(`gameId`): `Promise`\<\{ `id`: `string` ; `proposalHash`: `string` ; `proposal`: `string` ; `blockTimestamp`: `string` ; `srcAddress`: `string` ; `gameId`: `bigint` ; `turn`: `bigint` ; `roundNumber`: `bigint` ; `score`: `bigint` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId; `contractAddress`: \`0x$\{string}\`  }[]\>
 
 Retrieves the list of proposal scores for a specific game.
 
@@ -362,7 +374,7 @@ Retrieves the list of proposal scores for a specific game.
 
 #### Returns
 
-`Promise`\<\{ `id`: `string` ; `proposalHash`: `string` ; `proposal`: `string` ; `blockTimestamp`: `string` ; `srcAddress`: `string` ; `gameId`: `bigint` ; `turn`: `bigint` ; `roundNumber`: `bigint` ; `score`: `bigint` ; `blockNumber`: `bigint` ; `contractAddress`: \`0x$\{string}\`  }[]\>
+`Promise`\<\{ `id`: `string` ; `proposalHash`: `string` ; `proposal`: `string` ; `blockTimestamp`: `string` ; `srcAddress`: `string` ; `gameId`: `bigint` ; `turn`: `bigint` ; `roundNumber`: `bigint` ; `score`: `bigint` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId; `contractAddress`: \`0x$\{string}\`  }[]\>
 
 A Promise that resolves to the list of proposal scores.
 
@@ -424,6 +436,22 @@ ___
 
 ___
 
+### isWhitelistedGM
+
+▸ **isWhitelistedGM**(`address`): `Promise`\<`boolean`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `address` | \`0x$\{string}\` |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+___
+
 ### getGameStateDetails
 
 ▸ **getGameStateDetails**(`gameId`): `Promise`\<`GameState`\>
@@ -587,3 +615,150 @@ ___
 #### Returns
 
 `Promise`\<[`GameMetadata`](../interfaces/GameMetadata.md)\<[`FellowshipMetadata`](../index.md#fellowshipmetadata)\>\>
+
+___
+
+### getProposalGameScore
+
+▸ **getProposalGameScore**(`gameId`, `proposalHash`): `Promise`\<`bigint`\>
+
+Get the score of a proposal in a specific game
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `gameId` | `bigint` | The ID of the game |
+| `proposalHash` | \`0x$\{string}\` | The hash of the proposal |
+
+#### Returns
+
+`Promise`\<`bigint`\>
+
+The score of the proposal
+
+___
+
+### getProposalTurnScore
+
+▸ **getProposalTurnScore**(`gameId`, `turn`, `proposalHash`): `Promise`\<\{ `score`: `bigint` ; `proposedBy`: readonly \`0x$\{string}\`[]  }\>
+
+Get the score of a proposal in a specific turn
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `gameId` | `bigint` | The ID of the game |
+| `turn` | `bigint` | The turn number |
+| `proposalHash` | \`0x$\{string}\` | The hash of the proposal |
+
+#### Returns
+
+`Promise`\<\{ `score`: `bigint` ; `proposedBy`: readonly \`0x$\{string}\`[]  }\>
+
+Object with score and proposedBy array
+
+___
+
+### getProposalsTurnScores
+
+▸ **getProposalsTurnScores**(`gameId`, `turn`): `Promise`\<\{ `proposalHashes`: readonly \`0x$\{string}\`[] ; `scores`: readonly `bigint`[] ; `proposedBy`: readonly readonly \`0x$\{string}\`[][]  }\>
+
+Get the scores of all proposals in a specific turn
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `gameId` | `bigint` | The ID of the game |
+| `turn` | `bigint` | The turn number |
+
+#### Returns
+
+`Promise`\<\{ `proposalHashes`: readonly \`0x$\{string}\`[] ; `scores`: readonly `bigint`[] ; `proposedBy`: readonly readonly \`0x$\{string}\`[][]  }\>
+
+Object with proposalHashes, scores, and proposedBy arrays
+
+___
+
+### proposalExistsInTurn
+
+▸ **proposalExistsInTurn**(`gameId`, `turn`, `proposalHash`): `Promise`\<\{ `exists`: `boolean` ; `proposedBy`: readonly \`0x$\{string}\`[]  }\>
+
+Check if a proposal exists in a specific turn
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `gameId` | `bigint` | The ID of the game |
+| `turn` | `bigint` | The turn number |
+| `proposalHash` | \`0x$\{string}\` | The hash of the proposal |
+
+#### Returns
+
+`Promise`\<\{ `exists`: `boolean` ; `proposedBy`: readonly \`0x$\{string}\`[]  }\>
+
+Object with exists boolean and proposedBy array
+
+___
+
+### proposalExistsInGame
+
+▸ **proposalExistsInGame**(`gameId`, `proposalHash`): `Promise`\<`boolean`\>
+
+Check if a proposal exists in a specific game
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `gameId` | `bigint` | The ID of the game |
+| `proposalHash` | \`0x$\{string}\` | The hash of the proposal |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+Boolean indicating if the proposal exists
+
+___
+
+### proposalExists
+
+▸ **proposalExists**(`proposalHash`): `Promise`\<`boolean`\>
+
+Check if a proposal exists in the instance
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `proposalHash` | \`0x$\{string}\` | The hash of the proposal |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+Boolean indicating if the proposal exists
+
+___
+
+### getProposalTotalScore
+
+▸ **getProposalTotalScore**(`proposalHash`): `Promise`\<`bigint`\>
+
+Get the total aggregated score of a proposal across all games
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `proposalHash` | \`0x$\{string}\` | The hash of the proposal |
+
+#### Returns
+
+`Promise`\<`bigint`\>
+
+The total score of the proposal

package/docs/classes/InstancePlayer.md

@@ -44,6 +44,7 @@ Provides core functionality for managing game state and interactions
 - [getCurrentTurn](InstancePlayer.md#getcurrentturn)
 - [getPlayers](InstancePlayer.md#getplayers)
 - [getGameState](InstancePlayer.md#getgamestate)
+- [isWhitelistedGM](InstancePlayer.md#iswhitelistedgm)
 - [getGameStateDetails](InstancePlayer.md#getgamestatedetails)
 - [getGameStates](InstancePlayer.md#getgamestates)
 - [getEIP712Domain](InstancePlayer.md#geteip712domain)
@@ -53,6 +54,13 @@ Provides core functionality for managing game state and interactions
 - [isGameMetadata](InstancePlayer.md#isgamemetadata)
 - [isPlayerInGame](InstancePlayer.md#isplayeringame)
 - [getGameMetadata](InstancePlayer.md#getgamemetadata)
+- [getProposalGameScore](InstancePlayer.md#getproposalgamescore)
+- [getProposalTurnScore](InstancePlayer.md#getproposalturnscore)
+- [getProposalsTurnScores](InstancePlayer.md#getproposalsturnscores)
+- [proposalExistsInTurn](InstancePlayer.md#proposalexistsinturn)
+- [proposalExistsInGame](InstancePlayer.md#proposalexistsingame)
+- [proposalExists](InstancePlayer.md#proposalexists)
+- [getProposalTotalScore](InstancePlayer.md#getproposaltotalscore)
 - [approveTokensIfNeeded](InstancePlayer.md#approvetokensifneeded)
 - [createGame](InstancePlayer.md#creategame)
 - [createAndOpenGame](InstancePlayer.md#createandopengame)
@@ -413,13 +421,15 @@ ___
 
 ### getContractState
 
-▸ **getContractState**(): `Promise`\<\{ `numGames`: `bigint` ; `contractInitialized`: `boolean` ; `commonParams`: \{ `principalCost`: `bigint` ; `principalTimeConstant`: `bigint` ; `gamePaymentToken`: \`0x$\{string}\` ; `rankTokenAddress`: \`0x$\{string}\` ; `beneficiary`: \`0x$\{string}\` ; `minimumParticipantsInCircle`: `bigint` ; `derivedToken`: \`0x$\{string}\` ; `proposalIntegrityVerifier`: \`0x$\{string}\` ; `poseidon5`: \`0x$\{string}\` ; `poseidon6`: \`0x$\{string}\` ; `poseidon2`: \`0x$\{string}\`  }  }\>
+▸ **getContractState**(): `Promise`\<\{ `numGames`: `bigint` ; `contractInitialized`: `boolean` ; `commonParams`: \{ `principalCost`: `bigint` ; `principalTimeConstant`: `bigint` ; `gamePaymentToken`: \`0x$\{string}\` ; `rankTokenAddress`: \`0x$\{string}\` ; `beneficiary`: \`0x$\{string}\` ; `derivedToken`: \`0x$\{string}\` ; `minimumParticipantsInCircle`: `bigint` ; `proposalIntegrityVerifier`: \`0x$\{string}\` ; `poseidon5`: \`0x$\{string}\` ; `poseidon2`: \`0x$\{string}\`  }  }\>
 
 Retrieves the contract state.
 
 #### Returns
 
-`Promise`\<\{ `numGames`: `bigint` ; `contractInitialized`: `boolean` ; `commonParams`: \{ `principalCost`: `bigint` ; `principalTimeConstant`: `bigint` ; `gamePaymentToken`: \`0x$\{string}\` ; `rankTokenAddress`: \`0x$\{string}\` ; `beneficiary`: \`0x$\{string}\` ; `minimumParticipantsInCircle`: `bigint` ; `derivedToken`: \`0x$\{string}\` ; `proposalIntegrityVerifier`: \`0x$\{string}\` ; `poseidon5`: \`0x$\{string}\` ; `poseidon6`: \`0x$\{string}\` ; `poseidon2`: \`0x$\{string}\`  }  }\>
+`Promise`\<\{ `numGames`: `bigint` ; `contractInitialized`: `boolean` ; `commonParams`: \{ `principalCost`: `bigint` ; `principalTimeConstant`: `bigint` ; `gamePaymentToken`: \`0x$\{string}\` ; `rankTokenAddress`: \`0x$\{string}\` ; `beneficiary`: \`0x$\{string}\` ; `derivedToken`: \`0x$\{string}\` ; `minimumParticipantsInCircle`: `bigint` ; `proposalIntegrityVerifier`: \`0x$\{string}\` ; `poseidon5`: \`0x$\{string}\` ; `poseidon2`: \`0x$\{string}\`  }  }\>
+
+InstanceState object (maintains backward compatibility)
 
 #### Inherited from
 
@@ -451,7 +461,7 @@ ___
 
 ### getProposalScoresList
 
-▸ **getProposalScoresList**(`gameId`): `Promise`\<\{ `id`: `string` ; `proposalHash`: `string` ; `proposal`: `string` ; `blockTimestamp`: `string` ; `srcAddress`: `string` ; `gameId`: `bigint` ; `turn`: `bigint` ; `roundNumber`: `bigint` ; `score`: `bigint` ; `blockNumber`: `bigint` ; `contractAddress`: \`0x$\{string}\`  }[]\>
+▸ **getProposalScoresList**(`gameId`): `Promise`\<\{ `id`: `string` ; `proposalHash`: `string` ; `proposal`: `string` ; `blockTimestamp`: `string` ; `srcAddress`: `string` ; `gameId`: `bigint` ; `turn`: `bigint` ; `roundNumber`: `bigint` ; `score`: `bigint` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId; `contractAddress`: \`0x$\{string}\`  }[]\>
 
 Retrieves the list of proposal scores for a specific game.
 
@@ -463,7 +473,7 @@ Retrieves the list of proposal scores for a specific game.
 
 #### Returns
 
-`Promise`\<\{ `id`: `string` ; `proposalHash`: `string` ; `proposal`: `string` ; `blockTimestamp`: `string` ; `srcAddress`: `string` ; `gameId`: `bigint` ; `turn`: `bigint` ; `roundNumber`: `bigint` ; `score`: `bigint` ; `blockNumber`: `bigint` ; `contractAddress`: \`0x$\{string}\`  }[]\>
+`Promise`\<\{ `id`: `string` ; `proposalHash`: `string` ; `proposal`: `string` ; `blockTimestamp`: `string` ; `srcAddress`: `string` ; `gameId`: `bigint` ; `turn`: `bigint` ; `roundNumber`: `bigint` ; `score`: `bigint` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId; `contractAddress`: \`0x$\{string}\`  }[]\>
 
 A Promise that resolves to the list of proposal scores.
 
@@ -541,6 +551,26 @@ ___
 
 ___
 
+### isWhitelistedGM
+
+▸ **isWhitelistedGM**(`address`): `Promise`\<`boolean`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `address` | \`0x$\{string}\` |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[isWhitelistedGM](InstanceBase.md#iswhitelistedgm)
+
+___
+
 ### getGameStateDetails
 
 ▸ **getGameStateDetails**(`gameId`): `Promise`\<`GameState`\>
@@ -743,6 +773,181 @@ ___
 
 ___
 
+### getProposalGameScore
+
+▸ **getProposalGameScore**(`gameId`, `proposalHash`): `Promise`\<`bigint`\>
+
+Get the score of a proposal in a specific game
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `gameId` | `bigint` | The ID of the game |
+| `proposalHash` | \`0x$\{string}\` | The hash of the proposal |
+
+#### Returns
+
+`Promise`\<`bigint`\>
+
+The score of the proposal
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getProposalGameScore](InstanceBase.md#getproposalgamescore)
+
+___
+
+### getProposalTurnScore
+
+▸ **getProposalTurnScore**(`gameId`, `turn`, `proposalHash`): `Promise`\<\{ `score`: `bigint` ; `proposedBy`: readonly \`0x$\{string}\`[]  }\>
+
+Get the score of a proposal in a specific turn
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `gameId` | `bigint` | The ID of the game |
+| `turn` | `bigint` | The turn number |
+| `proposalHash` | \`0x$\{string}\` | The hash of the proposal |
+
+#### Returns
+
+`Promise`\<\{ `score`: `bigint` ; `proposedBy`: readonly \`0x$\{string}\`[]  }\>
+
+Object with score and proposedBy array
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getProposalTurnScore](InstanceBase.md#getproposalturnscore)
+
+___
+
+### getProposalsTurnScores
+
+▸ **getProposalsTurnScores**(`gameId`, `turn`): `Promise`\<\{ `proposalHashes`: readonly \`0x$\{string}\`[] ; `scores`: readonly `bigint`[] ; `proposedBy`: readonly readonly \`0x$\{string}\`[][]  }\>
+
+Get the scores of all proposals in a specific turn
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `gameId` | `bigint` | The ID of the game |
+| `turn` | `bigint` | The turn number |
+
+#### Returns
+
+`Promise`\<\{ `proposalHashes`: readonly \`0x$\{string}\`[] ; `scores`: readonly `bigint`[] ; `proposedBy`: readonly readonly \`0x$\{string}\`[][]  }\>
+
+Object with proposalHashes, scores, and proposedBy arrays
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getProposalsTurnScores](InstanceBase.md#getproposalsturnscores)
+
+___
+
+### proposalExistsInTurn
+
+▸ **proposalExistsInTurn**(`gameId`, `turn`, `proposalHash`): `Promise`\<\{ `exists`: `boolean` ; `proposedBy`: readonly \`0x$\{string}\`[]  }\>
+
+Check if a proposal exists in a specific turn
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `gameId` | `bigint` | The ID of the game |
+| `turn` | `bigint` | The turn number |
+| `proposalHash` | \`0x$\{string}\` | The hash of the proposal |
+
+#### Returns
+
+`Promise`\<\{ `exists`: `boolean` ; `proposedBy`: readonly \`0x$\{string}\`[]  }\>
+
+Object with exists boolean and proposedBy array
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[proposalExistsInTurn](InstanceBase.md#proposalexistsinturn)
+
+___
+
+### proposalExistsInGame
+
+▸ **proposalExistsInGame**(`gameId`, `proposalHash`): `Promise`\<`boolean`\>
+
+Check if a proposal exists in a specific game
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `gameId` | `bigint` | The ID of the game |
+| `proposalHash` | \`0x$\{string}\` | The hash of the proposal |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+Boolean indicating if the proposal exists
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[proposalExistsInGame](InstanceBase.md#proposalexistsingame)
+
+___
+
+### proposalExists
+
+▸ **proposalExists**(`proposalHash`): `Promise`\<`boolean`\>
+
+Check if a proposal exists in the instance
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `proposalHash` | \`0x$\{string}\` | The hash of the proposal |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+Boolean indicating if the proposal exists
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[proposalExists](InstanceBase.md#proposalexists)
+
+___
+
+### getProposalTotalScore
+
+▸ **getProposalTotalScore**(`proposalHash`): `Promise`\<`bigint`\>
+
+Get the total aggregated score of a proposal across all games
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `proposalHash` | \`0x$\{string}\` | The hash of the proposal |
+
+#### Returns
+
+`Promise`\<`bigint`\>
+
+The total score of the proposal
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getProposalTotalScore](InstanceBase.md#getproposaltotalscore)
+
+___
+
 ### approveTokensIfNeeded
 
 ▸ **approveTokensIfNeeded**(`value`, `overrideArtifact?`): `Promise`\<`void`\>
@@ -810,7 +1015,7 @@ ___
 
 ### createAndOpenGame
 
-▸ **createAndOpenGame**(`params`, `requirements`): `Promise`\<`bigint`\>
+▸ **createAndOpenGame**(`params`, `requirements`, `overrideArtifact?`): `Promise`\<`bigint`\>
 
 Create and open a game in one transaction
 
@@ -831,14 +1036,10 @@ Create and open a game in one transaction
 | `params.timeToJoin` | `bigint` | - |
 | `params.votePhaseDuration` | `bigint` | - |
 | `params.proposingPhaseDuration` | `bigint` | - |
-| `requirements` | `Object` | Game requirements |
-| `requirements.ethValues` | `Object` | - |
-| `requirements.ethValues.have` | `bigint` | - |
-| `requirements.ethValues.lock` | `bigint` | - |
-| `requirements.ethValues.burn` | `bigint` | - |
-| `requirements.ethValues.pay` | `bigint` | - |
-| `requirements.ethValues.bet` | `bigint` | - |
-| `requirements.contracts` | readonly \{ `contractAddress`: \`0x$\{string}\` ; `contractId`: `bigint` ; `contractType`: `number` ; `contractRequirement`: \{ `have`: \{ `data`: \`0x$\{string}\` ; `amount`: `bigint`  } ; `lock`: \{ `data`: \`0x$\{string}\` ; `amount`: `bigint`  } ; `burn`: \{ `data`: \`0x$\{string}\` ; `amount`: `bigint`  } ; `pay`: \{ `data`: \`0x$\{string}\` ; `amount`: `bigint`  } ; `bet`: \{ `data`: \`0x$\{string}\` ; `amount`: `bigint`  }  }  }[] | - |
+| `requirements` | [`JoinRequirementsInput`](../interfaces/JoinRequirementsInput.md) | Game requirements |
+| `overrideArtifact?` | `Object` | Optional override artifact for token approval on unsupported chains |
+| `overrideArtifact.address` | \`0x$\{string}\` | - |
+| `overrideArtifact.pathOverride` | `string` | - |
 
 #### Returns