@peeramid-labs/sdk 3.15.0 → 3.16.0

package/docs/classes/Multipass.md

@@ -18,10 +18,11 @@ Main Multipass class for handling registrations and queries
 
 - [chainId](Multipass.md#chainid)
 - [publicClient](Multipass.md#publicclient)
-- [creationBlock](Multipass.md#creationblock)
+- [envioClient](Multipass.md#envioclient)
 
 ### Methods
 
+- [getShortStringBytes32](Multipass.md#getshortstringbytes32)
 - [getRegistrarMessage](Multipass.md#getregistrarmessage)
 - [formQueryByAddress](Multipass.md#formquerybyaddress)
 - [formQueryById](Multipass.md#formquerybyid)
@@ -53,6 +54,7 @@ Creates a new Multipass instance
 | `params.chainId` | `number` | ID of the blockchain network |
 | `params.walletClient` | `Object` | Wallet client for signing transactions |
 | `params.publicClient` | `Object` | - |
+| `params.envioClient` | [`EnvioGraphQLClient`](EnvioGraphQLClient.md) | - |
 
 #### Returns
 
@@ -88,16 +90,40 @@ Public client for reading contracts
 
 ___
 
-### creationBlock
+### envioClient
 
-• **creationBlock**: `bigint`
+• **envioClient**: [`EnvioGraphQLClient`](EnvioGraphQLClient.md)
 
 #### Inherited from
 
-[MultipassBase](MultipassBase.md).[creationBlock](MultipassBase.md#creationblock)
+[MultipassBase](MultipassBase.md).[envioClient](MultipassBase.md#envioclient)
 
 ## Methods
 
+### getShortStringBytes32
+
+▸ **getShortStringBytes32**(`text`): \`0x$\{string}\`
+
+Convert a string to bytes32 format with length encoded in the last byte (UBI format)
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `text` | `string` | The string to convert |
+
+#### Returns
+
+\`0x$\{string}\`
+
+Hex string representing the bytes32 value
+
+#### Inherited from
+
+[MultipassBase](MultipassBase.md).[getShortStringBytes32](MultipassBase.md#getshortstringbytes32)
+
+___
+
 ### getRegistrarMessage
 
 ▸ **getRegistrarMessage**(`«destructured»`): [`RegisterMessage`](../interfaces/RegisterMessage.md)
@@ -136,6 +162,7 @@ Creates a name query by address
 | `params.address` | `string` | Address to be encoded in the query |
 | `params.domainName` | `string` | Domain name to be encoded in the query |
 | `params.targetDomain?` | `string` | Target domain to be encoded in the query |
+| `params.useBytes32?` | `boolean` | - |
 
 #### Returns
 

package/docs/classes/MultipassBase.md

@@ -18,11 +18,12 @@ Base class for Multipass functionality
 
 - [chainId](MultipassBase.md#chainid)
 - [publicClient](MultipassBase.md#publicclient)
-- [creationBlock](MultipassBase.md#creationblock)
+- [envioClient](MultipassBase.md#envioclient)
 
 ### Methods
 
 - [getDappURL](MultipassBase.md#getdappurl)
+- [getShortStringBytes32](MultipassBase.md#getshortstringbytes32)
 - [getRegistrarMessage](MultipassBase.md#getregistrarmessage)
 - [formQueryByAddress](MultipassBase.md#formquerybyaddress)
 - [formQueryById](MultipassBase.md#formquerybyid)
@@ -51,6 +52,7 @@ Creates a new MultipassBase instance
 | `params` | `Object` | Constructor parameters |
 | `params.chainId` | `number` | ID of the blockchain network |
 | `params.publicClient` | `Object` | Public client for reading contracts |
+| `params.envioClient` | [`EnvioGraphQLClient`](EnvioGraphQLClient.md) | Envio GraphQL client for querying data |
 
 #### Returns
 
@@ -74,9 +76,9 @@ Public client for reading contracts
 
 ___
 
-### creationBlock
+### envioClient
 
-• **creationBlock**: `bigint`
+• **envioClient**: [`EnvioGraphQLClient`](EnvioGraphQLClient.md)
 
 ## Methods
 
@@ -103,6 +105,26 @@ The generated URL
 
 ___
 
+### getShortStringBytes32
+
+▸ **getShortStringBytes32**(`text`): \`0x$\{string}\`
+
+Convert a string to bytes32 format with length encoded in the last byte (UBI format)
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `text` | `string` | The string to convert |
+
+#### Returns
+
+\`0x$\{string}\`
+
+Hex string representing the bytes32 value
+
+___
+
 ### getRegistrarMessage
 
 ▸ **getRegistrarMessage**(`«destructured»`): [`RegisterMessage`](../interfaces/RegisterMessage.md)
@@ -137,6 +159,7 @@ Creates a name query by address
 | `params.address` | `string` | Address to be encoded in the query |
 | `params.domainName` | `string` | Domain name to be encoded in the query |
 | `params.targetDomain?` | `string` | Target domain to be encoded in the query |
+| `params.useBytes32?` | `boolean` | - |
 
 #### Returns
 

package/docs/docs/classes/EnvioGraphQLClient.md

@@ -27,6 +27,24 @@ Client for interacting with Envio GraphQL API to retrieve indexed blockchain eve
 - [getMAOInstances](EnvioGraphQLClient.md#getmaoinstances)
 - [getProposingStageEndedEvents](EnvioGraphQLClient.md#getproposingstageendedevents)
 - [getVotingStageResults](EnvioGraphQLClient.md#getvotingstageresults)
+- [getMultipassDomainActivatedEvents](EnvioGraphQLClient.md#getmultipassdomainactivatedevents)
+- [getMultipassDomainDeactivatedEvents](EnvioGraphQLClient.md#getmultipassdomaindeactivatedevents)
+- [getMultipassDomainFeeChangedEvents](EnvioGraphQLClient.md#getmultipassdomainfeechangedevents)
+- [getMultipassInitializedDomainEvents](EnvioGraphQLClient.md#getmultipassinitializeddomainevents)
+- [getMultipassOwnershipTransferredEvents](EnvioGraphQLClient.md#getmultipassownershiptransferredevents)
+- [getMultipassReferralProgramChangedEvents](EnvioGraphQLClient.md#getmultipassreferralprogramchangedevents)
+- [getMultipassRegisteredEvents](EnvioGraphQLClient.md#getmultipassregisteredevents)
+- [getMultipassRegistrarChangedEvents](EnvioGraphQLClient.md#getmultipassregistrarchangedevents)
+- [getMultipassRenewalFeeChangedEvents](EnvioGraphQLClient.md#getmultipassrenewalfeechangedevents)
+- [getMultipassRenewedEvents](EnvioGraphQLClient.md#getmultipassrenewedevents)
+- [getMultipassFundsWithdrawnEvents](EnvioGraphQLClient.md#getmultipassfundswithdrawnevents)
+- [getMultipassNameDeletedEvents](EnvioGraphQLClient.md#getmultipassnamedeletedevents)
+- [getUBIProposingByAddressEvents](EnvioGraphQLClient.md#getubiproposingbyaddressevents)
+- [getUBIProposalScoreUpdatedByProposalEvents](EnvioGraphQLClient.md#getubiproposalscoreupdatedbyproposalevents)
+- [getUBIVotingByAddressEvents](EnvioGraphQLClient.md#getubivotingbyaddressevents)
+- [getUBIClaimedEvents](EnvioGraphQLClient.md#getubiclaimedevents)
+- [getUBIRepostByReposterEvents](EnvioGraphQLClient.md#getubirepostbyreposterevents)
+- [getUBIProposalLifetimeScoreEvents](EnvioGraphQLClient.md#getubiproposallifetimescoreevents)
 
 ## Constructors
 
@@ -325,3 +343,353 @@ ___
 #### Returns
 
 `Promise`\<\{ `id`: `string` ; `isActive`: `boolean`[] ; `gameId`: `bigint` ; `roundNumber`: `bigint` ; `winner`: \`0x$\{string}\` ; `players`: \`0x$\{string}\`[] ; `scores`: `bigint`[] ; `votesSorted`: `bigint`[][] ; `finalizedVotingMatrix`: `bigint`[][] ; `permutation`: `bigint`[] ; `blockNumber`: `bigint` ; `blockTimestamp`: `number` ; `chainId`: `number` = event.chainId; `srcAddress`: \`0x$\{string}\`  }[]\>
+
+___
+
+### getMultipassDomainActivatedEvents
+
+▸ **getMultipassDomainActivatedEvents**(`params`): `Promise`\<\{ `id`: `string` ; `domainName`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `blockNumber`: `bigint`  }[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `Object` |
+| `params.domainName?` | `string` |
+
+#### Returns
+
+`Promise`\<\{ `id`: `string` ; `domainName`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `blockNumber`: `bigint`  }[]\>
+
+___
+
+### getMultipassDomainDeactivatedEvents
+
+▸ **getMultipassDomainDeactivatedEvents**(`params`): `Promise`\<\{ `id`: `string` ; `domainName`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `blockNumber`: `bigint`  }[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `Object` |
+| `params.domainName?` | `string` |
+
+#### Returns
+
+`Promise`\<\{ `id`: `string` ; `domainName`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `blockNumber`: `bigint`  }[]\>
+
+___
+
+### getMultipassDomainFeeChangedEvents
+
+▸ **getMultipassDomainFeeChangedEvents**(`params`): `Promise`\<\{ `id`: `string` ; `domainName`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `blockNumber`: `bigint` ; `newFee`: `bigint`  }[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `Object` |
+| `params.domainName?` | `string` |
+| `params.newFee?` | `bigint` |
+
+#### Returns
+
+`Promise`\<\{ `id`: `string` ; `domainName`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `blockNumber`: `bigint` ; `newFee`: `bigint`  }[]\>
+
+___
+
+### getMultipassInitializedDomainEvents
+
+▸ **getMultipassInitializedDomainEvents**(`params`): `Promise`\<\{ `id`: `string` ; `domainName`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `registrar`: \`0x$\{string}\` ; `fee`: `bigint` ; `renewalFee`: `bigint` ; `referrerReward`: `bigint` ; `referralDiscount`: `bigint` ; `blockNumber`: `bigint`  }[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `Object` |
+| `params.domainName?` | `string` |
+| `params.registrar?` | \`0x$\{string}\` |
+
+#### Returns
+
+`Promise`\<\{ `id`: `string` ; `domainName`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `registrar`: \`0x$\{string}\` ; `fee`: `bigint` ; `renewalFee`: `bigint` ; `referrerReward`: `bigint` ; `referralDiscount`: `bigint` ; `blockNumber`: `bigint`  }[]\>
+
+___
+
+### getMultipassOwnershipTransferredEvents
+
+▸ **getMultipassOwnershipTransferredEvents**(`params`): `Promise`\<\{ `id`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `previousOwner`: \`0x$\{string}\` ; `newOwner`: \`0x$\{string}\` ; `blockNumber`: `bigint`  }[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `Object` |
+| `params.previousOwner?` | \`0x$\{string}\` |
+| `params.newOwner?` | \`0x$\{string}\` |
+
+#### Returns
+
+`Promise`\<\{ `id`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `previousOwner`: \`0x$\{string}\` ; `newOwner`: \`0x$\{string}\` ; `blockNumber`: `bigint`  }[]\>
+
+___
+
+### getMultipassReferralProgramChangedEvents
+
+▸ **getMultipassReferralProgramChangedEvents**(`params`): `Promise`\<\{ `id`: `string` ; `domainName`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `reward`: `bigint` ; `discount`: `bigint` ; `blockNumber`: `bigint`  }[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `Object` |
+| `params.domainName?` | `string` |
+
+#### Returns
+
+`Promise`\<\{ `id`: `string` ; `domainName`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `reward`: `bigint` ; `discount`: `bigint` ; `blockNumber`: `bigint`  }[]\>
+
+___
+
+### getMultipassRegisteredEvents
+
+▸ **getMultipassRegisteredEvents**(`params`): `Promise`\<\{ `id`: `string` ; `domainName`: `string` ; `userId`: `string` ; `name`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `wallet`: \`0x$\{string}\` ; `nonce`: `bigint` ; `validUntil`: `bigint` ; `blockNumber`: `bigint`  }[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `Object` |
+| `params.domainName?` | `string` |
+| `params.wallet?` | \`0x$\{string}\` |
+| `params.userId?` | `string` |
+
+#### Returns
+
+`Promise`\<\{ `id`: `string` ; `domainName`: `string` ; `userId`: `string` ; `name`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `wallet`: \`0x$\{string}\` ; `nonce`: `bigint` ; `validUntil`: `bigint` ; `blockNumber`: `bigint`  }[]\>
+
+___
+
+### getMultipassRegistrarChangedEvents
+
+▸ **getMultipassRegistrarChangedEvents**(`params`): `Promise`\<\{ `id`: `string` ; `domainName`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `registrar`: \`0x$\{string}\` ; `blockNumber`: `bigint`  }[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `Object` |
+| `params.domainName?` | `string` |
+| `params.registrar?` | \`0x$\{string}\` |
+
+#### Returns
+
+`Promise`\<\{ `id`: `string` ; `domainName`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `registrar`: \`0x$\{string}\` ; `blockNumber`: `bigint`  }[]\>
+
+___
+
+### getMultipassRenewalFeeChangedEvents
+
+▸ **getMultipassRenewalFeeChangedEvents**(`params`): `Promise`\<\{ `id`: `string` ; `domainName`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `newFee`: `bigint` ; `blockNumber`: `bigint`  }[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `Object` |
+| `params.domainName?` | `string` |
+| `params.newFee?` | `bigint` |
+
+#### Returns
+
+`Promise`\<\{ `id`: `string` ; `domainName`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `newFee`: `bigint` ; `blockNumber`: `bigint`  }[]\>
+
+___
+
+### getMultipassRenewedEvents
+
+▸ **getMultipassRenewedEvents**(`params`): `Promise`\<\{ `id`: `string` ; `domainName`: `string` ; `userId`: `string` ; `name`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `wallet`: \`0x$\{string}\` ; `nonce`: `bigint` ; `validUntil`: `bigint` ; `blockNumber`: `bigint`  }[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `Object` |
+| `params.domainName?` | `string` |
+| `params.wallet?` | \`0x$\{string}\` |
+| `params.userId?` | `string` |
+
+#### Returns
+
+`Promise`\<\{ `id`: `string` ; `domainName`: `string` ; `userId`: `string` ; `name`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `wallet`: \`0x$\{string}\` ; `nonce`: `bigint` ; `validUntil`: `bigint` ; `blockNumber`: `bigint`  }[]\>
+
+___
+
+### getMultipassFundsWithdrawnEvents
+
+▸ **getMultipassFundsWithdrawnEvents**(`params`): `Promise`\<\{ `id`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `account`: \`0x$\{string}\` ; `amount`: `bigint` ; `blockNumber`: `bigint`  }[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `Object` |
+| `params.account?` | \`0x$\{string}\` |
+
+#### Returns
+
+`Promise`\<\{ `id`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `account`: \`0x$\{string}\` ; `amount`: `bigint` ; `blockNumber`: `bigint`  }[]\>
+
+___
+
+### getMultipassNameDeletedEvents
+
+▸ **getMultipassNameDeletedEvents**(`params`): `Promise`\<\{ `id`: `string` ; `domainName`: `string` ; `userId`: `string` ; `name`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `wallet`: \`0x$\{string}\` ; `blockNumber`: `bigint`  }[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `Object` |
+| `params.domainName?` | `string` |
+| `params.wallet?` | \`0x$\{string}\` |
+| `params.userId?` | `string` |
+
+#### Returns
+
+`Promise`\<\{ `id`: `string` ; `domainName`: `string` ; `userId`: `string` ; `name`: `string` ; `blockTimestamp`: `string` ; `chainId`: `number` ; `hash`: `string` ; `wallet`: \`0x$\{string}\` ; `blockNumber`: `bigint`  }[]\>
+
+___
+
+### getUBIProposingByAddressEvents
+
+▸ **getUBIProposingByAddressEvents**(`«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 }[]\>
+
+Get UBI proposal events by proposer
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `«destructured»` | `Object` | `undefined` |
+| › `instanceAddress` | \`0x$\{string}\` | `undefined` |
+| › `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 }[]\>
+
+___
+
+### getUBIProposalScoreUpdatedByProposalEvents
+
+▸ **getUBIProposalScoreUpdatedByProposalEvents**(`«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 }[]\>
+
+Get UBI proposal score updates by proposal hash
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `«destructured»` | `Object` | `undefined` |
+| › `instanceAddress` | \`0x$\{string}\` | `undefined` |
+| › `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 }[]\>
+
+___
+
+### getUBIVotingByAddressEvents
+
+▸ **getUBIVotingByAddressEvents**(`«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 }[]\>
+
+Get UBI voting events by address
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `«destructured»` | `Object` | `undefined` |
+| › `instanceAddress` | \`0x$\{string}\` | `undefined` |
+| › `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 }[]\>
+
+___
+
+### getUBIClaimedEvents
+
+▸ **getUBIClaimedEvents**(`«destructured»`): `Promise`\<\{ `id`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `user`: \`0x$\{string}\` ; `amount`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[]\>
+
+Get UBI claimed events
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `«destructured»` | `Object` | `undefined` |
+| › `instanceAddress` | \`0x$\{string}\` | `undefined` |
+| › `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 }[]\>
+
+___
+
+### getUBIRepostByReposterEvents
+
+▸ **getUBIRepostByReposterEvents**(`«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 }[]\>
+
+Get UBI repost events by reposter
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `«destructured»` | `Object` | `undefined` |
+| › `instanceAddress` | \`0x$\{string}\` | `undefined` |
+| › `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 }[]\>
+
+___
+
+### getUBIProposalLifetimeScoreEvents
+
+▸ **getUBIProposalLifetimeScoreEvents**(`«destructured»`): `Promise`\<\{ `id`: `string` ; `blockTimestamp`: `string` ; `hash`: `string` ; `lifeTimeScore`: `bigint` ; `proposedTimes`: `bigint` ; `repostedTimes`: `bigint` ; `instanceAddress`: \`0x$\{string}\` ; `blockNumber`: `bigint` ; `chainId`: `number` = event.chainId }[]\>
+
+Get UBI proposal lifetime score
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `«destructured»` | `Object` | `undefined` |
+| › `instanceAddress` | \`0x$\{string}\` | `undefined` |
+| › `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 }[]\>

package/docs/docs/classes/GameMaster.md

@@ -30,6 +30,7 @@ Extends InstanceBase to provide game master specific functionality
 - [validateJoinGame](GameMaster.md#validatejoingame)
 - [signJoiningGame](GameMaster.md#signjoininggame)
 - [submitVote](GameMaster.md#submitvote)
+- [getGameState](GameMaster.md#getgamestate)
 - [proposalValues](GameMaster.md#proposalvalues)
 - [encryptProposal](GameMaster.md#encryptproposal)
 - [attestProposal](GameMaster.md#attestproposal)
@@ -395,6 +396,24 @@ Transaction hash
 
 ___
 
+### getGameState
+
+▸ **getGameState**(`«destructured»`): `Promise`\<`GameState`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `gameId` | `bigint` |
+| › `instanceAddress` | \`0x$\{string}\` |
+
+#### Returns
+
+`Promise`\<`GameState`\>
+
+___
+
 ### proposalValues
 
 ▸ **proposalValues**(`«destructured»`): `Promise`\<\{ `proposalValue`: `bigint` ; `randomnessValue`: `bigint` ; `proposal`: `string`  }\>

package/docs/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)
@@ -433,6 +436,22 @@ ___
 
 ___
 
+### isWhitelistedGM
+
+▸ **isWhitelistedGM**(`address`): `Promise`\<`boolean`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `address` | \`0x$\{string}\` |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+___
+
 ### getGameStateDetails
 
 ▸ **getGameStateDetails**(`gameId`): `Promise`\<`GameState`\>

package/docs/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)
@@ -550,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`\>
@@ -1015,14 +1036,7 @@ 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` | - |