CompetitionScheme | @daostack/arc.js

Hierarchy

SchemeBase
- CompetitionScheme

Implements

IStateful<ISchemeState>

Index

Constructors

constructor

Properties

Methods

Object literals

fragments

Constructors

constructor

new CompetitionScheme(idOrOpts: Address | ISchemeStaticState, context: Arc): CompetitionScheme

Inherited from SchemeBase.constructor
- Defined in src/schemes/base.ts:252
Parameters
- idOrOpts: Address | ISchemeStaticState
- context: Arc
Returns CompetitionScheme

Properties

CTL4R

CTL4R: CL4RScheme | null = null

ReputationFromToken

ReputationFromToken: ReputationFromTokenScheme | null = null

context

context: Arc

id

id: Address

staticState

staticState: ISchemeStaticState | null = null

Methods

competitions

competitions(options?: IProposalQueryOptions, apolloQueryOptions?: IApolloQueryOptions): Observable<Competition[]>

- Defined in src/schemes/competition.ts:176
Return a list of competitions in this scheme.

Parameters
- Default value options: IProposalQueryOptions = {}
- Default value apolloQueryOptions: IApolloQueryOptions = {}
Returns Observable<Competition[]>

createProposal

createProposal(options: IProposalCreateOptionsCompetition): Operation<Proposal>

Overrides SchemeBase.createProposal
- Defined in src/schemes/competition.ts:288
create a proposal for starting a Competition

memberof

CompetitionScheme

Parameters
- options: IProposalCreateOptionsCompetition
Returns Operation<Proposal>

createProposalErrorHandler

createProposalErrorHandler(options: any): function

Overrides SchemeBase.createProposalErrorHandler
- Defined in src/schemes/competition.ts:264
Parameters
- options: any
Returns function
- - (err: Error): Error | Promise<Error>
  - Parameters
    - err: Error
    Returns Error | Promise<Error>

createProposalTransaction

createProposalTransaction(options: IProposalCreateOptionsCompetition): (Anonymous function)

Overrides SchemeBase.createProposalTransaction
- Defined in src/schemes/competition.ts:196
Parameters
- options: IProposalCreateOptionsCompetition
Returns (Anonymous function)

createProposalTransactionMap

createProposalTransactionMap(): txMap

Overrides SchemeBase.createProposalTransactionMap
- Defined in src/schemes/competition.ts:255
Returns txMap

fetchStaticState

fetchStaticState(): Promise<ISchemeStaticState>

Inherited from SchemeBase.fetchStaticState
- Defined in src/schemes/base.ts:269
fetch the static state from the subgraph

Returns Promise<ISchemeStaticState>

the statatic state

getCompetitionContract

getCompetitionContract(): Promise<any>

- Defined in src/schemes/competition.ts:292
Returns Promise<any>

proposals

proposals(options?: IProposalQueryOptions, apolloQueryOptions?: IApolloQueryOptions): Observable<Proposal[]>

Inherited from SchemeBase.proposals
- Defined in src/schemes/base.ts:336
Parameters
- Default value options: IProposalQueryOptions = {}
- Default value apolloQueryOptions: IApolloQueryOptions = {}
Returns Observable<Proposal[]>

redeemSuggestion

redeemSuggestion(options: object): Operation<boolean>

- Defined in src/schemes/competition.ts:366
Parameters
- options: object
  - suggestionId: number
Returns Operation<boolean>

setStaticState

setStaticState(opts: ISchemeStaticState): void

Inherited from SchemeBase.setStaticState
- Defined in src/schemes/base.ts:295
Parameters
- opts: ISchemeStaticState
Returns void

state

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

Overrides SchemeBase.state
- Defined in src/schemes/competition.ts:90
Parameters
- Default value apolloQueryOptions: IApolloQueryOptions = {}
Returns Observable<ISchemeState>

voteSuggestion

voteSuggestion(options: object): Operation<CompetitionVote>

- Defined in src/schemes/competition.ts:307
Vote for the suggestion that is, in the current scheme, identified by suggestionId

memberof

CompetitionScheme

Parameters
- options: object
  - suggestionId: number
Returns Operation<CompetitionVote>

Object literals

Static fragments

fragments: object

SchemeFields

SchemeFields: DocumentNode = gql`fragment SchemeFields on ControllerScheme {idaddressnamedao { id }canDelegateCallcanRegisterSchemescanUpgradeControllercanManageGlobalConstraintsisRegisteredparamsHashcontributionRewardParams {idvotingMachinevoteParams {idqueuedVoteRequiredPercentagequeuedVotePeriodLimitboostedVotePeriodLimitpreBoostedVotePeriodLimitthresholdConstlimitExponentValuequietEndingPeriodproposingRepRewardvotersReputationLossRatiominimumDaoBountydaoBountyConstactivationTimevoteOnBehalf}}contributionRewardExtParams {idvotingMachinevoteParams {idqueuedVoteRequiredPercentagequeuedVotePeriodLimitboostedVotePeriodLimitpreBoostedVotePeriodLimitthresholdConstlimitExponentValuequietEndingPeriodproposingRepRewardvotersReputationLossRatiominimumDaoBountydaoBountyConstactivationTimevoteOnBehalf}rewarder}genericSchemeParams {votingMachinecontractToCallvoteParams {queuedVoteRequiredPercentagequeuedVotePeriodLimitboostedVotePeriodLimitpreBoostedVotePeriodLimitthresholdConstlimitExponentValuequietEndingPeriodproposingRepRewardvotersReputationLossRatiominimumDaoBountydaoBountyConstactivationTimevoteOnBehalf}}genericSchemeMultiCallParams {votingMachineschemeConstraintscontractsWhiteListvoteParams {queuedVoteRequiredPercentagequeuedVotePeriodLimitboostedVotePeriodLimitpreBoostedVotePeriodLimitthresholdConstlimitExponentValuequietEndingPeriodproposingRepRewardvotersReputationLossRatiominimumDaoBountydaoBountyConstactivationTimevoteOnBehalf}}schemeRegistrarParams {votingMachinevoteRemoveParams {queuedVoteRequiredPercentagequeuedVotePeriodLimitboostedVotePeriodLimitpreBoostedVotePeriodLimitthresholdConstlimitExponentValuequietEndingPeriodproposingRepRewardvotersReputationLossRatiominimumDaoBountydaoBountyConstactivationTimevoteOnBehalf}voteRegisterParams {queuedVoteRequiredPercentagequeuedVotePeriodLimitboostedVotePeriodLimitpreBoostedVotePeriodLimitthresholdConstlimitExponentValuequietEndingPeriodproposingRepRewardvotersReputationLossRatiominimumDaoBountydaoBountyConstactivationTimevoteOnBehalf}}numberOfQueuedProposalsnumberOfPreBoostedProposalsnumberOfBoostedProposalsuGenericSchemeParams {votingMachinecontractToCallvoteParams {queuedVoteRequiredPercentagequeuedVotePeriodLimitboostedVotePeriodLimitpreBoostedVotePeriodLimitthresholdConstlimitExponentValuequietEndingPeriodproposingRepRewardvotersReputationLossRatiominimumDaoBountydaoBountyConstactivationTimevoteOnBehalf}}version}`

Hierarchy

Implements

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Parameters

idOrOpts: Address | ISchemeStaticState

context: Arc

Returns CompetitionScheme

Properties

CTL4R

ReputationFromToken

context

id

staticState

Methods

competitions

Parameters

Default value options: IProposalQueryOptions = {}

Default value apolloQueryOptions: IApolloQueryOptions = {}

Returns Observable<Competition[]>

createProposal

Parameters

options: IProposalCreateOptionsCompetition

Returns Operation<Proposal>

createProposalErrorHandler

Parameters

options: any

Returns function

Parameters

err: Error

Returns Error | Promise<Error>

createProposalTransaction

Parameters

options: IProposalCreateOptionsCompetition

Returns (Anonymous function)

createProposalTransactionMap

Returns txMap

fetchStaticState

Returns Promise<ISchemeStaticState>

getCompetitionContract

Returns Promise<any>

proposals

Parameters

Default value options: IProposalQueryOptions = {}

Default value apolloQueryOptions: IApolloQueryOptions = {}

Returns Observable<Proposal[]>

redeemSuggestion

Parameters

options: object

suggestionId: number

Returns Operation<boolean>

setStaticState

Parameters

opts: ISchemeStaticState

Returns void

state

Parameters

Default value apolloQueryOptions: IApolloQueryOptions = {}

Returns Observable<ISchemeState>

voteSuggestion

Parameters

options: object

suggestionId: number

Returns Operation<CompetitionVote>

Object literals

Static fragments

SchemeFields