Skip to main content
Version: v3.x

Minimal Anti Collusion Infrastructure (MACI) / IPoll

Interface: IPoll

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

Extends

  • BaseContract

Properties

[internal]

readonly [internal]: any

Defined in: node_modules/.pnpm/[email protected]/node_modules/ethers/lib.commonjs/contract/contract.d.ts:46

@_ignore:

Inherited from

BaseContract.[internal]


actualStateTreeDepth

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

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


coordinatorPubKeyHash

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

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


currentSbCommitment

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

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


endDate

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

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


fallback

readonly fallback: null | WrappedFallback

Defined in: node_modules/.pnpm/[email protected]/node_modules/ethers/lib.commonjs/contract/contract.d.ts:50

The fallback or receive function if any.

Inherited from

BaseContract.fallback


filters

filters: object

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

All the Events available on this contract.

Overrides

BaseContract.filters


getBatchHashes

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

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


getMaciContract

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

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


getStartAndEndDate

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

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


getStateIndex

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

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


interface

interface: IPollInterface

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

The contract Interface.

Overrides

BaseContract.interface


joinPoll

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

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


mergeState

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

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


messageBatchSize

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

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


numSignUpsAndMessages

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

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


padLastBatch

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

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


publishMessage

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

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


publishMessageBatch

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

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


relayMessagesBatch

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

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


runner

readonly runner: null | ContractRunner

Defined in: node_modules/.pnpm/[email protected]/node_modules/ethers/lib.commonjs/contract/contract.d.ts:38

The connected runner. This is generally a [[Provider]] or a [[Signer]], which dictates what operations are supported.

For example, a Contract connected to a [[Provider]] may only execute read-only operations.

Inherited from

BaseContract.runner


startDate

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

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


stateMerged

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

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


target

readonly target: string | Addressable

Defined in: node_modules/.pnpm/[email protected]/node_modules/ethers/lib.commonjs/contract/contract.d.ts:26

The target to connect to.

This can be an address, ENS name or any [[Addressable]], such as another contract. To get the resovled address, use the getAddress method.

Inherited from

BaseContract.target


treeDepths

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

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


voteOptions

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

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

Methods

addListener()

addListener(event, listener): Promise<IPoll>

Defined in: node_modules/.pnpm/[email protected]/node_modules/ethers/lib.commonjs/contract/contract.d.ts:147

Alias for [on].

Parameters

event

ContractEventName

listener

Listener

Returns

Promise<IPoll>

Inherited from

BaseContract.addListener


attach()

attach(target): BaseContract

Defined in: node_modules/.pnpm/[email protected]/node_modules/ethers/lib.commonjs/contract/contract.d.ts:66

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

Parameters

target

string | Addressable

Returns

BaseContract

Inherited from

BaseContract.attach


connect()

connect(runner?): IPoll

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

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

Parameters

runner?

null | ContractRunner

Returns

IPoll

Overrides

BaseContract.connect


deploymentTransaction()

deploymentTransaction(): null | ContractTransactionResponse

Defined in: node_modules/.pnpm/[email protected]/node_modules/ethers/lib.commonjs/contract/contract.d.ts:86

Return the transaction used to deploy this contract.

This is only available if this instance was returned from a [[ContractFactory]].

Returns

null | ContractTransactionResponse

Inherited from

BaseContract.deploymentTransaction


emit()

emit(event, ...args): Promise<boolean>

Defined in: node_modules/.pnpm/[email protected]/node_modules/ethers/lib.commonjs/contract/contract.d.ts:123

Emit an %%event%% calling all listeners with %%args%%.

Resolves to true if any listeners were called.

Parameters

event

ContractEventName

args

...any[]

Returns

Promise<boolean>

Inherited from

BaseContract.emit


getAddress()

getAddress(): Promise<string>

Defined in: node_modules/.pnpm/[email protected]/node_modules/ethers/lib.commonjs/contract/contract.d.ts:70

Return the resolved address of this Contract.

Returns

Promise<string>

Inherited from

BaseContract.getAddress


getDeployedCode()

getDeployedCode(): Promise<null | string>

Defined in: node_modules/.pnpm/[email protected]/node_modules/ethers/lib.commonjs/contract/contract.d.ts:74

Return the deployed bytecode or null if no bytecode is found.

Returns

Promise<null | string>

Inherited from

BaseContract.getDeployedCode


getEvent()

getEvent(key): ContractEvent

Defined in: node_modules/.pnpm/[email protected]/node_modules/ethers/lib.commonjs/contract/contract.d.ts:98

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

Parameters

key

string | EventFragment

Returns

ContractEvent

Inherited from

BaseContract.getEvent


getFunction()

Call Signature

getFunction<T>(key): T

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

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: packages/contracts/typechain-types/contracts/interfaces/IPoll.ts:340

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: packages/contracts/typechain-types/contracts/interfaces/IPoll.ts:343

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

"coordinatorPubKeyHash"

Returns

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

Overrides

BaseContract.getFunction

Call Signature

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

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

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: packages/contracts/typechain-types/contracts/interfaces/IPoll.ts:349

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: packages/contracts/typechain-types/contracts/interfaces/IPoll.ts:352

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: packages/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

"getMaciContract"

Returns

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

Overrides

BaseContract.getFunction

Call Signature

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

Defined in: packages/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

"getStartAndEndDate"

Returns

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

Overrides

BaseContract.getFunction

Call Signature

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

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

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, PubKeyStruct, BigNumberish, BigNumberish[], BytesLike, BytesLike], [void], "nonpayable">

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

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, PubKeyStruct, BigNumberish, BigNumberish[], BytesLike, BytesLike], [void], "nonpayable">

Overrides

BaseContract.getFunction

Call Signature

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

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

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: packages/contracts/typechain-types/contracts/interfaces/IPoll.ts:385

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<[], [[bigint, bigint] & object], "view">

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

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

"numSignUpsAndMessages"

Returns

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

Overrides

BaseContract.getFunction

Call Signature

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

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

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, PubKeyStruct], [void], "nonpayable">

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

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, PubKeyStruct], [void], "nonpayable">

Overrides

BaseContract.getFunction

Call Signature

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

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

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[], PubKeyStruct[]], [void], "nonpayable">

Overrides

BaseContract.getFunction

Call Signature

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

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

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: packages/contracts/typechain-types/contracts/interfaces/IPoll.ts:422

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: packages/contracts/typechain-types/contracts/interfaces/IPoll.ts:425

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, bigint] & object], "view">

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

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] & object], "view">

Overrides

BaseContract.getFunction

Call Signature

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

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

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


listenerCount()

listenerCount(event?): Promise<number>

Defined in: node_modules/.pnpm/[email protected]/node_modules/ethers/lib.commonjs/contract/contract.d.ts:128

Resolves to the number of listeners of %%event%% or the total number of listeners if unspecified.

Parameters

event?

ContractEventName

Returns

Promise<number>

Inherited from

BaseContract.listenerCount


listeners()

Call Signature

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

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

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: packages/contracts/typechain-types/contracts/interfaces/IPoll.ts:248

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

Parameters
eventName?

string

Returns

Promise<Listener[]>

Overrides

BaseContract.listeners


off()

off(event, listener?): Promise<IPoll>

Defined in: node_modules/.pnpm/[email protected]/node_modules/ethers/lib.commonjs/contract/contract.d.ts:138

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

Parameters

event

ContractEventName

listener?

Listener

Returns

Promise<IPoll>

Inherited from

BaseContract.off


on()

Call Signature

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

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

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: packages/contracts/typechain-types/contracts/interfaces/IPoll.ts:231

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: packages/contracts/typechain-types/contracts/interfaces/IPoll.ts:236

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: packages/contracts/typechain-types/contracts/interfaces/IPoll.ts:240

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: packages/contracts/typechain-types/contracts/interfaces/IPoll.ts:216

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: packages/contracts/typechain-types/contracts/interfaces/IPoll.ts:221

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


queryTransaction()

queryTransaction(hash): Promise<EventLog[]>

Defined in: node_modules/.pnpm/[email protected]/node_modules/ethers/lib.commonjs/contract/contract.d.ts:102

@_ignore:

Parameters

hash

string

Returns

Promise<EventLog[]>

Inherited from

BaseContract.queryTransaction


removeAllListeners()

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

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

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


removeListener()

removeListener(event, listener): Promise<IPoll>

Defined in: node_modules/.pnpm/[email protected]/node_modules/ethers/lib.commonjs/contract/contract.d.ts:151

Alias for [off].

Parameters

event

ContractEventName

listener

Listener

Returns

Promise<IPoll>

Inherited from

BaseContract.removeListener


waitForDeployment()

waitForDeployment(): Promise<IPoll>

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

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

Returns

Promise<IPoll>

Overrides

BaseContract.waitForDeployment