@peeramid-labs/sdk 3.5.0 → 3.6.0

package/docs/classes/GameMaster.md

@@ -13,21 +13,26 @@ Extends InstanceBase to provide game master specific functionality
 
 - [walletClient](GameMaster.md#walletclient)
 - [publicClient](GameMaster.md#publicclient)
-- [encryptionCallback](GameMaster.md#encryptioncallback)
-- [decryptionCallback](GameMaster.md#decryptioncallback)
-- [randomnessCallback](GameMaster.md#randomnesscallback)
-- [turnSaltCallback](GameMaster.md#turnsaltcallback)
 - [chainId](GameMaster.md#chainid)
 
 ### Methods
 
+- [decryptProposal](GameMaster.md#decryptproposal)
 - [decryptProposals](GameMaster.md#decryptproposals)
-- [shuffle](GameMaster.md#shuffle)
+- [getPermutation](GameMaster.md#getpermutation)
+- [generateDeterministicPermutation](GameMaster.md#generatedeterministicpermutation)
+- [permuteArray](GameMaster.md#permutearray)
+- [reversePermutation](GameMaster.md#reversepermutation)
 - [getTurnSalt](GameMaster.md#getturnsalt)
 - [getTurnPlayersSalt](GameMaster.md#getturnplayerssalt)
+- [getProposalsVotedUpon](GameMaster.md#getproposalsvotedupon)
 - [findPlayerOngoingProposalIndex](GameMaster.md#findplayerongoingproposalindex)
+- [validateJoinGame](GameMaster.md#validatejoingame)
+- [signJoiningGame](GameMaster.md#signjoininggame)
 - [submitVote](GameMaster.md#submitvote)
-- [proposerHidden](GameMaster.md#proposerhidden)
+- [proposalValues](GameMaster.md#proposalvalues)
+- [encryptProposal](GameMaster.md#encryptproposal)
+- [attestProposal](GameMaster.md#attestproposal)
 - [submitProposal](GameMaster.md#submitproposal)
 - [decryptTurnVotes](GameMaster.md#decryptturnvotes)
 - [decryptVotes](GameMaster.md#decryptvotes)
@@ -35,6 +40,12 @@ Extends InstanceBase to provide game master specific functionality
 - [currentTurn](GameMaster.md#currentturn)
 - [getPlayers](GameMaster.md#getplayers)
 - [endTurn](GameMaster.md#endturn)
+- [gameKey](GameMaster.md#gamekey)
+- [attestVote](GameMaster.md#attestvote)
+- [signVote](GameMaster.md#signvote)
+- [generateEndTurnIntegrity](GameMaster.md#generateendturnintegrity)
+- [getProposalsIntegrity](GameMaster.md#getproposalsintegrity)
+- [createInputs](GameMaster.md#createinputs)
 
 ## Constructors
 
@@ -52,10 +63,6 @@ Creates a new GameMaster instance
 | › `walletClient` | `Object` |
 | › `publicClient` | `Object` |
 | › `chainId` | `number` |
-| › `encryptionCallback` | (`data`: `string`) => `Promise`\<`string`\> |
-| › `decryptionCallback` | (`data`: `string`) => `Promise`\<`string`\> |
-| › `randomnessCallback` | () => `Promise`\<`number`\> |
-| › `turnSaltCallback` | (`__namedParameters`: \{ `gameId`: `bigint` ; `turn`: `bigint`  }) => `Promise`\<\`0x$\{string}\`\> |
 
 #### Returns
 
@@ -75,117 +82,145 @@ ___
 
 ___
 
-### encryptionCallback
+### chainId
+
+• **chainId**: `number`
+
+## Methods
 
-• **encryptionCallback**: (`data`: `string`) => `Promise`\<`string`\>
+### decryptProposal
 
-#### Type declaration
+▸ **decryptProposal**(`«destructured»`): `Promise`\<`string`\>
 
-▸ (`data`): `Promise`\<`string`\>
+Decrypts a proposal for a specific game turn
 
-##### Parameters
+#### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `data` | `string` |
+| `«destructured»` | `Object` |
+| › `proposal` | `string` |
+| › `turn` | `bigint` |
+| › `instanceAddress` | \`0x$\{string}\` |
+| › `proposer` | \`0x$\{string}\` |
+| › `gameId` | `bigint` |
+| › `instance?` | [`InstanceBase`](InstanceBase.md) |
 
-##### Returns
+#### Returns
 
 `Promise`\<`string`\>
 
-___
+The decrypted proposal
 
-### decryptionCallback
+___
 
-• **decryptionCallback**: (`data`: `string`) => `Promise`\<`string`\>
+### decryptProposals
 
-#### Type declaration
+▸ **decryptProposals**(`«destructured»`): `Promise`\<\{ `proposer`: \`0x$\{string}\` = log.args.proposer; `proposal`: `string`  }[]\>
 
-▸ (`data`): `Promise`\<`string`\>
+Decrypts proposals for a specific game turn
 
-##### Parameters
+#### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `data` | `string` |
+| `«destructured»` | `Object` |
+| › `instanceAddress` | \`0x$\{string}\` |
+| › `gameId` | `bigint` |
+| › `turn` | `bigint` |
+| › `proposer?` | \`0x$\{string}\` |
 
-##### Returns
+#### Returns
 
-`Promise`\<`string`\>
+`Promise`\<\{ `proposer`: \`0x$\{string}\` = log.args.proposer; `proposal`: `string`  }[]\>
+
+Array of decrypted proposals with proposer addresses
 
 ___
 
-### randomnessCallback
+### getPermutation
 
-• **randomnessCallback**: () => `Promise`\<`number`\>
+▸ **getPermutation**(`«destructured»`): `Promise`\<\{ `permutation`: `number`[] ; `turnSalt`: `bigint`  }\>
 
-#### Type declaration
+Generates a deterministic permutation for a specific game turn
 
-▸ (): `Promise`\<`number`\>
+#### Parameters
 
-##### Returns
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `gameId` | `bigint` |
+| › `turn` | `bigint` |
+| › `size` | `number` |
+| › `verifierAddress` | \`0x$\{string}\` |
 
-`Promise`\<`number`\>
+#### Returns
+
+`Promise`\<\{ `permutation`: `number`[] ; `turnSalt`: `bigint`  }\>
+
+The generated permutation, secret, and commitment
 
 ___
 
-### turnSaltCallback
+### generateDeterministicPermutation
 
-• **turnSaltCallback**: (`__namedParameters`: \{ `gameId`: `bigint` ; `turn`: `bigint`  }) => `Promise`\<\`0x$\{string}\`\>
+▸ **generateDeterministicPermutation**(`«destructured»`): `Promise`\<\{ `permutation`: `number`[] ; `secret`: `bigint` ; `commitment`: `bigint`  }\>
 
-#### Type declaration
+Generates a deterministic permutation for a specific game turn
 
-▸ (`«destructured»`): `Promise`\<\`0x$\{string}\`\>
+#### Parameters
 
-##### Parameters
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `«destructured»` | `Object` | `undefined` |
+| › `gameId` | `bigint` | `undefined` |
+| › `turn` | `bigint` | `undefined` |
+| › `size?` | `number` | `15` |
+| › `verifierAddress` | \`0x$\{string}\` | `undefined` |
 
-| Name | Type |
-| :------ | :------ |
-| `«destructured»` | `Object` |
-| › `gameId` | `bigint` |
-| › `turn` | `bigint` |
+#### Returns
 
-##### Returns
+`Promise`\<\{ `permutation`: `number`[] ; `secret`: `bigint` ; `commitment`: `bigint`  }\>
 
-`Promise`\<\`0x$\{string}\`\>
+The generated permutation, secret, and commitment
 
 ___
 
-### chainId
-
-• **chainId**: `number`
+### permuteArray
 
-## Methods
+▸ **permuteArray**\<`T`\>(`«destructured»`): `Promise`\<`T`[]\>
 
-### decryptProposals
+Permutes an array based on a deterministic permutation
 
-▸ **decryptProposals**(`«destructured»`): `Promise`\<\{ `proposer`: `undefined` \| \`0x$\{string}\` = log.args.proposer; `proposal`: `string`  }[]\>
+#### Type parameters
 
-Decrypts proposals for a specific game turn
+| Name |
+| :------ |
+| `T` |
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `«destructured»` | `Object` |
-| › `instanceAddress` | \`0x$\{string}\` |
+| › `array` | `T`[] |
 | › `gameId` | `bigint` |
 | › `turn` | `bigint` |
-| › `proposer?` | \`0x$\{string}\` |
+| › `verifierAddress` | \`0x$\{string}\` |
 
 #### Returns
 
-`Promise`\<\{ `proposer`: `undefined` \| \`0x$\{string}\` = log.args.proposer; `proposal`: `string`  }[]\>
+`Promise`\<`T`[]\>
 
-Array of decrypted proposals with proposer addresses
+The permuted array
 
 ___
 
-### shuffle
+### reversePermutation
 
-▸ **shuffle**\<`T`\>(`array`): `Promise`\<`T`[]\>
+▸ **reversePermutation**\<`T`\>(`«destructured»`): `Promise`\<`T`[]\>
 
-Shuffles an array using cryptographically secure randomness
+Reverses a permutation of an array
 
 #### Type parameters
 
@@ -195,21 +230,25 @@ Shuffles an array using cryptographically secure randomness
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `array` | `T`[] | Array to shuffle |
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `permutedArray` | `T`[] |
+| › `gameId` | `bigint` |
+| › `turn` | `bigint` |
+| › `verifierAddress` | \`0x$\{string}\` |
 
 #### Returns
 
 `Promise`\<`T`[]\>
 
-Shuffled array
+The original array
 
 ___
 
 ### getTurnSalt
 
-▸ **getTurnSalt**(`«destructured»`): `Promise`\<\`0x$\{string}\`\>
+▸ **getTurnSalt**(`«destructured»`): `Promise`\<`bigint`\>
 
 Generates a salt for a specific game turn
 
@@ -220,10 +259,11 @@ Generates a salt for a specific game turn
 | `«destructured»` | `Object` |
 | › `gameId` | `bigint` |
 | › `turn` | `bigint` |
+| › `verifierAddress` | \`0x$\{string}\` |
 
 #### Returns
 
-`Promise`\<\`0x$\{string}\`\>
+`Promise`\<`bigint`\>
 
 Generated salt as Hex
 
@@ -242,7 +282,9 @@ Generates a salt for a specific player in a game turn
 | `«destructured»` | `Object` |
 | › `gameId` | `bigint` |
 | › `turn` | `bigint` |
-| › `proposer` | \`0x$\{string}\` |
+| › `player` | \`0x$\{string}\` |
+| › `verifierAddress` | \`0x$\{string}\` |
+| › `size` | `number` |
 
 #### Returns
 
@@ -252,6 +294,25 @@ Generated salt as Hex
 
 ___
 
+### getProposalsVotedUpon
+
+▸ **getProposalsVotedUpon**(`«destructured»`): `Promise`\<\{ `proposer`: \`0x$\{string}\` ; `proposal`: `string`  }[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `instanceAddress` | \`0x$\{string}\` |
+| › `gameId` | `bigint` |
+| › `turn` | `bigint` |
+
+#### Returns
+
+`Promise`\<\{ `proposer`: \`0x$\{string}\` ; `proposal`: `string`  }[]\>
+
+___
+
 ### findPlayerOngoingProposalIndex
 
 ▸ **findPlayerOngoingProposalIndex**(`«destructured»`): `Promise`\<`number`\>
@@ -266,6 +327,7 @@ Finds the index of a player's ongoing proposal
 | › `instanceAddress` | \`0x$\{string}\` |
 | › `gameId` | `bigint` |
 | › `player` | \`0x$\{string}\` |
+| › `turn?` | `bigint` |
 
 #### Returns
 
@@ -275,6 +337,46 @@ Index of the player's proposal, -1 if not found
 
 ___
 
+### validateJoinGame
+
+▸ **validateJoinGame**(`props`): `Promise`\<\{ `result`: `boolean` ; `errorMessage`: `string`  }\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `props` | `Object` |
+| `props.gameId` | `bigint` |
+| `props.participant` | \`0x$\{string}\` |
+| `props.instanceAddress` | \`0x$\{string}\` |
+
+#### Returns
+
+`Promise`\<\{ `result`: `boolean` ; `errorMessage`: `string`  }\>
+
+___
+
+### signJoiningGame
+
+▸ **signJoiningGame**(`props`, `timeToJoin?`): `Promise`\<\{ `signature`: \`0x$\{string}\` ; `gmCommitment`: \`0x$\{string}\` ; `deadline`: `bigint`  }\>
+
+Signs a joining game event
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `props` | `JoinGameProps` |
+| `timeToJoin` | `number` |
+
+#### Returns
+
+`Promise`\<\{ `signature`: \`0x$\{string}\` ; `gmCommitment`: \`0x$\{string}\` ; `deadline`: `bigint`  }\>
+
+Signature and gmCommitment
+
+___
+
 ### submitVote
 
 ▸ **submitVote**(`«destructured»`): `Promise`\<\`0x$\{string}\`\>
@@ -290,6 +392,9 @@ Submits a vote for proposals
 | › `gameId` | `bigint` |
 | › `vote` | `bigint`[] |
 | › `voter` | \`0x$\{string}\` |
+| › `voterSignature` | \`0x$\{string}\` |
+| › `ballotHash` | \`0x$\{string}\` |
+| › `ballotId` | `string` |
 
 #### Returns
 
@@ -299,26 +404,74 @@ Transaction hash
 
 ___
 
-### proposerHidden
+### proposalValues
 
-▸ **proposerHidden**(`«destructured»`): `Promise`\<\`0x$\{string}\`\>
+▸ **proposalValues**(`«destructured»`): `Promise`\<\{ `proposalValue`: `bigint` ; `randomnessValue`: `bigint` ; `proposal`: `string`  }\>
 
-Gets the hidden proposer hash for a specific game turn
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `instanceAddress` | \`0x$\{string}\` |
+| › `gameId` | `bigint` |
+| › `proposal` | `string` |
+| › `proposer` | \`0x$\{string}\` |
+| › `turn` | `bigint` |
+
+#### Returns
+
+`Promise`\<\{ `proposalValue`: `bigint` ; `randomnessValue`: `bigint` ; `proposal`: `string`  }\>
+
+___
+
+### encryptProposal
+
+▸ **encryptProposal**(`«destructured»`): `Promise`\<\{ `encryptedProposal`: `string` ; `sharedKey`: \`0x$\{string}\`  }\>
+
+Encrypts a proposal
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `proposal` | `string` |
+| › `turn` | `bigint` |
+| › `instanceAddress` | \`0x$\{string}\` |
+| › `gameId` | `bigint` |
+| › `proposerPubKey` | \`0x$\{string}\` |
+
+#### Returns
+
+`Promise`\<\{ `encryptedProposal`: `string` ; `sharedKey`: \`0x$\{string}\`  }\>
+
+Encrypted proposal and shared key
+
+___
+
+### attestProposal
+
+▸ **attestProposal**(`«destructured»`): `Promise`\<\{ `submissionParams`: [`GmProposalParams`](../interfaces/GmProposalParams.md) = params; `proposal`: `string` ; `proposerAddress`: \`0x$\{string}\` ; `proposalValue`: `bigint` ; `randomnessValue`: `bigint`  }\>
+
+Attests a proposal
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `«destructured»` | `Object` |
+| › `instanceAddress` | \`0x$\{string}\` |
 | › `gameId` | `bigint` |
+| › `proposal` | `string` |
+| › `proposerPubKey` | \`0x$\{string}\` |
 | › `turn` | `bigint` |
-| › `proposer` | \`0x$\{string}\` |
 
 #### Returns
 
-`Promise`\<\`0x$\{string}\`\>
+`Promise`\<\{ `submissionParams`: [`GmProposalParams`](../interfaces/GmProposalParams.md) = params; `proposal`: `string` ; `proposerAddress`: \`0x$\{string}\` ; `proposalValue`: `bigint` ; `randomnessValue`: `bigint`  }\>
 
-Hidden proposer hash
+The attested proposal
 
 ___
 
@@ -334,10 +487,8 @@ Submits a proposal to the game
 | :------ | :------ |
 | `«destructured»` | `Object` |
 | › `instanceAddress` | \`0x$\{string}\` |
-| › `gameId` | `bigint` |
-| › `commitmentHash` | \`0x$\{string}\` |
-| › `proposal` | `string` |
-| › `proposer` | \`0x$\{string}\` |
+| › `submissionParams` | [`GmProposalParams`](../interfaces/GmProposalParams.md) |
+| › `proposerSignature` | \`0x$\{string}\` |
 
 #### Returns
 
@@ -349,7 +500,7 @@ ___
 
 ### decryptTurnVotes
 
-▸ **decryptTurnVotes**(`«destructured»`): `Promise`\<\{ `player`: \`0x$\{string}\` = event.args.player; `votes`: `bigint`[]  }[]\>
+▸ **decryptTurnVotes**(`«destructured»`): `Promise`\<\{ `player`: \`0x$\{string}\` = event.args.player; `votes`: `bigint`[] = decryptedVotes }[]\>
 
 Decrypts votes for a specific game turn
 
@@ -364,7 +515,7 @@ Decrypts votes for a specific game turn
 
 #### Returns
 
-`Promise`\<\{ `player`: \`0x$\{string}\` = event.args.player; `votes`: `bigint`[]  }[]\>
+`Promise`\<\{ `player`: \`0x$\{string}\` = event.args.player; `votes`: `bigint`[] = decryptedVotes }[]\>
 
 Array of decrypted votes with player addresses
 
@@ -372,7 +523,7 @@ ___
 
 ### decryptVotes
 
-▸ **decryptVotes**(`gameId`): `Promise`\<``-1`` \| \{ `player`: \`0x$\{string}\` = event.args.player; `votes`: `bigint`[]  }[]\>
+▸ **decryptVotes**(`gameId`): `Promise`\<``-1`` \| \{ `player`: \`0x$\{string}\` = event.args.player; `votes`: `bigint`[] = decryptedVotes }[]\>
 
 Decrypts all votes for the current game turn
 
@@ -386,7 +537,7 @@ Decrypts all votes for the current game turn
 
 #### Returns
 
-`Promise`\<``-1`` \| \{ `player`: \`0x$\{string}\` = event.args.player; `votes`: `bigint`[]  }[]\>
+`Promise`\<``-1`` \| \{ `player`: \`0x$\{string}\` = event.args.player; `votes`: `bigint`[] = decryptedVotes }[]\>
 
 Array of decrypted votes with player addresses
 
@@ -477,3 +628,150 @@ Ends the current turn and processes votes
 `Promise`\<\`0x$\{string}\`\>
 
 Transaction hash
+
+___
+
+### gameKey
+
+▸ **gameKey**(`«destructured»`): `Promise`\<\`0x$\{string}\`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `gameId` | `bigint` |
+| › `contractAddress` | \`0x$\{string}\` |
+
+#### Returns
+
+`Promise`\<\`0x$\{string}\`\>
+
+___
+
+### attestVote
+
+▸ **attestVote**(`params`): `Promise`\<`VoteAttestation`\>
+
+Creates and signs a vote for testing purposes
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `params` | `Object` | Parameters including voter, game info, and vote configuration |
+| `params.gameId` | `bigint` | - |
+| `params.turn` | `bigint` | - |
+| `params.vote` | `bigint`[] | - |
+| `params.verifierAddress` | \`0x$\{string}\` | - |
+| `params.voter` | \`0x$\{string}\` | - |
+
+#### Returns
+
+`Promise`\<`VoteAttestation`\>
+
+A complete mock vote with signatures
+
+___
+
+### signVote
+
+▸ **signVote**(`params`): `Promise`\<\`0x$\{string}\`\>
+
+Signs a vote
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `params` | `Object` | Parameters including voter, game info, and vote configuration |
+| `params.verifierAddress` | \`0x$\{string}\` | - |
+| `params.voter` | \`0x$\{string}\` | - |
+| `params.gameId` | `bigint` | - |
+| `params.sealedBallotId` | `string` | - |
+| `params.ballotHash` | `string` | - |
+| `params.name` | `string` | - |
+| `params.version` | `string` | - |
+
+#### Returns
+
+`Promise`\<\`0x$\{string}\`\>
+
+The signed vote
+
+___
+
+### generateEndTurnIntegrity
+
+▸ **generateEndTurnIntegrity**(`params`): `Promise`\<\{ `commitment`: `bigint` = inputs.permutationCommitment; `nullifier`: `bigint` ; `permutation`: `number`[] ; `permutedProposals`: `string`[] ; `a`: readonly [`bigint`, `bigint`] ; `b`: readonly [readonly [`bigint`, `bigint`], readonly [`bigint`, `bigint`]] ; `c`: readonly [`bigint`, `bigint`]  }\>
+
+Generates integrity data for the end of a game turn
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `params` | `Object` | `undefined` | Parameters including game info, turn, and proposal data |
+| `params.gameId` | `bigint` | `undefined` | - |
+| `params.turn` | `bigint` | `undefined` | - |
+| `params.verifierAddress` | \`0x$\{string}\` | `undefined` | - |
+| `params.size?` | `number` | `15` | - |
+| `params.proposals` | \{ `proposal`: `string` ; `proposer`: \`0x$\{string}\`  }[] | `undefined` | - |
+
+#### Returns
+
+`Promise`\<\{ `commitment`: `bigint` = inputs.permutationCommitment; `nullifier`: `bigint` ; `permutation`: `number`[] ; `permutedProposals`: `string`[] ; `a`: readonly [`bigint`, `bigint`] ; `b`: readonly [readonly [`bigint`, `bigint`], readonly [`bigint`, `bigint`]] ; `c`: readonly [`bigint`, `bigint`]  }\>
+
+Integrity data including permutation, secret, and proof
+
+___
+
+### getProposalsIntegrity
+
+▸ **getProposalsIntegrity**(`params`): `Promise`\<`ProposalsIntegrity`\>
+
+Gets proposal integrity data for testing
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `params` | `Object` | Parameters including game info and proposal data |
+| `params.size` | `number` | - |
+| `params.gameId` | `bigint` | - |
+| `params.turn` | `bigint` | - |
+| `params.verifierAddress` | \`0x$\{string}\` | - |
+| `params.idlers?` | `number`[] | - |
+| `params.proposals` | \{ `proposal`: `string` ; `proposer`: \`0x$\{string}\`  }[] | - |
+
+#### Returns
+
+`Promise`\<`ProposalsIntegrity`\>
+
+Proposal integrity information including permutations and proofs
+
+___
+
+### createInputs
+
+▸ **createInputs**(`params`): `Promise`\<`PrivateProposalsIntegrity15Groth16`\>
+
+Creates inputs for the proposal integrity circuit
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `params` | `Object` | Parameters including number of active proposals, proposals, commitment random numbers, game ID, turn, and verifier address |
+| `params.numActive` | `number` | - |
+| `params.proposals` | `bigint`[] | - |
+| `params.commitmentRandomnesses` | `bigint`[] | - |
+| `params.gameId` | `bigint` | - |
+| `params.turn` | `bigint` | - |
+| `params.verifierAddress` | \`0x$\{string}\` | - |
+
+#### Returns
+
+`Promise`\<`PrivateProposalsIntegrity15Groth16`\>
+
+The inputs for the proposal integrity circuit