Proposal | @daostack/arc.js

Hierarchy

Proposal

Implements

IStateful<IProposalState>

Index

Constructors

constructor

Properties

Methods

Object literals

fragments

Constructors

constructor

new Proposal(idOrOpts: string | IProposalStaticState, context: Arc): Proposal

- Defined in src/proposal.ts:350
Parameters
- idOrOpts: string | IProposalStaticState
- context: Arc
Returns Proposal

Properties

context

context: Arc

id

id: string

staticState

staticState: IProposalStaticState | undefined

Methods

claimRewards

claimRewards(beneficiary?: Address): Operation<boolean>

- Defined in src/proposal.ts:858
[claimRewards description] Execute the proposal and distribute the rewards to the beneficiary. This uses the Redeemer.sol helper contract

Parameters
- Optional beneficiary: Address
  
  Addresss of the beneficiary, optional, if undefined will only redeem the ContributionReward rewards
Returns Operation<boolean>

an Operation

execute

execute(): Operation<any>

- Defined in src/proposal.ts:921
calll the 'execute()' function on the votingMachine. the main purpose of this function is to set the stage of the proposals this call may (or may not) "execute" the proposal itself (i.e. do what the proposal proposes)

Returns Operation<any>

an Operation that, when sucessful, will contain the receipt of the transaction

executeBoosted

executeBoosted(): Operation<any>

- Defined in src/proposal.ts:952
Returns Operation<any>

executeCalls

executeCalls(): Operation<boolean>

- Defined in src/proposal.ts:904
[executeCalls description] execute the actual proposals call of a GenericScheme or GenericSchemeMultiCall

Returns Operation<boolean>

an Operation

fetchStaticState

fetchStaticState(): Promise<IProposalStaticState>

- Defined in src/proposal.ts:368
Returns Promise<IProposalStaticState>

redeemerContract

redeemerContract(): any

- Defined in src/proposal.ts:671
[redeemerContract description]

Returns any

a web3 Contract instance

rewards

rewards(options?: IRewardQueryOptions, apolloQueryOptions?: IApolloQueryOptions): Observable<Reward[]>

- Defined in src/proposal.ts:841
Parameters
- Default value options: IRewardQueryOptions = {}
- Default value apolloQueryOptions: IApolloQueryOptions = {}
Returns Observable<Reward[]>

scheme

scheme(): Promise<any>

- Defined in src/proposal.ts:654
Returns Promise<any>

the scheme Contract

setStaticState

setStaticState(opts: IProposalStaticState): void

- Defined in src/proposal.ts:364
Parameters
- opts: IProposalStaticState
Returns void

stake

stake(outcome: IProposalOutcome, amount: BN): Operation<Stake>

- Defined in src/proposal.ts:767
Stake on this proposal

Parameters
- outcome: IProposalOutcome
  
  the outcome that is staked on, of type IProposalOutcome
- amount: BN
  
  the amount, in GEN, to stake
Returns Operation<Stake>

An observable that can be sent, or subscribed to

stakes

stakes(options?: IStakeQueryOptions, apolloQueryOptions?: IApolloQueryOptions): Observable<Stake[]>

- Defined in src/proposal.ts:755
Parameters
- Default value options: IStakeQueryOptions = {}
- Default value apolloQueryOptions: IApolloQueryOptions = {}
Returns Observable<Stake[]>

stakingToken

stakingToken(): Token

- Defined in src/proposal.ts:751
Returns Token

state

state(apolloQueryOptions?: IApolloQueryOptions): Observable<IProposalState>

- Defined in src/proposal.ts:390
state is an observable of the proposal state

Parameters
- Default value apolloQueryOptions: IApolloQueryOptions = {}
Returns Observable<IProposalState>

vote

vote(outcome: IProposalOutcome, amount?: number): Operation<Vote | null>

- Defined in src/proposal.ts:699
Vote for this proposal

Parameters
- outcome: IProposalOutcome
  
  one of IProposalOutcome.Pass (0) or IProposalOutcome.FAIL (1)
- Default value amount: number = 0
  
  the amount of reputation to vote with. Defaults to 0 - in that case, all the sender's rep will be used
Returns Operation<Vote | null>

an observable Operation

votes

votes(options?: IVoteQueryOptions, apolloQueryOptions?: IApolloQueryOptions): Observable<Vote[]>

- Defined in src/proposal.ts:686
Parameters
- Default value options: IVoteQueryOptions = {}
- Default value apolloQueryOptions: IApolloQueryOptions = {}
Returns Observable<Vote[]>

votingMachine

votingMachine(): Promise<any>

- Defined in src/proposal.ts:663
[votingMachine description]

Returns Promise<any>

a web3 Contract instance

Static search

search(context: Arc, options?: IProposalQueryOptions, apolloQueryOptions?: IApolloQueryOptions): Observable<Proposal[]>

- Defined in src/proposal.ts:259
Search for proposals

Parameters
- context: Arc
  
  An instance of Arc
- Default value options: IProposalQueryOptions = {}
  
  Search options, must implemeent IProposalQueryOptions
- Default value apolloQueryOptions: IApolloQueryOptions = {}
Returns Observable<Proposal[]>

An observable of lists of results

For example: Proposal.search({ stage: IProposalStage.Queued})

Object literals

Static fragments

fragments: object

ProposalFields

ProposalFields: DocumentNode = gql`fragment ProposalFields on Proposal {idaccountsWithUnclaimedRewardsboostedAtclosingAtconfidenceThresholdcompetition {idadminendTimecontractsuggestionsEndTimecreatedAtnumberOfWinningSuggestionsnumberOfVotesPerVotersnumberOfWinnersrewardSplitsnapshotBlockstartTimetotalSuggestionstotalVotesvotingStartTime}contributionReward {idbeneficiaryethRewardethRewardLeftexternalTokenexternalTokenRewardexternalTokenRewardLeftnativeTokenRewardnativeTokenRewardLeftperiodsperiodLengthreputationRewardreputationChangeLeftalreadyRedeemedReputationPeriodsalreadyRedeemedExternalTokenPeriodsalreadyRedeemedNativeTokenPeriodsalreadyRedeemedEthPeriods}createdAtdao {idschemes {idaddress}}descriptiondescriptionHashexecutedAtexecutionStateexpiresInQueueAtgenericScheme {idcontractToCallcallDataexecutedreturnValuevalue}genericSchemeMultiCall {idcontractsToCallcallsDataexecutedreturnValuesvalues}genesisProtocolParams {idactivationTimeboostedVotePeriodLimitdaoBountyConstlimitExponentValueminimumDaoBountypreBoostedVotePeriodLimitproposingRepRewardqueuedVotePeriodLimitqueuedVoteRequiredPercentagequietEndingPeriodthresholdConstvotersReputationLossRatio}gpRewards {id}scheme {...SchemeFields}gpQueue {idthresholdvotingMachine}organizationIdpreBoostedAtproposerquietEndingPeriodBeganAtschemeRegistrar {idschemeToRegisterschemeToRegisterParamsHashschemeToRegisterPermissionschemeToRemovedecisionschemeRegisteredschemeRemoved}stage# stakes { id }stakesForstakesAgainsttags {id}totalRepWhenCreatedtotalRepWhenExecutedtitleurl# votes { id }votesAgainstvotesForvotingMachinewinningOutcome}`

Hierarchy

Implements

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Parameters

idOrOpts: string | IProposalStaticState

context: Arc

Returns Proposal

Properties

context

id

staticState

Methods

claimRewards

Parameters

Optional beneficiary: Address

Returns Operation<boolean>

execute

Returns Operation<any>

executeBoosted

Returns Operation<any>

executeCalls

Returns Operation<boolean>

fetchStaticState

Returns Promise<IProposalStaticState>

redeemerContract

Returns any

rewards

Parameters

Default value options: IRewardQueryOptions = {}

Default value apolloQueryOptions: IApolloQueryOptions = {}

Returns Observable<Reward[]>

scheme

Returns Promise<any>

setStaticState

Parameters

opts: IProposalStaticState

Returns void

stake

Parameters

outcome: IProposalOutcome

amount: BN

Returns Operation<Stake>

stakes

Parameters

Default value options: IStakeQueryOptions = {}

Default value apolloQueryOptions: IApolloQueryOptions = {}

Returns Observable<Stake[]>

stakingToken

Returns Token

state

Parameters

Default value apolloQueryOptions: IApolloQueryOptions = {}

Returns Observable<IProposalState>

vote

Parameters

outcome: IProposalOutcome

Default value amount: number = 0

Returns Operation<Vote | null>

votes

Parameters

Default value options: IVoteQueryOptions = {}

Default value apolloQueryOptions: IApolloQueryOptions = {}

Returns Observable<Vote[]>

votingMachine

Returns Promise<any>

Static search

Parameters

context: Arc

Default value options: IProposalQueryOptions = {}

Default value apolloQueryOptions: IApolloQueryOptions = {}

Returns Observable<Proposal[]>

Object literals

Static fragments

ProposalFields