@peeramid-labs/sdk 3.15.0 → 3.16.0

package/docs/classes/InstanceUBI.md

@@ -0,0 +1,1591 @@
+# Class: InstanceUBI
+
+Class for interacting with UBI facet of a Rankify instance
+Extends InstanceBase and provides UBI-specific functionality
+
+## Hierarchy
+
+- [`InstanceBase`](InstanceBase.md)
+
+  ↳ **`InstanceUBI`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](InstanceUBI.md#constructor)
+
+### Properties
+
+- [publicClient](InstanceUBI.md#publicclient)
+- [chainId](InstanceUBI.md#chainid)
+- [instanceAddress](InstanceUBI.md#instanceaddress)
+- [creationBlock](InstanceUBI.md#creationblock)
+- [instanceContracts](InstanceUBI.md#instancecontracts)
+- [envioClient](InstanceUBI.md#envioclient)
+- [walletClient](InstanceUBI.md#walletclient)
+- [account](InstanceUBI.md#account)
+
+### Methods
+
+- [getHistoricTurn](InstanceUBI.md#gethistoricturn)
+- [reorganizeVotes](InstanceUBI.md#reorganizevotes)
+- [getCreationBlock](InstanceUBI.md#getcreationblock)
+- [getPreviousTurnStats](InstanceUBI.md#getpreviousturnstats)
+- [getVoting](InstanceUBI.md#getvoting)
+- [getOngoingVoting](InstanceUBI.md#getongoingvoting)
+- [getOngoingProposals](InstanceUBI.md#getongoingproposals)
+- [getRegistrationDeadline](InstanceUBI.md#getregistrationdeadline)
+- [resolveTurnDeadline](InstanceUBI.md#resolveturndeadline)
+- [getTurnDeadline](InstanceUBI.md#getturndeadline)
+- [getContractState](InstanceUBI.md#getcontractstate)
+- [getPlayersGames](InstanceUBI.md#getplayersgames)
+- [getProposalScoresList](InstanceUBI.md#getproposalscoreslist)
+- [getCurrentTurn](InstanceUBI.md#getcurrentturn)
+- [getPlayers](InstanceUBI.md#getplayers)
+- [getGameState](InstanceUBI.md#getgamestate)
+- [isWhitelistedGM](InstanceUBI.md#iswhitelistedgm)
+- [getGameStateDetails](InstanceUBI.md#getgamestatedetails)
+- [getGameStates](InstanceUBI.md#getgamestates)
+- [getEIP712Domain](InstanceUBI.md#geteip712domain)
+- [pkdf](InstanceUBI.md#pkdf)
+- [sharedSigner](InstanceUBI.md#sharedsigner)
+- [getPlayerPubKey](InstanceUBI.md#getplayerpubkey)
+- [isGameMetadata](InstanceUBI.md#isgamemetadata)
+- [isPlayerInGame](InstanceUBI.md#isplayeringame)
+- [getGameMetadata](InstanceUBI.md#getgamemetadata)
+- [getProposalGameScore](InstanceUBI.md#getproposalgamescore)
+- [getProposalTurnScore](InstanceUBI.md#getproposalturnscore)
+- [getProposalsTurnScores](InstanceUBI.md#getproposalsturnscores)
+- [proposalExistsInTurn](InstanceUBI.md#proposalexistsinturn)
+- [proposalExistsInGame](InstanceUBI.md#proposalexistsingame)
+- [proposalExists](InstanceUBI.md#proposalexists)
+- [getProposalTotalScore](InstanceUBI.md#getproposaltotalscore)
+- [getCurrentDay](InstanceUBI.md#getcurrentday)
+- [currentDay](InstanceUBI.md#currentday)
+- [getUBIParams](InstanceUBI.md#getubiparams)
+- [getProposalLifetimeStats](InstanceUBI.md#getproposallifetimestats)
+- [getProposalDailyScore](InstanceUBI.md#getproposaldailyscore)
+- [getProposalsCnt](InstanceUBI.md#getproposalscnt)
+- [getLastClaimedAt](InstanceUBI.md#getlastclaimedat)
+- [getUserState](InstanceUBI.md#getuserstate)
+- [getPauser](InstanceUBI.md#getpauser)
+- [getMultipass](InstanceUBI.md#getmultipass)
+- [getToken](InstanceUBI.md#gettoken)
+- [isPaused](InstanceUBI.md#ispaused)
+- [getUserInfo](InstanceUBI.md#getuserinfo)
+- [getProposalInfo](InstanceUBI.md#getproposalinfo)
+- [getDayProposals](InstanceUBI.md#getdayproposals)
+- [claim](InstanceUBI.md#claim)
+- [support](InstanceUBI.md#support)
+- [pause](InstanceUBI.md#pause)
+- [unpause](InstanceUBI.md#unpause)
+- [getProposalsByAddress](InstanceUBI.md#getproposalsbyaddress)
+- [getDailyProposals](InstanceUBI.md#getdailyproposals)
+- [getProposalScoreHistory](InstanceUBI.md#getproposalscorehistory)
+- [getVotesByAddress](InstanceUBI.md#getvotesbyaddress)
+- [getDailyVotes](InstanceUBI.md#getdailyvotes)
+- [getClaimHistory](InstanceUBI.md#getclaimhistory)
+- [getRepostsByAddress](InstanceUBI.md#getrepostsbyaddress)
+- [getProposalLifetimeScores](InstanceUBI.md#getproposallifetimescores)
+- [getDayActivity](InstanceUBI.md#getdayactivity)
+- [getUserActivity](InstanceUBI.md#getuseractivity)
+- [getProposalScores](InstanceUBI.md#getproposalscores)
+- [getProposalScore](InstanceUBI.md#getproposalscore)
+
+## Constructors
+
+### constructor
+
+• **new InstanceUBI**(`params`): [`InstanceUBI`](InstanceUBI.md)
+
+Creates a new InstanceUBI
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `params` | `Object` | Constructor parameters |
+| `params.publicClient` | `Object` | Public client for blockchain interactions |
+| `params.walletClient?` | `Object` | Optional wallet client for write operations |
+| `params.chainId` | `number` | Chain ID of the network |
+| `params.instanceAddress` | \`0x$\{string}\` | Address of the Rankify instance with UBI facet |
+| `params.account?` | \`0x$\{string}\` | Optional account address for write operations |
+| `params.envioClient` | [`EnvioGraphQLClient`](EnvioGraphQLClient.md) | Envio GraphQL client for event queries |
+
+#### Returns
+
+[`InstanceUBI`](InstanceUBI.md)
+
+#### Overrides
+
+[InstanceBase](InstanceBase.md).[constructor](InstanceBase.md#constructor)
+
+## Properties
+
+### publicClient
+
+• **publicClient**: `Object`
+
+Public client for blockchain interactions
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[publicClient](InstanceBase.md#publicclient)
+
+___
+
+### chainId
+
+• **chainId**: `number`
+
+Chain ID of the network
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[chainId](InstanceBase.md#chainid)
+
+___
+
+### instanceAddress
+
+• **instanceAddress**: \`0x$\{string}\`
+
+Address of the Rankify instance contract
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[instanceAddress](InstanceBase.md#instanceaddress)
+
+___
+
+### creationBlock
+
+• **creationBlock**: `bigint`
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[creationBlock](InstanceBase.md#creationblock)
+
+___
+
+### instanceContracts
+
+• `Optional` **instanceContracts**: [`MAOInstanceContracts`](../interfaces/MAOInstanceContracts.md)
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[instanceContracts](InstanceBase.md#instancecontracts)
+
+___
+
+### envioClient
+
+• **envioClient**: [`EnvioGraphQLClient`](EnvioGraphQLClient.md)
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[envioClient](InstanceBase.md#envioclient)
+
+___
+
+### walletClient
+
+• `Optional` **walletClient**: `Object`
+
+Wallet client for write operations (optional)
+
+___
+
+### account
+
+• `Optional` **account**: \`0x$\{string}\`
+
+Account address for write operations
+
+## Methods
+
+### getHistoricTurn
+
+▸ **getHistoricTurn**(`gameId`, `turnId`): `Promise`\<\{ `player`: `string` ; `proposal`: `string` ; `votes`: `number` ; `score`: `number` ; `scoreList`: \{ `player`: \`0x$\{string}\` = p; `score`: `number`  }[] ; `blockTimestamp`: `bigint`  }[]\>
+
+Retrieves the historic turn information for a specific game and turn ID.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `gameId` | `bigint` |
+| `turnId` | `bigint` |
+
+#### Returns
+
+`Promise`\<\{ `player`: `string` ; `proposal`: `string` ; `votes`: `number` ; `score`: `number` ; `scoreList`: \{ `player`: \`0x$\{string}\` = p; `score`: `number`  }[] ; `blockTimestamp`: `bigint`  }[]\>
+
+The historic turn event object.
+
+**`Throws`**
+
+If the game or turn is not found.
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getHistoricTurn](InstanceBase.md#gethistoricturn)
+
+___
+
+### reorganizeVotes
+
+▸ **reorganizeVotes**(`votes`, `proposerIndices`): `bigint`[][]
+
+Reorganizes votes array based on proposerIndices mapping
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `votes` | readonly readonly `bigint`[][] | Array of votes for each player |
+| `proposerIndices` | readonly `bigint`[] | Array of indices mapping shuffled order to original order |
+
+#### Returns
+
+`bigint`[][]
+
+Reorganized votes array
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[reorganizeVotes](InstanceBase.md#reorganizevotes)
+
+___
+
+### getCreationBlock
+
+▸ **getCreationBlock**(): `Promise`\<`bigint`\>
+
+#### Returns
+
+`Promise`\<`bigint`\>
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getCreationBlock](InstanceBase.md#getcreationblock)
+
+___
+
+### getPreviousTurnStats
+
+▸ **getPreviousTurnStats**(`gameId`): `Promise`\<\{ `player`: `string` ; `proposal`: `string` ; `votes`: `number` ; `score`: `number` ; `scoreList`: \{ `player`: \`0x$\{string}\` = p; `score`: `number`  }[] ; `blockTimestamp`: `bigint`  }[] \| \{ `players`: `string` = "N/A"; `scores`: `string` = "N/A"; `turnSalt`: `string` = "N/A"; `voters`: `string`[] ; `votesRevealed`: `string`[]  }\>
+
+Retrieves the previous turn information for a specific game.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `gameId` | `bigint` | The ID of the game. |
+
+#### Returns
+
+`Promise`\<\{ `player`: `string` ; `proposal`: `string` ; `votes`: `number` ; `score`: `number` ; `scoreList`: \{ `player`: \`0x$\{string}\` = p; `score`: `number`  }[] ; `blockTimestamp`: `bigint`  }[] \| \{ `players`: `string` = "N/A"; `scores`: `string` = "N/A"; `turnSalt`: `string` = "N/A"; `voters`: `string`[] ; `votesRevealed`: `string`[]  }\>
+
+The previous turn information for the specified game.
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getPreviousTurnStats](InstanceBase.md#getpreviousturnstats)
+
+___
+
+### getVoting
+
+▸ **getVoting**(`gameId`, `turnId`): `Promise`\<\{ `voteEvents`: \{ `player`: \`0x$\{string}\` ; `sealedBallotId`: `string` = event.sealedBallotId; `gmSignature`: `string` = event.gmSignature; `voterSignature`: `string` = event.voterSignature; `ballotHash`: `string` = event.ballotHash }[] ; `proposalEvents`: \{ `proposer`: \`0x$\{string}\` = event.proposer; `encryptedProposal`: `string` = event.encryptedProposal; `commitment`: `bigint` = event.commitment; `gmSignature`: `string` = event.gmSignature; `proposerSignature`: `string` = event.proposerSignature }[]  }\>
+
+Retrieves the voting information for a specific game and turn.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `gameId` | `bigint` | The ID of the game. |
+| `turnId` | `bigint` | The ID of the turn. |
+
+#### Returns
+
+`Promise`\<\{ `voteEvents`: \{ `player`: \`0x$\{string}\` ; `sealedBallotId`: `string` = event.sealedBallotId; `gmSignature`: `string` = event.gmSignature; `voterSignature`: `string` = event.voterSignature; `ballotHash`: `string` = event.ballotHash }[] ; `proposalEvents`: \{ `proposer`: \`0x$\{string}\` = event.proposer; `encryptedProposal`: `string` = event.encryptedProposal; `commitment`: `bigint` = event.commitment; `gmSignature`: `string` = event.gmSignature; `proposerSignature`: `string` = event.proposerSignature }[]  }\>
+
+The voting information for the specified game and turn.
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getVoting](InstanceBase.md#getvoting)
+
+___
+
+### getOngoingVoting
+
+▸ **getOngoingVoting**(`gameId`): `Promise`\<\{ `voteEvents`: \{ `player`: \`0x$\{string}\` ; `sealedBallotId`: `string` = event.sealedBallotId; `gmSignature`: `string` = event.gmSignature; `voterSignature`: `string` = event.voterSignature; `ballotHash`: `string` = event.ballotHash }[] ; `proposalEvents`: \{ `proposer`: \`0x$\{string}\` = event.proposer; `encryptedProposal`: `string` = event.encryptedProposal; `commitment`: `bigint` = event.commitment; `gmSignature`: `string` = event.gmSignature; `proposerSignature`: `string` = event.proposerSignature }[]  }\>
+
+Retrieves the ongoing voting for a specific game.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `gameId` | `bigint` | The ID of the game. |
+
+#### Returns
+
+`Promise`\<\{ `voteEvents`: \{ `player`: \`0x$\{string}\` ; `sealedBallotId`: `string` = event.sealedBallotId; `gmSignature`: `string` = event.gmSignature; `voterSignature`: `string` = event.voterSignature; `ballotHash`: `string` = event.ballotHash }[] ; `proposalEvents`: \{ `proposer`: \`0x$\{string}\` = event.proposer; `encryptedProposal`: `string` = event.encryptedProposal; `commitment`: `bigint` = event.commitment; `gmSignature`: `string` = event.gmSignature; `proposerSignature`: `string` = event.proposerSignature }[]  }\>
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getOngoingVoting](InstanceBase.md#getongoingvoting)
+
+___
+
+### getOngoingProposals
+
+▸ **getOngoingProposals**(`gameId`): `Promise`\<\{ `currentTurn`: `bigint` ; `proposals`: `unknown`[]  }\>
+
+Retrieves the ongoing proposals for a specific game.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `gameId` | `bigint` | The ID of the game. |
+
+#### Returns
+
+`Promise`\<\{ `currentTurn`: `bigint` ; `proposals`: `unknown`[]  }\>
+
+The ongoing proposals for the specified game.
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getOngoingProposals](InstanceBase.md#getongoingproposals)
+
+___
+
+### getRegistrationDeadline
+
+▸ **getRegistrationDeadline**(`gameId`, `timeToJoin?`): `Promise`\<`undefined` \| `number`\>
+
+Retrieves the registration deadline for a specific game.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `gameId` | `bigint` | The ID of the game. |
+| `timeToJoin?` | `number` | Optional. The additional time (in seconds) to join the game. |
+
+#### Returns
+
+`Promise`\<`undefined` \| `number`\>
+
+A Promise that resolves to the registration deadline timestamp.
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getRegistrationDeadline](InstanceBase.md#getregistrationdeadline)
+
+___
+
+### resolveTurnDeadline
+
+▸ **resolveTurnDeadline**(`block`, `gameId`, `timePerTurn?`): `Promise`\<`number`\>
+
+Resolves the deadline for the current turn.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `block` | `Block` | The current block. |
+| `gameId` | `bigint` | The ID of the game. |
+| `timePerTurn?` | `number` | The time duration per turn (optional). |
+
+#### Returns
+
+`Promise`\<`number`\>
+
+The deadline for the current turn.
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[resolveTurnDeadline](InstanceBase.md#resolveturndeadline)
+
+___
+
+### getTurnDeadline
+
+▸ **getTurnDeadline**(`gameId`, `timePerTurn?`): `Promise`\<`number`\>
+
+Retrieves the deadline for the current turn in a game.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `gameId` | `bigint` | The ID of the game. |
+| `timePerTurn?` | `number` | Optional. The duration of each turn in seconds. |
+
+#### Returns
+
+`Promise`\<`number`\>
+
+A Promise that resolves to the deadline for the current turn, or 0 if the turn has not started.
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getTurnDeadline](InstanceBase.md#getturndeadline)
+
+___
+
+### getContractState
+
+▸ **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}\` ; `derivedToken`: \`0x$\{string}\` ; `minimumParticipantsInCircle`: `bigint` ; `proposalIntegrityVerifier`: \`0x$\{string}\` ; `poseidon5`: \`0x$\{string}\` ; `poseidon2`: \`0x$\{string}\`  }  }\>
+
+InstanceState object (maintains backward compatibility)
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getContractState](InstanceBase.md#getcontractstate)
+
+___
+
+### getPlayersGames
+
+▸ **getPlayersGames**(`account`): `Promise`\<readonly `bigint`[]\>
+
+Retrieves a player's game.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `account` | \`0x$\{string}\` | The player's account address. |
+
+#### Returns
+
+`Promise`\<readonly `bigint`[]\>
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getPlayersGames](InstanceBase.md#getplayersgames)
+
+___
+
+### getProposalScoresList
+
+▸ **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.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `gameId` | `bigint` | The ID of the game. |
+
+#### Returns
+
+`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.
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getProposalScoresList](InstanceBase.md#getproposalscoreslist)
+
+___
+
+### getCurrentTurn
+
+▸ **getCurrentTurn**(`gameId`): `Promise`\<`bigint`\>
+
+Retrieve s the current turn of a game.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `gameId` | `bigint` | The ID of the game. |
+
+#### Returns
+
+`Promise`\<`bigint`\>
+
+A Promise that resolves to the current turn of the game.
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getCurrentTurn](InstanceBase.md#getcurrentturn)
+
+___
+
+### getPlayers
+
+▸ **getPlayers**(`gameId`): `Promise`\<readonly \`0x$\{string}\`[]\>
+
+Retrieve s the palyers of a game.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `gameId` | `bigint` | The ID of the game. |
+
+#### Returns
+
+`Promise`\<readonly \`0x$\{string}\`[]\>
+
+A Promise that resolves to the player addresses of the game.
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getPlayers](InstanceBase.md#getplayers)
+
+___
+
+### getGameState
+
+▸ **getGameState**(`gameId`): `Promise`\<\{ `rank`: `bigint` ; `minGameTime`: `bigint` ; `createdBy`: \`0x$\{string}\` ; `numCommitments`: `bigint` ; `numVotes`: `bigint` ; `voting`: \{ `voteCredits`: `bigint` ; `maxQuadraticPoints`: `bigint` ; `minQuadraticPositions`: `bigint`  } ; `currentTurn`: `bigint` ; `turnStartedAt`: `bigint` ; `registrationOpenAt`: `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` ; `phase`: `bigint` ; `votePhaseDuration`: `bigint` ; `proposingPhaseDuration`: `bigint` ; `phaseStartedAt`: `bigint` ; `startedAt`: `bigint`  }\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `gameId` | `bigint` |
+
+#### Returns
+
+`Promise`\<\{ `rank`: `bigint` ; `minGameTime`: `bigint` ; `createdBy`: \`0x$\{string}\` ; `numCommitments`: `bigint` ; `numVotes`: `bigint` ; `voting`: \{ `voteCredits`: `bigint` ; `maxQuadraticPoints`: `bigint` ; `minQuadraticPositions`: `bigint`  } ; `currentTurn`: `bigint` ; `turnStartedAt`: `bigint` ; `registrationOpenAt`: `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` ; `phase`: `bigint` ; `votePhaseDuration`: `bigint` ; `proposingPhaseDuration`: `bigint` ; `phaseStartedAt`: `bigint` ; `startedAt`: `bigint`  }\>
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getGameState](InstanceBase.md#getgamestate)
+
+___
+
+### 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`\>
+
+Retrieves the game state for a specific game.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `gameId` | `bigint` | The ID of the game. |
+
+#### Returns
+
+`Promise`\<`GameState`\>
+
+A promise that resolves to an object containing the game state.
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getGameStateDetails](InstanceBase.md#getgamestatedetails)
+
+___
+
+### getGameStates
+
+▸ **getGameStates**(`«destructured»`): `Promise`\<\{ `items`: \{ `rank`: `bigint` ; `minGameTime`: `bigint` ; `createdBy`: \`0x$\{string}\` ; `numCommitments`: `bigint` ; `numVotes`: `bigint` ; `voting`: \{ `voteCredits`: `bigint` ; `maxQuadraticPoints`: `bigint` ; `minQuadraticPositions`: `bigint`  } ; `currentTurn`: `bigint` ; `turnStartedAt`: `bigint` ; `registrationOpenAt`: `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` ; `phase`: `bigint` ; `votePhaseDuration`: `bigint` ; `proposingPhaseDuration`: `bigint` ; `phaseStartedAt`: `bigint` ; `startedAt`: `bigint`  } & \{ `gamePhase`: [`gameStatusEnum`](../enums/gameStatusEnum.md)  }[] ; `nextPage`: `undefined` \| `number` ; `hasMore`: `boolean`  }\>
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `«destructured»` | `Object` | `undefined` |
+| › `pageParam?` | `number` | `0` |
+| › `pageSize?` | `number` | `10` |
+
+#### Returns
+
+`Promise`\<\{ `items`: \{ `rank`: `bigint` ; `minGameTime`: `bigint` ; `createdBy`: \`0x$\{string}\` ; `numCommitments`: `bigint` ; `numVotes`: `bigint` ; `voting`: \{ `voteCredits`: `bigint` ; `maxQuadraticPoints`: `bigint` ; `minQuadraticPositions`: `bigint`  } ; `currentTurn`: `bigint` ; `turnStartedAt`: `bigint` ; `registrationOpenAt`: `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` ; `phase`: `bigint` ; `votePhaseDuration`: `bigint` ; `proposingPhaseDuration`: `bigint` ; `phaseStartedAt`: `bigint` ; `startedAt`: `bigint`  } & \{ `gamePhase`: [`gameStatusEnum`](../enums/gameStatusEnum.md)  }[] ; `nextPage`: `undefined` \| `number` ; `hasMore`: `boolean`  }\>
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getGameStates](InstanceBase.md#getgamestates)
+
+___
+
+### getEIP712Domain
+
+▸ **getEIP712Domain**(): `Promise`\<\{ `domainSeparator`: \`0x$\{string}\` ; `chainId`: `bigint` ; `verifierContract`: \`0x$\{string}\` ; `hashedName`: \`0x$\{string}\` ; `hashedVersion`: \`0x$\{string}\` ; `typeHash`: \`0x$\{string}\` ; `name`: `string` ; `version`: `string`  }\>
+
+#### Returns
+
+`Promise`\<\{ `domainSeparator`: \`0x$\{string}\` ; `chainId`: `bigint` ; `verifierContract`: \`0x$\{string}\` ; `hashedName`: \`0x$\{string}\` ; `hashedVersion`: \`0x$\{string}\` ; `typeHash`: \`0x$\{string}\` ; `name`: `string` ; `version`: `string`  }\>
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getEIP712Domain](InstanceBase.md#geteip712domain)
+
+___
+
+### pkdf
+
+▸ **pkdf**(`«destructured»`): \`0x$\{string}\`
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `«destructured»` | `Object` | `undefined` |
+| › `chainId` | `number` | `undefined` |
+| › `privateKey` | \`0x$\{string}\` | `undefined` |
+| › `gameId` | `bigint` | `undefined` |
+| › `turn` | `bigint` | `undefined` |
+| › `contractAddress` | \`0x$\{string}\` | `undefined` |
+| › `scope?` | ``"default"`` \| ``"turnSalt"`` | `"default"` |
+
+#### Returns
+
+\`0x$\{string}\`
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[pkdf](InstanceBase.md#pkdf)
+
+___
+
+### sharedSigner
+
+▸ **sharedSigner**(`«destructured»`): \`0x$\{string}\`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `publicKey` | \`0x$\{string}\` |
+| › `privateKey` | \`0x$\{string}\` |
+| › `gameId` | `bigint` |
+| › `turn` | `bigint` |
+| › `contractAddress` | \`0x$\{string}\` |
+| › `chainId` | `number` |
+
+#### Returns
+
+\`0x$\{string}\`
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[sharedSigner](InstanceBase.md#sharedsigner)
+
+___
+
+### getPlayerPubKey
+
+▸ **getPlayerPubKey**(`«destructured»`): `Promise`\<\`0x$\{string}\`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `instanceAddress` | \`0x$\{string}\` |
+| › `gameId` | `bigint` |
+| › `player` | \`0x$\{string}\` |
+
+#### Returns
+
+`Promise`\<\`0x$\{string}\`\>
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getPlayerPubKey](InstanceBase.md#getplayerpubkey)
+
+___
+
+### isGameMetadata
+
+▸ **isGameMetadata**(`data`, `fellowshipMetadata`): data is GameMetadata\<FellowshipMetadata\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | `unknown` |
+| `fellowshipMetadata` | [`FellowshipMetadata`](../index.md#fellowshipmetadata) |
+
+#### Returns
+
+data is GameMetadata\<FellowshipMetadata\>
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[isGameMetadata](InstanceBase.md#isgamemetadata)
+
+___
+
+### isPlayerInGame
+
+▸ **isPlayerInGame**(`gameId`, `player`): `Promise`\<`boolean`\>
+
+Check if a player is in a specific game
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `gameId` | `bigint` | The ID of the game to check |
+| `player` | \`0x$\{string}\` | The address of the player |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+Whether the player is in the game
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[isPlayerInGame](InstanceBase.md#isplayeringame)
+
+___
+
+### getGameMetadata
+
+▸ **getGameMetadata**(`ipfsGateway`, `gameId`): `Promise`\<[`GameMetadata`](../interfaces/GameMetadata.md)\<[`FellowshipMetadata`](../index.md#fellowshipmetadata)\>\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `ipfsGateway` | `string` |
+| `gameId` | `bigint` |
+
+#### Returns
+
+`Promise`\<[`GameMetadata`](../interfaces/GameMetadata.md)\<[`FellowshipMetadata`](../index.md#fellowshipmetadata)\>\>
+
+#### Inherited from
+
+[InstanceBase](InstanceBase.md).[getGameMetadata](InstanceBase.md#getgamemetadata)
+
+___
+
+### 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)
+
+___
+
+### getCurrentDay
+
+▸ **getCurrentDay**(): `Promise`\<`bigint`\>
+
+Gets the current day number based on block timestamp
+
+#### Returns
+
+`Promise`\<`bigint`\>
+
+The current day number (block.timestamp / 1 days)
+
+___
+
+### currentDay
+
+▸ **currentDay**(): `Promise`\<`bigint`\>
+
+Gets the current day number (alias for getCurrentDay)
+
+#### Returns
+
+`Promise`\<`bigint`\>
+
+The current day number
+
+___
+
+### getUBIParams
+
+▸ **getUBIParams**(): `Promise`\<[`UBIParams`](../interfaces/UBIParams.md)\>
+
+Gets the UBI system parameters
+
+#### Returns
+
+`Promise`\<[`UBIParams`](../interfaces/UBIParams.md)\>
+
+Object containing dailyClaimAmount, dailySupportAmount, and domainName
+
+___
+
+### getProposalLifetimeStats
+
+▸ **getProposalLifetimeStats**(`proposalHash`): `Promise`\<[`ProposalGlobalStats`](../interfaces/ProposalGlobalStats.md)\>
+
+Gets the lifetime statistics for a proposal
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `proposalHash` | \`0x$\{string}\` | The hash of the proposal |
+
+#### Returns
+
+`Promise`\<[`ProposalGlobalStats`](../interfaces/ProposalGlobalStats.md)\>
+
+Object containing aggregateScore, proposedTimes, and repostedTimes
+
+___
+
+### getProposalDailyScore
+
+▸ **getProposalDailyScore**(`proposalHash`, `day`): `Promise`\<[`DailyProposal`](../interfaces/DailyProposal.md)\>
+
+Gets the daily score for a proposal on a specific day
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `proposalHash` | \`0x$\{string}\` | The hash of the proposal |
+| `day` | `bigint` | The day number to query |
+
+#### Returns
+
+`Promise`\<[`DailyProposal`](../interfaces/DailyProposal.md)\>
+
+DailyProposal object with proposal details for that day
+
+___
+
+### getProposalsCnt
+
+▸ **getProposalsCnt**(`day`): `Promise`\<`bigint`\>
+
+Gets the total number of proposals for a specific day
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `day` | `bigint` | The day number to query |
+
+#### Returns
+
+`Promise`\<`bigint`\>
+
+The count of proposals for that day
+
+___
+
+### getLastClaimedAt
+
+▸ **getLastClaimedAt**(`user`): `Promise`\<`bigint`\>
+
+Gets the day a user last claimed their tokens
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `user` | \`0x$\{string}\` | The address of the user |
+
+#### Returns
+
+`Promise`\<`bigint`\>
+
+The day number of the last claim (0 if never claimed)
+
+___
+
+### getUserState
+
+▸ **getUserState**(`user`): `Promise`\<[`UserState`](../interfaces/UserState.md)\>
+
+Gets the current state for a user
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `user` | \`0x$\{string}\` | The address of the user |
+
+#### Returns
+
+`Promise`\<[`UserState`](../interfaces/UserState.md)\>
+
+Object containing claimedToday and supportSpent
+
+___
+
+### getPauser
+
+▸ **getPauser**(): `Promise`\<\`0x$\{string}\`\>
+
+Gets the address of the pauser
+
+#### Returns
+
+`Promise`\<\`0x$\{string}\`\>
+
+The address with pausing/unpausing permissions
+
+___
+
+### getMultipass
+
+▸ **getMultipass**(): `Promise`\<\`0x$\{string}\`\>
+
+Gets the Multipass contract address
+
+#### Returns
+
+`Promise`\<\`0x$\{string}\`\>
+
+The address of the Multipass contract
+
+___
+
+### getToken
+
+▸ **getToken**(): `Promise`\<\`0x$\{string}\`\>
+
+Gets the governance token contract address
+
+#### Returns
+
+`Promise`\<\`0x$\{string}\`\>
+
+The address of the DistributableGovernanceERC20 token
+
+___
+
+### isPaused
+
+▸ **isPaused**(): `Promise`\<`boolean`\>
+
+Checks if the contract is currently paused
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if paused, false otherwise
+
+___
+
+### getUserInfo
+
+▸ **getUserInfo**(`user`): `Promise`\<\{ `userState`: [`UserState`](../interfaces/UserState.md) ; `lastClaimedAt`: `bigint` ; `currentDay`: `bigint` ; `canClaim`: `boolean`  }\>
+
+Gets comprehensive information about a user's current status
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `user` | \`0x$\{string}\` | The address of the user |
+
+#### Returns
+
+`Promise`\<\{ `userState`: [`UserState`](../interfaces/UserState.md) ; `lastClaimedAt`: `bigint` ; `currentDay`: `bigint` ; `canClaim`: `boolean`  }\>
+
+Object containing user state, last claimed day, and current day
+
+___
+
+### getProposalInfo
+
+▸ **getProposalInfo**(`proposalHash`, `day?`): `Promise`\<\{ `lifetimeStats`: [`ProposalGlobalStats`](../interfaces/ProposalGlobalStats.md) ; `dailyScore`: [`DailyProposal`](../interfaces/DailyProposal.md) ; `day`: `bigint`  }\>
+
+Gets comprehensive information about a proposal
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `proposalHash` | \`0x$\{string}\` | The hash of the proposal |
+| `day?` | `bigint` | Optional day to get daily score (defaults to current day - 1) |
+
+#### Returns
+
+`Promise`\<\{ `lifetimeStats`: [`ProposalGlobalStats`](../interfaces/ProposalGlobalStats.md) ; `dailyScore`: [`DailyProposal`](../interfaces/DailyProposal.md) ; `day`: `bigint`  }\>
+
+Object containing lifetime stats and daily score
+
+___
+
+### getDayProposals
+
+▸ **getDayProposals**(`day`): `Promise`\<\{ `count`: `bigint` ; `day`: `bigint`  }\>
+
+Gets all proposals for a specific day (requires querying events or off-chain indexer)
+This is a helper method that would typically use an indexer/subgraph
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `day` | `bigint` | The day to query |
+
+#### Returns
+
+`Promise`\<\{ `count`: `bigint` ; `day`: `bigint`  }\>
+
+The count of proposals for that day
+
+___
+
+### claim
+
+▸ **claim**(`proposalText?`): `Promise`\<\`0x$\{string}\`\>
+
+Claims daily UBI tokens and optionally submits a proposal
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `proposalText` | `string` | `""` | The proposal text (empty string for no proposal) |
+
+#### Returns
+
+`Promise`\<\`0x$\{string}\`\>
+
+Transaction hash
+
+**`Throws`**
+
+Error if wallet client is not configured
+
+___
+
+### support
+
+▸ **support**(`votes`): `Promise`\<\`0x$\{string}\`\>
+
+Supports one or more proposals from the previous day using quadratic voting
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `votes` | [`VoteElement`](../interfaces/VoteElement.md)[] | Array of vote elements (proposal hash and amount) |
+
+#### Returns
+
+`Promise`\<\`0x$\{string}\`\>
+
+Transaction hash
+
+**`Throws`**
+
+Error if wallet client is not configured
+
+___
+
+### pause
+
+▸ **pause**(): `Promise`\<\`0x$\{string}\`\>
+
+Pauses the UBI contract (only callable by pauser)
+
+#### Returns
+
+`Promise`\<\`0x$\{string}\`\>
+
+Transaction hash
+
+**`Throws`**
+
+Error if wallet client is not configured or caller is not pauser
+
+___
+
+### unpause
+
+▸ **unpause**(): `Promise`\<\`0x$\{string}\`\>
+
+Unpauses the UBI contract (only callable by pauser)
+
+#### Returns
+
+`Promise`\<\`0x$\{string}\`\>
+
+Transaction hash
+
+**`Throws`**
+
+Error if wallet client is not configured or caller is not pauser
+
+___
+
+### getProposalsByAddress
+
+▸ **getProposalsByAddress**(`«destructured»?`): `Promise`\<\{ `id`: `string` ; `proposal`: `string` ; `proposalText`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `proposer`: \`0x$\{string}\` ; `day`: `bigint` ; `scoreWhenProposed`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[]\>
+
+Gets proposals submitted by a specific address
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `«destructured»` | `Object` | `{}` |
+| › `proposer?` | \`0x$\{string}\` | `undefined` |
+| › `day?` | `bigint` | `undefined` |
+| › `limit?` | `number` | `100` |
+| › `offset?` | `number` | `0` |
+
+#### Returns
+
+`Promise`\<\{ `id`: `string` ; `proposal`: `string` ; `proposalText`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `proposer`: \`0x$\{string}\` ; `day`: `bigint` ; `scoreWhenProposed`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[]\>
+
+Array of proposal events
+
+___
+
+### getDailyProposals
+
+▸ **getDailyProposals**(`«destructured»?`): `Promise`\<\{ `id`: `string` ; `proposal`: `string` ; `proposalText`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `proposer`: \`0x$\{string}\` ; `day`: `bigint` ; `scoreWhenProposed`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[]\>
+
+Gets all proposals for a specific day
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `«destructured»` | `Object` | `{}` |
+| › `day?` | `bigint` | `undefined` |
+| › `limit?` | `number` | `100` |
+| › `offset?` | `number` | `0` |
+
+#### Returns
+
+`Promise`\<\{ `id`: `string` ; `proposal`: `string` ; `proposalText`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `proposer`: \`0x$\{string}\` ; `day`: `bigint` ; `scoreWhenProposed`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[]\>
+
+Array of proposal events for the day
+
+___
+
+### getProposalScoreHistory
+
+▸ **getProposalScoreHistory**(`«destructured»?`): `Promise`\<\{ `id`: `string` ; `proposal`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `dailyScore`: `bigint` ; `day`: `bigint` ; `proposer`: \`0x$\{string}\` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[]\>
+
+Gets proposal score updates for a specific proposal
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `«destructured»` | `Object` | `{}` |
+| › `proposal?` | `string` | `undefined` |
+| › `day?` | `bigint` | `undefined` |
+| › `limit?` | `number` | `100` |
+| › `offset?` | `number` | `0` |
+
+#### Returns
+
+`Promise`\<\{ `id`: `string` ; `proposal`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `dailyScore`: `bigint` ; `day`: `bigint` ; `proposer`: \`0x$\{string}\` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[]\>
+
+Array of proposal score update events
+
+___
+
+### getVotesByAddress
+
+▸ **getVotesByAddress**(`«destructured»?`): `Promise`\<\{ `id`: `string` ; `proposal`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `participant`: \`0x$\{string}\` ; `day`: `bigint` ; `amount`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[]\>
+
+Gets voting events for a specific participant
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `«destructured»` | `Object` | `{}` |
+| › `participant?` | \`0x$\{string}\` | `undefined` |
+| › `day?` | `bigint` | `undefined` |
+| › `limit?` | `number` | `100` |
+| › `offset?` | `number` | `0` |
+
+#### Returns
+
+`Promise`\<\{ `id`: `string` ; `proposal`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `participant`: \`0x$\{string}\` ; `day`: `bigint` ; `amount`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[]\>
+
+Array of voting events
+
+___
+
+### getDailyVotes
+
+▸ **getDailyVotes**(`«destructured»?`): `Promise`\<\{ `id`: `string` ; `proposal`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `participant`: \`0x$\{string}\` ; `day`: `bigint` ; `amount`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[]\>
+
+Gets all votes for a specific day
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `«destructured»` | `Object` | `{}` |
+| › `day?` | `bigint` | `undefined` |
+| › `limit?` | `number` | `100` |
+| › `offset?` | `number` | `0` |
+
+#### Returns
+
+`Promise`\<\{ `id`: `string` ; `proposal`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `participant`: \`0x$\{string}\` ; `day`: `bigint` ; `amount`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[]\>
+
+Array of voting events for the day
+
+___
+
+### getClaimHistory
+
+▸ **getClaimHistory**(`«destructured»?`): `Promise`\<\{ `id`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `user`: \`0x$\{string}\` ; `amount`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[]\>
+
+Gets claim history
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `«destructured»` | `Object` | `{}` |
+| › `user?` | \`0x$\{string}\` | `undefined` |
+| › `limit?` | `number` | `100` |
+| › `offset?` | `number` | `0` |
+
+#### Returns
+
+`Promise`\<\{ `id`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `user`: \`0x$\{string}\` ; `amount`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[]\>
+
+Array of claim events
+
+___
+
+### getRepostsByAddress
+
+▸ **getRepostsByAddress**(`«destructured»?`): `Promise`\<\{ `id`: `string` ; `proposal`: `string` ; `proposalText`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `proposer`: \`0x$\{string}\` ; `reposter`: \`0x$\{string}\` ; `day`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[]\>
+
+Gets repost events by reposter
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `«destructured»` | `Object` | `{}` |
+| › `reposter?` | \`0x$\{string}\` | `undefined` |
+| › `day?` | `bigint` | `undefined` |
+| › `limit?` | `number` | `100` |
+| › `offset?` | `number` | `0` |
+
+#### Returns
+
+`Promise`\<\{ `id`: `string` ; `proposal`: `string` ; `proposalText`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `proposer`: \`0x$\{string}\` ; `reposter`: \`0x$\{string}\` ; `day`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[]\>
+
+Array of repost events
+
+___
+
+### getProposalLifetimeScores
+
+▸ **getProposalLifetimeScores**(`«destructured»?`): `Promise`\<\{ `id`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `lifeTimeScore`: `bigint` ; `proposedTimes`: `bigint` ; `repostedTimes`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[]\>
+
+Gets lifetime scores for all proposals
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `«destructured»` | `Object` | `{}` |
+| › `limit?` | `number` | `100` |
+| › `offset?` | `number` | `0` |
+
+#### Returns
+
+`Promise`\<\{ `id`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `lifeTimeScore`: `bigint` ; `proposedTimes`: `bigint` ; `repostedTimes`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[]\>
+
+Array of proposal lifetime score events
+
+___
+
+### getDayActivity
+
+▸ **getDayActivity**(`«destructured»?`): `Promise`\<\{ `day`: `bigint` = queryDay; `proposals`: \{ `id`: `string` ; `proposal`: `string` ; `proposalText`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `proposer`: \`0x$\{string}\` ; `day`: `bigint` ; `scoreWhenProposed`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[] ; `votes`: \{ `id`: `string` ; `proposal`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `participant`: \`0x$\{string}\` ; `day`: `bigint` ; `amount`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[] ; `reposts`: \{ `id`: `string` ; `proposal`: `string` ; `proposalText`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `proposer`: \`0x$\{string}\` ; `reposter`: \`0x$\{string}\` ; `day`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[] ; `proposalCount`: `number` = proposals.length; `voteCount`: `number` = votes.length; `repostCount`: `number` = reposts.length }\>
+
+Gets comprehensive proposal data including proposals, scores, and votes for a specific day
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `«destructured»` | `Object` | `{}` |
+| › `day?` | `bigint` | `undefined` |
+| › `limit?` | `number` | `100` |
+
+#### Returns
+
+`Promise`\<\{ `day`: `bigint` = queryDay; `proposals`: \{ `id`: `string` ; `proposal`: `string` ; `proposalText`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `proposer`: \`0x$\{string}\` ; `day`: `bigint` ; `scoreWhenProposed`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[] ; `votes`: \{ `id`: `string` ; `proposal`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `participant`: \`0x$\{string}\` ; `day`: `bigint` ; `amount`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[] ; `reposts`: \{ `id`: `string` ; `proposal`: `string` ; `proposalText`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `proposer`: \`0x$\{string}\` ; `reposter`: \`0x$\{string}\` ; `day`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[] ; `proposalCount`: `number` = proposals.length; `voteCount`: `number` = votes.length; `repostCount`: `number` = reposts.length }\>
+
+Object containing proposals, scores, and votes for the day
+
+___
+
+### getUserActivity
+
+▸ **getUserActivity**(`«destructured»`): `Promise`\<\{ `user`: \`0x$\{string}\` ; `userInfo`: \{ `userState`: [`UserState`](../interfaces/UserState.md) ; `lastClaimedAt`: `bigint` ; `currentDay`: `bigint` ; `canClaim`: `boolean`  } ; `proposals`: \{ `id`: `string` ; `proposal`: `string` ; `proposalText`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `proposer`: \`0x$\{string}\` ; `day`: `bigint` ; `scoreWhenProposed`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[] ; `votes`: \{ `id`: `string` ; `proposal`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `participant`: \`0x$\{string}\` ; `day`: `bigint` ; `amount`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[] ; `reposts`: \{ `id`: `string` ; `proposal`: `string` ; `proposalText`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `proposer`: \`0x$\{string}\` ; `reposter`: \`0x$\{string}\` ; `day`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[] ; `claims`: \{ `id`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `user`: \`0x$\{string}\` ; `amount`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[] ; `proposalCount`: `number` = proposals.length; `voteCount`: `number` = votes.length; `repostCount`: `number` = reposts.length; `claimCount`: `number` = claims.length }\>
+
+Gets comprehensive user activity data
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `«destructured»` | `Object` | `undefined` |
+| › `user` | \`0x$\{string}\` | `undefined` |
+| › `limit?` | `number` | `100` |
+
+#### Returns
+
+`Promise`\<\{ `user`: \`0x$\{string}\` ; `userInfo`: \{ `userState`: [`UserState`](../interfaces/UserState.md) ; `lastClaimedAt`: `bigint` ; `currentDay`: `bigint` ; `canClaim`: `boolean`  } ; `proposals`: \{ `id`: `string` ; `proposal`: `string` ; `proposalText`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `proposer`: \`0x$\{string}\` ; `day`: `bigint` ; `scoreWhenProposed`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[] ; `votes`: \{ `id`: `string` ; `proposal`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `participant`: \`0x$\{string}\` ; `day`: `bigint` ; `amount`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[] ; `reposts`: \{ `id`: `string` ; `proposal`: `string` ; `proposalText`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `proposer`: \`0x$\{string}\` ; `reposter`: \`0x$\{string}\` ; `day`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[] ; `claims`: \{ `id`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `user`: \`0x$\{string}\` ; `amount`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[] ; `proposalCount`: `number` = proposals.length; `voteCount`: `number` = votes.length; `repostCount`: `number` = reposts.length; `claimCount`: `number` = claims.length }\>
+
+Object containing user's proposals, votes, reposts, and claims
+
+___
+
+### getProposalScores
+
+▸ **getProposalScores**(`«destructured»?`): `Promise`\<\{ `proposal`: `string` ; `score`: `bigint` ; `stars`: `number`  }[]\>
+
+Gets aggregated proposal scores from voting events
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `«destructured»` | `Object` | `{}` |
+| › `day?` | `bigint` | `undefined` |
+| › `limit?` | `number` | `1000` |
+
+#### Returns
+
+`Promise`\<\{ `proposal`: `string` ; `score`: `bigint` ; `stars`: `number`  }[]\>
+
+Map of proposal hashes to their total support scores
+
+___
+
+### getProposalScore
+
+▸ **getProposalScore**(`proposalHash`, `day?`): `Promise`\<\{ `proposal`: \`0x$\{string}\` ; `score`: `bigint` ; `stars`: `number`  }\>
+
+Gets the score for a specific proposal
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `proposalHash` | \`0x$\{string}\` | The hash of the proposal |
+| `day?` | `bigint` | Optional day to filter votes |
+
+#### Returns
+
+`Promise`\<\{ `proposal`: \`0x$\{string}\` ; `score`: `bigint` ; `stars`: `number`  }\>
+
+Total support score for the proposal