Class Votable

Hierarchy

Model<VotableMethods>
- Votable

Implements

Deployable

Constructors

constructor

new Votable(web3Connection: Web3Connection | Web3ConnectionOptions, contractAddress?: string, erc20TokenAddress?: string): Votable

Overrides Model.constructor
- Defined in src/models/votable.ts:15
Parameters
- web3Connection: Web3Connection | Web3ConnectionOptions
- Optional contractAddress: string
- Optional erc20TokenAddress: string
Returns Votable

Properties

Protected _contract

_contract: Web3Contract<VotableMethods, any>

Private _erc20

_erc20: ERC20

Readonly abi

abi: AbiItem[]

Optional Readonly contractAddress

contractAddress?: string

Optional Readonly erc20TokenAddress

erc20TokenAddress?: string

Accessors

account

get account(): Account

Inherited from Model.account
- Defined in src/base/model.ts:48
Returns the Account associated with this connection

Returns Account

Protected connection

get connection(): Web3Connection

Inherited from Model.connection
- Defined in src/base/model.ts:38
Pointer to the Web3Connection assigned to this contract class

Returns Web3Connection

contract

get contract(): Web3Contract<Methods, any>

Inherited from Model.contract
- Defined in src/base/model.ts:21
Returns the Web3Contract class representing this contract

Returns Web3Contract<Methods, any>

erc20

get erc20(): ERC20

- Defined in src/models/votable.ts:22
Returns ERC20

web3

get web3(): default

Inherited from Model.web3
- Defined in src/base/model.ts:43
Returns the Web3 class assigned to this connection

Returns default

Methods

callTx

callTx<ReturnData>(method: ContractCallMethod<ReturnData>): Promise<ReturnData>

Inherited from Model.callTx
- Defined in src/base/model.ts:93
Return a property value from the contract

Type Parameters
- ReturnData = any
Parameters
- method: ContractCallMethod<ReturnData>
Returns Promise<ReturnData>

castVote

castVote(_pollID: number, _voteId: number): Promise<TransactionReceipt<any>>

- Defined in src/models/votable.ts:94
Parameters
- _pollID: number
- _voteId: number
Returns Promise<TransactionReceipt<any>>

connect

connect(): Promise<boolean>

Inherited from Model.connect
- Defined in src/base/model.ts:72
Alias for Web3Connection.connect(); Will load contract if success

Returns Promise<boolean>

createPoll

createPoll(_description: string, _voteLength: number, options: number[]): Promise<TransactionReceipt<any>>

- Defined in src/models/votable.ts:61
Parameters
- _description: string
  
  description of the poll
- _voteLength: number
  
  length of the voting in seconds
- options: number[]
  
  available options
Returns Promise<TransactionReceipt<any>>

Protected deploy

deploy(deployOptions: DeployOptions, account?: Account): Promise<TransactionReceipt<any>>

Inherited from Model.deploy
- Defined in src/base/model.ts:147
Deploy the loaded abi contract

Parameters
- deployOptions: DeployOptions
- Optional account: Account
Returns Promise<TransactionReceipt<any>>

deployJsonAbi

deployJsonAbi(_token: string): Promise<TransactionReceipt<any>>

Implementation of Deployable.deployJsonAbi
- Defined in src/models/votable.ts:38
Parameters
- _token: string
Returns Promise<TransactionReceipt<any>>

endPoll

endPoll(_pollID: number): Promise<TransactionReceipt<any>>

- Defined in src/models/votable.ts:65
Parameters
- _pollID: number
Returns Promise<TransactionReceipt<any>>

getLockedAmount

getLockedAmount(_voter: string): Promise<string>

- Defined in src/models/votable.ts:109
Parameters
- _voter: string
Returns Promise<string>

getPollHistory

getPollHistory(_voter: string): Promise<number[]>

- Defined in src/models/votable.ts:81
Parameters
- _voter: string
Returns Promise<number[]>

getPollInfoForVoter

getPollInfoForVoter(_pollID: number, _voter: string): Promise<VoterInfo>

- Defined in src/models/votable.ts:85
Parameters
- _pollID: number
- _voter: string
Returns Promise<VoterInfo>

getPollOptionById

getPollOptionById(_pollID: number, id: number): Promise<number>

- Defined in src/models/votable.ts:77
Parameters
- _pollID: number
- id: number
Returns Promise<number>

getPoolInformation

getPoolInformation(_pollID: number): Promise<{ _id: number; creator: string; description: string; expirationTime: number; optionsSize: number; status: undefined; voters: string[] }>

- Defined in src/models/votable.ts:69
Parameters
- _pollID: number
Returns Promise<{ _id: number; creator: string; description: string; expirationTime: number; optionsSize: number; status: undefined; voters: string[] }>

getPoolWinner

getPoolWinner(_pollID: number): Promise<{ optionId: number; winnerId: number }>

- Defined in src/models/votable.ts:73
Parameters
- _pollID: number
Returns Promise<{ optionId: number; winnerId: number }>

getTokenStake

getTokenStake(_voter: string): Promise<number>

- Defined in src/models/votable.ts:113
Parameters
- _voter: string
Returns Promise<number>

loadAbi

loadAbi(): void

Inherited from Model.loadAbi
- Defined in src/base/model.ts:53
Permissive way of initializing the contract, used primarily for deploys. Prefer to use loadContract

Returns void

loadContract

loadContract(): Promise<void>

Overrides Model.loadContract
- Defined in src/models/votable.ts:24
Preferred way of initializing and loading a contract

Returns Promise<void>

pollCount

pollCount(): Promise<number>

- Defined in src/models/votable.ts:47
Returns Promise<number>

polls

polls(v1: number): Promise<{ 0: string; 1: undefined; 2: number; 3: string; 4: number; 5: number }>

- Defined in src/models/votable.ts:51
Parameters
- v1: number
Returns Promise<{ 0: string; 1: undefined; 2: number; 3: string; 4: number; 5: number }>

sendTx

sendTx(method: ContractSendMethod, value?: any): Promise<TransactionReceipt<any>>

Inherited from Model.sendTx
- Defined in src/base/model.ts:100
Interact with, or change a value of, a property on the contract

Parameters
- method: ContractSendMethod
- Optional value: any
Returns Promise<TransactionReceipt<any>>

sendUnsignedTx

sendUnsignedTx(method: ContractSendMethod, value?: any, __namedParameters?: Partial<Web3ConnectionOptions>): Promise<TransactionReceipt<any>>

Inherited from Model.sendUnsignedTx
- Defined in src/base/model.ts:118
Send unsigned transaction

Parameters
- method: ContractSendMethod
- Optional value: any
- __namedParameters: Partial<Web3ConnectionOptions> = {}
Returns Promise<TransactionReceipt<any>>

stakeVotingTokens

stakeVotingTokens(_numTokens: number): Promise<TransactionReceipt<any>>

- Defined in src/models/votable.ts:98
Parameters
- _numTokens: number
Returns Promise<TransactionReceipt<any>>

start

start(): Promise<void>

Overrides Model.start
- Defined in src/models/votable.ts:33
Alias for Web3Connection.start(); Will load contract if success

Returns Promise<void>

userHasVoted

userHasVoted(_pollID: number, _user: string): Promise<boolean>

- Defined in src/models/votable.ts:90
Parameters
- _pollID: number
- _user: string
Returns Promise<boolean>

withdrawTokens

withdrawTokens(_numTokens: number): Promise<TransactionReceipt<any>>

- Defined in src/models/votable.ts:104
Parameters
- _numTokens: number
Returns Promise<TransactionReceipt<any>>

Generated using TypeDoc