Skip to main content
Version: v3.x

Minimal Anti Collusion Infrastructure (MACI) / IPoll

Interface: IPoll

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:219

Extends​

  • BaseContract

Properties​

actualStateTreeDepth​

actualStateTreeDepth: TypedContractMethod<[], [bigint], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:262


coordinatorPublicKeyHash​

coordinatorPublicKeyHash: TypedContractMethod<[], [bigint], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:264


currentSbCommitment​

currentSbCommitment: TypedContractMethod<[], [bigint], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:266


endDate​

endDate: TypedContractMethod<[], [bigint], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:268


filters​

filters: object

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:466

All the Events available on this contract.

Overrides​

BaseContract.filters


getBatchHashes​

getBatchHashes: TypedContractMethod<[], [bigint[]], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:270


getMaciContract​

getMaciContract: TypedContractMethod<[], [string], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:272


getStartAndEndDate​

getStartAndEndDate: TypedContractMethod<[], [[bigint, bigint] & object], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:274


getStateIndex​

getStateIndex: TypedContractMethod<[BigNumberish], [bigint], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:280


interface​

interface: IPollInterface

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:223

The contract Interface.

Overrides​

BaseContract.interface


joinPoll​

joinPoll: TypedContractMethod<[BigNumberish, PublicKeyStruct, BigNumberish, BigNumberish[], BytesLike, BytesLike], [void], "nonpayable">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:282


mergeState​

mergeState: TypedContractMethod<[], [void], "nonpayable">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:295


messageBatchSize​

messageBatchSize: TypedContractMethod<[], [bigint], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:297


padLastBatch​

padLastBatch: TypedContractMethod<[], [void], "nonpayable">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:299


publishMessage​

publishMessage: TypedContractMethod<[MessageStruct, PublicKeyStruct], [void], "nonpayable">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:301


publishMessageBatch​

publishMessageBatch: TypedContractMethod<[MessageStruct[], PublicKeyStruct[]], [void], "nonpayable">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:310


relayMessagesBatch​

relayMessagesBatch: TypedContractMethod<[BigNumberish[], BytesLike], [void], "nonpayable">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:319


startDate​

startDate: TypedContractMethod<[], [bigint], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:325


stateMerged​

stateMerged: TypedContractMethod<[], [boolean], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:327


totalSignups​

totalSignups: TypedContractMethod<[], [bigint], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:329


totalSignupsAndMessages​

totalSignupsAndMessages: TypedContractMethod<[], [[bigint, bigint] & object], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:331


treeDepths​

treeDepths: TypedContractMethod<[], [[bigint, bigint, bigint] & object], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:337


voteOptions​

voteOptions: TypedContractMethod<[], [bigint], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:349

Methods​

connect()​

connect(runner?): IPoll

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:220

Return a new Contract instance with the same target and ABI, but a different %%runner%%.

Parameters​

runner?​

ContractRunner | null

Returns​

IPoll

Overrides​

BaseContract.connect


getFunction()​

Call Signature​

getFunction<T>(key): T

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:351

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Type Parameters​
T​

T extends ContractMethod<any[], any, any> = ContractMethod<any[], any, any>

Parameters​
key​

string | FunctionFragment

Returns​

T

Overrides​

BaseContract.getFunction

Call Signature​

getFunction(nameOrSignature): TypedContractMethod<[], [bigint], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:355

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters​
nameOrSignature​

"actualStateTreeDepth"

Returns​

TypedContractMethod<[], [bigint], "view">

Overrides​

BaseContract.getFunction

Call Signature​

getFunction(nameOrSignature): TypedContractMethod<[], [bigint], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:358

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters​
nameOrSignature​

"coordinatorPublicKeyHash"

Returns​

TypedContractMethod<[], [bigint], "view">

Overrides​

BaseContract.getFunction

Call Signature​

getFunction(nameOrSignature): TypedContractMethod<[], [bigint], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:361

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters​
nameOrSignature​

"currentSbCommitment"

Returns​

TypedContractMethod<[], [bigint], "view">

Overrides​

BaseContract.getFunction

Call Signature​

getFunction(nameOrSignature): TypedContractMethod<[], [bigint], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:364

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters​
nameOrSignature​

"endDate"

Returns​

TypedContractMethod<[], [bigint], "view">

Overrides​

BaseContract.getFunction

Call Signature​

getFunction(nameOrSignature): TypedContractMethod<[], [bigint[]], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:367

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters​
nameOrSignature​

"getBatchHashes"

Returns​

TypedContractMethod<[], [bigint[]], "view">

Overrides​

BaseContract.getFunction

Call Signature​

getFunction(nameOrSignature): TypedContractMethod<[], [string], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:370

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters​
nameOrSignature​

"getMaciContract"

Returns​

TypedContractMethod<[], [string], "view">

Overrides​

BaseContract.getFunction

Call Signature​

getFunction(nameOrSignature): TypedContractMethod<[], [[bigint, bigint] & object], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:373

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters​
nameOrSignature​

"getStartAndEndDate"

Returns​

TypedContractMethod<[], [[bigint, bigint] & object], "view">

Overrides​

BaseContract.getFunction

Call Signature​

getFunction(nameOrSignature): TypedContractMethod<[BigNumberish], [bigint], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:380

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters​
nameOrSignature​

"getStateIndex"

Returns​

TypedContractMethod<[BigNumberish], [bigint], "view">

Overrides​

BaseContract.getFunction

Call Signature​

getFunction(nameOrSignature): TypedContractMethod<[BigNumberish, PublicKeyStruct, BigNumberish, BigNumberish[], BytesLike, BytesLike], [void], "nonpayable">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:383

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters​
nameOrSignature​

"joinPoll"

Returns​

TypedContractMethod<[BigNumberish, PublicKeyStruct, BigNumberish, BigNumberish[], BytesLike, BytesLike], [void], "nonpayable">

Overrides​

BaseContract.getFunction

Call Signature​

getFunction(nameOrSignature): TypedContractMethod<[], [void], "nonpayable">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:397

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters​
nameOrSignature​

"mergeState"

Returns​

TypedContractMethod<[], [void], "nonpayable">

Overrides​

BaseContract.getFunction

Call Signature​

getFunction(nameOrSignature): TypedContractMethod<[], [bigint], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:400

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters​
nameOrSignature​

"messageBatchSize"

Returns​

TypedContractMethod<[], [bigint], "view">

Overrides​

BaseContract.getFunction

Call Signature​

getFunction(nameOrSignature): TypedContractMethod<[], [void], "nonpayable">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:403

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters​
nameOrSignature​

"padLastBatch"

Returns​

TypedContractMethod<[], [void], "nonpayable">

Overrides​

BaseContract.getFunction

Call Signature​

getFunction(nameOrSignature): TypedContractMethod<[MessageStruct, PublicKeyStruct], [void], "nonpayable">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:406

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters​
nameOrSignature​

"publishMessage"

Returns​

TypedContractMethod<[MessageStruct, PublicKeyStruct], [void], "nonpayable">

Overrides​

BaseContract.getFunction

Call Signature​

getFunction(nameOrSignature): TypedContractMethod<[MessageStruct[], PublicKeyStruct[]], [void], "nonpayable">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:416

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters​
nameOrSignature​

"publishMessageBatch"

Returns​

TypedContractMethod<[MessageStruct[], PublicKeyStruct[]], [void], "nonpayable">

Overrides​

BaseContract.getFunction

Call Signature​

getFunction(nameOrSignature): TypedContractMethod<[BigNumberish[], BytesLike], [void], "nonpayable">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:426

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters​
nameOrSignature​

"relayMessagesBatch"

Returns​

TypedContractMethod<[BigNumberish[], BytesLike], [void], "nonpayable">

Overrides​

BaseContract.getFunction

Call Signature​

getFunction(nameOrSignature): TypedContractMethod<[], [bigint], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:433

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters​
nameOrSignature​

"startDate"

Returns​

TypedContractMethod<[], [bigint], "view">

Overrides​

BaseContract.getFunction

Call Signature​

getFunction(nameOrSignature): TypedContractMethod<[], [boolean], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:436

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters​
nameOrSignature​

"stateMerged"

Returns​

TypedContractMethod<[], [boolean], "view">

Overrides​

BaseContract.getFunction

Call Signature​

getFunction(nameOrSignature): TypedContractMethod<[], [bigint], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:439

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters​
nameOrSignature​

"totalSignups"

Returns​

TypedContractMethod<[], [bigint], "view">

Overrides​

BaseContract.getFunction

Call Signature​

getFunction(nameOrSignature): TypedContractMethod<[], [[bigint, bigint] & object], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:442

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters​
nameOrSignature​

"totalSignupsAndMessages"

Returns​

TypedContractMethod<[], [[bigint, bigint] & object], "view">

Overrides​

BaseContract.getFunction

Call Signature​

getFunction(nameOrSignature): TypedContractMethod<[], [[bigint, bigint, bigint] & object], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:449

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters​
nameOrSignature​

"treeDepths"

Returns​

TypedContractMethod<[], [[bigint, bigint, bigint] & object], "view">

Overrides​

BaseContract.getFunction

Call Signature​

getFunction(nameOrSignature): TypedContractMethod<[], [bigint], "view">

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:462

Return the function for a given name. This is useful when a contract method name conflicts with a JavaScript name such as prototype or when using a Contract programatically.

Parameters​
nameOrSignature​

"voteOptions"

Returns​

TypedContractMethod<[], [bigint], "view">

Overrides​

BaseContract.getFunction


listeners()​

Call Signature​

listeners<TCEvent>(event): Promise<TypedListener<TCEvent>[]>

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:254

Resolves to the listeners subscribed to %%event%% or all listeners if unspecified.

Type Parameters​
TCEvent​

TCEvent extends TypedContractEvent<any, any, any>

Parameters​
event​

TCEvent

Returns​

Promise<TypedListener<TCEvent>[]>

Overrides​

BaseContract.listeners

Call Signature​

listeners(eventName?): Promise<Listener[]>

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:257

Resolves to the listeners subscribed to %%event%% or all listeners if unspecified.

Parameters​
eventName?​

string

Returns​

Promise<Listener[]>

Overrides​

BaseContract.listeners


on()​

Call Signature​

on<TCEvent>(event, listener): Promise<IPoll>

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:236

Add an event %%listener%% for the %%event%%.

Type Parameters​
TCEvent​

TCEvent extends TypedContractEvent<any, any, any>

Parameters​
event​

TCEvent

listener​

TypedListener<TCEvent>

Returns​

Promise<IPoll>

Overrides​

BaseContract.on

Call Signature​

on<TCEvent>(filter, listener): Promise<IPoll>

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:240

Add an event %%listener%% for the %%event%%.

Type Parameters​
TCEvent​

TCEvent extends TypedContractEvent<any, any, any>

Parameters​
filter​

TypedDeferredTopicFilter<TCEvent>

listener​

TypedListener<TCEvent>

Returns​

Promise<IPoll>

Overrides​

BaseContract.on


once()​

Call Signature​

once<TCEvent>(event, listener): Promise<IPoll>

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:245

Add an event %%listener%% for the %%event%%, but remove the listener after it is fired once.

Type Parameters​
TCEvent​

TCEvent extends TypedContractEvent<any, any, any>

Parameters​
event​

TCEvent

listener​

TypedListener<TCEvent>

Returns​

Promise<IPoll>

Overrides​

BaseContract.once

Call Signature​

once<TCEvent>(filter, listener): Promise<IPoll>

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:249

Add an event %%listener%% for the %%event%%, but remove the listener after it is fired once.

Type Parameters​
TCEvent​

TCEvent extends TypedContractEvent<any, any, any>

Parameters​
filter​

TypedDeferredTopicFilter<TCEvent>

listener​

TypedListener<TCEvent>

Returns​

Promise<IPoll>

Overrides​

BaseContract.once


queryFilter()​

Call Signature​

queryFilter<TCEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TypedEventLog<TCEvent>[]>

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:225

Provide historic access to event data for %%event%% in the range %%fromBlock%% (default: 0) to %%toBlock%% (default: "latest") inclusive.

Type Parameters​
TCEvent​

TCEvent extends TypedContractEvent<any, any, any>

Parameters​
event​

TCEvent

fromBlockOrBlockhash?​

string | number

toBlock?​

string | number

Returns​

Promise<TypedEventLog<TCEvent>[]>

Overrides​

BaseContract.queryFilter

Call Signature​

queryFilter<TCEvent>(filter, fromBlockOrBlockhash?, toBlock?): Promise<TypedEventLog<TCEvent>[]>

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:230

Provide historic access to event data for %%event%% in the range %%fromBlock%% (default: 0) to %%toBlock%% (default: "latest") inclusive.

Type Parameters​
TCEvent​

TCEvent extends TypedContractEvent<any, any, any>

Parameters​
filter​

TypedDeferredTopicFilter<TCEvent>

fromBlockOrBlockhash?​

string | number

toBlock?​

string | number

Returns​

Promise<TypedEventLog<TCEvent>[]>

Overrides​

BaseContract.queryFilter


removeAllListeners()​

removeAllListeners<TCEvent>(event?): Promise<IPoll>

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:258

Remove all the listeners for %%event%% or remove all listeners if unspecified.

Type Parameters​

TCEvent​

TCEvent extends TypedContractEvent<any, any, any>

Parameters​

event?​

TCEvent

Returns​

Promise<IPoll>

Overrides​

BaseContract.removeAllListeners


waitForDeployment()​

waitForDeployment(): Promise<IPoll>

Defined in: contracts/typechain-types/contracts/interfaces/IPoll.ts:221

Resolve to this Contract once the bytecode has been deployed, or resolve immediately if already deployed.

Returns​

Promise<IPoll>

Overrides​

BaseContract.waitForDeployment