diff --git a/docs/classes/arc.md b/docs/classes/arc.md index 80917003..0d3bfce2 100644 --- a/docs/classes/arc.md +++ b/docs/classes/arc.md @@ -77,7 +77,7 @@ Any useage of the library typically will start with instantiating a new Arc inst *Overrides [GraphNodeObserver](graphnodeobserver.md).[constructor](graphnodeobserver.md#constructor)* -*Defined in [arc.ts:51](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L51)* +*Defined in [arc.ts:51](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L51)* **Parameters:** @@ -104,7 +104,7 @@ Name | Type | Description | *Inherited from [GraphNodeObserver](graphnodeobserver.md).[Logger](graphnodeobserver.md#logger)* -*Defined in [graphnode.ts:117](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L117)* +*Defined in [graphnode.ts:117](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L117)* ___ @@ -114,7 +114,7 @@ ___ *Inherited from [GraphNodeObserver](graphnodeobserver.md).[apolloClient](graphnodeobserver.md#optional-apolloclient)* -*Defined in [graphnode.ts:118](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L118)* +*Defined in [graphnode.ts:118](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L118)* ___ @@ -122,7 +122,7 @@ ___ • **blockHeaderSubscription**: *Subscription | undefined* = undefined -*Defined in [arc.ts:44](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L44)* +*Defined in [arc.ts:44](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L44)* ___ @@ -130,7 +130,7 @@ ___ • **contractInfos**: *[IContractInfo](../interfaces/icontractinfo.md)[]* -*Defined in [arc.ts:39](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L39)* +*Defined in [arc.ts:39](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L39)* a mapping of contrct names to contract addresses @@ -140,7 +140,7 @@ ___ • **contracts**: *object* -*Defined in [arc.ts:40](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L40)* +*Defined in [arc.ts:40](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L40)* #### Type declaration: @@ -152,7 +152,7 @@ ___ • **contractsR**: *object* -*Defined in [arc.ts:41](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L41)* +*Defined in [arc.ts:41](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L41)* #### Type declaration: @@ -166,7 +166,7 @@ ___ *Inherited from [GraphNodeObserver](graphnodeobserver.md).[graphqlHttpProvider](graphnodeobserver.md#optional-graphqlhttpprovider)* -*Defined in [graphnode.ts:115](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L115)* +*Defined in [graphnode.ts:115](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L115)* ___ @@ -176,7 +176,7 @@ ___ *Inherited from [GraphNodeObserver](graphnodeobserver.md).[graphqlSubscribeToQueries](graphnodeobserver.md#optional-graphqlsubscribetoqueries)* -*Defined in [graphnode.ts:119](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L119)* +*Defined in [graphnode.ts:119](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L119)* ___ @@ -186,7 +186,7 @@ ___ *Inherited from [GraphNodeObserver](graphnodeobserver.md).[graphqlWsProvider](graphnodeobserver.md#optional-graphqlwsprovider)* -*Defined in [graphnode.ts:116](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L116)* +*Defined in [graphnode.ts:116](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L116)* ___ @@ -194,7 +194,7 @@ ___ • **ipfs**: *any* -*Defined in [arc.ts:33](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L33)* +*Defined in [arc.ts:33](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L33)* ___ @@ -202,7 +202,7 @@ ___ • **ipfsProvider**: *[IPFSProvider](../globals.md#ipfsprovider)* -*Defined in [arc.ts:29](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L29)* +*Defined in [arc.ts:29](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L29)* ___ @@ -210,7 +210,7 @@ ___ • **observedAccounts**: *object* -*Defined in [arc.ts:45](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L45)* +*Defined in [arc.ts:45](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L45)* #### Type declaration: @@ -230,7 +230,7 @@ ___ • **pendingOperations**: *Observable‹Array‹[Operation](../globals.md#operation)‹any›››* = of() -*Defined in [arc.ts:31](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L31)* +*Defined in [arc.ts:31](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L31)* ___ @@ -238,7 +238,7 @@ ___ • **web3**: *any* -*Defined in [arc.ts:34](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L34)* +*Defined in [arc.ts:34](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L34)* ___ @@ -246,7 +246,7 @@ ___ • **web3Provider**: *[Web3Provider](../globals.md#web3provider)* = "" -*Defined in [arc.ts:27](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L27)* +*Defined in [arc.ts:27](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L27)* ___ @@ -254,7 +254,7 @@ ___ • **web3ProviderRead**: *[Web3Provider](../globals.md#web3provider)* = "" -*Defined in [arc.ts:28](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L28)* +*Defined in [arc.ts:28](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L28)* ___ @@ -262,7 +262,7 @@ ___ • **web3Read**: *any* -*Defined in [arc.ts:35](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L35)* +*Defined in [arc.ts:35](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L35)* ## Methods @@ -270,7 +270,7 @@ ___ ▸ **GENToken**(): *[Token](token.md)‹›* -*Defined in [arc.ts:341](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L341)* +*Defined in [arc.ts:341](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L341)* get the GEN Token @@ -284,7 +284,7 @@ ___ ▸ **allowance**(`owner`: [Address](../globals.md#address), `spender`: [Address](../globals.md#address)): *Observable‹BN›* -*Defined in [arc.ts:402](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L402)* +*Defined in [arc.ts:402](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L402)* How much GEN spender may spend on behalve of the owner @@ -303,7 +303,7 @@ ___ ▸ **approveForStaking**(`spender`: [Address](../globals.md#address), `amount`: BN): *[IOperationObservable](../interfaces/ioperationobservable.md)‹[ITransactionUpdate](../interfaces/itransactionupdate.md)‹any››* -*Defined in [arc.ts:392](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L392)* +*Defined in [arc.ts:392](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L392)* **Parameters:** @@ -320,7 +320,7 @@ ___ ▸ **dao**(`address`: [Address](../globals.md#address)): *[DAO](dao.md)* -*Defined in [arc.ts:134](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L134)* +*Defined in [arc.ts:134](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L134)* get a DAO instance from an address @@ -340,7 +340,7 @@ ___ ▸ **daos**(`options`: [IDAOQueryOptions](../interfaces/idaoqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[DAO](dao.md)[]›* -*Defined in [arc.ts:144](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L144)* +*Defined in [arc.ts:144](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L144)* return an observable of the list of DAOs @@ -359,7 +359,7 @@ ___ ▸ **ethBalance**(`owner`: [Address](../globals.md#address)): *Observable‹BN›* -*Defined in [arc.ts:180](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L180)* +*Defined in [arc.ts:180](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L180)* **Parameters:** @@ -375,7 +375,7 @@ ___ ▸ **events**(`options`: [IEventQueryOptions](../interfaces/ieventqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Event](event.md)[]›* -*Defined in [arc.ts:173](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L173)* +*Defined in [arc.ts:173](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L173)* **Parameters:** @@ -392,7 +392,7 @@ ___ ▸ **fetchContractInfos**(`apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Promise‹[IContractInfo](../interfaces/icontractinfo.md)[]›* -*Defined in [arc.ts:113](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L113)* +*Defined in [arc.ts:113](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L113)* fetch contractInfos from the subgraph @@ -412,7 +412,7 @@ ___ ▸ **getABI**(`address?`: [Address](../globals.md#address), `abiName?`: undefined | string, `version?`: undefined | string): *any* -*Defined in [arc.ts:284](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L284)* +*Defined in [arc.ts:284](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L284)* **Parameters:** @@ -430,7 +430,7 @@ ___ ▸ **getAccount**(): *Observable‹[Address](../globals.md#address)›* -*Defined in [arc.ts:354](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L354)* +*Defined in [arc.ts:354](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L354)* **Returns:** *Observable‹[Address](../globals.md#address)›* @@ -440,7 +440,7 @@ ___ ▸ **getContract**(`address`: [Address](../globals.md#address), `abi?`: any, `mode?`: undefined | "readonly"): *any* -*Defined in [arc.ts:313](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L313)* +*Defined in [arc.ts:313](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L313)* return a web3 Contract instance. @@ -462,7 +462,7 @@ ___ ▸ **getContractInfo**(`address`: [Address](../globals.md#address)): *[IContractInfo](../interfaces/icontractinfo.md)* -*Defined in [arc.ts:259](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L259)* +*Defined in [arc.ts:259](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L259)* return information about the contract @@ -482,7 +482,7 @@ ___ ▸ **getContractInfoByName**(`name`: string, `version`: string): *[IContractInfo](../interfaces/icontractinfo.md)* -*Defined in [arc.ts:272](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L272)* +*Defined in [arc.ts:272](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L272)* **Parameters:** @@ -501,7 +501,7 @@ ___ *Inherited from [GraphNodeObserver](graphnodeobserver.md).[getObservable](graphnodeobserver.md#getobservable)* -*Defined in [graphnode.ts:145](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L145)* +*Defined in [graphnode.ts:145](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L145)* Given a gql query, will return an observable of query results @@ -524,7 +524,7 @@ ___ *Inherited from [GraphNodeObserver](graphnodeobserver.md).[getObservableList](graphnodeobserver.md#getobservablelist)* -*Defined in [graphnode.ts:246](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L246)* +*Defined in [graphnode.ts:246](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L246)* Returns an observable that: - sends a query over http and returns the current list of results @@ -574,7 +574,7 @@ ___ *Inherited from [GraphNodeObserver](graphnodeobserver.md).[getObservableListWithFilter](graphnodeobserver.md#getobservablelistwithfilter)* -*Defined in [graphnode.ts:285](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L285)* +*Defined in [graphnode.ts:285](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L285)* Returns an observable that: - sends a query over http and returns the current list of results @@ -629,7 +629,7 @@ ___ *Inherited from [GraphNodeObserver](graphnodeobserver.md).[getObservableObject](graphnodeobserver.md#getobservableobject)* -*Defined in [graphnode.ts:302](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L302)* +*Defined in [graphnode.ts:302](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L302)* **Parameters:** @@ -655,7 +655,7 @@ ___ ▸ **proposal**(`id`: string): *[Proposal](proposal.md)* -*Defined in [arc.ts:163](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L163)* +*Defined in [arc.ts:163](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L163)* **Parameters:** @@ -671,7 +671,7 @@ ___ ▸ **proposals**(`options`: [IProposalQueryOptions](../interfaces/iproposalqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Proposal](proposal.md)[]›* -*Defined in [arc.ts:167](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L167)* +*Defined in [arc.ts:167](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L167)* **Parameters:** @@ -688,7 +688,7 @@ ___ ▸ **saveIPFSData**(`options`: object): *Promise‹string›* -*Defined in [arc.ts:426](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L426)* +*Defined in [arc.ts:427](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L427)* save data of a proposal to IPFS, return the IPFS hash @@ -715,7 +715,7 @@ ___ ▸ **scheme**(`id`: string): *[Scheme](scheme.md)* -*Defined in [arc.ts:152](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L152)* +*Defined in [arc.ts:152](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L152)* **Parameters:** @@ -731,7 +731,7 @@ ___ ▸ **schemes**(`options`: ISchemeQueryOptions, `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Scheme](scheme.md)[]›* -*Defined in [arc.ts:156](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L156)* +*Defined in [arc.ts:156](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L156)* **Parameters:** @@ -750,7 +750,7 @@ ___ *Inherited from [GraphNodeObserver](graphnodeobserver.md).[sendQuery](graphnodeobserver.md#sendquery)* -*Defined in [graphnode.ts:322](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L322)* +*Defined in [graphnode.ts:322](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L322)* **Parameters:** @@ -765,9 +765,9 @@ ___ ### sendTransaction -▸ **sendTransaction**<**T**>(`transaction`: any, `mapToObject`: function, `errorHandler`: function): *[Operation](../globals.md#operation)‹T›* +▸ **sendTransaction**<**T**>(`transaction`: any, `mapToObject`: function, `errorHandler?`: undefined | function): *[Operation](../globals.md#operation)‹T›* -*Defined in [arc.ts:413](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L413)* +*Defined in [arc.ts:413](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L413)* send an Ethereum transaction @@ -789,15 +789,7 @@ Name | Type | ------ | ------ | `receipt` | [web3receipt](../globals.md#web3receipt) | -▪`Default value` **errorHandler**: *function*= (error) => error - -▸ (`error`: Error): *Promise‹Error› | Error* - -**Parameters:** - -Name | Type | ------- | ------ | -`error` | Error | +▪`Optional` **errorHandler**: *undefined | function* **Returns:** *[Operation](../globals.md#operation)‹T›* @@ -809,7 +801,7 @@ ___ ▸ **setAccount**(`address`: [Address](../globals.md#address)): *void* -*Defined in [arc.ts:388](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L388)* +*Defined in [arc.ts:388](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L388)* **Parameters:** @@ -825,7 +817,7 @@ ___ ▸ **setContractInfos**(`contractInfos`: [IContractInfo](../interfaces/icontractinfo.md)[]): *Promise‹void›* -*Defined in [arc.ts:102](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L102)* +*Defined in [arc.ts:102](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L102)* set the contract addresses @@ -843,7 +835,7 @@ ___ ▸ **tags**(`options`: [ITagQueryOptions](../interfaces/itagqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Tag](tag.md)[]›* -*Defined in [arc.ts:148](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L148)* +*Defined in [arc.ts:148](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L148)* **Parameters:** diff --git a/docs/classes/competition.md b/docs/classes/competition.md index 0e5954f4..aed2c9ad 100644 --- a/docs/classes/competition.md +++ b/docs/classes/competition.md @@ -31,7 +31,7 @@ \+ **new Competition**(`id`: string, `context`: [Arc](arc.md)): *[Competition](competition.md)* -*Defined in [schemes/competition.ts:396](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L396)* +*Defined in [schemes/competition.ts:419](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L419)* **Parameters:** @@ -48,7 +48,7 @@ Name | Type | • **context**: *[Arc](arc.md)* -*Defined in [schemes/competition.ts:396](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L396)* +*Defined in [schemes/competition.ts:419](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L419)* ___ @@ -56,7 +56,7 @@ ___ • **id**: *string* -*Defined in [schemes/competition.ts:395](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L395)* +*Defined in [schemes/competition.ts:418](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L418)* ## Methods @@ -64,7 +64,7 @@ ___ ▸ **createSuggestion**(`options`: object): *[Operation](../globals.md#operation)‹any›* -*Defined in [schemes/competition.ts:404](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L404)* +*Defined in [schemes/competition.ts:427](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L427)* **Parameters:** @@ -73,8 +73,9 @@ ___ Name | Type | ------ | ------ | `description` | string | +`tags?` | string[] | `title` | string | -`url` | string | +`url?` | undefined | string | **Returns:** *[Operation](../globals.md#operation)‹any›* @@ -84,7 +85,7 @@ ___ ▸ **redeemSuggestion**(`suggestionId`: number, `beneficiary`: [Address](../globals.md#address)): *[Operation](../globals.md#operation)‹boolean›* -*Defined in [schemes/competition.ts:463](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L463)* +*Defined in [schemes/competition.ts:488](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L488)* **Parameters:** @@ -101,7 +102,7 @@ ___ ▸ **suggestions**(`options`: [ICompetitionSuggestionQueryOptions](../interfaces/icompetitionsuggestionqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[CompetitionSuggestion](competitionsuggestion.md)[]›* -*Defined in [schemes/competition.ts:475](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L475)* +*Defined in [schemes/competition.ts:500](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L500)* **Parameters:** @@ -118,7 +119,7 @@ ___ ▸ **voteSuggestion**(`suggestionId`: number): *[Operation](../globals.md#operation)‹[CompetitionVote](competitionvote.md)›* -*Defined in [schemes/competition.ts:452](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L452)* +*Defined in [schemes/competition.ts:477](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L477)* **Parameters:** @@ -134,7 +135,7 @@ ___ ▸ **search**(`context`: [Arc](arc.md), `options`: [IProposalQueryOptions](../interfaces/iproposalqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Competition](competition.md)[]›* -*Defined in [schemes/competition.ts:385](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L385)* +*Defined in [schemes/competition.ts:408](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L408)* **Parameters:** diff --git a/docs/classes/competitionscheme.md b/docs/classes/competitionscheme.md index 7cd99972..f82eb452 100644 --- a/docs/classes/competitionscheme.md +++ b/docs/classes/competitionscheme.md @@ -33,6 +33,7 @@ * [createProposalTransaction](competitionscheme.md#createproposaltransaction) * [createProposalTransactionMap](competitionscheme.md#createproposaltransactionmap) * [fetchStaticState](competitionscheme.md#fetchstaticstate) +* [getCompetitionContract](competitionscheme.md#getcompetitioncontract) * [proposals](competitionscheme.md#proposals) * [redeemSuggestion](competitionscheme.md#redeemsuggestion) * [setStaticState](competitionscheme.md#setstaticstate) @@ -52,7 +53,7 @@ *Inherited from [SchemeBase](schemebase.md).[constructor](schemebase.md#constructor)* -*Defined in [schemes/base.ts:239](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L239)* +*Defined in [schemes/base.ts:239](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L239)* **Parameters:** @@ -71,7 +72,7 @@ Name | Type | *Inherited from [SchemeBase](schemebase.md).[ReputationFromToken](schemebase.md#reputationfromtoken)* -*Defined in [schemes/base.ts:239](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L239)* +*Defined in [schemes/base.ts:239](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L239)* ___ @@ -81,7 +82,7 @@ ___ *Inherited from [SchemeBase](schemebase.md).[context](schemebase.md#context)* -*Defined in [schemes/base.ts:241](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L241)* +*Defined in [schemes/base.ts:241](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L241)* ___ @@ -91,7 +92,7 @@ ___ *Inherited from [SchemeBase](schemebase.md).[id](schemebase.md#id)* -*Defined in [schemes/base.ts:237](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L237)* +*Defined in [schemes/base.ts:237](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L237)* ___ @@ -101,7 +102,7 @@ ___ *Inherited from [SchemeBase](schemebase.md).[staticState](schemebase.md#staticstate)* -*Defined in [schemes/base.ts:238](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L238)* +*Defined in [schemes/base.ts:238](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L238)* ## Methods @@ -109,7 +110,7 @@ ___ ▸ **competitions**(`options`: [IProposalQueryOptions](../interfaces/iproposalqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Competition](competition.md)[]›* -*Defined in [schemes/competition.ts:168](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L168)* +*Defined in [schemes/competition.ts:167](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L167)* Return a list of competitions in this scheme. @@ -130,7 +131,11 @@ ___ *Overrides [SchemeBase](schemebase.md).[createProposal](schemebase.md#createproposal)* -*Defined in [schemes/competition.ts:271](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L271)* +*Defined in [schemes/competition.ts:277](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L277)* + +create a proposal for starting a Competition + +**`memberof`** CompetitionScheme **Parameters:** @@ -148,7 +153,7 @@ ___ *Overrides [SchemeBase](schemebase.md).[createProposalErrorHandler](schemebase.md#createproposalerrorhandler)* -*Defined in [schemes/competition.ts:254](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L254)* +*Defined in [schemes/competition.ts:253](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L253)* **Parameters:** @@ -174,7 +179,7 @@ ___ *Overrides [SchemeBase](schemebase.md).[createProposalTransaction](schemebase.md#createproposaltransaction)* -*Defined in [schemes/competition.ts:188](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L188)* +*Defined in [schemes/competition.ts:187](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L187)* **Parameters:** @@ -192,7 +197,7 @@ ___ *Overrides [SchemeBase](schemebase.md).[createProposalTransactionMap](schemebase.md#createproposaltransactionmap)* -*Defined in [schemes/competition.ts:245](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L245)* +*Defined in [schemes/competition.ts:244](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L244)* **Returns:** *txMap* @@ -204,7 +209,7 @@ ___ *Inherited from [SchemeBase](schemebase.md).[fetchStaticState](schemebase.md#fetchstaticstate)* -*Defined in [schemes/base.ts:256](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L256)* +*Defined in [schemes/base.ts:256](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L256)* fetch the static state from the subgraph @@ -214,13 +219,23 @@ the statatic state ___ +### getCompetitionContract + +▸ **getCompetitionContract**(): *Promise‹any›* + +*Defined in [schemes/competition.ts:281](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L281)* + +**Returns:** *Promise‹any›* + +___ + ### proposals ▸ **proposals**(`options`: [IProposalQueryOptions](../interfaces/iproposalqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Proposal](proposal.md)[]›* *Inherited from [SchemeBase](schemebase.md).[proposals](schemebase.md#proposals)* -*Defined in [schemes/base.ts:467](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L467)* +*Defined in [schemes/base.ts:467](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L467)* **Parameters:** @@ -237,7 +252,7 @@ ___ ▸ **redeemSuggestion**(`options`: object): *[Operation](../globals.md#operation)‹boolean›* -*Defined in [schemes/competition.ts:324](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L324)* +*Defined in [schemes/competition.ts:347](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L347)* **Parameters:** @@ -258,7 +273,7 @@ ___ *Inherited from [SchemeBase](schemebase.md).[setStaticState](schemebase.md#setstaticstate)* -*Defined in [schemes/base.ts:279](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L279)* +*Defined in [schemes/base.ts:279](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L279)* **Parameters:** @@ -276,7 +291,7 @@ ___ *Overrides [SchemeBase](schemebase.md).[state](schemebase.md#abstract-state)* -*Defined in [schemes/competition.ts:83](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L83)* +*Defined in [schemes/competition.ts:82](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L82)* **Parameters:** @@ -292,7 +307,11 @@ ___ ▸ **voteSuggestion**(`options`: object): *[Operation](../globals.md#operation)‹[CompetitionVote](competitionvote.md)›* -*Defined in [schemes/competition.ts:275](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L275)* +*Defined in [schemes/competition.ts:296](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L296)* + +Vote for the suggestion that is, in the current scheme, identified by suggestionId + +**`memberof`** CompetitionScheme **Parameters:** @@ -312,7 +331,7 @@ ___ *Inherited from [SchemeBase](schemebase.md).[x](schemebase.md#x)* -*Defined in [schemes/base.ts:319](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L319)* +*Defined in [schemes/base.ts:319](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L319)* **Returns:** *void* @@ -324,7 +343,7 @@ ___ *Inherited from [SchemeBase](schemebase.md).[fragments](schemebase.md#static-fragments)* -*Defined in [schemes/base.ts:106](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L106)* +*Defined in [schemes/base.ts:106](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L106)* ### SchemeFields @@ -457,4 +476,4 @@ ___ version }` -*Defined in [schemes/base.ts:107](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L107)* +*Defined in [schemes/base.ts:107](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L107)* diff --git a/docs/classes/competitionsuggestion.md b/docs/classes/competitionsuggestion.md index 17909f32..d7cb0f15 100644 --- a/docs/classes/competitionsuggestion.md +++ b/docs/classes/competitionsuggestion.md @@ -22,6 +22,8 @@ ### Methods * [fetchStaticState](competitionsuggestion.md#fetchstaticstate) +* [getPosition](competitionsuggestion.md#getposition) +* [isWinner](competitionsuggestion.md#iswinner) * [redeem](competitionsuggestion.md#redeem) * [setStaticState](competitionsuggestion.md#setstaticstate) * [state](competitionsuggestion.md#state) @@ -39,15 +41,15 @@ ### constructor -\+ **new CompetitionSuggestion**(`idOrOpts`: string | object | [ICompetitionSuggestion](../interfaces/icompetitionsuggestion.md), `context`: [Arc](arc.md)): *[CompetitionSuggestion](competitionsuggestion.md)* +\+ **new CompetitionSuggestion**(`idOrOpts`: string | object | [ICompetitionSuggestionState](../interfaces/icompetitionsuggestionstate.md), `context`: [Arc](arc.md)): *[CompetitionSuggestion](competitionsuggestion.md)* -*Defined in [schemes/competition.ts:585](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L585)* +*Defined in [schemes/competition.ts:616](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L616)* **Parameters:** Name | Type | ------ | ------ | -`idOrOpts` | string | object | [ICompetitionSuggestion](../interfaces/icompetitionsuggestion.md) | +`idOrOpts` | string | object | [ICompetitionSuggestionState](../interfaces/icompetitionsuggestionstate.md) | `context` | [Arc](arc.md) | **Returns:** *[CompetitionSuggestion](competitionsuggestion.md)* @@ -58,7 +60,7 @@ Name | Type | • **context**: *[Arc](arc.md)* -*Defined in [schemes/competition.ts:587](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L587)* +*Defined in [schemes/competition.ts:620](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L620)* ___ @@ -66,15 +68,15 @@ ___ • **id**: *string* -*Defined in [schemes/competition.ts:583](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L583)* +*Defined in [schemes/competition.ts:614](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L614)* ___ ### `Optional` staticState -• **staticState**? : *[ICompetitionSuggestion](../interfaces/icompetitionsuggestion.md)* +• **staticState**? : *[ICompetitionSuggestionState](../interfaces/icompetitionsuggestionstate.md)* -*Defined in [schemes/competition.ts:585](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L585)* +*Defined in [schemes/competition.ts:616](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L616)* ___ @@ -82,17 +84,37 @@ ___ • **suggestionId**? : *undefined | number* -*Defined in [schemes/competition.ts:584](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L584)* +*Defined in [schemes/competition.ts:615](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L615)* ## Methods ### fetchStaticState -▸ **fetchStaticState**(): *Promise‹[ICompetitionSuggestion](../interfaces/icompetitionsuggestion.md)›* +▸ **fetchStaticState**(): *Promise‹[ICompetitionSuggestionState](../interfaces/icompetitionsuggestionstate.md)›* -*Defined in [schemes/competition.ts:609](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L609)* +*Defined in [schemes/competition.ts:643](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L643)* -**Returns:** *Promise‹[ICompetitionSuggestion](../interfaces/icompetitionsuggestion.md)›* +**Returns:** *Promise‹[ICompetitionSuggestionState](../interfaces/icompetitionsuggestionstate.md)›* + +___ + +### getPosition + +▸ **getPosition**(): *Promise‹null | number›* + +*Defined in [schemes/competition.ts:681](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L681)* + +**Returns:** *Promise‹null | number›* + +___ + +### isWinner + +▸ **isWinner**(): *Promise‹boolean›* + +*Defined in [schemes/competition.ts:687](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L687)* + +**Returns:** *Promise‹boolean›* ___ @@ -100,7 +122,7 @@ ___ ▸ **redeem**(`beneficiary`: [Address](../globals.md#address)): *[Operation](../globals.md#operation)‹boolean›* -*Defined in [schemes/competition.ts:647](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L647)* +*Defined in [schemes/competition.ts:693](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L693)* **Parameters:** @@ -114,15 +136,15 @@ ___ ### setStaticState -▸ **setStaticState**(`opts`: [ICompetitionSuggestion](../interfaces/icompetitionsuggestion.md)): *void* +▸ **setStaticState**(`opts`: [ICompetitionSuggestionState](../interfaces/icompetitionsuggestionstate.md)): *void* -*Defined in [schemes/competition.ts:605](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L605)* +*Defined in [schemes/competition.ts:639](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L639)* **Parameters:** Name | Type | ------ | ------ | -`opts` | [ICompetitionSuggestion](../interfaces/icompetitionsuggestion.md) | +`opts` | [ICompetitionSuggestionState](../interfaces/icompetitionsuggestionstate.md) | **Returns:** *void* @@ -130,9 +152,9 @@ ___ ### state -▸ **state**(`apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[ICompetitionSuggestion](../interfaces/icompetitionsuggestion.md)›* +▸ **state**(`apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[ICompetitionSuggestionState](../interfaces/icompetitionsuggestionstate.md)›* -*Defined in [schemes/competition.ts:613](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L613)* +*Defined in [schemes/competition.ts:647](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L647)* **Parameters:** @@ -140,7 +162,7 @@ Name | Type | Default | ------ | ------ | ------ | `apolloQueryOptions` | [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md) | {} | -**Returns:** *Observable‹[ICompetitionSuggestion](../interfaces/icompetitionsuggestion.md)›* +**Returns:** *Observable‹[ICompetitionSuggestionState](../interfaces/icompetitionsuggestionstate.md)›* ___ @@ -148,7 +170,7 @@ ___ ▸ **vote**(): *[Operation](../globals.md#operation)‹[CompetitionVote](competitionvote.md)›* -*Defined in [schemes/competition.ts:627](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L627)* +*Defined in [schemes/competition.ts:661](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L661)* **Returns:** *[Operation](../globals.md#operation)‹[CompetitionVote](competitionvote.md)›* @@ -158,7 +180,7 @@ ___ ▸ **votes**(`options`: [ICompetitionVoteQueryOptions](../interfaces/icompetitionvotequeryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[CompetitionVote](competitionvote.md)[]›* -*Defined in [schemes/competition.ts:638](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L638)* +*Defined in [schemes/competition.ts:672](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L672)* **Parameters:** @@ -175,7 +197,7 @@ ___ ▸ **calculateId**(`opts`: object): *string* -*Defined in [schemes/competition.ts:516](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L516)* +*Defined in [schemes/competition.ts:547](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L547)* **Parameters:** @@ -192,9 +214,9 @@ ___ ### `Static` `Private` mapItemToObject -▸ **mapItemToObject**(`item`: any, `context`: [Arc](arc.md)): *[ICompetitionSuggestion](../interfaces/icompetitionsuggestion.md) | null* +▸ **mapItemToObject**(`item`: any, `context`: [Arc](arc.md)): *[ICompetitionSuggestionState](../interfaces/icompetitionsuggestionstate.md) | null* -*Defined in [schemes/competition.ts:557](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L557)* +*Defined in [schemes/competition.ts:581](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L581)* **Parameters:** @@ -203,7 +225,7 @@ Name | Type | `item` | any | `context` | [Arc](arc.md) | -**Returns:** *[ICompetitionSuggestion](../interfaces/icompetitionsuggestion.md) | null* +**Returns:** *[ICompetitionSuggestionState](../interfaces/icompetitionsuggestionstate.md) | null* ___ @@ -211,7 +233,7 @@ ___ ▸ **search**(`context`: [Arc](arc.md), `options`: [ICompetitionSuggestionQueryOptions](../interfaces/icompetitionsuggestionqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[CompetitionSuggestion](competitionsuggestion.md)[]›* -*Defined in [schemes/competition.ts:524](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L524)* +*Defined in [schemes/competition.ts:555](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L555)* **Parameters:** @@ -229,7 +251,7 @@ Name | Type | Default | ### ▪ **fragments**: *object* -*Defined in [schemes/competition.ts:495](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L495)* +*Defined in [schemes/competition.ts:522](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L522)* ### CompetitionSuggestionFields @@ -243,6 +265,9 @@ Name | Type | Default | title description url + tags { + id + } # fulltext: [string] suggester # votes: [CompetitionVote!] @derivedFrom(field: "suggestion") @@ -250,6 +275,7 @@ Name | Type | Default | createdAt redeemedAt rewardPercentage + positionInWinnerList }` -*Defined in [schemes/competition.ts:496](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L496)* +*Defined in [schemes/competition.ts:523](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L523)* diff --git a/docs/classes/competitionvote.md b/docs/classes/competitionvote.md index 2b932160..5fe441a9 100644 --- a/docs/classes/competitionvote.md +++ b/docs/classes/competitionvote.md @@ -21,7 +21,6 @@ ### Methods * [setStaticState](competitionvote.md#setstaticstate) -* [calculateId](competitionvote.md#static-calculateid) * [search](competitionvote.md#static-search) ### Object literals @@ -32,15 +31,15 @@ ### constructor -\+ **new CompetitionVote**(`idOrOpts`: string | [ICompetitionVote](../interfaces/icompetitionvote.md), `context`: [Arc](arc.md)): *[CompetitionVote](competitionvote.md)* +\+ **new CompetitionVote**(`idOrOpts`: string | [ICompetitionVoteState](../interfaces/icompetitionvotestate.md), `context`: [Arc](arc.md)): *[CompetitionVote](competitionvote.md)* -*Defined in [schemes/competition.ts:715](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L715)* +*Defined in [schemes/competition.ts:757](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L757)* **Parameters:** Name | Type | ------ | ------ | -`idOrOpts` | string | [ICompetitionVote](../interfaces/icompetitionvote.md) | +`idOrOpts` | string | [ICompetitionVoteState](../interfaces/icompetitionvotestate.md) | `context` | [Arc](arc.md) | **Returns:** *[CompetitionVote](competitionvote.md)* @@ -51,7 +50,7 @@ Name | Type | • **context**: *[Arc](arc.md)* -*Defined in [schemes/competition.ts:717](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L717)* +*Defined in [schemes/competition.ts:759](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L759)* ___ @@ -59,58 +58,39 @@ ___ • **id**? : *undefined | string* -*Defined in [schemes/competition.ts:714](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L714)* +*Defined in [schemes/competition.ts:756](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L756)* ___ ### `Optional` staticState -• **staticState**? : *[ICompetitionVote](../interfaces/icompetitionvote.md)* +• **staticState**? : *[ICompetitionVoteState](../interfaces/icompetitionvotestate.md)* -*Defined in [schemes/competition.ts:715](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L715)* +*Defined in [schemes/competition.ts:757](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L757)* ## Methods ### setStaticState -▸ **setStaticState**(`opts`: [ICompetitionVote](../interfaces/icompetitionvote.md)): *void* +▸ **setStaticState**(`opts`: [ICompetitionVoteState](../interfaces/icompetitionvotestate.md)): *void* -*Defined in [schemes/competition.ts:727](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L727)* +*Defined in [schemes/competition.ts:769](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L769)* **Parameters:** Name | Type | ------ | ------ | -`opts` | [ICompetitionVote](../interfaces/icompetitionvote.md) | +`opts` | [ICompetitionVoteState](../interfaces/icompetitionvotestate.md) | **Returns:** *void* ___ -### `Static` calculateId - -▸ **calculateId**(`opts`: object): *string* - -*Defined in [schemes/competition.ts:677](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L677)* - -**Parameters:** - -▪ **opts**: *object* - -Name | Type | ------- | ------ | -`scheme` | [Address](../globals.md#address) | -`suggestionId` | number | - -**Returns:** *string* - -___ - ### `Static` search ▸ **search**(`context`: [Arc](arc.md), `options`: [ICompetitionVoteQueryOptions](../interfaces/icompetitionvotequeryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[CompetitionVote](competitionvote.md)[]›* -*Defined in [schemes/competition.ts:685](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L685)* +*Defined in [schemes/competition.ts:727](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L727)* **Parameters:** @@ -128,7 +108,7 @@ Name | Type | Default | ### ▪ **fragments**: *object* -*Defined in [schemes/competition.ts:669](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L669)* +*Defined in [schemes/competition.ts:716](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L716)* ### CompetitionVoteFields @@ -137,6 +117,8 @@ Name | Type | Default | createdAt reputation voter + proposal { id } + suggestion { id } }` -*Defined in [schemes/competition.ts:670](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L670)* +*Defined in [schemes/competition.ts:717](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L717)* diff --git a/docs/classes/dao.md b/docs/classes/dao.md index c01b6842..7c5100c2 100644 --- a/docs/classes/dao.md +++ b/docs/classes/dao.md @@ -51,7 +51,7 @@ \+ **new DAO**(`idOrOpts`: [Address](../globals.md#address) | [IDAOStaticState](../interfaces/idaostaticstate.md), `context`: [Arc](arc.md)): *[DAO](dao.md)* -*Defined in [dao.ts:136](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L136)* +*Defined in [dao.ts:136](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L136)* **Parameters:** @@ -68,7 +68,7 @@ Name | Type | • **context**: *[Arc](arc.md)* -*Defined in [dao.ts:138](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L138)* +*Defined in [dao.ts:138](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L138)* ___ @@ -76,7 +76,7 @@ ___ • **id**: *[Address](../globals.md#address)* -*Defined in [dao.ts:135](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L135)* +*Defined in [dao.ts:135](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L135)* ___ @@ -84,7 +84,7 @@ ___ • **staticState**: *[IDAOStaticState](../interfaces/idaostaticstate.md) | undefined* -*Defined in [dao.ts:136](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L136)* +*Defined in [dao.ts:136](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L136)* ## Methods @@ -92,7 +92,7 @@ ___ ▸ **createProposal**(`options`: [IProposalCreateOptions](../globals.md#iproposalcreateoptions)): *[IOperationObservable](../interfaces/ioperationobservable.md)‹[ITransactionUpdate](../interfaces/itransactionupdate.md)‹[Proposal](proposal.md)‹›››* -*Defined in [dao.ts:270](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L270)* +*Defined in [dao.ts:270](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L270)* create a new proposal in this DAO @@ -112,7 +112,7 @@ ___ ▸ **ethBalance**(): *Observable‹BN›* -*Defined in [dao.ts:343](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L343)* +*Defined in [dao.ts:343](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L343)* get (an observable of) the Ether balance of the DAO from the web3Provider @@ -126,7 +126,7 @@ ___ ▸ **fetchStaticState**(): *Promise‹[IDAOStaticState](../interfaces/idaostaticstate.md)›* -*Defined in [dao.ts:151](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L151)* +*Defined in [dao.ts:151](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L151)* **Returns:** *Promise‹[IDAOStaticState](../interfaces/idaostaticstate.md)›* @@ -136,7 +136,7 @@ ___ ▸ **member**(`address`: [Address](../globals.md#address)): *[Member](member.md)* -*Defined in [dao.ts:255](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L255)* +*Defined in [dao.ts:255](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L255)* **Parameters:** @@ -152,7 +152,7 @@ ___ ▸ **members**(`options`: [IMemberQueryOptions](../interfaces/imemberqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Member](member.md)[]›* -*Defined in [dao.ts:246](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L246)* +*Defined in [dao.ts:246](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L246)* **Parameters:** @@ -169,7 +169,7 @@ ___ ▸ **nativeReputation**(): *Observable‹[Reputation](reputation.md)›* -*Defined in [dao.ts:225](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L225)* +*Defined in [dao.ts:225](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L225)* **Returns:** *Observable‹[Reputation](reputation.md)›* @@ -179,7 +179,7 @@ ___ ▸ **proposal**(`proposalId`: string): *[Proposal](proposal.md)* -*Defined in [dao.ts:307](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L307)* +*Defined in [dao.ts:307](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L307)* **Parameters:** @@ -195,7 +195,7 @@ ___ ▸ **proposals**(`options`: [IProposalQueryOptions](../interfaces/iproposalqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Proposal](proposal.md)[]›* -*Defined in [dao.ts:296](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L296)* +*Defined in [dao.ts:296](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L296)* **Parameters:** @@ -212,7 +212,7 @@ ___ ▸ **rewards**(`options`: [IRewardQueryOptions](../interfaces/irewardqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Reward](reward.md)[]›* -*Defined in [dao.ts:311](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L311)* +*Defined in [dao.ts:311](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L311)* **Parameters:** @@ -229,7 +229,7 @@ ___ ▸ **scheme**(`options`: ISchemeQueryOptions): *Promise‹[Scheme](scheme.md)›* -*Defined in [dao.ts:238](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L238)* +*Defined in [dao.ts:238](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L238)* **Parameters:** @@ -245,7 +245,7 @@ ___ ▸ **schemes**(`options`: ISchemeQueryOptions, `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Scheme](scheme.md)[]›* -*Defined in [dao.ts:229](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L229)* +*Defined in [dao.ts:229](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L229)* **Parameters:** @@ -262,7 +262,7 @@ ___ ▸ **setStaticState**(`opts`: [IDAOStaticState](../interfaces/idaostaticstate.md)): *void* -*Defined in [dao.ts:147](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L147)* +*Defined in [dao.ts:147](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L147)* **Parameters:** @@ -278,7 +278,7 @@ ___ ▸ **stakes**(`options`: [IStakeQueryOptions](../interfaces/istakequeryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Stake](stake.md)[]›* -*Defined in [dao.ts:329](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L329)* +*Defined in [dao.ts:329](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L329)* **Parameters:** @@ -295,7 +295,7 @@ ___ ▸ **state**(`apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[IDAOState](../interfaces/idaostate.md)›* -*Defined in [dao.ts:175](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L175)* +*Defined in [dao.ts:175](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L175)* get the current state of the DAO @@ -315,7 +315,7 @@ ___ ▸ **votes**(`options`: [IVoteQueryOptions](../interfaces/ivotequeryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Vote](vote.md)[]›* -*Defined in [dao.ts:320](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L320)* +*Defined in [dao.ts:320](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L320)* **Parameters:** @@ -332,7 +332,7 @@ ___ ▸ **search**(`context`: [Arc](arc.md), `options`: [IDAOQueryOptions](../interfaces/idaoqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[DAO](dao.md)[]›* -*Defined in [dao.ts:71](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L71)* +*Defined in [dao.ts:71](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L71)* DAO.search(context, options) searches for DAO entities @@ -354,7 +354,7 @@ an observable of DAO objects ### ▪ **fragments**: *object* -*Defined in [dao.ts:50](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L50)* +*Defined in [dao.ts:50](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L50)* ### DAOFields @@ -371,4 +371,4 @@ an observable of DAO objects reputationHoldersCount }` -*Defined in [dao.ts:51](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L51)* +*Defined in [dao.ts:51](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L51)* diff --git a/docs/classes/event.md b/docs/classes/event.md index 9354b13e..c2c6cefc 100644 --- a/docs/classes/event.md +++ b/docs/classes/event.md @@ -40,7 +40,7 @@ \+ **new Event**(`idOrOpts`: string | [IEventStaticState](../interfaces/ieventstaticstate.md), `context`: [Arc](arc.md)): *[Event](event.md)* -*Defined in [event.ts:90](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L90)* +*Defined in [event.ts:90](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L90)* **Parameters:** @@ -57,7 +57,7 @@ Name | Type | • **context**: *[Arc](arc.md)* -*Defined in [event.ts:92](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L92)* +*Defined in [event.ts:92](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L92)* ___ @@ -65,7 +65,7 @@ ___ • **id**: *string* -*Defined in [event.ts:89](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L89)* +*Defined in [event.ts:89](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L89)* ___ @@ -73,7 +73,7 @@ ___ • **idOrOpts**: *string | [IEventStaticState](../interfaces/ieventstaticstate.md)* -*Defined in [event.ts:92](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L92)* +*Defined in [event.ts:92](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L92)* ___ @@ -81,7 +81,7 @@ ___ • **staticState**: *[IEventStaticState](../interfaces/ieventstaticstate.md) | undefined* -*Defined in [event.ts:90](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L90)* +*Defined in [event.ts:90](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L90)* ## Methods @@ -89,7 +89,7 @@ ___ ▸ **fetchStaticState**(): *Promise‹[IEventStaticState](../interfaces/ieventstaticstate.md)›* -*Defined in [event.ts:135](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L135)* +*Defined in [event.ts:135](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L135)* **Returns:** *Promise‹[IEventStaticState](../interfaces/ieventstaticstate.md)›* @@ -99,7 +99,7 @@ ___ ▸ **setStaticState**(`opts`: [IEventStaticState](../interfaces/ieventstaticstate.md)): *void* -*Defined in [event.ts:131](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L131)* +*Defined in [event.ts:131](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L131)* **Parameters:** @@ -115,7 +115,7 @@ ___ ▸ **state**(`apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[IEventState](../interfaces/ieventstate.md)›* -*Defined in [event.ts:102](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L102)* +*Defined in [event.ts:102](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L102)* **Parameters:** @@ -131,7 +131,7 @@ ___ ▸ **search**(`context`: [Arc](arc.md), `options`: [IEventQueryOptions](../interfaces/ieventqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Event](event.md)[]›* -*Defined in [event.ts:56](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L56)* +*Defined in [event.ts:56](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L56)* Event.search(context, options) searches for reward entities @@ -153,7 +153,7 @@ an observable of Event objects ### ▪ **fragments**: *object* -*Defined in [event.ts:34](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L34)* +*Defined in [event.ts:34](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L34)* ### EventFields @@ -171,4 +171,4 @@ an observable of Event objects timestamp }` -*Defined in [event.ts:35](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L35)* +*Defined in [event.ts:35](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L35)* diff --git a/docs/classes/graphnodeobserver.md b/docs/classes/graphnodeobserver.md index 4160e507..a24b9ef7 100644 --- a/docs/classes/graphnodeobserver.md +++ b/docs/classes/graphnodeobserver.md @@ -40,7 +40,7 @@ handles connections with the Graph \+ **new GraphNodeObserver**(`options`: object): *[GraphNodeObserver](graphnodeobserver.md)* -*Defined in [graphnode.ts:119](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L119)* +*Defined in [graphnode.ts:119](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L119)* **Parameters:** @@ -60,7 +60,7 @@ Name | Type | • **Logger**: *GlobalLogger* = Logger -*Defined in [graphnode.ts:117](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L117)* +*Defined in [graphnode.ts:117](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L117)* ___ @@ -68,7 +68,7 @@ ___ • **apolloClient**? : *ApolloClient‹object›* -*Defined in [graphnode.ts:118](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L118)* +*Defined in [graphnode.ts:118](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L118)* ___ @@ -76,7 +76,7 @@ ___ • **graphqlHttpProvider**? : *undefined | string* -*Defined in [graphnode.ts:115](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L115)* +*Defined in [graphnode.ts:115](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L115)* ___ @@ -84,7 +84,7 @@ ___ • **graphqlSubscribeToQueries**? : *undefined | false | true* -*Defined in [graphnode.ts:119](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L119)* +*Defined in [graphnode.ts:119](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L119)* ___ @@ -92,7 +92,7 @@ ___ • **graphqlWsProvider**? : *undefined | string* -*Defined in [graphnode.ts:116](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L116)* +*Defined in [graphnode.ts:116](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L116)* ## Methods @@ -100,7 +100,7 @@ ___ ▸ **getObservable**(`query`: any, `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *any* -*Defined in [graphnode.ts:145](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L145)* +*Defined in [graphnode.ts:145](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L145)* Given a gql query, will return an observable of query results @@ -121,7 +121,7 @@ ___ ▸ **getObservableList**(`query`: any, `itemMap`: function, `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *any* -*Defined in [graphnode.ts:246](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L246)* +*Defined in [graphnode.ts:246](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L246)* Returns an observable that: - sends a query over http and returns the current list of results @@ -169,7 +169,7 @@ ___ ▸ **getObservableListWithFilter**(`query`: any, `itemMap`: function, `filterFunc`: function, `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *any* -*Defined in [graphnode.ts:285](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L285)* +*Defined in [graphnode.ts:285](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L285)* Returns an observable that: - sends a query over http and returns the current list of results @@ -222,7 +222,7 @@ ___ ▸ **getObservableObject**(`query`: any, `itemMap`: function, `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *any* -*Defined in [graphnode.ts:302](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L302)* +*Defined in [graphnode.ts:302](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L302)* **Parameters:** @@ -248,7 +248,7 @@ ___ ▸ **sendQuery**(`query`: any, `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Promise‹object›* -*Defined in [graphnode.ts:322](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L322)* +*Defined in [graphnode.ts:322](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L322)* **Parameters:** diff --git a/docs/classes/member.md b/docs/classes/member.md index b1fdd201..aa7ab1f4 100644 --- a/docs/classes/member.md +++ b/docs/classes/member.md @@ -47,7 +47,7 @@ Represents an account that holds reputaion in a specific DAO \+ **new Member**(`idOrOpts`: string | [IMemberStaticState](../interfaces/imemberstaticstate.md), `context`: [Arc](arc.md)): *[Member](member.md)* -*Defined in [member.ts:107](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L107)* +*Defined in [member.ts:107](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L107)* **Parameters:** @@ -64,7 +64,7 @@ Name | Type | Description | • **context**: *[Arc](arc.md)* -*Defined in [member.ts:114](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L114)* +*Defined in [member.ts:114](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L114)* an instance of Arc @@ -74,7 +74,7 @@ ___ • **id**: *string | undefined* -*Defined in [member.ts:106](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L106)* +*Defined in [member.ts:106](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L106)* ___ @@ -82,7 +82,7 @@ ___ • **staticState**: *[IMemberStaticState](../interfaces/imemberstaticstate.md) | undefined* -*Defined in [member.ts:107](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L107)* +*Defined in [member.ts:107](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L107)* ## Methods @@ -90,7 +90,7 @@ ___ ▸ **calculateId**(`opts`: object): *string* -*Defined in [member.ts:136](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L136)* +*Defined in [member.ts:136](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L136)* **Parameters:** @@ -109,7 +109,7 @@ ___ ▸ **dao**(): *Promise‹[DAO](dao.md)›* -*Defined in [member.ts:231](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L231)* +*Defined in [member.ts:231](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L231)* **Returns:** *Promise‹[DAO](dao.md)›* @@ -119,7 +119,7 @@ ___ ▸ **fetchStaticState**(): *Promise‹[IMemberStaticState](../interfaces/imemberstaticstate.md)›* -*Defined in [member.ts:123](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L123)* +*Defined in [member.ts:123](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L123)* **Returns:** *Promise‹[IMemberStaticState](../interfaces/imemberstaticstate.md)›* @@ -129,7 +129,7 @@ ___ ▸ **proposals**(`options`: [IProposalQueryOptions](../interfaces/iproposalqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Proposal](proposal.md)[]›* -*Defined in [member.ts:240](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L240)* +*Defined in [member.ts:240](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L240)* **Parameters:** @@ -146,7 +146,7 @@ ___ ▸ **rewards**(): *Observable‹[Reward](reward.md)[]›* -*Defined in [member.ts:236](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L236)* +*Defined in [member.ts:236](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L236)* **Returns:** *Observable‹[Reward](reward.md)[]›* @@ -156,7 +156,7 @@ ___ ▸ **setStaticState**(`opts`: [IMemberStaticState](../interfaces/imemberstaticstate.md)): *[IMemberStaticState](../interfaces/imemberstaticstate.md)* -*Defined in [member.ts:143](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L143)* +*Defined in [member.ts:143](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L143)* **Parameters:** @@ -172,7 +172,7 @@ ___ ▸ **stakes**(`options`: [IStakeQueryOptions](../interfaces/istakequeryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Stake](stake.md)[]›* -*Defined in [member.ts:256](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L256)* +*Defined in [member.ts:256](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L256)* **Parameters:** @@ -189,7 +189,7 @@ ___ ▸ **state**(`apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[IMemberState](../interfaces/imemberstate.md)›* -*Defined in [member.ts:158](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L158)* +*Defined in [member.ts:158](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L158)* **Parameters:** @@ -205,7 +205,7 @@ ___ ▸ **votes**(`options`: [IVoteQueryOptions](../interfaces/ivotequeryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Vote](vote.md)[]›* -*Defined in [member.ts:269](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L269)* +*Defined in [member.ts:269](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L269)* **Parameters:** @@ -222,7 +222,7 @@ ___ ▸ **search**(`context`: [Arc](arc.md), `options`: [IMemberQueryOptions](../interfaces/imemberqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Member](member.md)[]›* -*Defined in [member.ts:64](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L64)* +*Defined in [member.ts:64](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L64)* Member.search(context, options) searches for member entities @@ -244,7 +244,7 @@ an observable of IRewardState objects ### ▪ **fragments**: *object* -*Defined in [member.ts:44](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L44)* +*Defined in [member.ts:44](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L44)* ### ReputationHolderFields @@ -260,4 +260,4 @@ an observable of IRewardState objects } ` -*Defined in [member.ts:45](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L45)* +*Defined in [member.ts:45](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L45)* diff --git a/docs/classes/proposal.md b/docs/classes/proposal.md index 67a8722f..37e5c498 100644 --- a/docs/classes/proposal.md +++ b/docs/classes/proposal.md @@ -50,7 +50,7 @@ \+ **new Proposal**(`idOrOpts`: string | [IProposalStaticState](../interfaces/iproposalstaticstate.md), `context`: [Arc](arc.md)): *[Proposal](proposal.md)* -*Defined in [proposal.ts:327](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L327)* +*Defined in [proposal.ts:328](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L328)* **Parameters:** @@ -67,7 +67,7 @@ Name | Type | • **context**: *[Arc](arc.md)* -*Defined in [proposal.ts:325](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L325)* +*Defined in [proposal.ts:326](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L326)* ___ @@ -75,7 +75,7 @@ ___ • **id**: *string* -*Defined in [proposal.ts:326](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L326)* +*Defined in [proposal.ts:327](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L327)* ___ @@ -83,7 +83,7 @@ ___ • **staticState**: *[IProposalStaticState](../interfaces/iproposalstaticstate.md) | undefined* -*Defined in [proposal.ts:327](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L327)* +*Defined in [proposal.ts:328](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L328)* ## Methods @@ -91,7 +91,7 @@ ___ ▸ **claimRewards**(`beneficiary?`: [Address](../globals.md#address)): *[Operation](../globals.md#operation)‹boolean›* -*Defined in [proposal.ts:754](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L754)* +*Defined in [proposal.ts:764](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L764)* [claimRewards description] Execute the proposal and distribute the rewards to the beneficiary. @@ -113,7 +113,7 @@ ___ ▸ **execute**(): *[Operation](../globals.md#operation)‹any›* -*Defined in [proposal.ts:798](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L798)* +*Defined in [proposal.ts:808](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L808)* calll the 'execute()' function on the votingMachine. the main purpose of this function is to set the stage of the proposals @@ -129,7 +129,7 @@ ___ ▸ **fetchStaticState**(): *Promise‹[IProposalStaticState](../interfaces/iproposalstaticstate.md)›* -*Defined in [proposal.ts:345](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L345)* +*Defined in [proposal.ts:346](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L346)* **Returns:** *Promise‹[IProposalStaticState](../interfaces/iproposalstaticstate.md)›* @@ -139,7 +139,7 @@ ___ ▸ **redeemerContract**(): *any* -*Defined in [proposal.ts:581](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L581)* +*Defined in [proposal.ts:582](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L582)* [redeemerContract description] @@ -153,7 +153,7 @@ ___ ▸ **rewards**(`options`: [IRewardQueryOptions](../interfaces/irewardqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Reward](reward.md)[]›* -*Defined in [proposal.ts:737](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L737)* +*Defined in [proposal.ts:747](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L747)* **Parameters:** @@ -170,7 +170,7 @@ ___ ▸ **scheme**(): *Promise‹any›* -*Defined in [proposal.ts:564](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L564)* +*Defined in [proposal.ts:565](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L565)* **Returns:** *Promise‹any›* @@ -182,7 +182,7 @@ ___ ▸ **setStaticState**(`opts`: [IProposalStaticState](../interfaces/iproposalstaticstate.md)): *void* -*Defined in [proposal.ts:341](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L341)* +*Defined in [proposal.ts:342](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L342)* **Parameters:** @@ -198,7 +198,7 @@ ___ ▸ **stake**(`outcome`: [IProposalOutcome](../enums/iproposaloutcome.md), `amount`: BN): *[Operation](../globals.md#operation)‹[Stake](stake.md)›* -*Defined in [proposal.ts:671](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L671)* +*Defined in [proposal.ts:674](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L674)* Stake on this proposal @@ -207,7 +207,7 @@ Stake on this proposal Name | Type | Description | ------ | ------ | ------ | `outcome` | [IProposalOutcome](../enums/iproposaloutcome.md) | the outcome that is staked on, of type IProposalOutcome | -`amount` | BN | the amount, in GEn, to stake | +`amount` | BN | the amount, in GEN, to stake | **Returns:** *[Operation](../globals.md#operation)‹[Stake](stake.md)›* @@ -219,7 +219,7 @@ ___ ▸ **stakes**(`options`: [IStakeQueryOptions](../interfaces/istakequeryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Stake](stake.md)[]›* -*Defined in [proposal.ts:659](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L659)* +*Defined in [proposal.ts:662](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L662)* **Parameters:** @@ -236,7 +236,7 @@ ___ ▸ **stakingToken**(): *[Token](token.md)‹›* -*Defined in [proposal.ts:655](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L655)* +*Defined in [proposal.ts:658](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L658)* **Returns:** *[Token](token.md)‹›* @@ -246,7 +246,7 @@ ___ ▸ **state**(`apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[IProposalState](../interfaces/iproposalstate.md)›* -*Defined in [proposal.ts:367](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L367)* +*Defined in [proposal.ts:368](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L368)* `state` is an observable of the proposal state @@ -264,7 +264,7 @@ ___ ▸ **vote**(`outcome`: [IProposalOutcome](../enums/iproposaloutcome.md), `amount`: number): *[Operation](../globals.md#operation)‹[Vote](vote.md) | null›* -*Defined in [proposal.ts:603](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L603)* +*Defined in [proposal.ts:604](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L604)* Vote for this proposal @@ -285,7 +285,7 @@ ___ ▸ **votes**(`options`: [IVoteQueryOptions](../interfaces/ivotequeryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Vote](vote.md)[]›* -*Defined in [proposal.ts:590](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L590)* +*Defined in [proposal.ts:591](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L591)* **Parameters:** @@ -302,7 +302,7 @@ ___ ▸ **votingMachine**(): *Promise‹any›* -*Defined in [proposal.ts:573](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L573)* +*Defined in [proposal.ts:574](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L574)* [votingMachine description] @@ -316,7 +316,7 @@ ___ ▸ **search**(`context`: [Arc](arc.md), `options`: [IProposalQueryOptions](../interfaces/iproposalqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Proposal](proposal.md)[]›* -*Defined in [proposal.ts:236](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L236)* +*Defined in [proposal.ts:237](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L237)* Search for proposals @@ -341,7 +341,7 @@ For example: ### ▪ **fragments**: *object* -*Defined in [proposal.ts:111](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L111)* +*Defined in [proposal.ts:111](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L111)* ### ProposalFields @@ -402,6 +402,7 @@ For example: returnValue } genesisProtocolParams { + id activationTime boostedVotePeriodLimit daoBountyConst @@ -458,4 +459,4 @@ For example: winningOutcome }` -*Defined in [proposal.ts:112](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L112)* +*Defined in [proposal.ts:112](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L112)* diff --git a/docs/classes/queue.md b/docs/classes/queue.md index 0edd5cf7..80303b4e 100644 --- a/docs/classes/queue.md +++ b/docs/classes/queue.md @@ -33,7 +33,7 @@ \+ **new Queue**(`id`: string, `dao`: [DAO](dao.md), `context`: [Arc](arc.md)): *[Queue](queue.md)* -*Defined in [queue.ts:90](https://github.com/daostack/client/blob/7361fcc/src/queue.ts#L90)* +*Defined in [queue.ts:90](https://github.com/daostack/client/blob/1bc237e/src/queue.ts#L90)* **Parameters:** @@ -51,7 +51,7 @@ Name | Type | • **context**: *[Arc](arc.md)* -*Defined in [queue.ts:95](https://github.com/daostack/client/blob/7361fcc/src/queue.ts#L95)* +*Defined in [queue.ts:95](https://github.com/daostack/client/blob/1bc237e/src/queue.ts#L95)* ___ @@ -59,7 +59,7 @@ ___ • **dao**: *[DAO](dao.md)* -*Defined in [queue.ts:94](https://github.com/daostack/client/blob/7361fcc/src/queue.ts#L94)* +*Defined in [queue.ts:94](https://github.com/daostack/client/blob/1bc237e/src/queue.ts#L94)* ___ @@ -67,7 +67,7 @@ ___ • **id**: *string* -*Defined in [queue.ts:93](https://github.com/daostack/client/blob/7361fcc/src/queue.ts#L93)* +*Defined in [queue.ts:93](https://github.com/daostack/client/blob/1bc237e/src/queue.ts#L93)* ## Methods @@ -75,7 +75,7 @@ ___ ▸ **state**(`apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[IQueueState](../interfaces/iqueuestate.md)›* -*Defined in [queue.ts:100](https://github.com/daostack/client/blob/7361fcc/src/queue.ts#L100)* +*Defined in [queue.ts:100](https://github.com/daostack/client/blob/1bc237e/src/queue.ts#L100)* **Parameters:** @@ -91,7 +91,7 @@ ___ ▸ **search**(`context`: [Arc](arc.md), `options`: [IQueueQueryOptions](../interfaces/iqueuequeryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Queue](queue.md)[]›* -*Defined in [queue.ts:39](https://github.com/daostack/client/blob/7361fcc/src/queue.ts#L39)* +*Defined in [queue.ts:39](https://github.com/daostack/client/blob/1bc237e/src/queue.ts#L39)* Queue.search(context, options) searches for queue entities diff --git a/docs/classes/reputation.md b/docs/classes/reputation.md index a0483322..b5411dbb 100644 --- a/docs/classes/reputation.md +++ b/docs/classes/reputation.md @@ -36,7 +36,7 @@ \+ **new Reputation**(`id`: [Address](../globals.md#address), `context`: [Arc](arc.md)): *[Reputation](reputation.md)* -*Defined in [reputation.ts:67](https://github.com/daostack/client/blob/7361fcc/src/reputation.ts#L67)* +*Defined in [reputation.ts:67](https://github.com/daostack/client/blob/1bc237e/src/reputation.ts#L67)* **Parameters:** @@ -53,7 +53,7 @@ Name | Type | • **address**: *[Address](../globals.md#address)* -*Defined in [reputation.ts:67](https://github.com/daostack/client/blob/7361fcc/src/reputation.ts#L67)* +*Defined in [reputation.ts:67](https://github.com/daostack/client/blob/1bc237e/src/reputation.ts#L67)* ___ @@ -61,7 +61,7 @@ ___ • **context**: *[Arc](arc.md)* -*Defined in [reputation.ts:68](https://github.com/daostack/client/blob/7361fcc/src/reputation.ts#L68)* +*Defined in [reputation.ts:68](https://github.com/daostack/client/blob/1bc237e/src/reputation.ts#L68)* ___ @@ -69,7 +69,7 @@ ___ • **id**: *[Address](../globals.md#address)* -*Defined in [reputation.ts:68](https://github.com/daostack/client/blob/7361fcc/src/reputation.ts#L68)* +*Defined in [reputation.ts:68](https://github.com/daostack/client/blob/1bc237e/src/reputation.ts#L68)* ## Methods @@ -77,7 +77,7 @@ ___ ▸ **contract**(): *any* -*Defined in [reputation.ts:120](https://github.com/daostack/client/blob/7361fcc/src/reputation.ts#L120)* +*Defined in [reputation.ts:120](https://github.com/daostack/client/blob/1bc237e/src/reputation.ts#L120)* **Returns:** *any* @@ -87,7 +87,7 @@ ___ ▸ **mint**(`beneficiary`: [Address](../globals.md#address), `amount`: BN): *[IOperationObservable](../interfaces/ioperationobservable.md)‹[ITransactionUpdate](../interfaces/itransactionupdate.md)‹any››* -*Defined in [reputation.ts:125](https://github.com/daostack/client/blob/7361fcc/src/reputation.ts#L125)* +*Defined in [reputation.ts:125](https://github.com/daostack/client/blob/1bc237e/src/reputation.ts#L125)* **Parameters:** @@ -104,7 +104,7 @@ ___ ▸ **reputationOf**(`address`: [Address](../globals.md#address)): *Observable‹BN›* -*Defined in [reputation.ts:96](https://github.com/daostack/client/blob/7361fcc/src/reputation.ts#L96)* +*Defined in [reputation.ts:96](https://github.com/daostack/client/blob/1bc237e/src/reputation.ts#L96)* **Parameters:** @@ -120,7 +120,7 @@ ___ ▸ **state**(`apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[IReputationState](../interfaces/ireputationstate.md)›* -*Defined in [reputation.ts:72](https://github.com/daostack/client/blob/7361fcc/src/reputation.ts#L72)* +*Defined in [reputation.ts:72](https://github.com/daostack/client/blob/1bc237e/src/reputation.ts#L72)* **Parameters:** @@ -136,7 +136,7 @@ ___ ▸ **search**(`context`: [Arc](arc.md), `options`: [IReputationQueryOptions](../interfaces/ireputationqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Reputation](reputation.md)[]›* -*Defined in [reputation.ts:31](https://github.com/daostack/client/blob/7361fcc/src/reputation.ts#L31)* +*Defined in [reputation.ts:31](https://github.com/daostack/client/blob/1bc237e/src/reputation.ts#L31)* Reputation.search(context, options) searches for reputation entities diff --git a/docs/classes/reputationfromtokenscheme.md b/docs/classes/reputationfromtokenscheme.md index c42a96f6..e5adb175 100644 --- a/docs/classes/reputationfromtokenscheme.md +++ b/docs/classes/reputationfromtokenscheme.md @@ -18,6 +18,7 @@ ### Methods +* [getAgreementHash](reputationfromtokenscheme.md#getagreementhash) * [getContract](reputationfromtokenscheme.md#getcontract) * [redeem](reputationfromtokenscheme.md#redeem) * [redemptionAmount](reputationfromtokenscheme.md#redemptionamount) @@ -28,7 +29,7 @@ \+ **new ReputationFromTokenScheme**(`scheme`: [Scheme](scheme.md)): *[ReputationFromTokenScheme](reputationfromtokenscheme.md)* -*Defined in [schemes/reputationFromToken.ts:13](https://github.com/daostack/client/blob/7361fcc/src/schemes/reputationFromToken.ts#L13)* +*Defined in [schemes/reputationFromToken.ts:13](https://github.com/daostack/client/blob/1bc237e/src/schemes/reputationFromToken.ts#L13)* **Parameters:** @@ -44,15 +45,25 @@ Name | Type | • **scheme**: *[Scheme](scheme.md)* -*Defined in [schemes/reputationFromToken.ts:15](https://github.com/daostack/client/blob/7361fcc/src/schemes/reputationFromToken.ts#L15)* +*Defined in [schemes/reputationFromToken.ts:15](https://github.com/daostack/client/blob/1bc237e/src/schemes/reputationFromToken.ts#L15)* ## Methods +### getAgreementHash + +▸ **getAgreementHash**(): *Promise‹string›* + +*Defined in [schemes/reputationFromToken.ts:19](https://github.com/daostack/client/blob/1bc237e/src/schemes/reputationFromToken.ts#L19)* + +**Returns:** *Promise‹string›* + +___ + ### getContract ▸ **getContract**(): *Promise‹any›* -*Defined in [schemes/reputationFromToken.ts:47](https://github.com/daostack/client/blob/7361fcc/src/schemes/reputationFromToken.ts#L47)* +*Defined in [schemes/reputationFromToken.ts:73](https://github.com/daostack/client/blob/1bc237e/src/schemes/reputationFromToken.ts#L73)* **Returns:** *Promise‹any›* @@ -60,15 +71,16 @@ ___ ### redeem -▸ **redeem**(`beneficiary`: [Address](../globals.md#address)): *[Operation](../globals.md#operation)‹any›* +▸ **redeem**(`beneficiary`: [Address](../globals.md#address), `agreementHash?`: undefined | string): *[Operation](../globals.md#operation)‹any›* -*Defined in [schemes/reputationFromToken.ts:19](https://github.com/daostack/client/blob/7361fcc/src/schemes/reputationFromToken.ts#L19)* +*Defined in [schemes/reputationFromToken.ts:25](https://github.com/daostack/client/blob/1bc237e/src/schemes/reputationFromToken.ts#L25)* **Parameters:** Name | Type | ------ | ------ | `beneficiary` | [Address](../globals.md#address) | +`agreementHash?` | undefined | string | **Returns:** *[Operation](../globals.md#operation)‹any›* @@ -78,7 +90,7 @@ ___ ▸ **redemptionAmount**(`beneficiary`: [Address](../globals.md#address)): *Promise‹number›* -*Defined in [schemes/reputationFromToken.ts:41](https://github.com/daostack/client/blob/7361fcc/src/schemes/reputationFromToken.ts#L41)* +*Defined in [schemes/reputationFromToken.ts:67](https://github.com/daostack/client/blob/1bc237e/src/schemes/reputationFromToken.ts#L67)* **Parameters:** diff --git a/docs/classes/reward.md b/docs/classes/reward.md index ab8e509d..86c5efa6 100644 --- a/docs/classes/reward.md +++ b/docs/classes/reward.md @@ -40,7 +40,7 @@ \+ **new Reward**(`idOrOpts`: string | [IRewardStaticState](../interfaces/irewardstaticstate.md), `context`: [Arc](arc.md)): *[Reward](reward.md)* -*Defined in [reward.ts:155](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L155)* +*Defined in [reward.ts:155](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L155)* **Parameters:** @@ -57,7 +57,7 @@ Name | Type | • **context**: *[Arc](arc.md)* -*Defined in [reward.ts:157](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L157)* +*Defined in [reward.ts:157](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L157)* ___ @@ -65,7 +65,7 @@ ___ • **id**: *string* -*Defined in [reward.ts:154](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L154)* +*Defined in [reward.ts:154](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L154)* ___ @@ -73,7 +73,7 @@ ___ • **idOrOpts**: *string | [IRewardStaticState](../interfaces/irewardstaticstate.md)* -*Defined in [reward.ts:157](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L157)* +*Defined in [reward.ts:157](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L157)* ___ @@ -81,7 +81,7 @@ ___ • **staticState**: *[IRewardStaticState](../interfaces/irewardstaticstate.md) | undefined* -*Defined in [reward.ts:155](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L155)* +*Defined in [reward.ts:155](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L155)* ## Methods @@ -89,7 +89,7 @@ ___ ▸ **fetchStaticState**(): *Promise‹[IRewardStaticState](../interfaces/irewardstaticstate.md)›* -*Defined in [reward.ts:215](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L215)* +*Defined in [reward.ts:215](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L215)* **Returns:** *Promise‹[IRewardStaticState](../interfaces/irewardstaticstate.md)›* @@ -99,7 +99,7 @@ ___ ▸ **setStaticState**(`opts`: [IRewardStaticState](../interfaces/irewardstaticstate.md)): *void* -*Defined in [reward.ts:211](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L211)* +*Defined in [reward.ts:211](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L211)* **Parameters:** @@ -115,7 +115,7 @@ ___ ▸ **state**(`apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[IRewardState](../interfaces/irewardstate.md)›* -*Defined in [reward.ts:167](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L167)* +*Defined in [reward.ts:167](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L167)* **Parameters:** @@ -131,7 +131,7 @@ ___ ▸ **search**(`context`: [Arc](arc.md), `options`: [IRewardQueryOptions](../interfaces/irewardqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Reward](reward.md)[]›* -*Defined in [reward.ts:71](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L71)* +*Defined in [reward.ts:71](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L71)* Reward.search(context, options) searches for reward entities @@ -153,7 +153,7 @@ an observable of Reward objects ### ▪ **fragments**: *object* -*Defined in [reward.ts:42](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L42)* +*Defined in [reward.ts:42](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L42)* ### RewardFields @@ -178,4 +178,4 @@ an observable of Reward objects daoBountyForStakerRedeemedAt }` -*Defined in [reward.ts:43](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L43)* +*Defined in [reward.ts:43](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L43)* diff --git a/docs/classes/scheme.md b/docs/classes/scheme.md index 40b983b7..94191474 100644 --- a/docs/classes/scheme.md +++ b/docs/classes/scheme.md @@ -53,7 +53,7 @@ A Scheme represents a scheme instance that is registered at a DAO *Overrides [SchemeBase](schemebase.md).[constructor](schemebase.md#constructor)* -*Defined in [scheme.ts:259](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L259)* +*Defined in [scheme.ts:259](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L259)* **Parameters:** @@ -72,7 +72,7 @@ Name | Type | *Overrides [SchemeBase](schemebase.md).[ReputationFromToken](schemebase.md#reputationfromtoken)* -*Defined in [scheme.ts:259](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L259)* +*Defined in [scheme.ts:259](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L259)* ___ @@ -82,7 +82,7 @@ ___ *Overrides [SchemeBase](schemebase.md).[context](schemebase.md#context)* -*Defined in [scheme.ts:261](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L261)* +*Defined in [scheme.ts:261](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L261)* ___ @@ -92,7 +92,7 @@ ___ *Overrides [SchemeBase](schemebase.md).[id](schemebase.md#id)* -*Defined in [scheme.ts:257](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L257)* +*Defined in [scheme.ts:257](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L257)* ___ @@ -102,7 +102,7 @@ ___ *Overrides [SchemeBase](schemebase.md).[staticState](schemebase.md#staticstate)* -*Defined in [scheme.ts:258](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L258)* +*Defined in [scheme.ts:258](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L258)* ## Methods @@ -112,7 +112,7 @@ ___ *Overrides [SchemeBase](schemebase.md).[createProposal](schemebase.md#createproposal)* -*Defined in [scheme.ts:295](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L295)* +*Defined in [scheme.ts:323](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L323)* create a new proposal in this Scheme @@ -134,7 +134,7 @@ ___ *Inherited from [SchemeBase](schemebase.md).[createProposalErrorHandler](schemebase.md#createproposalerrorhandler)* -*Defined in [schemes/base.ts:296](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L296)* +*Defined in [schemes/base.ts:296](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L296)* **Parameters:** @@ -160,7 +160,7 @@ ___ *Inherited from [SchemeBase](schemebase.md).[createProposalTransaction](schemebase.md#createproposaltransaction)* -*Defined in [schemes/base.ts:288](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L288)* +*Defined in [schemes/base.ts:288](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L288)* create a new proposal in this scheme TODO: move this to the schemes - we should call proposal.scheme.createProposal @@ -185,7 +185,7 @@ ___ *Inherited from [SchemeBase](schemebase.md).[createProposalTransactionMap](schemebase.md#createproposaltransactionmap)* -*Defined in [schemes/base.ts:292](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L292)* +*Defined in [schemes/base.ts:292](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L292)* **Returns:** *function* @@ -201,15 +201,15 @@ ___ ### fetchStaticState -▸ **fetchStaticState**(): *Promise‹[ISchemeStaticState](../interfaces/ischemestaticstate.md)›* +▸ **fetchStaticState**(): *Promise‹ISchemeStaticState›* -*Inherited from [SchemeBase](schemebase.md).[fetchStaticState](schemebase.md#fetchstaticstate)* +*Overrides [SchemeBase](schemebase.md).[fetchStaticState](schemebase.md#fetchstaticstate)* -*Defined in [schemes/base.ts:256](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L256)* +*Defined in [scheme.ts:284](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L284)* fetch the static state from the subgraph -**Returns:** *Promise‹[ISchemeStaticState](../interfaces/ischemestaticstate.md)›* +**Returns:** *Promise‹ISchemeStaticState›* the statatic state @@ -221,7 +221,7 @@ ___ *Overrides [SchemeBase](schemebase.md).[proposals](schemebase.md#proposals)* -*Defined in [scheme.ts:363](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L363)* +*Defined in [scheme.ts:390](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L390)* **Parameters:** @@ -240,7 +240,7 @@ ___ *Overrides [SchemeBase](schemebase.md).[setStaticState](schemebase.md#setstaticstate)* -*Defined in [scheme.ts:273](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L273)* +*Defined in [scheme.ts:273](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L273)* **Parameters:** @@ -258,7 +258,7 @@ ___ *Overrides [SchemeBase](schemebase.md).[state](schemebase.md#abstract-state)* -*Defined in [scheme.ts:277](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L277)* +*Defined in [scheme.ts:305](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L305)* **Parameters:** @@ -276,7 +276,7 @@ ___ *Inherited from [SchemeBase](schemebase.md).[x](schemebase.md#x)* -*Defined in [schemes/base.ts:319](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L319)* +*Defined in [schemes/base.ts:319](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L319)* **Returns:** *void* @@ -286,7 +286,7 @@ ___ ▸ **itemMap**(`item`: any, `arc`: [Arc](arc.md)): *ISchemeState | null* -*Defined in [scheme.ts:188](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L188)* +*Defined in [scheme.ts:188](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L188)* map an apollo query result to ISchemeState @@ -309,7 +309,7 @@ ___ ▸ **search**(`context`: [Arc](arc.md), `options`: ISchemeQueryOptions, `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹Array‹[Scheme](scheme.md) | [CompetitionScheme](competitionscheme.md)››* -*Defined in [scheme.ts:116](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L116)* +*Defined in [scheme.ts:116](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L116)* Scheme.search(context, options) searches for scheme entities @@ -333,7 +333,7 @@ an observable of Scheme objects *Inherited from [SchemeBase](schemebase.md).[fragments](schemebase.md#static-fragments)* -*Defined in [schemes/base.ts:106](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L106)* +*Defined in [schemes/base.ts:106](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L106)* ### SchemeFields @@ -466,4 +466,4 @@ an observable of Scheme objects version }` -*Defined in [schemes/base.ts:107](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L107)* +*Defined in [schemes/base.ts:107](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L107)* diff --git a/docs/classes/schemebase.md b/docs/classes/schemebase.md index 66f9c3d1..05db3948 100644 --- a/docs/classes/schemebase.md +++ b/docs/classes/schemebase.md @@ -51,7 +51,7 @@ A Scheme represents a scheme instance that is registered at a DAO \+ **new SchemeBase**(`idOrOpts`: [Address](../globals.md#address) | [ISchemeStaticState](../interfaces/ischemestaticstate.md), `context`: [Arc](arc.md)): *[SchemeBase](schemebase.md)* -*Defined in [schemes/base.ts:239](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L239)* +*Defined in [schemes/base.ts:239](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L239)* **Parameters:** @@ -68,7 +68,7 @@ Name | Type | • **ReputationFromToken**: *[ReputationFromTokenScheme](reputationfromtokenscheme.md) | null* = null -*Defined in [schemes/base.ts:239](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L239)* +*Defined in [schemes/base.ts:239](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L239)* ___ @@ -76,7 +76,7 @@ ___ • **context**: *[Arc](arc.md)* -*Defined in [schemes/base.ts:241](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L241)* +*Defined in [schemes/base.ts:241](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L241)* ___ @@ -84,7 +84,7 @@ ___ • **id**: *[Address](../globals.md#address)* -*Defined in [schemes/base.ts:237](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L237)* +*Defined in [schemes/base.ts:237](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L237)* ___ @@ -92,7 +92,7 @@ ___ • **staticState**: *[ISchemeStaticState](../interfaces/ischemestaticstate.md) | null* = null -*Defined in [schemes/base.ts:238](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L238)* +*Defined in [schemes/base.ts:238](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L238)* ## Methods @@ -100,7 +100,7 @@ ___ ▸ **createProposal**(`options`: [IProposalCreateOptions](../globals.md#iproposalcreateoptions)): *[Operation](../globals.md#operation)‹[Proposal](proposal.md)›* -*Defined in [schemes/base.ts:300](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L300)* +*Defined in [schemes/base.ts:300](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L300)* **Parameters:** @@ -116,7 +116,7 @@ ___ ▸ **createProposalErrorHandler**(`options?`: any): *function* -*Defined in [schemes/base.ts:296](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L296)* +*Defined in [schemes/base.ts:296](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L296)* **Parameters:** @@ -140,7 +140,7 @@ ___ ▸ **createProposalTransaction**(`options`: any): *function* -*Defined in [schemes/base.ts:288](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L288)* +*Defined in [schemes/base.ts:288](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L288)* create a new proposal in this scheme TODO: move this to the schemes - we should call proposal.scheme.createProposal @@ -163,7 +163,7 @@ ___ ▸ **createProposalTransactionMap**(): *function* -*Defined in [schemes/base.ts:292](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L292)* +*Defined in [schemes/base.ts:292](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L292)* **Returns:** *function* @@ -181,7 +181,7 @@ ___ ▸ **fetchStaticState**(): *Promise‹[ISchemeStaticState](../interfaces/ischemestaticstate.md)›* -*Defined in [schemes/base.ts:256](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L256)* +*Defined in [schemes/base.ts:256](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L256)* fetch the static state from the subgraph @@ -195,7 +195,7 @@ ___ ▸ **proposals**(`options`: [IProposalQueryOptions](../interfaces/iproposalqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Proposal](proposal.md)[]›* -*Defined in [schemes/base.ts:467](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L467)* +*Defined in [schemes/base.ts:467](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L467)* **Parameters:** @@ -212,7 +212,7 @@ ___ ▸ **setStaticState**(`opts`: [ISchemeStaticState](../interfaces/ischemestaticstate.md)): *void* -*Defined in [schemes/base.ts:279](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L279)* +*Defined in [schemes/base.ts:279](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L279)* **Parameters:** @@ -228,7 +228,7 @@ ___ ▸ **state**(`apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[ISchemeState](../interfaces/ischemestate.md)›* -*Defined in [schemes/base.ts:317](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L317)* +*Defined in [schemes/base.ts:317](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L317)* **Parameters:** @@ -244,7 +244,7 @@ ___ ▸ **x**(): *void* -*Defined in [schemes/base.ts:319](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L319)* +*Defined in [schemes/base.ts:319](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L319)* **Returns:** *void* @@ -254,7 +254,7 @@ ___ ### ▪ **fragments**: *object* -*Defined in [schemes/base.ts:106](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L106)* +*Defined in [schemes/base.ts:106](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L106)* ### SchemeFields @@ -387,4 +387,4 @@ ___ version }` -*Defined in [schemes/base.ts:107](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L107)* +*Defined in [schemes/base.ts:107](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L107)* diff --git a/docs/classes/stake.md b/docs/classes/stake.md index b06a6c56..a3dc7ffb 100644 --- a/docs/classes/stake.md +++ b/docs/classes/stake.md @@ -39,7 +39,7 @@ \+ **new Stake**(`idOrOpts`: string | [IStakeStaticState](../interfaces/istakestaticstate.md), `context`: [Arc](arc.md)): *[Stake](stake.md)* -*Defined in [stake.ts:149](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L149)* +*Defined in [stake.ts:149](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L149)* **Parameters:** @@ -56,7 +56,7 @@ Name | Type | • **context**: *[Arc](arc.md)* -*Defined in [stake.ts:153](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L153)* +*Defined in [stake.ts:153](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L153)* ___ @@ -64,7 +64,7 @@ ___ • **id**: *string | undefined* -*Defined in [stake.ts:148](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L148)* +*Defined in [stake.ts:148](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L148)* ___ @@ -72,7 +72,7 @@ ___ • **staticState**: *[IStakeStaticState](../interfaces/istakestaticstate.md) | undefined* -*Defined in [stake.ts:149](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L149)* +*Defined in [stake.ts:149](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L149)* ## Methods @@ -80,7 +80,7 @@ ___ ▸ **fetchStaticState**(): *Promise‹[IStakeStaticState](../interfaces/istakestaticstate.md)›* -*Defined in [stake.ts:207](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L207)* +*Defined in [stake.ts:207](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L207)* **Returns:** *Promise‹[IStakeStaticState](../interfaces/istakestaticstate.md)›* @@ -90,7 +90,7 @@ ___ ▸ **setStaticState**(`opts`: [IStakeStaticState](../interfaces/istakestaticstate.md)): *void* -*Defined in [stake.ts:203](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L203)* +*Defined in [stake.ts:203](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L203)* **Parameters:** @@ -106,7 +106,7 @@ ___ ▸ **state**(`apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[IStakeState](../interfaces/istakestate.md)›* -*Defined in [stake.ts:163](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L163)* +*Defined in [stake.ts:163](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L163)* **Parameters:** @@ -122,7 +122,7 @@ ___ ▸ **search**(`context`: [Arc](arc.md), `options`: [IStakeQueryOptions](../interfaces/istakequeryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Stake](stake.md)[]›* -*Defined in [stake.ts:57](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L57)* +*Defined in [stake.ts:57](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L57)* Stake.search(context, options) searches for stake entities @@ -144,7 +144,7 @@ an observable of Stake objects ### ▪ **fragments**: *object* -*Defined in [stake.ts:35](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L35)* +*Defined in [stake.ts:35](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L35)* ### StakeFields @@ -162,4 +162,4 @@ an observable of Stake objects amount }` -*Defined in [stake.ts:36](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L36)* +*Defined in [stake.ts:36](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L36)* diff --git a/docs/classes/tag.md b/docs/classes/tag.md index 829c1c45..20dd88c1 100644 --- a/docs/classes/tag.md +++ b/docs/classes/tag.md @@ -39,7 +39,7 @@ \+ **new Tag**(`idOrOpts`: string | [ITagStaticState](../interfaces/itagstaticstate.md), `context`: [Arc](arc.md)): *[Tag](tag.md)* -*Defined in [tag.ts:113](https://github.com/daostack/client/blob/7361fcc/src/tag.ts#L113)* +*Defined in [tag.ts:113](https://github.com/daostack/client/blob/1bc237e/src/tag.ts#L113)* **Parameters:** @@ -56,7 +56,7 @@ Name | Type | • **context**: *[Arc](arc.md)* -*Defined in [tag.ts:117](https://github.com/daostack/client/blob/7361fcc/src/tag.ts#L117)* +*Defined in [tag.ts:117](https://github.com/daostack/client/blob/1bc237e/src/tag.ts#L117)* ___ @@ -64,7 +64,7 @@ ___ • **id**: *string | undefined* -*Defined in [tag.ts:112](https://github.com/daostack/client/blob/7361fcc/src/tag.ts#L112)* +*Defined in [tag.ts:112](https://github.com/daostack/client/blob/1bc237e/src/tag.ts#L112)* ___ @@ -72,7 +72,7 @@ ___ • **staticState**: *[ITagStaticState](../interfaces/itagstaticstate.md) | undefined* -*Defined in [tag.ts:113](https://github.com/daostack/client/blob/7361fcc/src/tag.ts#L113)* +*Defined in [tag.ts:113](https://github.com/daostack/client/blob/1bc237e/src/tag.ts#L113)* ## Methods @@ -80,7 +80,7 @@ ___ ▸ **fetchStaticState**(): *Promise‹[ITagStaticState](../interfaces/itagstaticstate.md)›* -*Defined in [tag.ts:158](https://github.com/daostack/client/blob/7361fcc/src/tag.ts#L158)* +*Defined in [tag.ts:158](https://github.com/daostack/client/blob/1bc237e/src/tag.ts#L158)* **Returns:** *Promise‹[ITagStaticState](../interfaces/itagstaticstate.md)›* @@ -90,7 +90,7 @@ ___ ▸ **setStaticState**(`opts`: [ITagStaticState](../interfaces/itagstaticstate.md)): *void* -*Defined in [tag.ts:154](https://github.com/daostack/client/blob/7361fcc/src/tag.ts#L154)* +*Defined in [tag.ts:154](https://github.com/daostack/client/blob/1bc237e/src/tag.ts#L154)* **Parameters:** @@ -106,7 +106,7 @@ ___ ▸ **state**(`apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[ITagState](../interfaces/itagstate.md)›* -*Defined in [tag.ts:127](https://github.com/daostack/client/blob/7361fcc/src/tag.ts#L127)* +*Defined in [tag.ts:127](https://github.com/daostack/client/blob/1bc237e/src/tag.ts#L127)* **Parameters:** @@ -122,7 +122,7 @@ ___ ▸ **search**(`context`: [Arc](arc.md), `options`: [ITagQueryOptions](../interfaces/itagqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Tag](tag.md)[]›* -*Defined in [tag.ts:41](https://github.com/daostack/client/blob/7361fcc/src/tag.ts#L41)* +*Defined in [tag.ts:41](https://github.com/daostack/client/blob/1bc237e/src/tag.ts#L41)* Tag.search(context, options) searches for stake entities @@ -144,7 +144,7 @@ an observable of Tag objects ### ▪ **fragments**: *object* -*Defined in [tag.ts:27](https://github.com/daostack/client/blob/7361fcc/src/tag.ts#L27)* +*Defined in [tag.ts:27](https://github.com/daostack/client/blob/1bc237e/src/tag.ts#L27)* ### TagFields @@ -154,4 +154,4 @@ an observable of Tag objects proposals { id } }` -*Defined in [tag.ts:28](https://github.com/daostack/client/blob/7361fcc/src/tag.ts#L28)* +*Defined in [tag.ts:28](https://github.com/daostack/client/blob/1bc237e/src/tag.ts#L28)* diff --git a/docs/classes/token.md b/docs/classes/token.md index 1803e594..90a58f5f 100644 --- a/docs/classes/token.md +++ b/docs/classes/token.md @@ -39,7 +39,7 @@ \+ **new Token**(`id`: [Address](../globals.md#address), `context`: [Arc](arc.md)): *[Token](token.md)* -*Defined in [token.ts:87](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L87)* +*Defined in [token.ts:87](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L87)* **Parameters:** @@ -56,7 +56,7 @@ Name | Type | • **address**: *string* -*Defined in [token.ts:87](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L87)* +*Defined in [token.ts:87](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L87)* ___ @@ -64,7 +64,7 @@ ___ • **context**: *[Arc](arc.md)* -*Defined in [token.ts:89](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L89)* +*Defined in [token.ts:89](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L89)* ___ @@ -72,7 +72,7 @@ ___ • **id**: *[Address](../globals.md#address)* -*Defined in [token.ts:89](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L89)* +*Defined in [token.ts:89](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L89)* ## Methods @@ -80,7 +80,7 @@ ___ ▸ **allowance**(`owner`: [Address](../globals.md#address), `spender`: [Address](../globals.md#address)): *Observable‹BN›* -*Defined in [token.ts:185](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L185)* +*Defined in [token.ts:185](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L185)* **Parameters:** @@ -97,7 +97,7 @@ ___ ▸ **approveForStaking**(`spender`: [Address](../globals.md#address), `amount`: BN): *[IOperationObservable](../interfaces/ioperationobservable.md)‹[ITransactionUpdate](../interfaces/itransactionupdate.md)‹any››* -*Defined in [token.ts:226](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L226)* +*Defined in [token.ts:226](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L226)* **Parameters:** @@ -114,7 +114,7 @@ ___ ▸ **balanceOf**(`owner`: string): *Observable‹BN›* -*Defined in [token.ts:133](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L133)* +*Defined in [token.ts:133](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L133)* **Parameters:** @@ -130,7 +130,7 @@ ___ ▸ **contract**(`mode?`: undefined | "readonly"): *any* -*Defined in [token.ts:128](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L128)* +*Defined in [token.ts:128](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L128)* **Parameters:** @@ -146,7 +146,7 @@ ___ ▸ **mint**(`beneficiary`: [Address](../globals.md#address), `amount`: BN): *[IOperationObservable](../interfaces/ioperationobservable.md)‹[ITransactionUpdate](../interfaces/itransactionupdate.md)‹any››* -*Defined in [token.ts:212](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L212)* +*Defined in [token.ts:212](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L212)* **Parameters:** @@ -163,7 +163,7 @@ ___ ▸ **state**(`apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[ITokenState](../interfaces/itokenstate.md)›* -*Defined in [token.ts:97](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L97)* +*Defined in [token.ts:97](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L97)* **Parameters:** @@ -179,7 +179,7 @@ ___ ▸ **transfer**(`beneficiary`: [Address](../globals.md#address), `amount`: BN): *[IOperationObservable](../interfaces/ioperationobservable.md)‹[ITransactionUpdate](../interfaces/itransactionupdate.md)‹any››* -*Defined in [token.ts:219](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L219)* +*Defined in [token.ts:219](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L219)* **Parameters:** @@ -196,7 +196,7 @@ ___ ▸ **search**(`context`: [Arc](arc.md), `options`: [ITokenQueryOptions](../interfaces/itokenqueryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Token](token.md)[]›* -*Defined in [token.ts:52](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L52)* +*Defined in [token.ts:52](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L52)* Token.search(context, options) searches for token entities diff --git a/docs/classes/vote.md b/docs/classes/vote.md index f59200a6..882beee8 100644 --- a/docs/classes/vote.md +++ b/docs/classes/vote.md @@ -39,7 +39,7 @@ \+ **new Vote**(`idOrOpts`: string | [IVoteStaticState](../interfaces/ivotestaticstate.md), `context`: [Arc](arc.md)): *[Vote](vote.md)* -*Defined in [vote.ts:155](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L155)* +*Defined in [vote.ts:155](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L155)* **Parameters:** @@ -56,7 +56,7 @@ Name | Type | • **context**: *[Arc](arc.md)* -*Defined in [vote.ts:157](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L157)* +*Defined in [vote.ts:157](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L157)* ___ @@ -64,7 +64,7 @@ ___ • **id**: *string | undefined* -*Defined in [vote.ts:154](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L154)* +*Defined in [vote.ts:154](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L154)* ___ @@ -72,7 +72,7 @@ ___ • **staticState**: *[IVoteStaticState](../interfaces/ivotestaticstate.md) | undefined* -*Defined in [vote.ts:155](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L155)* +*Defined in [vote.ts:155](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L155)* ## Methods @@ -80,7 +80,7 @@ ___ ▸ **fetchStaticState**(): *Promise‹[IVoteStaticState](../interfaces/ivotestaticstate.md)›* -*Defined in [vote.ts:197](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L197)* +*Defined in [vote.ts:197](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L197)* **Returns:** *Promise‹[IVoteStaticState](../interfaces/ivotestaticstate.md)›* @@ -90,7 +90,7 @@ ___ ▸ **setStaticState**(`opts`: [IVoteStaticState](../interfaces/ivotestaticstate.md)): *void* -*Defined in [vote.ts:193](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L193)* +*Defined in [vote.ts:193](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L193)* **Parameters:** @@ -106,7 +106,7 @@ ___ ▸ **state**(`apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[IVoteState](../interfaces/ivotestate.md)›* -*Defined in [vote.ts:167](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L167)* +*Defined in [vote.ts:167](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L167)* **Parameters:** @@ -122,7 +122,7 @@ ___ ▸ **search**(`context`: [Arc](arc.md), `options`: [IVoteQueryOptions](../interfaces/ivotequeryoptions.md), `apolloQueryOptions`: [IApolloQueryOptions](../interfaces/iapolloqueryoptions.md)): *Observable‹[Vote](vote.md)[]›* -*Defined in [vote.ts:58](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L58)* +*Defined in [vote.ts:58](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L58)* Vote.search(context, options) searches for vote entities @@ -144,7 +144,7 @@ an observable of Vote objects ### ▪ **fragments**: *object* -*Defined in [vote.ts:36](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L36)* +*Defined in [vote.ts:36](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L36)* ### VoteFields @@ -162,4 +162,4 @@ an observable of Vote objects reputation }` -*Defined in [vote.ts:37](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L37)* +*Defined in [vote.ts:37](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L37)* diff --git a/docs/enums/iexecutionstate.md b/docs/enums/iexecutionstate.md index 6670e9e9..92cb2f7e 100644 --- a/docs/enums/iexecutionstate.md +++ b/docs/enums/iexecutionstate.md @@ -19,7 +19,7 @@ • **BoostedBarCrossed**: -*Defined in [proposal.ts:58](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L58)* +*Defined in [proposal.ts:58](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L58)* ___ @@ -27,7 +27,7 @@ ___ • **BoostedTimeOut**: -*Defined in [proposal.ts:57](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L57)* +*Defined in [proposal.ts:57](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L57)* ___ @@ -35,7 +35,7 @@ ___ • **None**: -*Defined in [proposal.ts:53](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L53)* +*Defined in [proposal.ts:53](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L53)* ___ @@ -43,7 +43,7 @@ ___ • **PreBoostedBarCrossed**: -*Defined in [proposal.ts:56](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L56)* +*Defined in [proposal.ts:56](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L56)* ___ @@ -51,7 +51,7 @@ ___ • **QueueBarCrossed**: -*Defined in [proposal.ts:54](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L54)* +*Defined in [proposal.ts:54](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L54)* ___ @@ -59,4 +59,4 @@ ___ • **QueueTimeOut**: -*Defined in [proposal.ts:55](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L55)* +*Defined in [proposal.ts:55](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L55)* diff --git a/docs/enums/iproposaloutcome.md b/docs/enums/iproposaloutcome.md index 29e1c99a..8e66ff6a 100644 --- a/docs/enums/iproposaloutcome.md +++ b/docs/enums/iproposaloutcome.md @@ -16,7 +16,7 @@ • **Fail**: -*Defined in [proposal.ts:40](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L40)* +*Defined in [proposal.ts:40](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L40)* ___ @@ -24,7 +24,7 @@ ___ • **None**: -*Defined in [proposal.ts:38](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L38)* +*Defined in [proposal.ts:38](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L38)* ___ @@ -32,4 +32,4 @@ ___ • **Pass**: -*Defined in [proposal.ts:39](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L39)* +*Defined in [proposal.ts:39](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L39)* diff --git a/docs/enums/iproposalstage.md b/docs/enums/iproposalstage.md index 958306d2..e30fac68 100644 --- a/docs/enums/iproposalstage.md +++ b/docs/enums/iproposalstage.md @@ -19,7 +19,7 @@ • **Boosted**: -*Defined in [proposal.ts:48](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L48)* +*Defined in [proposal.ts:48](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L48)* ___ @@ -27,7 +27,7 @@ ___ • **Executed**: -*Defined in [proposal.ts:45](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L45)* +*Defined in [proposal.ts:45](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L45)* ___ @@ -35,7 +35,7 @@ ___ • **ExpiredInQueue**: -*Defined in [proposal.ts:44](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L44)* +*Defined in [proposal.ts:44](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L44)* ___ @@ -43,7 +43,7 @@ ___ • **PreBoosted**: -*Defined in [proposal.ts:47](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L47)* +*Defined in [proposal.ts:47](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L47)* ___ @@ -51,7 +51,7 @@ ___ • **Queued**: -*Defined in [proposal.ts:46](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L46)* +*Defined in [proposal.ts:46](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L46)* ___ @@ -59,4 +59,4 @@ ___ • **QuietEndingPeriod**: -*Defined in [proposal.ts:49](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L49)* +*Defined in [proposal.ts:49](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L49)* diff --git a/docs/enums/itransactionstate.md b/docs/enums/itransactionstate.md index bf2f8f2c..316fdbf8 100644 --- a/docs/enums/itransactionstate.md +++ b/docs/enums/itransactionstate.md @@ -16,7 +16,7 @@ • **Mined**: -*Defined in [operation.ts:10](https://github.com/daostack/client/blob/7361fcc/src/operation.ts#L10)* +*Defined in [operation.ts:10](https://github.com/daostack/client/blob/1bc237e/src/operation.ts#L10)* ___ @@ -24,7 +24,7 @@ ___ • **Sending**: -*Defined in [operation.ts:8](https://github.com/daostack/client/blob/7361fcc/src/operation.ts#L8)* +*Defined in [operation.ts:8](https://github.com/daostack/client/blob/1bc237e/src/operation.ts#L8)* ___ @@ -32,4 +32,4 @@ ___ • **Sent**: -*Defined in [operation.ts:9](https://github.com/daostack/client/blob/7361fcc/src/operation.ts#L9)* +*Defined in [operation.ts:9](https://github.com/daostack/client/blob/1bc237e/src/operation.ts#L9)* diff --git a/docs/enums/proposalquerysortoptions.md b/docs/enums/proposalquerysortoptions.md index 09be06eb..43d83894 100644 --- a/docs/enums/proposalquerysortoptions.md +++ b/docs/enums/proposalquerysortoptions.md @@ -15,7 +15,7 @@ • **preBoostedAt**: = "preBoostedAt" -*Defined in [proposal.ts:832](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L832)* +*Defined in [proposal.ts:843](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L843)* ___ @@ -23,4 +23,4 @@ ___ • **resolvesAt**: = "resolvesAt" -*Defined in [proposal.ts:831](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L831)* +*Defined in [proposal.ts:842](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L842)* diff --git a/docs/globals.md b/docs/globals.md index dc39b281..59e6d1f1 100644 --- a/docs/globals.md +++ b/docs/globals.md @@ -41,11 +41,11 @@ * [IApolloQueryOptions](interfaces/iapolloqueryoptions.md) * [IApproval](interfaces/iapproval.md) * [ICommonQueryOptions](interfaces/icommonqueryoptions.md) -* [ICompetitionProposal](interfaces/icompetitionproposal.md) -* [ICompetitionSuggestion](interfaces/icompetitionsuggestion.md) +* [ICompetitionProposalState](interfaces/icompetitionproposalstate.md) * [ICompetitionSuggestionQueryOptions](interfaces/icompetitionsuggestionqueryoptions.md) -* [ICompetitionVote](interfaces/icompetitionvote.md) +* [ICompetitionSuggestionState](interfaces/icompetitionsuggestionstate.md) * [ICompetitionVoteQueryOptions](interfaces/icompetitionvotequeryoptions.md) +* [ICompetitionVoteState](interfaces/icompetitionvotestate.md) * [IContractAddresses](interfaces/icontractaddresses.md) * [IContractInfo](interfaces/icontractinfo.md) * [IContributionReward](interfaces/icontributionreward.md) @@ -167,7 +167,7 @@ Ƭ **Address**: *string* -*Defined in [types.ts:4](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L4)* +*Defined in [types.ts:4](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L4)* ___ @@ -175,7 +175,7 @@ ___ Ƭ **Date**: *number* -*Defined in [types.ts:5](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L5)* ___ @@ -183,7 +183,7 @@ ___ Ƭ **EthereumEvent**: *any* -*Defined in [utils.ts:59](https://github.com/daostack/client/blob/7361fcc/src/utils.ts#L59)* +*Defined in [utils.ts:59](https://github.com/daostack/client/blob/1bc237e/src/utils.ts#L59)* ___ @@ -191,7 +191,7 @@ ___ Ƭ **Hash**: *string* -*Defined in [types.ts:6](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L6)* +*Defined in [types.ts:6](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L6)* ___ @@ -199,7 +199,7 @@ ___ Ƭ **IPFSProvider**: *string | object* -*Defined in [types.ts:22](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L22)* ___ @@ -207,7 +207,7 @@ ___ Ƭ **IProposalCreateOptions**: *[IProposalBaseCreateOptions](interfaces/iproposalbasecreateoptions.md) & [IProposalCreateOptionsGS](interfaces/iproposalcreateoptionsgs.md) | [IProposalBaseCreateOptions](interfaces/iproposalbasecreateoptions.md) & [IProposalCreateOptionsSR](interfaces/iproposalcreateoptionssr.md) | [IProposalBaseCreateOptions](interfaces/iproposalbasecreateoptions.md) & [IProposalCreateOptionsCR](interfaces/iproposalcreateoptionscr.md) | [IProposalCreateOptionsContributionRewardExt](interfaces/iproposalcreateoptionscontributionrewardext.md) | [IProposalCreateOptionsCompetition](interfaces/iproposalcreateoptionscompetition.md)* -*Defined in [proposal.ts:871](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L871)* +*Defined in [proposal.ts:882](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L882)* ___ @@ -215,7 +215,7 @@ ___ Ƭ **IProposalType**: *[ContributionReward](globals.md#contributionreward) | [GenericScheme](globals.md#genericscheme) | [SchemeRegistrarAdd](globals.md#schemeregistraradd) | [SchemeRegistrarEdit](globals.md#schemeregistraredit) | [SchemeRegistrarRemove](globals.md#schemeregistrarremove)* -*Defined in [proposal.ts:31](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L31)* +*Defined in [proposal.ts:31](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L31)* ___ @@ -223,7 +223,7 @@ ___ Ƭ **Operation**: *[IOperationObservable](interfaces/ioperationobservable.md)‹[ITransactionUpdate](interfaces/itransactionupdate.md)‹T››* -*Defined in [operation.ts:38](https://github.com/daostack/client/blob/7361fcc/src/operation.ts#L38)* +*Defined in [operation.ts:38](https://github.com/daostack/client/blob/1bc237e/src/operation.ts#L38)* ___ @@ -231,7 +231,7 @@ ___ Ƭ **Web3Provider**: *string | object* -*Defined in [types.ts:8](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L8)* ___ @@ -239,7 +239,7 @@ ___ Ƭ **Web3Receipt**: *any* -*Defined in [types.ts:7](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L7)* ___ @@ -247,7 +247,7 @@ ___ Ƭ **web3receipt**: *object* -*Defined in [operation.ts:40](https://github.com/daostack/client/blob/7361fcc/src/operation.ts#L40)* +*Defined in [operation.ts:40](https://github.com/daostack/client/blob/1bc237e/src/operation.ts#L40)* ## Variables @@ -255,7 +255,7 @@ ___ • **ABI_DIR**: *"./abis"* = "./abis" -*Defined in [settings.ts:8](https://github.com/daostack/client/blob/7361fcc/src/settings.ts#L8)* +*Defined in [settings.ts:8](https://github.com/daostack/client/blob/1bc237e/src/settings.ts#L8)* ___ @@ -263,7 +263,7 @@ ___ • **DAOTOKEN_CONTRACT_VERSION**: *"0.0.1-rc.19"* = "0.0.1-rc.19" -*Defined in [settings.ts:5](https://github.com/daostack/client/blob/7361fcc/src/settings.ts#L5)* +*Defined in [settings.ts:5](https://github.com/daostack/client/blob/1bc237e/src/settings.ts#L5)* ___ @@ -271,7 +271,7 @@ ___ • **IPFSClient**: *any* = require('ipfs-http-client') -*Defined in [arc.ts:18](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L18)* +*Defined in [arc.ts:18](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L18)* ___ @@ -279,7 +279,7 @@ ___ • **LATEST_ARC_VERSION**: *"0.0.1-rc.19"* = "0.0.1-rc.19" -*Defined in [settings.ts:6](https://github.com/daostack/client/blob/7361fcc/src/settings.ts#L6)* +*Defined in [settings.ts:6](https://github.com/daostack/client/blob/1bc237e/src/settings.ts#L6)* ___ @@ -287,7 +287,7 @@ ___ • **NULL_ADDRESS**: *"0x0000000000000000000000000000000000000000"* = "0x0000000000000000000000000000000000000000" -*Defined in [utils.ts:97](https://github.com/daostack/client/blob/7361fcc/src/utils.ts#L97)* +*Defined in [utils.ts:97](https://github.com/daostack/client/blob/1bc237e/src/utils.ts#L97)* ___ @@ -295,7 +295,7 @@ ___ • **REDEEMER_CONTRACT_VERSION**: *"0.0.1-rc.36"* = "0.0.1-rc.36" -*Defined in [settings.ts:2](https://github.com/daostack/client/blob/7361fcc/src/settings.ts#L2)* +*Defined in [settings.ts:2](https://github.com/daostack/client/blob/1bc237e/src/settings.ts#L2)* ___ @@ -303,7 +303,7 @@ ___ • **REPUTATION_CONTRACT_VERSION**: *"0.0.1-rc.19"* = "0.0.1-rc.19" -*Defined in [settings.ts:4](https://github.com/daostack/client/blob/7361fcc/src/settings.ts#L4)* +*Defined in [settings.ts:4](https://github.com/daostack/client/blob/1bc237e/src/settings.ts#L4)* ___ @@ -311,11 +311,11 @@ ___ • **Web3**: *any* = require('web3') -*Defined in [utils.ts:5](https://github.com/daostack/client/blob/7361fcc/src/utils.ts#L5)* +*Defined in [utils.ts:5](https://github.com/daostack/client/blob/1bc237e/src/utils.ts#L5)* -*Defined in [schemes/competition.ts:20](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L20)* +*Defined in [schemes/competition.ts:20](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L20)* -*Defined in [arc.ts:19](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L19)* +*Defined in [arc.ts:19](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L19)* ## Functions @@ -323,7 +323,7 @@ ___ ▸ **checkWebsocket**(`options`: object): *void* -*Defined in [utils.ts:16](https://github.com/daostack/client/blob/7361fcc/src/utils.ts#L16)* +*Defined in [utils.ts:16](https://github.com/daostack/client/blob/1bc237e/src/utils.ts#L16)* **Parameters:** @@ -341,7 +341,7 @@ ___ ▸ **concat**(`a`: Uint8Array, `b`: Uint8Array): *Uint8Array* -*Defined in [utils.ts:47](https://github.com/daostack/client/blob/7361fcc/src/utils.ts#L47)* +*Defined in [utils.ts:47](https://github.com/daostack/client/blob/1bc237e/src/utils.ts#L47)* **Parameters:** @@ -358,7 +358,7 @@ ___ ▸ **createApolloClient**(`options`: object): *ApolloClient‹NormalizedCacheObject›* -*Defined in [graphnode.ts:26](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L26)* +*Defined in [graphnode.ts:26](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L26)* **Parameters:** @@ -378,7 +378,7 @@ ___ ▸ **createGraphQlQuery**(`options`: [ICommonQueryOptions](interfaces/icommonqueryoptions.md), `where`: string): *string* -*Defined in [utils.ts:109](https://github.com/daostack/client/blob/7361fcc/src/utils.ts#L109)* +*Defined in [utils.ts:109](https://github.com/daostack/client/blob/1bc237e/src/utils.ts#L109)* creates a string to be plugsging into a graphql query @@ -402,7 +402,7 @@ ___ ▸ **createGraphQlWhereQuery**(`where?`: undefined | object): *string* -*Defined in [utils.ts:139](https://github.com/daostack/client/blob/7361fcc/src/utils.ts#L139)* +*Defined in [utils.ts:139](https://github.com/daostack/client/blob/1bc237e/src/utils.ts#L139)* **Parameters:** @@ -418,7 +418,7 @@ ___ ▸ **createProposal**(`options`: any, `context`: [Arc](classes/arc.md)): *(Anonymous function)* -*Defined in [schemes/contributionReward.ts:37](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L37)* +*Defined in [schemes/contributionReward.ts:37](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L37)* **Parameters:** @@ -435,7 +435,7 @@ ___ ▸ **createTransaction**(`options`: any, `context`: [Arc](classes/arc.md)): *(Anonymous function)* -*Defined in [schemes/genericScheme.ts:28](https://github.com/daostack/client/blob/7361fcc/src/schemes/genericScheme.ts#L28)* +*Defined in [schemes/genericScheme.ts:28](https://github.com/daostack/client/blob/1bc237e/src/schemes/genericScheme.ts#L28)* **Parameters:** @@ -452,7 +452,7 @@ ___ ▸ **createTransactionMap**(`options`: any, `context`: [Arc](classes/arc.md)): *map* -*Defined in [schemes/contributionReward.ts:61](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L61)* +*Defined in [schemes/contributionReward.ts:61](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L61)* map the transaction receipt of the createTransaction call to a nice result map the transaction receipt of the createTransaction call to a nice result @@ -473,7 +473,7 @@ ___ ▸ **dateToSecondsSinceEpoch**(`date`: Date): *number* -*Defined in [utils.ts:164](https://github.com/daostack/client/blob/7361fcc/src/utils.ts#L164)* +*Defined in [utils.ts:164](https://github.com/daostack/client/blob/1bc237e/src/utils.ts#L164)* **Parameters:** @@ -489,7 +489,7 @@ ___ ▸ **eventId**(`event`: [EthereumEvent](globals.md#ethereumevent)): *string* -*Defined in [utils.ts:61](https://github.com/daostack/client/blob/7361fcc/src/utils.ts#L61)* +*Defined in [utils.ts:61](https://github.com/daostack/client/blob/1bc237e/src/utils.ts#L61)* **Parameters:** @@ -505,7 +505,7 @@ ___ ▸ **fromWei**(`amount`: BN): *string* -*Defined in [utils.ts:8](https://github.com/daostack/client/blob/7361fcc/src/utils.ts#L8)* +*Defined in [utils.ts:8](https://github.com/daostack/client/blob/1bc237e/src/utils.ts#L8)* **Parameters:** @@ -521,7 +521,7 @@ ___ ▸ **getBlockTime**(`web3`: any): *Promise‹Date›* -*Defined in [utils.ts:191](https://github.com/daostack/client/blob/7361fcc/src/utils.ts#L191)* +*Defined in [utils.ts:191](https://github.com/daostack/client/blob/1bc237e/src/utils.ts#L191)* get the latest block time, or the current time, whichver is later @@ -541,7 +541,7 @@ ___ ▸ **getCompetitionContract**(`schemeState`: [ISchemeState](interfaces/ischemestate.md), `arc`: [Arc](classes/arc.md)): *any* -*Defined in [schemes/competition.ts:738](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L738)* +*Defined in [schemes/competition.ts:780](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L780)* If this scheme is a ContributionREwardExt scheme and if its rewarder is Competition contract, return that contract @@ -563,7 +563,7 @@ ___ ▸ **hasCompetitionContract**(`schemeState`: [ISchemeState](interfaces/ischemestate.md), `arc`: [Arc](classes/arc.md)): *boolean* -*Defined in [schemes/competition.ts:766](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L766)* +*Defined in [schemes/competition.ts:808](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L808)* **Parameters:** @@ -582,7 +582,7 @@ ___ ▸ **hexStringToUint8Array**(`hexString`: string): *Uint8Array‹›* -*Defined in [utils.ts:38](https://github.com/daostack/client/blob/7361fcc/src/utils.ts#L38)* +*Defined in [utils.ts:38](https://github.com/daostack/client/blob/1bc237e/src/utils.ts#L38)* **Parameters:** @@ -598,7 +598,7 @@ ___ ▸ **isAddress**(`address`: [Address](globals.md#address)): *void* -*Defined in [utils.ts:66](https://github.com/daostack/client/blob/7361fcc/src/utils.ts#L66)* +*Defined in [utils.ts:66](https://github.com/daostack/client/blob/1bc237e/src/utils.ts#L66)* **Parameters:** @@ -614,7 +614,7 @@ ___ ▸ **isCompetitionScheme**(`arc`: [Arc](classes/arc.md), `item`: any): *boolean* -*Defined in [schemes/competition.ts:754](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L754)* +*Defined in [schemes/competition.ts:796](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L796)* **Parameters:** @@ -631,7 +631,7 @@ ___ ▸ **mapGenesisProtocolParams**(`params`: [IGenesisProtocolParams](interfaces/igenesisprotocolparams.md)): *object* -*Defined in [genesisProtocol.ts:19](https://github.com/daostack/client/blob/7361fcc/src/genesisProtocol.ts#L19)* +*Defined in [genesisProtocol.ts:19](https://github.com/daostack/client/blob/1bc237e/src/genesisProtocol.ts#L19)* **Parameters:** @@ -671,7 +671,7 @@ ___ ▸ **realMathToNumber**(`t`: BN): *number* -*Defined in [utils.ts:91](https://github.com/daostack/client/blob/7361fcc/src/utils.ts#L91)* +*Defined in [utils.ts:91](https://github.com/daostack/client/blob/1bc237e/src/utils.ts#L91)* convert the number representation of RealMath.sol representations to real real numbers @@ -691,7 +691,7 @@ ___ ▸ **secondSinceEpochToDate**(`seconds`: number): *Date* -*Defined in [utils.ts:172](https://github.com/daostack/client/blob/7361fcc/src/utils.ts#L172)* +*Defined in [utils.ts:172](https://github.com/daostack/client/blob/1bc237e/src/utils.ts#L172)* **Parameters:** @@ -705,27 +705,13 @@ ___ ### sendTransaction -▸ **sendTransaction**<**T**>(`transaction`: any, `mapReceipt`: function, `errorHandler`: function, `context`: [Arc](classes/arc.md)): *[Operation](globals.md#operation)‹T›* +▸ **sendTransaction**<**T**>(`context`: [Arc](classes/arc.md), `transaction`: any, `mapReceipt`: function, `errorHandler?`: undefined | function): *[Operation](globals.md#operation)‹T›* -*Defined in [operation.ts:59](https://github.com/daostack/client/blob/7361fcc/src/operation.ts#L59)* +*Defined in [operation.ts:74](https://github.com/daostack/client/blob/1bc237e/src/operation.ts#L74)* -send a transaction to the ethereumblockchain, and return a observable of ITransactionUpdatessend -for example: - sendTransaction(.....).subscribe((txUpdate) => { - if (txUpdate.state === 'sent' ) { notify("your transaction has been sent, waitin'for it to be mnied") } - if (txUpdate.state === 'mined'} { - notify("your transaction has been mined! It was confirmed ${txUpdate.confirmations} times"} - // and we also ahve the txUpdate.receipt and the txUpdate.result to do stuff with - } - }) - -**`parameter`** transaction A web3 transaction, or an (async) function that returns a transaction - -**`parameter`** map A function that takes the receipt of the transaction and returns an object - -**`parameter`** errorHandler A function that takes an error, and either returns or throws a more informative Error +**`export`** -**`parameter`** context An instance of Arc +**`template`** T **Type parameters:** @@ -733,41 +719,38 @@ for example: **Parameters:** -▪ **transaction**: *any* +▪ **context**: *[Arc](classes/arc.md)* -▪ **mapReceipt**: *function* +An instance of Arc -▸ (`receipt`: [web3receipt](globals.md#web3receipt)): *T | Promise‹T›* +▪ **transaction**: *any* -**Parameters:** +A Web3 transaction object to send -Name | Type | ------- | ------ | -`receipt` | [web3receipt](globals.md#web3receipt) | +▪ **mapReceipt**: *function* -▪`Default value` **errorHandler**: *function*= (error) => error +A function that takes the receipt of + the transaction and returns an object -▸ (`error`: Error): *Promise‹Error› | Error* +▸ (`receipt`: [web3receipt](globals.md#web3receipt)): *T | Promise‹T›* **Parameters:** Name | Type | ------ | ------ | -`error` | Error | +`receipt` | [web3receipt](globals.md#web3receipt) | -▪ **context**: *[Arc](classes/arc.md)* +▪`Optional` **errorHandler**: *undefined | function* **Returns:** *[Operation](globals.md#operation)‹T›* -An observable with ITransactionUpdate instnces - ___ ### toIOperationObservable ▸ **toIOperationObservable**<**T**>(`observable`: Observable‹T›): *[IOperationObservable](interfaces/ioperationobservable.md)‹T›* -*Defined in [operation.ts:180](https://github.com/daostack/client/blob/7361fcc/src/operation.ts#L180)* +*Defined in [operation.ts:211](https://github.com/daostack/client/blob/1bc237e/src/operation.ts#L211)* **Type parameters:** @@ -787,7 +770,7 @@ ___ ▸ **toWei**(`amount`: string | number): *BN* -*Defined in [utils.ts:12](https://github.com/daostack/client/blob/7361fcc/src/utils.ts#L12)* +*Defined in [utils.ts:12](https://github.com/daostack/client/blob/1bc237e/src/utils.ts#L12)* **Parameters:** @@ -803,7 +786,7 @@ ___ ▸ **zenToRxjsObservable**(`zenObservable`: ZenObservable‹any›): *any* -*Defined in [utils.ts:80](https://github.com/daostack/client/blob/7361fcc/src/utils.ts#L80)* +*Defined in [utils.ts:80](https://github.com/daostack/client/blob/1bc237e/src/utils.ts#L80)* convert a ZenObservable to an rxjs.Observable @@ -823,48 +806,48 @@ an Observable instance ### ▪ **IProposalType**: *object* -*Defined in [schemes/contributionReward.ts:33](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L33)* +*Defined in [schemes/contributionReward.ts:33](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L33)* -*Defined in [schemes/contributionRewardExt.ts:32](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionRewardExt.ts#L32)* +*Defined in [schemes/contributionRewardExt.ts:32](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionRewardExt.ts#L32)* -*Defined in [schemes/genericScheme.ts:24](https://github.com/daostack/client/blob/7361fcc/src/schemes/genericScheme.ts#L24)* +*Defined in [schemes/genericScheme.ts:24](https://github.com/daostack/client/blob/1bc237e/src/schemes/genericScheme.ts#L24)* -*Defined in [schemes/schemeRegistrar.ts:22](https://github.com/daostack/client/blob/7361fcc/src/schemes/schemeRegistrar.ts#L22)* +*Defined in [schemes/schemeRegistrar.ts:22](https://github.com/daostack/client/blob/1bc237e/src/schemes/schemeRegistrar.ts#L22)* -*Defined in [schemes/uGenericScheme.ts:23](https://github.com/daostack/client/blob/7361fcc/src/schemes/uGenericScheme.ts#L23)* +*Defined in [schemes/uGenericScheme.ts:23](https://github.com/daostack/client/blob/1bc237e/src/schemes/uGenericScheme.ts#L23)* -*Defined in [proposal.ts:25](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L25)* +*Defined in [proposal.ts:25](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L25)* ### ContributionReward • **ContributionReward**: = "ContributionRewardExt" -*Defined in [schemes/contributionReward.ts:34](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L34)* +*Defined in [schemes/contributionReward.ts:34](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L34)* -*Defined in [schemes/contributionRewardExt.ts:33](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionRewardExt.ts#L33)* +*Defined in [schemes/contributionRewardExt.ts:33](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionRewardExt.ts#L33)* ### GenericScheme • **GenericScheme**: = "UGenericScheme" -*Defined in [schemes/genericScheme.ts:25](https://github.com/daostack/client/blob/7361fcc/src/schemes/genericScheme.ts#L25)* +*Defined in [schemes/genericScheme.ts:25](https://github.com/daostack/client/blob/1bc237e/src/schemes/genericScheme.ts#L25)* -*Defined in [schemes/uGenericScheme.ts:24](https://github.com/daostack/client/blob/7361fcc/src/schemes/uGenericScheme.ts#L24)* +*Defined in [schemes/uGenericScheme.ts:24](https://github.com/daostack/client/blob/1bc237e/src/schemes/uGenericScheme.ts#L24)* ### SchemeRegistrarAdd • **SchemeRegistrarAdd**: = "SchemeRegistrarAdd" -*Defined in [schemes/schemeRegistrar.ts:23](https://github.com/daostack/client/blob/7361fcc/src/schemes/schemeRegistrar.ts#L23)* +*Defined in [schemes/schemeRegistrar.ts:23](https://github.com/daostack/client/blob/1bc237e/src/schemes/schemeRegistrar.ts#L23)* ### SchemeRegistrarEdit • **SchemeRegistrarEdit**: = "SchemeRegistrarEdit" -*Defined in [schemes/schemeRegistrar.ts:24](https://github.com/daostack/client/blob/7361fcc/src/schemes/schemeRegistrar.ts#L24)* +*Defined in [schemes/schemeRegistrar.ts:24](https://github.com/daostack/client/blob/1bc237e/src/schemes/schemeRegistrar.ts#L24)* ### SchemeRegistrarRemove • **SchemeRegistrarRemove**: = "SchemeRegistrarRemove" -*Defined in [schemes/schemeRegistrar.ts:25](https://github.com/daostack/client/blob/7361fcc/src/schemes/schemeRegistrar.ts#L25)* +*Defined in [schemes/schemeRegistrar.ts:25](https://github.com/daostack/client/blob/1bc237e/src/schemes/schemeRegistrar.ts#L25)* diff --git a/docs/interfaces/iallowance.md b/docs/interfaces/iallowance.md index 13292ea4..398a891a 100644 --- a/docs/interfaces/iallowance.md +++ b/docs/interfaces/iallowance.md @@ -21,7 +21,7 @@ • **amount**: *BN* -*Defined in [token.ts:41](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L41)* +*Defined in [token.ts:41](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L41)* ___ @@ -29,7 +29,7 @@ ___ • **owner**: *[Address](../globals.md#address)* -*Defined in [token.ts:39](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L39)* +*Defined in [token.ts:39](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L39)* ___ @@ -37,7 +37,7 @@ ___ • **spender**: *[Address](../globals.md#address)* -*Defined in [token.ts:40](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L40)* +*Defined in [token.ts:40](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L40)* ___ @@ -45,4 +45,4 @@ ___ • **token**: *[Address](../globals.md#address)* -*Defined in [token.ts:38](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L38)* +*Defined in [token.ts:38](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L38)* diff --git a/docs/interfaces/iapolloqueryoptions.md b/docs/interfaces/iapolloqueryoptions.md index be0ade02..a3c6bea4 100644 --- a/docs/interfaces/iapolloqueryoptions.md +++ b/docs/interfaces/iapolloqueryoptions.md @@ -20,7 +20,7 @@ • **fetchAllData**? : *true | false* -*Defined in [graphnode.ts:19](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L19)* +*Defined in [graphnode.ts:19](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L19)* ___ @@ -28,7 +28,7 @@ ___ • **fetchPolicy**? : *"cache-first" | "network-only" | "cache-only" | "no-cache" | "standby"* -*Defined in [graphnode.ts:17](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L17)* +*Defined in [graphnode.ts:17](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L17)* ___ @@ -36,4 +36,4 @@ ___ • **subscribe**? : *true | false* -*Defined in [graphnode.ts:18](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L18)* +*Defined in [graphnode.ts:18](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L18)* diff --git a/docs/interfaces/iapproval.md b/docs/interfaces/iapproval.md index a6dbf7ca..cdefe7be 100644 --- a/docs/interfaces/iapproval.md +++ b/docs/interfaces/iapproval.md @@ -23,7 +23,7 @@ • **contract**: *[Address](../globals.md#address)* -*Defined in [token.ts:31](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L31)* +*Defined in [token.ts:31](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L31)* ___ @@ -31,7 +31,7 @@ ___ • **id**: *[Hash](../globals.md#hash)* -*Defined in [token.ts:29](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L29)* +*Defined in [token.ts:29](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L29)* ___ @@ -39,7 +39,7 @@ ___ • **owner**: *[Address](../globals.md#address)* -*Defined in [token.ts:32](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L32)* +*Defined in [token.ts:32](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L32)* ___ @@ -47,7 +47,7 @@ ___ • **spender**: *[Address](../globals.md#address)* -*Defined in [token.ts:33](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L33)* +*Defined in [token.ts:33](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L33)* ___ @@ -55,7 +55,7 @@ ___ • **txHash**: *[Hash](../globals.md#hash)* -*Defined in [token.ts:30](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L30)* +*Defined in [token.ts:30](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L30)* ___ @@ -63,4 +63,4 @@ ___ • **value**: *BN* -*Defined in [token.ts:34](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L34)* +*Defined in [token.ts:34](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L34)* diff --git a/docs/interfaces/icommonqueryoptions.md b/docs/interfaces/icommonqueryoptions.md index 04562848..abe92307 100644 --- a/docs/interfaces/icommonqueryoptions.md +++ b/docs/interfaces/icommonqueryoptions.md @@ -16,6 +16,8 @@ ↳ [ICompetitionSuggestionQueryOptions](icompetitionsuggestionqueryoptions.md) + ↳ [ICompetitionVoteQueryOptions](icompetitionvotequeryoptions.md) + ↳ [IQueueQueryOptions](iqueuequeryoptions.md) ↳ [IRewardQueryOptions](irewardqueryoptions.md) @@ -54,7 +56,7 @@ • **first**? : *undefined | number* -*Defined in [types.ts:16](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L16)* ___ @@ -62,7 +64,7 @@ ___ • **orderBy**? : *undefined | string* -*Defined in [types.ts:17](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L17)* ___ @@ -70,7 +72,7 @@ ___ • **orderDirection**? : *"asc" | "desc"* -*Defined in [types.ts:18](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L18)* ___ @@ -78,7 +80,7 @@ ___ • **skip**? : *undefined | number* -*Defined in [types.ts:15](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L15)* ___ @@ -86,4 +88,4 @@ ___ • **where**? : *any* -*Defined in [types.ts:19](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L19)* diff --git a/docs/interfaces/icompetitionproposal.md b/docs/interfaces/icompetitionproposalstate.md similarity index 50% rename from docs/interfaces/icompetitionproposal.md rename to docs/interfaces/icompetitionproposalstate.md index 614923e8..1ac6501e 100644 --- a/docs/interfaces/icompetitionproposal.md +++ b/docs/interfaces/icompetitionproposalstate.md @@ -1,26 +1,26 @@ -[@daostack/client](../README.md) › [Globals](../globals.md) › [ICompetitionProposal](icompetitionproposal.md) +[@daostack/client](../README.md) › [Globals](../globals.md) › [ICompetitionProposalState](icompetitionproposalstate.md) -# Interface: ICompetitionProposal +# Interface: ICompetitionProposalState ## Hierarchy -* **ICompetitionProposal** +* **ICompetitionProposalState** ## Index ### Properties -* [contract](icompetitionproposal.md#contract) -* [createdAt](icompetitionproposal.md#createdat) -* [endTime](icompetitionproposal.md#endtime) -* [id](icompetitionproposal.md#id) -* [numberOfVotesPerVoter](icompetitionproposal.md#numberofvotespervoter) -* [numberOfWinners](icompetitionproposal.md#numberofwinners) -* [rewardSplit](icompetitionproposal.md#rewardsplit) -* [snapshotBlock](icompetitionproposal.md#snapshotblock) -* [startTime](icompetitionproposal.md#starttime) -* [suggestionsEndTime](icompetitionproposal.md#suggestionsendtime) -* [votingStartTime](icompetitionproposal.md#votingstarttime) +* [contract](icompetitionproposalstate.md#contract) +* [createdAt](icompetitionproposalstate.md#createdat) +* [endTime](icompetitionproposalstate.md#endtime) +* [id](icompetitionproposalstate.md#id) +* [numberOfVotesPerVoter](icompetitionproposalstate.md#numberofvotespervoter) +* [numberOfWinners](icompetitionproposalstate.md#numberofwinners) +* [rewardSplit](icompetitionproposalstate.md#rewardsplit) +* [snapshotBlock](icompetitionproposalstate.md#snapshotblock) +* [startTime](icompetitionproposalstate.md#starttime) +* [suggestionsEndTime](icompetitionproposalstate.md#suggestionsendtime) +* [votingStartTime](icompetitionproposalstate.md#votingstarttime) ## Properties @@ -28,7 +28,7 @@ • **contract**: *[Address](../globals.md#address)* -*Defined in [schemes/competition.ts:24](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L24)* +*Defined in [schemes/competition.ts:24](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L24)* ___ @@ -36,7 +36,7 @@ ___ • **createdAt**: *Date* -*Defined in [schemes/competition.ts:33](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L33)* +*Defined in [schemes/competition.ts:33](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L33)* ___ @@ -44,7 +44,7 @@ ___ • **endTime**: *Date* -*Defined in [schemes/competition.ts:25](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L25)* +*Defined in [schemes/competition.ts:25](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L25)* ___ @@ -52,7 +52,7 @@ ___ • **id**: *string* -*Defined in [schemes/competition.ts:23](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L23)* +*Defined in [schemes/competition.ts:23](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L23)* ___ @@ -60,7 +60,7 @@ ___ • **numberOfVotesPerVoter**: *number* -*Defined in [schemes/competition.ts:31](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L31)* +*Defined in [schemes/competition.ts:31](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L31)* ___ @@ -68,7 +68,7 @@ ___ • **numberOfWinners**: *number* -*Defined in [schemes/competition.ts:26](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L26)* +*Defined in [schemes/competition.ts:26](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L26)* ___ @@ -76,7 +76,7 @@ ___ • **rewardSplit**: *number[]* -*Defined in [schemes/competition.ts:27](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L27)* +*Defined in [schemes/competition.ts:27](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L27)* ___ @@ -84,7 +84,7 @@ ___ • **snapshotBlock**: *number* -*Defined in [schemes/competition.ts:32](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L32)* +*Defined in [schemes/competition.ts:32](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L32)* ___ @@ -92,7 +92,7 @@ ___ • **startTime**: *Date* -*Defined in [schemes/competition.ts:28](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L28)* +*Defined in [schemes/competition.ts:28](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L28)* ___ @@ -100,7 +100,7 @@ ___ • **suggestionsEndTime**: *Date* -*Defined in [schemes/competition.ts:30](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L30)* +*Defined in [schemes/competition.ts:30](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L30)* ___ @@ -108,4 +108,4 @@ ___ • **votingStartTime**: *Date* -*Defined in [schemes/competition.ts:29](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L29)* +*Defined in [schemes/competition.ts:29](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L29)* diff --git a/docs/interfaces/icompetitionsuggestion.md b/docs/interfaces/icompetitionsuggestion.md deleted file mode 100644 index 21336af1..00000000 --- a/docs/interfaces/icompetitionsuggestion.md +++ /dev/null @@ -1,120 +0,0 @@ -[@daostack/client](../README.md) › [Globals](../globals.md) › [ICompetitionSuggestion](icompetitionsuggestion.md) - -# Interface: ICompetitionSuggestion - -## Hierarchy - -* **ICompetitionSuggestion** - -## Index - -### Properties - -* [createdAt](icompetitionsuggestion.md#createdat) -* [description](icompetitionsuggestion.md#optional-description) -* [descriptionHash](icompetitionsuggestion.md#descriptionhash) -* [id](icompetitionsuggestion.md#id) -* [proposal](icompetitionsuggestion.md#proposal) -* [redeemedAt](icompetitionsuggestion.md#redeemedat) -* [rewardPercentage](icompetitionsuggestion.md#rewardpercentage) -* [suggester](icompetitionsuggestion.md#suggester) -* [suggestionId](icompetitionsuggestion.md#suggestionid) -* [title](icompetitionsuggestion.md#optional-title) -* [totalVotes](icompetitionsuggestion.md#totalvotes) -* [url](icompetitionsuggestion.md#optional-url) - -## Properties - -### createdAt - -• **createdAt**: *Date* - -*Defined in [schemes/competition.ts:64](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L64)* - -___ - -### `Optional` description - -• **description**? : *undefined | string* - -*Defined in [schemes/competition.ts:58](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L58)* - -___ - -### descriptionHash - -• **descriptionHash**: *string* - -*Defined in [schemes/competition.ts:56](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L56)* - -___ - -### id - -• **id**: *string* - -*Defined in [schemes/competition.ts:53](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L53)* - -___ - -### proposal - -• **proposal**: *string* - -*Defined in [schemes/competition.ts:55](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L55)* - -___ - -### redeemedAt - -• **redeemedAt**: *Date | null* - -*Defined in [schemes/competition.ts:65](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L65)* - -___ - -### rewardPercentage - -• **rewardPercentage**: *number* - -*Defined in [schemes/competition.ts:66](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L66)* - -___ - -### suggester - -• **suggester**: *[Address](../globals.md#address)* - -*Defined in [schemes/competition.ts:61](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L61)* - -___ - -### suggestionId - -• **suggestionId**: *number* - -*Defined in [schemes/competition.ts:54](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L54)* - -___ - -### `Optional` title - -• **title**? : *undefined | string* - -*Defined in [schemes/competition.ts:57](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L57)* - -___ - -### totalVotes - -• **totalVotes**: *BN* - -*Defined in [schemes/competition.ts:63](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L63)* - -___ - -### `Optional` url - -• **url**? : *undefined | string* - -*Defined in [schemes/competition.ts:59](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L59)* diff --git a/docs/interfaces/icompetitionsuggestionqueryoptions.md b/docs/interfaces/icompetitionsuggestionqueryoptions.md index c2d047af..679725ab 100644 --- a/docs/interfaces/icompetitionsuggestionqueryoptions.md +++ b/docs/interfaces/icompetitionsuggestionqueryoptions.md @@ -26,7 +26,7 @@ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[first](icommonqueryoptions.md#optional-first)* -*Defined in [types.ts:16](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L16)* ___ @@ -36,7 +36,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderBy](icommonqueryoptions.md#optional-orderby)* -*Defined in [types.ts:17](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L17)* ___ @@ -46,7 +46,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderDirection](icommonqueryoptions.md#optional-orderdirection)* -*Defined in [types.ts:18](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L18)* ___ @@ -56,7 +56,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[skip](icommonqueryoptions.md#optional-skip)* -*Defined in [types.ts:15](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L15)* ___ @@ -66,4 +66,4 @@ ___ *Overrides [ICommonQueryOptions](icommonqueryoptions.md).[where](icommonqueryoptions.md#optional-where)* -*Defined in [schemes/competition.ts:486](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L486)* +*Defined in [schemes/competition.ts:511](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L511)* diff --git a/docs/interfaces/icompetitionsuggestionstate.md b/docs/interfaces/icompetitionsuggestionstate.md new file mode 100644 index 00000000..e7043aab --- /dev/null +++ b/docs/interfaces/icompetitionsuggestionstate.md @@ -0,0 +1,147 @@ +[@daostack/client](../README.md) › [Globals](../globals.md) › [ICompetitionSuggestionState](icompetitionsuggestionstate.md) + +# Interface: ICompetitionSuggestionState + +## Hierarchy + +* **ICompetitionSuggestionState** + +## Index + +### Properties + +* [createdAt](icompetitionsuggestionstate.md#createdat) +* [description](icompetitionsuggestionstate.md#optional-description) +* [descriptionHash](icompetitionsuggestionstate.md#descriptionhash) +* [id](icompetitionsuggestionstate.md#id) +* [isWinner](icompetitionsuggestionstate.md#iswinner) +* [positionInWinnerList](icompetitionsuggestionstate.md#positioninwinnerlist) +* [proposal](icompetitionsuggestionstate.md#proposal) +* [redeemedAt](icompetitionsuggestionstate.md#redeemedat) +* [rewardPercentage](icompetitionsuggestionstate.md#rewardpercentage) +* [suggester](icompetitionsuggestionstate.md#suggester) +* [suggestionId](icompetitionsuggestionstate.md#suggestionid) +* [tags](icompetitionsuggestionstate.md#tags) +* [title](icompetitionsuggestionstate.md#optional-title) +* [totalVotes](icompetitionsuggestionstate.md#totalvotes) +* [url](icompetitionsuggestionstate.md#optional-url) + +## Properties + +### createdAt + +• **createdAt**: *Date* + +*Defined in [schemes/competition.ts:65](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L65)* + +___ + +### `Optional` description + +• **description**? : *undefined | string* + +*Defined in [schemes/competition.ts:58](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L58)* + +___ + +### descriptionHash + +• **descriptionHash**: *string* + +*Defined in [schemes/competition.ts:56](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L56)* + +___ + +### id + +• **id**: *string* + +*Defined in [schemes/competition.ts:53](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L53)* + +___ + +### isWinner + +• **isWinner**: *boolean* + +*Defined in [schemes/competition.ts:69](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L69)* + +___ + +### positionInWinnerList + +• **positionInWinnerList**: *number | null* + +*Defined in [schemes/competition.ts:68](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L68)* + +___ + +### proposal + +• **proposal**: *string* + +*Defined in [schemes/competition.ts:55](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L55)* + +___ + +### redeemedAt + +• **redeemedAt**: *Date | null* + +*Defined in [schemes/competition.ts:66](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L66)* + +___ + +### rewardPercentage + +• **rewardPercentage**: *number* + +*Defined in [schemes/competition.ts:67](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L67)* + +___ + +### suggester + +• **suggester**: *[Address](../globals.md#address)* + +*Defined in [schemes/competition.ts:61](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L61)* + +___ + +### suggestionId + +• **suggestionId**: *number* + +*Defined in [schemes/competition.ts:54](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L54)* + +___ + +### tags + +• **tags**: *string[]* + +*Defined in [schemes/competition.ts:63](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L63)* + +___ + +### `Optional` title + +• **title**? : *undefined | string* + +*Defined in [schemes/competition.ts:57](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L57)* + +___ + +### totalVotes + +• **totalVotes**: *BN* + +*Defined in [schemes/competition.ts:64](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L64)* + +___ + +### `Optional` url + +• **url**? : *undefined | string* + +*Defined in [schemes/competition.ts:59](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L59)* diff --git a/docs/interfaces/icompetitionvote.md b/docs/interfaces/icompetitionvote.md deleted file mode 100644 index 010521fd..00000000 --- a/docs/interfaces/icompetitionvote.md +++ /dev/null @@ -1,48 +0,0 @@ -[@daostack/client](../README.md) › [Globals](../globals.md) › [ICompetitionVote](icompetitionvote.md) - -# Interface: ICompetitionVote - -## Hierarchy - -* **ICompetitionVote** - -## Index - -### Properties - -* [createdAt](icompetitionvote.md#optional-createdat) -* [id](icompetitionvote.md#optional-id) -* [reputation](icompetitionvote.md#reputation) -* [voter](icompetitionvote.md#voter) - -## Properties - -### `Optional` createdAt - -• **createdAt**? : *[Date](../globals.md#date)* - -*Defined in [schemes/competition.ts:74](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L74)* - -___ - -### `Optional` id - -• **id**? : *undefined | string* - -*Defined in [schemes/competition.ts:70](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L70)* - -___ - -### reputation - -• **reputation**: *BN* - -*Defined in [schemes/competition.ts:75](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L75)* - -___ - -### voter - -• **voter**: *[Address](../globals.md#address)* - -*Defined in [schemes/competition.ts:73](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L73)* diff --git a/docs/interfaces/icompetitionvotequeryoptions.md b/docs/interfaces/icompetitionvotequeryoptions.md index 43b41676..2c272fca 100644 --- a/docs/interfaces/icompetitionvotequeryoptions.md +++ b/docs/interfaces/icompetitionvotequeryoptions.md @@ -4,18 +4,66 @@ ## Hierarchy -* **ICompetitionVoteQueryOptions** +* [ICommonQueryOptions](icommonqueryoptions.md) + + ↳ **ICompetitionVoteQueryOptions** ## Index ### Properties +* [first](icompetitionvotequeryoptions.md#optional-first) +* [orderBy](icompetitionvotequeryoptions.md#optional-orderby) +* [orderDirection](icompetitionvotequeryoptions.md#optional-orderdirection) +* [skip](icompetitionvotequeryoptions.md#optional-skip) * [where](icompetitionvotequeryoptions.md#optional-where) ## Properties +### `Optional` first + +• **first**? : *undefined | number* + +*Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[first](icommonqueryoptions.md#optional-first)* + +*Defined in [types.ts:16](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L16)* + +___ + +### `Optional` orderBy + +• **orderBy**? : *undefined | string* + +*Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderBy](icommonqueryoptions.md#optional-orderby)* + +*Defined in [types.ts:17](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L17)* + +___ + +### `Optional` orderDirection + +• **orderDirection**? : *"asc" | "desc"* + +*Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderDirection](icommonqueryoptions.md#optional-orderdirection)* + +*Defined in [types.ts:18](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L18)* + +___ + +### `Optional` skip + +• **skip**? : *undefined | number* + +*Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[skip](icommonqueryoptions.md#optional-skip)* + +*Defined in [types.ts:15](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L15)* + +___ + ### `Optional` where • **where**? : *undefined | object* -*Defined in [schemes/competition.ts:659](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L659)* +*Overrides [ICommonQueryOptions](icommonqueryoptions.md).[where](icommonqueryoptions.md#optional-where)* + +*Defined in [schemes/competition.ts:705](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L705)* diff --git a/docs/interfaces/icompetitionvotestate.md b/docs/interfaces/icompetitionvotestate.md new file mode 100644 index 00000000..b56549ab --- /dev/null +++ b/docs/interfaces/icompetitionvotestate.md @@ -0,0 +1,48 @@ +[@daostack/client](../README.md) › [Globals](../globals.md) › [ICompetitionVoteState](icompetitionvotestate.md) + +# Interface: ICompetitionVoteState + +## Hierarchy + +* **ICompetitionVoteState** + +## Index + +### Properties + +* [createdAt](icompetitionvotestate.md#optional-createdat) +* [id](icompetitionvotestate.md#optional-id) +* [reputation](icompetitionvotestate.md#reputation) +* [voter](icompetitionvotestate.md#voter) + +## Properties + +### `Optional` createdAt + +• **createdAt**? : *[Date](../globals.md#date)* + +*Defined in [schemes/competition.ts:77](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L77)* + +___ + +### `Optional` id + +• **id**? : *undefined | string* + +*Defined in [schemes/competition.ts:73](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L73)* + +___ + +### reputation + +• **reputation**: *BN* + +*Defined in [schemes/competition.ts:78](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L78)* + +___ + +### voter + +• **voter**: *[Address](../globals.md#address)* + +*Defined in [schemes/competition.ts:76](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L76)* diff --git a/docs/interfaces/icontractinfo.md b/docs/interfaces/icontractinfo.md index 89d3d9b5..7c64df52 100644 --- a/docs/interfaces/icontractinfo.md +++ b/docs/interfaces/icontractinfo.md @@ -21,7 +21,7 @@ • **address**: *[Address](../globals.md#address)* -*Defined in [arc.ts:462](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L462)* +*Defined in [arc.ts:463](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L463)* ___ @@ -29,7 +29,7 @@ ___ • **id**: *string* -*Defined in [arc.ts:460](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L460)* +*Defined in [arc.ts:461](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L461)* ___ @@ -37,7 +37,7 @@ ___ • **name**: *string* -*Defined in [arc.ts:463](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L463)* +*Defined in [arc.ts:464](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L464)* ___ @@ -45,4 +45,4 @@ ___ • **version**: *string* -*Defined in [arc.ts:461](https://github.com/daostack/client/blob/7361fcc/src/arc.ts#L461)* +*Defined in [arc.ts:462](https://github.com/daostack/client/blob/1bc237e/src/arc.ts#L462)* diff --git a/docs/interfaces/icontributionreward.md b/docs/interfaces/icontributionreward.md index ec222730..0556353f 100644 --- a/docs/interfaces/icontributionreward.md +++ b/docs/interfaces/icontributionreward.md @@ -29,7 +29,7 @@ • **alreadyRedeemedEthPeriods**: *number* -*Defined in [schemes/contributionReward.ts:19](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L19)* +*Defined in [schemes/contributionReward.ts:19](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L19)* ___ @@ -37,7 +37,7 @@ ___ • **alreadyRedeemedExternalTokenPeriods**: *number* -*Defined in [schemes/contributionReward.ts:18](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L18)* +*Defined in [schemes/contributionReward.ts:18](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L18)* ___ @@ -45,7 +45,7 @@ ___ • **alreadyRedeemedNativeTokenPeriods**: *number* -*Defined in [schemes/contributionReward.ts:16](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L16)* +*Defined in [schemes/contributionReward.ts:16](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L16)* ___ @@ -53,7 +53,7 @@ ___ • **alreadyRedeemedReputationPeriods**: *number* -*Defined in [schemes/contributionReward.ts:17](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L17)* +*Defined in [schemes/contributionReward.ts:17](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L17)* ___ @@ -61,7 +61,7 @@ ___ • **beneficiary**: *[Address](../globals.md#address)* -*Defined in [schemes/contributionReward.ts:8](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L8)* +*Defined in [schemes/contributionReward.ts:8](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L8)* ___ @@ -69,7 +69,7 @@ ___ • **ethReward**: *BN* -*Defined in [schemes/contributionReward.ts:11](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L11)* +*Defined in [schemes/contributionReward.ts:11](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L11)* ___ @@ -77,7 +77,7 @@ ___ • **externalToken**: *[Address](../globals.md#address)* -*Defined in [schemes/contributionReward.ts:10](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L10)* +*Defined in [schemes/contributionReward.ts:10](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L10)* ___ @@ -85,7 +85,7 @@ ___ • **externalTokenReward**: *BN* -*Defined in [schemes/contributionReward.ts:9](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L9)* +*Defined in [schemes/contributionReward.ts:9](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L9)* ___ @@ -93,7 +93,7 @@ ___ • **nativeTokenReward**: *BN* -*Defined in [schemes/contributionReward.ts:12](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L12)* +*Defined in [schemes/contributionReward.ts:12](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L12)* ___ @@ -101,7 +101,7 @@ ___ • **periodLength**: *number* -*Defined in [schemes/contributionReward.ts:14](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L14)* +*Defined in [schemes/contributionReward.ts:14](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L14)* ___ @@ -109,7 +109,7 @@ ___ • **periods**: *number* -*Defined in [schemes/contributionReward.ts:13](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L13)* +*Defined in [schemes/contributionReward.ts:13](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L13)* ___ @@ -117,4 +117,4 @@ ___ • **reputationReward**: *BN* -*Defined in [schemes/contributionReward.ts:15](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L15)* +*Defined in [schemes/contributionReward.ts:15](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L15)* diff --git a/docs/interfaces/icontributionrewardext.md b/docs/interfaces/icontributionrewardext.md index 91eca498..e206869f 100644 --- a/docs/interfaces/icontributionrewardext.md +++ b/docs/interfaces/icontributionrewardext.md @@ -29,7 +29,7 @@ • **alreadyRedeemedEthPeriods**: *number* -*Defined in [schemes/contributionRewardExt.ts:19](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionRewardExt.ts#L19)* +*Defined in [schemes/contributionRewardExt.ts:19](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionRewardExt.ts#L19)* ___ @@ -37,7 +37,7 @@ ___ • **alreadyRedeemedExternalTokenPeriods**: *number* -*Defined in [schemes/contributionRewardExt.ts:18](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionRewardExt.ts#L18)* +*Defined in [schemes/contributionRewardExt.ts:18](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionRewardExt.ts#L18)* ___ @@ -45,7 +45,7 @@ ___ • **alreadyRedeemedNativeTokenPeriods**: *number* -*Defined in [schemes/contributionRewardExt.ts:16](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionRewardExt.ts#L16)* +*Defined in [schemes/contributionRewardExt.ts:16](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionRewardExt.ts#L16)* ___ @@ -53,7 +53,7 @@ ___ • **alreadyRedeemedReputationPeriods**: *number* -*Defined in [schemes/contributionRewardExt.ts:17](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionRewardExt.ts#L17)* +*Defined in [schemes/contributionRewardExt.ts:17](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionRewardExt.ts#L17)* ___ @@ -61,7 +61,7 @@ ___ • **beneficiary**: *[Address](../globals.md#address)* -*Defined in [schemes/contributionRewardExt.ts:8](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionRewardExt.ts#L8)* +*Defined in [schemes/contributionRewardExt.ts:8](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionRewardExt.ts#L8)* ___ @@ -69,7 +69,7 @@ ___ • **ethReward**: *BN* -*Defined in [schemes/contributionRewardExt.ts:11](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionRewardExt.ts#L11)* +*Defined in [schemes/contributionRewardExt.ts:11](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionRewardExt.ts#L11)* ___ @@ -77,7 +77,7 @@ ___ • **externalToken**: *[Address](../globals.md#address)* -*Defined in [schemes/contributionRewardExt.ts:10](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionRewardExt.ts#L10)* +*Defined in [schemes/contributionRewardExt.ts:10](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionRewardExt.ts#L10)* ___ @@ -85,7 +85,7 @@ ___ • **externalTokenReward**: *BN* -*Defined in [schemes/contributionRewardExt.ts:9](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionRewardExt.ts#L9)* +*Defined in [schemes/contributionRewardExt.ts:9](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionRewardExt.ts#L9)* ___ @@ -93,7 +93,7 @@ ___ • **nativeTokenReward**: *BN* -*Defined in [schemes/contributionRewardExt.ts:12](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionRewardExt.ts#L12)* +*Defined in [schemes/contributionRewardExt.ts:12](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionRewardExt.ts#L12)* ___ @@ -101,7 +101,7 @@ ___ • **periodLength**: *number* -*Defined in [schemes/contributionRewardExt.ts:14](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionRewardExt.ts#L14)* +*Defined in [schemes/contributionRewardExt.ts:14](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionRewardExt.ts#L14)* ___ @@ -109,7 +109,7 @@ ___ • **periods**: *number* -*Defined in [schemes/contributionRewardExt.ts:13](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionRewardExt.ts#L13)* +*Defined in [schemes/contributionRewardExt.ts:13](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionRewardExt.ts#L13)* ___ @@ -117,4 +117,4 @@ ___ • **reputationReward**: *BN* -*Defined in [schemes/contributionRewardExt.ts:15](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionRewardExt.ts#L15)* +*Defined in [schemes/contributionRewardExt.ts:15](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionRewardExt.ts#L15)* diff --git a/docs/interfaces/icontributionrewardextparams.md b/docs/interfaces/icontributionrewardextparams.md index 80bf3faf..90245b66 100644 --- a/docs/interfaces/icontributionrewardextparams.md +++ b/docs/interfaces/icontributionrewardextparams.md @@ -20,9 +20,9 @@ • **rewarder**: *[Address](../globals.md#address)* -*Defined in [schemes/base.ts:63](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L63)* +*Defined in [schemes/base.ts:63](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L63)* -*Defined in [scheme.ts:66](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L66)* +*Defined in [scheme.ts:66](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L66)* ___ @@ -30,9 +30,9 @@ ___ • **voteParams**: *[IGenesisProtocolParams](igenesisprotocolparams.md)* -*Defined in [schemes/base.ts:62](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L62)* +*Defined in [schemes/base.ts:62](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L62)* -*Defined in [scheme.ts:65](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L65)* +*Defined in [scheme.ts:65](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L65)* ___ @@ -40,6 +40,6 @@ ___ • **votingMachine**: *[Address](../globals.md#address)* -*Defined in [schemes/base.ts:61](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L61)* +*Defined in [schemes/base.ts:61](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L61)* -*Defined in [scheme.ts:64](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L64)* +*Defined in [scheme.ts:64](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L64)* diff --git a/docs/interfaces/icontributionrewardparams.md b/docs/interfaces/icontributionrewardparams.md index 0b045bc3..b369d682 100644 --- a/docs/interfaces/icontributionrewardparams.md +++ b/docs/interfaces/icontributionrewardparams.md @@ -19,9 +19,9 @@ • **voteParams**: *[IGenesisProtocolParams](igenesisprotocolparams.md)* -*Defined in [schemes/base.ts:58](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L58)* +*Defined in [schemes/base.ts:58](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L58)* -*Defined in [scheme.ts:61](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L61)* +*Defined in [scheme.ts:61](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L61)* ___ @@ -29,6 +29,6 @@ ___ • **votingMachine**: *[Address](../globals.md#address)* -*Defined in [schemes/base.ts:57](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L57)* +*Defined in [schemes/base.ts:57](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L57)* -*Defined in [scheme.ts:60](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L60)* +*Defined in [scheme.ts:60](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L60)* diff --git a/docs/interfaces/idaoqueryoptions.md b/docs/interfaces/idaoqueryoptions.md index 01f64b54..160c12b8 100644 --- a/docs/interfaces/idaoqueryoptions.md +++ b/docs/interfaces/idaoqueryoptions.md @@ -26,7 +26,7 @@ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[first](icommonqueryoptions.md#optional-first)* -*Defined in [types.ts:16](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L16)* ___ @@ -36,7 +36,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderBy](icommonqueryoptions.md#optional-orderby)* -*Defined in [types.ts:17](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L17)* ___ @@ -46,7 +46,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderDirection](icommonqueryoptions.md#optional-orderdirection)* -*Defined in [types.ts:18](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L18)* ___ @@ -56,7 +56,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[skip](icommonqueryoptions.md#optional-skip)* -*Defined in [types.ts:15](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L15)* ___ @@ -66,4 +66,4 @@ ___ *Overrides [ICommonQueryOptions](icommonqueryoptions.md).[where](icommonqueryoptions.md#optional-where)* -*Defined in [dao.ts:41](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L41)* +*Defined in [dao.ts:41](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L41)* diff --git a/docs/interfaces/idaostate.md b/docs/interfaces/idaostate.md index 7b78f286..6b737ed9 100644 --- a/docs/interfaces/idaostate.md +++ b/docs/interfaces/idaostate.md @@ -36,7 +36,7 @@ *Inherited from [IDAOStaticState](idaostaticstate.md).[address](idaostaticstate.md#address)* -*Defined in [dao.ts:21](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L21)* +*Defined in [dao.ts:21](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L21)* ___ @@ -44,7 +44,7 @@ ___ • **dao**: *[DAO](../classes/dao.md)* -*Defined in [dao.ts:34](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L34)* +*Defined in [dao.ts:34](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L34)* ___ @@ -54,7 +54,7 @@ ___ *Inherited from [IDAOStaticState](idaostaticstate.md).[id](idaostaticstate.md#id)* -*Defined in [dao.ts:20](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L20)* +*Defined in [dao.ts:20](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L20)* ___ @@ -62,7 +62,7 @@ ___ • **memberCount**: *number* -*Defined in [dao.ts:31](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L31)* +*Defined in [dao.ts:31](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L31)* ___ @@ -72,7 +72,7 @@ ___ *Inherited from [IDAOStaticState](idaostaticstate.md).[name](idaostaticstate.md#name)* -*Defined in [dao.ts:22](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L22)* +*Defined in [dao.ts:22](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L22)* ___ @@ -80,7 +80,7 @@ ___ • **numberOfBoostedProposals**: *number* -*Defined in [dao.ts:37](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L37)* +*Defined in [dao.ts:37](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L37)* ___ @@ -88,7 +88,7 @@ ___ • **numberOfPreBoostedProposals**: *number* -*Defined in [dao.ts:36](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L36)* +*Defined in [dao.ts:36](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L36)* ___ @@ -96,7 +96,7 @@ ___ • **numberOfQueuedProposals**: *number* -*Defined in [dao.ts:35](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L35)* +*Defined in [dao.ts:35](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L35)* ___ @@ -106,7 +106,7 @@ ___ *Inherited from [IDAOStaticState](idaostaticstate.md).[register](idaostaticstate.md#register)* -*Defined in [dao.ts:23](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L23)* +*Defined in [dao.ts:23](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L23)* ___ @@ -116,7 +116,7 @@ ___ *Inherited from [IDAOStaticState](idaostaticstate.md).[reputation](idaostaticstate.md#reputation)* -*Defined in [dao.ts:24](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L24)* +*Defined in [dao.ts:24](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L24)* ___ @@ -124,7 +124,7 @@ ___ • **reputationTotalSupply**: *BN* -*Defined in [dao.ts:32](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L32)* +*Defined in [dao.ts:32](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L32)* ___ @@ -134,7 +134,7 @@ ___ *Inherited from [IDAOStaticState](idaostaticstate.md).[token](idaostaticstate.md#token)* -*Defined in [dao.ts:25](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L25)* +*Defined in [dao.ts:25](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L25)* ___ @@ -144,7 +144,7 @@ ___ *Inherited from [IDAOStaticState](idaostaticstate.md).[tokenName](idaostaticstate.md#tokenname)* -*Defined in [dao.ts:26](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L26)* +*Defined in [dao.ts:26](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L26)* ___ @@ -154,7 +154,7 @@ ___ *Inherited from [IDAOStaticState](idaostaticstate.md).[tokenSymbol](idaostaticstate.md#tokensymbol)* -*Defined in [dao.ts:27](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L27)* +*Defined in [dao.ts:27](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L27)* ___ @@ -162,4 +162,4 @@ ___ • **tokenTotalSupply**: *BN* -*Defined in [dao.ts:33](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L33)* +*Defined in [dao.ts:33](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L33)* diff --git a/docs/interfaces/idaostaticstate.md b/docs/interfaces/idaostaticstate.md index 37b4f01e..73c47178 100644 --- a/docs/interfaces/idaostaticstate.md +++ b/docs/interfaces/idaostaticstate.md @@ -27,7 +27,7 @@ • **address**: *[Address](../globals.md#address)* -*Defined in [dao.ts:21](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L21)* +*Defined in [dao.ts:21](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L21)* ___ @@ -35,7 +35,7 @@ ___ • **id**: *[Address](../globals.md#address)* -*Defined in [dao.ts:20](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L20)* +*Defined in [dao.ts:20](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L20)* ___ @@ -43,7 +43,7 @@ ___ • **name**: *string* -*Defined in [dao.ts:22](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L22)* +*Defined in [dao.ts:22](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L22)* ___ @@ -51,7 +51,7 @@ ___ • **register**: *"na" | "proposed" | "registered" | "unRegistered"* -*Defined in [dao.ts:23](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L23)* +*Defined in [dao.ts:23](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L23)* ___ @@ -59,7 +59,7 @@ ___ • **reputation**: *[Reputation](../classes/reputation.md)* -*Defined in [dao.ts:24](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L24)* +*Defined in [dao.ts:24](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L24)* ___ @@ -67,7 +67,7 @@ ___ • **token**: *[Token](../classes/token.md)* -*Defined in [dao.ts:25](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L25)* +*Defined in [dao.ts:25](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L25)* ___ @@ -75,7 +75,7 @@ ___ • **tokenName**: *string* -*Defined in [dao.ts:26](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L26)* +*Defined in [dao.ts:26](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L26)* ___ @@ -83,4 +83,4 @@ ___ • **tokenSymbol**: *string* -*Defined in [dao.ts:27](https://github.com/daostack/client/blob/7361fcc/src/dao.ts#L27)* +*Defined in [dao.ts:27](https://github.com/daostack/client/blob/1bc237e/src/dao.ts#L27)* diff --git a/docs/interfaces/ieventqueryoptions.md b/docs/interfaces/ieventqueryoptions.md index 964ae5e3..62ca7fcb 100644 --- a/docs/interfaces/ieventqueryoptions.md +++ b/docs/interfaces/ieventqueryoptions.md @@ -26,7 +26,7 @@ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[first](icommonqueryoptions.md#optional-first)* -*Defined in [types.ts:16](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L16)* ___ @@ -36,7 +36,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderBy](icommonqueryoptions.md#optional-orderby)* -*Defined in [types.ts:17](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L17)* ___ @@ -46,7 +46,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderDirection](icommonqueryoptions.md#optional-orderdirection)* -*Defined in [types.ts:18](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L18)* ___ @@ -56,7 +56,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[skip](icommonqueryoptions.md#optional-skip)* -*Defined in [types.ts:15](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L15)* ___ @@ -66,4 +66,4 @@ ___ *Overrides [ICommonQueryOptions](icommonqueryoptions.md).[where](icommonqueryoptions.md#optional-where)* -*Defined in [event.ts:23](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L23)* +*Defined in [event.ts:23](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L23)* diff --git a/docs/interfaces/ieventstate.md b/docs/interfaces/ieventstate.md index 4d1dade5..54892301 100644 --- a/docs/interfaces/ieventstate.md +++ b/docs/interfaces/ieventstate.md @@ -28,7 +28,7 @@ *Inherited from [IEventStaticState](ieventstaticstate.md).[dao](ieventstaticstate.md#dao)* -*Defined in [event.ts:10](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L10)* +*Defined in [event.ts:10](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L10)* ___ @@ -38,7 +38,7 @@ ___ *Inherited from [IEventStaticState](ieventstaticstate.md).[data](ieventstaticstate.md#data)* -*Defined in [event.ts:14](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L14)* +*Defined in [event.ts:14](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L14)* #### Type declaration: @@ -52,7 +52,7 @@ ___ *Overrides [IEventStaticState](ieventstaticstate.md).[id](ieventstaticstate.md#id)* -*Defined in [event.ts:19](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L19)* +*Defined in [event.ts:19](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L19)* ___ @@ -62,7 +62,7 @@ ___ *Inherited from [IEventStaticState](ieventstaticstate.md).[proposal](ieventstaticstate.md#proposal)* -*Defined in [event.ts:11](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L11)* +*Defined in [event.ts:11](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L11)* ___ @@ -72,7 +72,7 @@ ___ *Inherited from [IEventStaticState](ieventstaticstate.md).[timestamp](ieventstaticstate.md#timestamp)* -*Defined in [event.ts:15](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L15)* +*Defined in [event.ts:15](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L15)* ___ @@ -82,7 +82,7 @@ ___ *Inherited from [IEventStaticState](ieventstaticstate.md).[type](ieventstaticstate.md#type)* -*Defined in [event.ts:13](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L13)* +*Defined in [event.ts:13](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L13)* ___ @@ -92,4 +92,4 @@ ___ *Inherited from [IEventStaticState](ieventstaticstate.md).[user](ieventstaticstate.md#user)* -*Defined in [event.ts:12](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L12)* +*Defined in [event.ts:12](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L12)* diff --git a/docs/interfaces/ieventstaticstate.md b/docs/interfaces/ieventstaticstate.md index aec97416..800d7d39 100644 --- a/docs/interfaces/ieventstaticstate.md +++ b/docs/interfaces/ieventstaticstate.md @@ -26,7 +26,7 @@ • **dao**: *string* -*Defined in [event.ts:10](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L10)* +*Defined in [event.ts:10](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L10)* ___ @@ -34,7 +34,7 @@ ___ • **data**: *object* -*Defined in [event.ts:14](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L14)* +*Defined in [event.ts:14](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L14)* #### Type declaration: @@ -46,7 +46,7 @@ ___ • **id**: *string* -*Defined in [event.ts:9](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L9)* +*Defined in [event.ts:9](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L9)* ___ @@ -54,7 +54,7 @@ ___ • **proposal**: *string* -*Defined in [event.ts:11](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L11)* +*Defined in [event.ts:11](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L11)* ___ @@ -62,7 +62,7 @@ ___ • **timestamp**: *string* -*Defined in [event.ts:15](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L15)* +*Defined in [event.ts:15](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L15)* ___ @@ -70,7 +70,7 @@ ___ • **type**: *string* -*Defined in [event.ts:13](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L13)* +*Defined in [event.ts:13](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L13)* ___ @@ -78,4 +78,4 @@ ___ • **user**: *string* -*Defined in [event.ts:12](https://github.com/daostack/client/blob/7361fcc/src/event.ts#L12)* +*Defined in [event.ts:12](https://github.com/daostack/client/blob/1bc237e/src/event.ts#L12)* diff --git a/docs/interfaces/igenericscheme.md b/docs/interfaces/igenericscheme.md index 35450064..16163a89 100644 --- a/docs/interfaces/igenericscheme.md +++ b/docs/interfaces/igenericscheme.md @@ -22,7 +22,7 @@ • **callData**: *string* -*Defined in [schemes/genericScheme.ts:14](https://github.com/daostack/client/blob/7361fcc/src/schemes/genericScheme.ts#L14)* +*Defined in [schemes/genericScheme.ts:14](https://github.com/daostack/client/blob/1bc237e/src/schemes/genericScheme.ts#L14)* ___ @@ -30,7 +30,7 @@ ___ • **contractToCall**: *[Address](../globals.md#address)* -*Defined in [schemes/genericScheme.ts:13](https://github.com/daostack/client/blob/7361fcc/src/schemes/genericScheme.ts#L13)* +*Defined in [schemes/genericScheme.ts:13](https://github.com/daostack/client/blob/1bc237e/src/schemes/genericScheme.ts#L13)* ___ @@ -38,7 +38,7 @@ ___ • **executed**: *boolean* -*Defined in [schemes/genericScheme.ts:15](https://github.com/daostack/client/blob/7361fcc/src/schemes/genericScheme.ts#L15)* +*Defined in [schemes/genericScheme.ts:15](https://github.com/daostack/client/blob/1bc237e/src/schemes/genericScheme.ts#L15)* ___ @@ -46,7 +46,7 @@ ___ • **id**: *string* -*Defined in [schemes/genericScheme.ts:12](https://github.com/daostack/client/blob/7361fcc/src/schemes/genericScheme.ts#L12)* +*Defined in [schemes/genericScheme.ts:12](https://github.com/daostack/client/blob/1bc237e/src/schemes/genericScheme.ts#L12)* ___ @@ -54,4 +54,4 @@ ___ • **returnValue**: *string* -*Defined in [schemes/genericScheme.ts:16](https://github.com/daostack/client/blob/7361fcc/src/schemes/genericScheme.ts#L16)* +*Defined in [schemes/genericScheme.ts:16](https://github.com/daostack/client/blob/1bc237e/src/schemes/genericScheme.ts#L16)* diff --git a/docs/interfaces/igenericschemeinfo.md b/docs/interfaces/igenericschemeinfo.md index ba65e957..85dc785d 100644 --- a/docs/interfaces/igenericschemeinfo.md +++ b/docs/interfaces/igenericschemeinfo.md @@ -20,7 +20,7 @@ • **contractToCall**: *[Address](../globals.md#address)* -*Defined in [schemes/genericScheme.ts:7](https://github.com/daostack/client/blob/7361fcc/src/schemes/genericScheme.ts#L7)* +*Defined in [schemes/genericScheme.ts:7](https://github.com/daostack/client/blob/1bc237e/src/schemes/genericScheme.ts#L7)* ___ @@ -28,7 +28,7 @@ ___ • **id**: *string* -*Defined in [schemes/genericScheme.ts:6](https://github.com/daostack/client/blob/7361fcc/src/schemes/genericScheme.ts#L6)* +*Defined in [schemes/genericScheme.ts:6](https://github.com/daostack/client/blob/1bc237e/src/schemes/genericScheme.ts#L6)* ___ @@ -36,4 +36,4 @@ ___ • **votingMachine**: *[Address](../globals.md#address)* -*Defined in [schemes/genericScheme.ts:8](https://github.com/daostack/client/blob/7361fcc/src/schemes/genericScheme.ts#L8)* +*Defined in [schemes/genericScheme.ts:8](https://github.com/daostack/client/blob/1bc237e/src/schemes/genericScheme.ts#L8)* diff --git a/docs/interfaces/igenericschemeparams.md b/docs/interfaces/igenericschemeparams.md index eefcdb91..fd4a245e 100644 --- a/docs/interfaces/igenericschemeparams.md +++ b/docs/interfaces/igenericschemeparams.md @@ -20,9 +20,9 @@ • **contractToCall**: *[Address](../globals.md#address)* -*Defined in [schemes/base.ts:52](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L52)* +*Defined in [schemes/base.ts:52](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L52)* -*Defined in [scheme.ts:55](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L55)* +*Defined in [scheme.ts:55](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L55)* ___ @@ -30,9 +30,9 @@ ___ • **voteParams**: *[IGenesisProtocolParams](igenesisprotocolparams.md)* -*Defined in [schemes/base.ts:53](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L53)* +*Defined in [schemes/base.ts:53](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L53)* -*Defined in [scheme.ts:56](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L56)* +*Defined in [scheme.ts:56](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L56)* ___ @@ -40,6 +40,6 @@ ___ • **votingMachine**: *[Address](../globals.md#address)* -*Defined in [schemes/base.ts:51](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L51)* +*Defined in [schemes/base.ts:51](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L51)* -*Defined in [scheme.ts:54](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L54)* +*Defined in [scheme.ts:54](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L54)* diff --git a/docs/interfaces/igenesisprotocolparams.md b/docs/interfaces/igenesisprotocolparams.md index b6b838bd..306222a2 100644 --- a/docs/interfaces/igenesisprotocolparams.md +++ b/docs/interfaces/igenesisprotocolparams.md @@ -29,7 +29,7 @@ • **activationTime**: *number* -*Defined in [genesisProtocol.ts:5](https://github.com/daostack/client/blob/7361fcc/src/genesisProtocol.ts#L5)* +*Defined in [genesisProtocol.ts:5](https://github.com/daostack/client/blob/1bc237e/src/genesisProtocol.ts#L5)* ___ @@ -37,7 +37,7 @@ ___ • **boostedVotePeriodLimit**: *number* -*Defined in [genesisProtocol.ts:6](https://github.com/daostack/client/blob/7361fcc/src/genesisProtocol.ts#L6)* +*Defined in [genesisProtocol.ts:6](https://github.com/daostack/client/blob/1bc237e/src/genesisProtocol.ts#L6)* ___ @@ -45,7 +45,7 @@ ___ • **daoBountyConst**: *number* -*Defined in [genesisProtocol.ts:7](https://github.com/daostack/client/blob/7361fcc/src/genesisProtocol.ts#L7)* +*Defined in [genesisProtocol.ts:7](https://github.com/daostack/client/blob/1bc237e/src/genesisProtocol.ts#L7)* ___ @@ -53,7 +53,7 @@ ___ • **limitExponentValue**: *number* -*Defined in [genesisProtocol.ts:8](https://github.com/daostack/client/blob/7361fcc/src/genesisProtocol.ts#L8)* +*Defined in [genesisProtocol.ts:8](https://github.com/daostack/client/blob/1bc237e/src/genesisProtocol.ts#L8)* ___ @@ -61,7 +61,7 @@ ___ • **minimumDaoBounty**: *BN* -*Defined in [genesisProtocol.ts:9](https://github.com/daostack/client/blob/7361fcc/src/genesisProtocol.ts#L9)* +*Defined in [genesisProtocol.ts:9](https://github.com/daostack/client/blob/1bc237e/src/genesisProtocol.ts#L9)* ___ @@ -69,7 +69,7 @@ ___ • **preBoostedVotePeriodLimit**: *number* -*Defined in [genesisProtocol.ts:10](https://github.com/daostack/client/blob/7361fcc/src/genesisProtocol.ts#L10)* +*Defined in [genesisProtocol.ts:10](https://github.com/daostack/client/blob/1bc237e/src/genesisProtocol.ts#L10)* ___ @@ -77,7 +77,7 @@ ___ • **proposingRepReward**: *BN* -*Defined in [genesisProtocol.ts:11](https://github.com/daostack/client/blob/7361fcc/src/genesisProtocol.ts#L11)* +*Defined in [genesisProtocol.ts:11](https://github.com/daostack/client/blob/1bc237e/src/genesisProtocol.ts#L11)* ___ @@ -85,7 +85,7 @@ ___ • **queuedVotePeriodLimit**: *number* -*Defined in [genesisProtocol.ts:13](https://github.com/daostack/client/blob/7361fcc/src/genesisProtocol.ts#L13)* +*Defined in [genesisProtocol.ts:13](https://github.com/daostack/client/blob/1bc237e/src/genesisProtocol.ts#L13)* ___ @@ -93,7 +93,7 @@ ___ • **queuedVoteRequiredPercentage**: *number* -*Defined in [genesisProtocol.ts:12](https://github.com/daostack/client/blob/7361fcc/src/genesisProtocol.ts#L12)* +*Defined in [genesisProtocol.ts:12](https://github.com/daostack/client/blob/1bc237e/src/genesisProtocol.ts#L12)* ___ @@ -101,7 +101,7 @@ ___ • **quietEndingPeriod**: *number* -*Defined in [genesisProtocol.ts:14](https://github.com/daostack/client/blob/7361fcc/src/genesisProtocol.ts#L14)* +*Defined in [genesisProtocol.ts:14](https://github.com/daostack/client/blob/1bc237e/src/genesisProtocol.ts#L14)* ___ @@ -109,7 +109,7 @@ ___ • **thresholdConst**: *number* -*Defined in [genesisProtocol.ts:15](https://github.com/daostack/client/blob/7361fcc/src/genesisProtocol.ts#L15)* +*Defined in [genesisProtocol.ts:15](https://github.com/daostack/client/blob/1bc237e/src/genesisProtocol.ts#L15)* ___ @@ -117,4 +117,4 @@ ___ • **votersReputationLossRatio**: *number* -*Defined in [genesisProtocol.ts:16](https://github.com/daostack/client/blob/7361fcc/src/genesisProtocol.ts#L16)* +*Defined in [genesisProtocol.ts:16](https://github.com/daostack/client/blob/1bc237e/src/genesisProtocol.ts#L16)* diff --git a/docs/interfaces/imemberqueryoptions.md b/docs/interfaces/imemberqueryoptions.md index a184b4d7..9b0f1fed 100644 --- a/docs/interfaces/imemberqueryoptions.md +++ b/docs/interfaces/imemberqueryoptions.md @@ -26,7 +26,7 @@ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[first](icommonqueryoptions.md#optional-first)* -*Defined in [types.ts:16](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L16)* ___ @@ -36,7 +36,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderBy](icommonqueryoptions.md#optional-orderby)* -*Defined in [types.ts:17](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L17)* ___ @@ -46,7 +46,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderDirection](icommonqueryoptions.md#optional-orderdirection)* -*Defined in [types.ts:18](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L18)* ___ @@ -56,7 +56,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[skip](icommonqueryoptions.md#optional-skip)* -*Defined in [types.ts:15](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L15)* ___ @@ -66,4 +66,4 @@ ___ *Overrides [ICommonQueryOptions](icommonqueryoptions.md).[where](icommonqueryoptions.md#optional-where)* -*Defined in [member.ts:31](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L31)* +*Defined in [member.ts:31](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L31)* diff --git a/docs/interfaces/imemberstate.md b/docs/interfaces/imemberstate.md index 4d8636ca..fc1ab1bb 100644 --- a/docs/interfaces/imemberstate.md +++ b/docs/interfaces/imemberstate.md @@ -26,7 +26,7 @@ *Inherited from [IMemberStaticState](imemberstaticstate.md).[address](imemberstaticstate.md#address)* -*Defined in [member.ts:20](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L20)* +*Defined in [member.ts:20](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L20)* ___ @@ -36,7 +36,7 @@ ___ *Overrides [IMemberStaticState](imemberstaticstate.md).[contract](imemberstaticstate.md#optional-contract)* -*Defined in [member.ts:25](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L25)* +*Defined in [member.ts:25](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L25)* ___ @@ -46,7 +46,7 @@ ___ *Inherited from [IMemberStaticState](imemberstaticstate.md).[dao](imemberstaticstate.md#optional-dao)* -*Defined in [member.ts:22](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L22)* +*Defined in [member.ts:22](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L22)* ___ @@ -56,7 +56,7 @@ ___ *Overrides [IMemberStaticState](imemberstaticstate.md).[id](imemberstaticstate.md#optional-id)* -*Defined in [member.ts:26](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L26)* +*Defined in [member.ts:26](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L26)* ___ @@ -64,4 +64,4 @@ ___ • **reputation**: *BN* -*Defined in [member.ts:27](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L27)* +*Defined in [member.ts:27](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L27)* diff --git a/docs/interfaces/imemberstaticstate.md b/docs/interfaces/imemberstaticstate.md index c362fe13..2bf5fcbe 100644 --- a/docs/interfaces/imemberstaticstate.md +++ b/docs/interfaces/imemberstaticstate.md @@ -23,7 +23,7 @@ • **address**: *[Address](../globals.md#address)* -*Defined in [member.ts:20](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L20)* +*Defined in [member.ts:20](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L20)* ___ @@ -31,7 +31,7 @@ ___ • **contract**? : *[Address](../globals.md#address)* -*Defined in [member.ts:21](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L21)* +*Defined in [member.ts:21](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L21)* ___ @@ -39,7 +39,7 @@ ___ • **dao**? : *[Address](../globals.md#address)* -*Defined in [member.ts:22](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L22)* +*Defined in [member.ts:22](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L22)* ___ @@ -47,4 +47,4 @@ ___ • **id**? : *undefined | string* -*Defined in [member.ts:19](https://github.com/daostack/client/blob/7361fcc/src/member.ts#L19)* +*Defined in [member.ts:19](https://github.com/daostack/client/blob/1bc237e/src/member.ts#L19)* diff --git a/docs/interfaces/iobservable.md b/docs/interfaces/iobservable.md index 138eb06c..2e844e0e 100644 --- a/docs/interfaces/iobservable.md +++ b/docs/interfaces/iobservable.md @@ -80,7 +80,7 @@ ___ • **first**: *function* -*Defined in [graphnode.ts:23](https://github.com/daostack/client/blob/7361fcc/src/graphnode.ts#L23)* +*Defined in [graphnode.ts:23](https://github.com/daostack/client/blob/1bc237e/src/graphnode.ts#L23)* #### Type declaration: diff --git a/docs/interfaces/ioperationobservable.md b/docs/interfaces/ioperationobservable.md index 1763be38..7e4c726d 100644 --- a/docs/interfaces/ioperationobservable.md +++ b/docs/interfaces/ioperationobservable.md @@ -94,7 +94,7 @@ ___ • **send**: *function* -*Defined in [operation.ts:35](https://github.com/daostack/client/blob/7361fcc/src/operation.ts#L35)* +*Defined in [operation.ts:35](https://github.com/daostack/client/blob/1bc237e/src/operation.ts#L35)* #### Type declaration: diff --git a/docs/interfaces/iproposalbasecreateoptions.md b/docs/interfaces/iproposalbasecreateoptions.md index 39d568cb..e448a090 100644 --- a/docs/interfaces/iproposalbasecreateoptions.md +++ b/docs/interfaces/iproposalbasecreateoptions.md @@ -29,7 +29,7 @@ • **dao**: *[Address](../globals.md#address)* -*Defined in [proposal.ts:860](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L860)* +*Defined in [proposal.ts:871](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L871)* ___ @@ -37,7 +37,7 @@ ___ • **description**? : *undefined | string* -*Defined in [proposal.ts:861](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L861)* +*Defined in [proposal.ts:872](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L872)* ___ @@ -45,7 +45,7 @@ ___ • **descriptionHash**? : *undefined | string* -*Defined in [proposal.ts:862](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L862)* +*Defined in [proposal.ts:873](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L873)* ___ @@ -53,7 +53,7 @@ ___ • **proposalType**? : *undefined | string* -*Defined in [proposal.ts:868](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L868)* +*Defined in [proposal.ts:879](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L879)* ___ @@ -61,7 +61,7 @@ ___ • **scheme**? : *[Address](../globals.md#address)* -*Defined in [proposal.ts:865](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L865)* +*Defined in [proposal.ts:876](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L876)* ___ @@ -69,7 +69,7 @@ ___ • **tags**? : *string[]* -*Defined in [proposal.ts:864](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L864)* +*Defined in [proposal.ts:875](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L875)* ___ @@ -77,7 +77,7 @@ ___ • **title**? : *undefined | string* -*Defined in [proposal.ts:863](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L863)* +*Defined in [proposal.ts:874](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L874)* ___ @@ -85,4 +85,4 @@ ___ • **url**? : *undefined | string* -*Defined in [proposal.ts:866](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L866)* +*Defined in [proposal.ts:877](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L877)* diff --git a/docs/interfaces/iproposalcreateoptionscompetition.md b/docs/interfaces/iproposalcreateoptionscompetition.md index bf00c58f..2497eb55 100644 --- a/docs/interfaces/iproposalcreateoptionscompetition.md +++ b/docs/interfaces/iproposalcreateoptionscompetition.md @@ -40,7 +40,7 @@ *Inherited from [IProposalBaseCreateOptions](iproposalbasecreateoptions.md).[dao](iproposalbasecreateoptions.md#dao)* -*Defined in [proposal.ts:860](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L860)* +*Defined in [proposal.ts:871](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L871)* ___ @@ -50,7 +50,7 @@ ___ *Inherited from [IProposalBaseCreateOptions](iproposalbasecreateoptions.md).[description](iproposalbasecreateoptions.md#optional-description)* -*Defined in [proposal.ts:861](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L861)* +*Defined in [proposal.ts:872](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L872)* ___ @@ -60,7 +60,7 @@ ___ *Inherited from [IProposalBaseCreateOptions](iproposalbasecreateoptions.md).[descriptionHash](iproposalbasecreateoptions.md#optional-descriptionhash)* -*Defined in [proposal.ts:862](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L862)* +*Defined in [proposal.ts:873](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L873)* ___ @@ -68,7 +68,7 @@ ___ • **endTime**: *Date* -*Defined in [schemes/competition.ts:38](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L38)* +*Defined in [schemes/competition.ts:38](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L38)* ___ @@ -76,7 +76,7 @@ ___ • **ethReward**? : *BN* -*Defined in [schemes/competition.ts:40](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L40)* +*Defined in [schemes/competition.ts:40](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L40)* ___ @@ -84,7 +84,7 @@ ___ • **externalTokenAddress**? : *[Address](../globals.md#address)* -*Defined in [schemes/competition.ts:42](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L42)* +*Defined in [schemes/competition.ts:42](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L42)* ___ @@ -92,7 +92,7 @@ ___ • **externalTokenReward**? : *BN* -*Defined in [schemes/competition.ts:41](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L41)* +*Defined in [schemes/competition.ts:41](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L41)* ___ @@ -100,7 +100,7 @@ ___ • **nativeTokenReward**? : *BN* -*Defined in [schemes/competition.ts:45](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L45)* +*Defined in [schemes/competition.ts:45](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L45)* ___ @@ -108,7 +108,7 @@ ___ • **numberOfVotesPerVoter**: *number* -*Defined in [schemes/competition.ts:46](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L46)* +*Defined in [schemes/competition.ts:46](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L46)* ___ @@ -118,7 +118,7 @@ ___ *Inherited from [IProposalBaseCreateOptions](iproposalbasecreateoptions.md).[proposalType](iproposalbasecreateoptions.md#optional-proposaltype)* -*Defined in [proposal.ts:868](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L868)* +*Defined in [proposal.ts:879](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L879)* ___ @@ -126,7 +126,7 @@ ___ • **reputationReward**? : *BN* -*Defined in [schemes/competition.ts:39](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L39)* +*Defined in [schemes/competition.ts:39](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L39)* ___ @@ -134,7 +134,7 @@ ___ • **rewardSplit**: *number[]* -*Defined in [schemes/competition.ts:44](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L44)* +*Defined in [schemes/competition.ts:44](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L44)* ___ @@ -144,7 +144,7 @@ ___ *Inherited from [IProposalBaseCreateOptions](iproposalbasecreateoptions.md).[scheme](iproposalbasecreateoptions.md#optional-scheme)* -*Defined in [proposal.ts:865](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L865)* +*Defined in [proposal.ts:876](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L876)* ___ @@ -152,7 +152,7 @@ ___ • **startTime**: *Date | null* -*Defined in [schemes/competition.ts:47](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L47)* +*Defined in [schemes/competition.ts:47](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L47)* ___ @@ -160,7 +160,7 @@ ___ • **suggestionsEndTime**: *Date* -*Defined in [schemes/competition.ts:48](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L48)* +*Defined in [schemes/competition.ts:48](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L48)* ___ @@ -170,7 +170,7 @@ ___ *Inherited from [IProposalBaseCreateOptions](iproposalbasecreateoptions.md).[tags](iproposalbasecreateoptions.md#optional-tags)* -*Defined in [proposal.ts:864](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L864)* +*Defined in [proposal.ts:875](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L875)* ___ @@ -180,7 +180,7 @@ ___ *Inherited from [IProposalBaseCreateOptions](iproposalbasecreateoptions.md).[title](iproposalbasecreateoptions.md#optional-title)* -*Defined in [proposal.ts:863](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L863)* +*Defined in [proposal.ts:874](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L874)* ___ @@ -190,7 +190,7 @@ ___ *Inherited from [IProposalBaseCreateOptions](iproposalbasecreateoptions.md).[url](iproposalbasecreateoptions.md#optional-url)* -*Defined in [proposal.ts:866](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L866)* +*Defined in [proposal.ts:877](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L877)* ___ @@ -198,4 +198,4 @@ ___ • **votingStartTime**: *Date* -*Defined in [schemes/competition.ts:49](https://github.com/daostack/client/blob/7361fcc/src/schemes/competition.ts#L49)* +*Defined in [schemes/competition.ts:49](https://github.com/daostack/client/blob/1bc237e/src/schemes/competition.ts#L49)* diff --git a/docs/interfaces/iproposalcreateoptionscontributionrewardext.md b/docs/interfaces/iproposalcreateoptionscontributionrewardext.md index 7ec68405..29f16512 100644 --- a/docs/interfaces/iproposalcreateoptionscontributionrewardext.md +++ b/docs/interfaces/iproposalcreateoptionscontributionrewardext.md @@ -34,7 +34,7 @@ • **beneficiary**: *[Address](../globals.md#address)* -*Defined in [schemes/contributionRewardExt.ts:23](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionRewardExt.ts#L23)* +*Defined in [schemes/contributionRewardExt.ts:23](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionRewardExt.ts#L23)* ___ @@ -44,7 +44,7 @@ ___ *Inherited from [IProposalBaseCreateOptions](iproposalbasecreateoptions.md).[dao](iproposalbasecreateoptions.md#dao)* -*Defined in [proposal.ts:860](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L860)* +*Defined in [proposal.ts:871](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L871)* ___ @@ -54,7 +54,7 @@ ___ *Inherited from [IProposalBaseCreateOptions](iproposalbasecreateoptions.md).[description](iproposalbasecreateoptions.md#optional-description)* -*Defined in [proposal.ts:861](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L861)* +*Defined in [proposal.ts:872](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L872)* ___ @@ -64,7 +64,7 @@ ___ *Inherited from [IProposalBaseCreateOptions](iproposalbasecreateoptions.md).[descriptionHash](iproposalbasecreateoptions.md#optional-descriptionhash)* -*Defined in [proposal.ts:862](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L862)* +*Defined in [proposal.ts:873](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L873)* ___ @@ -72,7 +72,7 @@ ___ • **ethReward**? : *BN* -*Defined in [schemes/contributionRewardExt.ts:26](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionRewardExt.ts#L26)* +*Defined in [schemes/contributionRewardExt.ts:26](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionRewardExt.ts#L26)* ___ @@ -80,7 +80,7 @@ ___ • **externalTokenAddress**? : *[Address](../globals.md#address)* -*Defined in [schemes/contributionRewardExt.ts:28](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionRewardExt.ts#L28)* +*Defined in [schemes/contributionRewardExt.ts:28](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionRewardExt.ts#L28)* ___ @@ -88,7 +88,7 @@ ___ • **externalTokenReward**? : *BN* -*Defined in [schemes/contributionRewardExt.ts:27](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionRewardExt.ts#L27)* +*Defined in [schemes/contributionRewardExt.ts:27](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionRewardExt.ts#L27)* ___ @@ -96,7 +96,7 @@ ___ • **nativeTokenReward**? : *BN* -*Defined in [schemes/contributionRewardExt.ts:24](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionRewardExt.ts#L24)* +*Defined in [schemes/contributionRewardExt.ts:24](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionRewardExt.ts#L24)* ___ @@ -106,7 +106,7 @@ ___ *Inherited from [IProposalBaseCreateOptions](iproposalbasecreateoptions.md).[proposalType](iproposalbasecreateoptions.md#optional-proposaltype)* -*Defined in [proposal.ts:868](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L868)* +*Defined in [proposal.ts:879](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L879)* ___ @@ -114,7 +114,7 @@ ___ • **proposer**: *[Address](../globals.md#address)* -*Defined in [schemes/contributionRewardExt.ts:29](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionRewardExt.ts#L29)* +*Defined in [schemes/contributionRewardExt.ts:29](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionRewardExt.ts#L29)* ___ @@ -122,7 +122,7 @@ ___ • **reputationReward**? : *BN* -*Defined in [schemes/contributionRewardExt.ts:25](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionRewardExt.ts#L25)* +*Defined in [schemes/contributionRewardExt.ts:25](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionRewardExt.ts#L25)* ___ @@ -132,7 +132,7 @@ ___ *Inherited from [IProposalBaseCreateOptions](iproposalbasecreateoptions.md).[scheme](iproposalbasecreateoptions.md#optional-scheme)* -*Defined in [proposal.ts:865](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L865)* +*Defined in [proposal.ts:876](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L876)* ___ @@ -142,7 +142,7 @@ ___ *Inherited from [IProposalBaseCreateOptions](iproposalbasecreateoptions.md).[tags](iproposalbasecreateoptions.md#optional-tags)* -*Defined in [proposal.ts:864](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L864)* +*Defined in [proposal.ts:875](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L875)* ___ @@ -152,7 +152,7 @@ ___ *Inherited from [IProposalBaseCreateOptions](iproposalbasecreateoptions.md).[title](iproposalbasecreateoptions.md#optional-title)* -*Defined in [proposal.ts:863](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L863)* +*Defined in [proposal.ts:874](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L874)* ___ @@ -162,4 +162,4 @@ ___ *Inherited from [IProposalBaseCreateOptions](iproposalbasecreateoptions.md).[url](iproposalbasecreateoptions.md#optional-url)* -*Defined in [proposal.ts:866](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L866)* +*Defined in [proposal.ts:877](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L877)* diff --git a/docs/interfaces/iproposalcreateoptionscr.md b/docs/interfaces/iproposalcreateoptionscr.md index e4a6aac5..da7e5b98 100644 --- a/docs/interfaces/iproposalcreateoptionscr.md +++ b/docs/interfaces/iproposalcreateoptionscr.md @@ -25,7 +25,7 @@ • **beneficiary**: *[Address](../globals.md#address)* -*Defined in [schemes/contributionReward.ts:23](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L23)* +*Defined in [schemes/contributionReward.ts:23](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L23)* ___ @@ -33,7 +33,7 @@ ___ • **ethReward**? : *BN* -*Defined in [schemes/contributionReward.ts:26](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L26)* +*Defined in [schemes/contributionReward.ts:26](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L26)* ___ @@ -41,7 +41,7 @@ ___ • **externalTokenAddress**? : *[Address](../globals.md#address)* -*Defined in [schemes/contributionReward.ts:28](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L28)* +*Defined in [schemes/contributionReward.ts:28](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L28)* ___ @@ -49,7 +49,7 @@ ___ • **externalTokenReward**? : *BN* -*Defined in [schemes/contributionReward.ts:27](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L27)* +*Defined in [schemes/contributionReward.ts:27](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L27)* ___ @@ -57,7 +57,7 @@ ___ • **nativeTokenReward**? : *BN* -*Defined in [schemes/contributionReward.ts:24](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L24)* +*Defined in [schemes/contributionReward.ts:24](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L24)* ___ @@ -65,7 +65,7 @@ ___ • **periodLength**? : *undefined | number* -*Defined in [schemes/contributionReward.ts:29](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L29)* +*Defined in [schemes/contributionReward.ts:29](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L29)* ___ @@ -73,7 +73,7 @@ ___ • **periods**? : *any* -*Defined in [schemes/contributionReward.ts:30](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L30)* +*Defined in [schemes/contributionReward.ts:30](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L30)* ___ @@ -81,4 +81,4 @@ ___ • **reputationReward**? : *BN* -*Defined in [schemes/contributionReward.ts:25](https://github.com/daostack/client/blob/7361fcc/src/schemes/contributionReward.ts#L25)* +*Defined in [schemes/contributionReward.ts:25](https://github.com/daostack/client/blob/1bc237e/src/schemes/contributionReward.ts#L25)* diff --git a/docs/interfaces/iproposalcreateoptionsgs.md b/docs/interfaces/iproposalcreateoptionsgs.md index b44cba56..8d1c4cb3 100644 --- a/docs/interfaces/iproposalcreateoptionsgs.md +++ b/docs/interfaces/iproposalcreateoptionsgs.md @@ -19,9 +19,9 @@ • **callData**? : *undefined | string* -*Defined in [schemes/genericScheme.ts:20](https://github.com/daostack/client/blob/7361fcc/src/schemes/genericScheme.ts#L20)* +*Defined in [schemes/genericScheme.ts:20](https://github.com/daostack/client/blob/1bc237e/src/schemes/genericScheme.ts#L20)* -*Defined in [schemes/uGenericScheme.ts:20](https://github.com/daostack/client/blob/7361fcc/src/schemes/uGenericScheme.ts#L20)* +*Defined in [schemes/uGenericScheme.ts:20](https://github.com/daostack/client/blob/1bc237e/src/schemes/uGenericScheme.ts#L20)* ___ @@ -29,6 +29,6 @@ ___ • **value**? : *undefined | number* -*Defined in [schemes/genericScheme.ts:21](https://github.com/daostack/client/blob/7361fcc/src/schemes/genericScheme.ts#L21)* +*Defined in [schemes/genericScheme.ts:21](https://github.com/daostack/client/blob/1bc237e/src/schemes/genericScheme.ts#L21)* -*Defined in [schemes/uGenericScheme.ts:21](https://github.com/daostack/client/blob/7361fcc/src/schemes/uGenericScheme.ts#L21)* +*Defined in [schemes/uGenericScheme.ts:21](https://github.com/daostack/client/blob/1bc237e/src/schemes/uGenericScheme.ts#L21)* diff --git a/docs/interfaces/iproposalcreateoptionssr.md b/docs/interfaces/iproposalcreateoptionssr.md index 4f868836..6a1c8990 100644 --- a/docs/interfaces/iproposalcreateoptionssr.md +++ b/docs/interfaces/iproposalcreateoptionssr.md @@ -20,7 +20,7 @@ • **parametersHash**? : *undefined | string* -*Defined in [schemes/schemeRegistrar.ts:17](https://github.com/daostack/client/blob/7361fcc/src/schemes/schemeRegistrar.ts#L17)* +*Defined in [schemes/schemeRegistrar.ts:17](https://github.com/daostack/client/blob/1bc237e/src/schemes/schemeRegistrar.ts#L17)* ___ @@ -28,7 +28,7 @@ ___ • **permissions**? : *undefined | string* -*Defined in [schemes/schemeRegistrar.ts:18](https://github.com/daostack/client/blob/7361fcc/src/schemes/schemeRegistrar.ts#L18)* +*Defined in [schemes/schemeRegistrar.ts:18](https://github.com/daostack/client/blob/1bc237e/src/schemes/schemeRegistrar.ts#L18)* ___ @@ -36,4 +36,4 @@ ___ • **schemeToRegister**? : *[Address](../globals.md#address)* -*Defined in [schemes/schemeRegistrar.ts:19](https://github.com/daostack/client/blob/7361fcc/src/schemes/schemeRegistrar.ts#L19)* +*Defined in [schemes/schemeRegistrar.ts:19](https://github.com/daostack/client/blob/1bc237e/src/schemes/schemeRegistrar.ts#L19)* diff --git a/docs/interfaces/iproposalqueryoptions.md b/docs/interfaces/iproposalqueryoptions.md index d15d7eb1..87eab6a3 100644 --- a/docs/interfaces/iproposalqueryoptions.md +++ b/docs/interfaces/iproposalqueryoptions.md @@ -26,7 +26,7 @@ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[first](icommonqueryoptions.md#optional-first)* -*Defined in [types.ts:16](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L16)* ___ @@ -36,7 +36,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderBy](icommonqueryoptions.md#optional-orderby)* -*Defined in [types.ts:17](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L17)* ___ @@ -46,7 +46,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderDirection](icommonqueryoptions.md#optional-orderdirection)* -*Defined in [types.ts:18](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L18)* ___ @@ -56,7 +56,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[skip](icommonqueryoptions.md#optional-skip)* -*Defined in [types.ts:15](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L15)* ___ @@ -66,4 +66,4 @@ ___ *Overrides [ICommonQueryOptions](icommonqueryoptions.md).[where](icommonqueryoptions.md#optional-where)* -*Defined in [proposal.ts:836](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L836)* +*Defined in [proposal.ts:847](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L847)* diff --git a/docs/interfaces/iproposalstate.md b/docs/interfaces/iproposalstate.md index c4add0f5..f3f5f0e9 100644 --- a/docs/interfaces/iproposalstate.md +++ b/docs/interfaces/iproposalstate.md @@ -62,7 +62,7 @@ • **accountsWithUnclaimedRewards**: *[Address](../globals.md#address)[]* -*Defined in [proposal.ts:69](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L69)* +*Defined in [proposal.ts:69](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L69)* ___ @@ -70,7 +70,7 @@ ___ • **boostedAt**: *[Date](../globals.md#date)* -*Defined in [proposal.ts:70](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L70)* +*Defined in [proposal.ts:70](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L70)* ___ @@ -78,15 +78,15 @@ ___ • **closingAt**: *[Date](../globals.md#date)* -*Defined in [proposal.ts:74](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L74)* +*Defined in [proposal.ts:74](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L74)* ___ ### competition -• **competition**: *[ICompetitionProposal](icompetitionproposal.md) | null* +• **competition**: *[ICompetitionProposalState](icompetitionproposalstate.md) | null* -*Defined in [proposal.ts:72](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L72)* +*Defined in [proposal.ts:72](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L72)* ___ @@ -94,7 +94,7 @@ ___ • **confidenceThreshold**: *number* -*Defined in [proposal.ts:73](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L73)* +*Defined in [proposal.ts:73](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L73)* ___ @@ -102,7 +102,7 @@ ___ • **contributionReward**: *[IContributionReward](icontributionreward.md) | null* -*Defined in [proposal.ts:71](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L71)* +*Defined in [proposal.ts:71](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L71)* ___ @@ -110,7 +110,7 @@ ___ • **createdAt**: *[Date](../globals.md#date)* -*Defined in [proposal.ts:75](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L75)* +*Defined in [proposal.ts:75](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L75)* ___ @@ -120,7 +120,7 @@ ___ *Inherited from [IProposalStaticState](iproposalstaticstate.md).[dao](iproposalstaticstate.md#dao)* -*Defined in [proposal.ts:63](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L63)* +*Defined in [proposal.ts:63](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L63)* ___ @@ -128,7 +128,7 @@ ___ • **description**? : *undefined | string* -*Defined in [proposal.ts:77](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L77)* +*Defined in [proposal.ts:77](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L77)* ___ @@ -136,7 +136,7 @@ ___ • **descriptionHash**? : *undefined | string* -*Defined in [proposal.ts:76](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L76)* +*Defined in [proposal.ts:76](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L76)* ___ @@ -144,7 +144,7 @@ ___ • **downStakeNeededToQueue**: *BN* -*Defined in [proposal.ts:78](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L78)* +*Defined in [proposal.ts:78](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L78)* ___ @@ -152,7 +152,7 @@ ___ • **executedAt**: *[Date](../globals.md#date)* -*Defined in [proposal.ts:79](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L79)* +*Defined in [proposal.ts:79](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L79)* ___ @@ -160,7 +160,7 @@ ___ • **executionState**: *[IExecutionState](../enums/iexecutionstate.md)* -*Defined in [proposal.ts:80](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L80)* +*Defined in [proposal.ts:80](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L80)* ___ @@ -168,7 +168,7 @@ ___ • **expiresInQueueAt**: *[Date](../globals.md#date)* -*Defined in [proposal.ts:81](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L81)* +*Defined in [proposal.ts:81](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L81)* ___ @@ -176,7 +176,7 @@ ___ • **genericScheme**: *[IGenericScheme](igenericscheme.md) | null* -*Defined in [proposal.ts:82](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L82)* +*Defined in [proposal.ts:82](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L82)* ___ @@ -184,7 +184,7 @@ ___ • **genesisProtocolParams**: *[IGenesisProtocolParams](igenesisprotocolparams.md)* -*Defined in [proposal.ts:83](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L83)* +*Defined in [proposal.ts:83](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L83)* ___ @@ -194,7 +194,7 @@ ___ *Inherited from [IProposalStaticState](iproposalstaticstate.md).[id](iproposalstaticstate.md#id)* -*Defined in [proposal.ts:62](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L62)* +*Defined in [proposal.ts:62](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L62)* ___ @@ -202,7 +202,7 @@ ___ • **organizationId**: *string* -*Defined in [proposal.ts:84](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L84)* +*Defined in [proposal.ts:84](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L84)* ___ @@ -210,7 +210,7 @@ ___ • **paramsHash**: *string* -*Defined in [proposal.ts:85](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L85)* +*Defined in [proposal.ts:85](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L85)* ___ @@ -218,7 +218,7 @@ ___ • **preBoostedAt**: *[Date](../globals.md#date)* -*Defined in [proposal.ts:86](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L86)* +*Defined in [proposal.ts:86](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L86)* ___ @@ -226,7 +226,7 @@ ___ • **proposal**: *[Proposal](../classes/proposal.md)* -*Defined in [proposal.ts:87](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L87)* +*Defined in [proposal.ts:87](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L87)* ___ @@ -234,7 +234,7 @@ ___ • **proposer**: *[Address](../globals.md#address)* -*Defined in [proposal.ts:88](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L88)* +*Defined in [proposal.ts:88](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L88)* ___ @@ -242,7 +242,7 @@ ___ • **queue**: *[IQueueState](iqueuestate.md)* -*Defined in [proposal.ts:89](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L89)* +*Defined in [proposal.ts:89](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L89)* ___ @@ -250,7 +250,7 @@ ___ • **quietEndingPeriodBeganAt**: *[Date](../globals.md#date)* -*Defined in [proposal.ts:90](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L90)* +*Defined in [proposal.ts:90](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L90)* ___ @@ -258,7 +258,7 @@ ___ • **resolvedAt**: *[Date](../globals.md#date)* -*Defined in [proposal.ts:92](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L92)* +*Defined in [proposal.ts:92](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L92)* ___ @@ -268,7 +268,7 @@ ___ *Inherited from [IProposalStaticState](iproposalstaticstate.md).[scheme](iproposalstaticstate.md#scheme)* -*Defined in [proposal.ts:64](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L64)* +*Defined in [proposal.ts:64](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L64)* ___ @@ -276,7 +276,7 @@ ___ • **schemeRegistrar**: *[ISchemeRegistrar](ischemeregistrar.md) | null* -*Defined in [proposal.ts:91](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L91)* +*Defined in [proposal.ts:91](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L91)* ___ @@ -284,7 +284,7 @@ ___ • **stage**: *[IProposalStage](../enums/iproposalstage.md)* -*Defined in [proposal.ts:93](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L93)* +*Defined in [proposal.ts:93](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L93)* ___ @@ -292,7 +292,7 @@ ___ • **stakesAgainst**: *BN* -*Defined in [proposal.ts:95](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L95)* +*Defined in [proposal.ts:95](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L95)* ___ @@ -300,7 +300,7 @@ ___ • **stakesFor**: *BN* -*Defined in [proposal.ts:94](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L94)* +*Defined in [proposal.ts:94](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L94)* ___ @@ -308,7 +308,7 @@ ___ • **tags**? : *string[]* -*Defined in [proposal.ts:96](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L96)* +*Defined in [proposal.ts:96](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L96)* ___ @@ -316,7 +316,7 @@ ___ • **title**? : *undefined | string* -*Defined in [proposal.ts:97](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L97)* +*Defined in [proposal.ts:97](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L97)* ___ @@ -324,7 +324,7 @@ ___ • **totalRepWhenCreated**: *BN* -*Defined in [proposal.ts:98](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L98)* +*Defined in [proposal.ts:98](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L98)* ___ @@ -332,7 +332,7 @@ ___ • **totalRepWhenExecuted**: *BN* -*Defined in [proposal.ts:99](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L99)* +*Defined in [proposal.ts:99](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L99)* ___ @@ -340,7 +340,7 @@ ___ • **type**: *[IProposalType](../globals.md#const-iproposaltype)* -*Defined in [proposal.ts:100](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L100)* +*Defined in [proposal.ts:100](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L100)* ___ @@ -348,7 +348,7 @@ ___ • **upstakeNeededToPreBoost**: *BN* -*Defined in [proposal.ts:101](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L101)* +*Defined in [proposal.ts:101](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L101)* ___ @@ -356,7 +356,7 @@ ___ • **url**? : *undefined | string* -*Defined in [proposal.ts:102](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L102)* +*Defined in [proposal.ts:102](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L102)* ___ @@ -364,7 +364,7 @@ ___ • **voteOnBehalf**: *[Address](../globals.md#address)* -*Defined in [proposal.ts:106](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L106)* +*Defined in [proposal.ts:106](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L106)* ___ @@ -372,7 +372,7 @@ ___ • **votesAgainst**: *BN* -*Defined in [proposal.ts:104](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L104)* +*Defined in [proposal.ts:104](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L104)* ___ @@ -380,7 +380,7 @@ ___ • **votesCount**: *number* -*Defined in [proposal.ts:105](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L105)* +*Defined in [proposal.ts:105](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L105)* ___ @@ -388,7 +388,7 @@ ___ • **votesFor**: *BN* -*Defined in [proposal.ts:103](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L103)* +*Defined in [proposal.ts:103](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L103)* ___ @@ -398,7 +398,7 @@ ___ *Inherited from [IProposalStaticState](iproposalstaticstate.md).[votingMachine](iproposalstaticstate.md#votingmachine)* -*Defined in [proposal.ts:65](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L65)* +*Defined in [proposal.ts:65](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L65)* ___ @@ -406,4 +406,4 @@ ___ • **winningOutcome**: *[IProposalOutcome](../enums/iproposaloutcome.md)* -*Defined in [proposal.ts:107](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L107)* +*Defined in [proposal.ts:107](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L107)* diff --git a/docs/interfaces/iproposalstaticstate.md b/docs/interfaces/iproposalstaticstate.md index 87b6679e..4410c443 100644 --- a/docs/interfaces/iproposalstaticstate.md +++ b/docs/interfaces/iproposalstaticstate.md @@ -23,7 +23,7 @@ • **dao**: *[DAO](../classes/dao.md)* -*Defined in [proposal.ts:63](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L63)* +*Defined in [proposal.ts:63](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L63)* ___ @@ -31,7 +31,7 @@ ___ • **id**: *string* -*Defined in [proposal.ts:62](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L62)* +*Defined in [proposal.ts:62](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L62)* ___ @@ -39,7 +39,7 @@ ___ • **scheme**: *ISchemeState* -*Defined in [proposal.ts:64](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L64)* +*Defined in [proposal.ts:64](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L64)* ___ @@ -47,4 +47,4 @@ ___ • **votingMachine**: *[Address](../globals.md#address)* -*Defined in [proposal.ts:65](https://github.com/daostack/client/blob/7361fcc/src/proposal.ts#L65)* +*Defined in [proposal.ts:65](https://github.com/daostack/client/blob/1bc237e/src/proposal.ts#L65)* diff --git a/docs/interfaces/iqueuequeryoptions.md b/docs/interfaces/iqueuequeryoptions.md index 9e524ebd..e9c03725 100644 --- a/docs/interfaces/iqueuequeryoptions.md +++ b/docs/interfaces/iqueuequeryoptions.md @@ -26,7 +26,7 @@ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[first](icommonqueryoptions.md#optional-first)* -*Defined in [types.ts:16](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L16)* ___ @@ -36,7 +36,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderBy](icommonqueryoptions.md#optional-orderby)* -*Defined in [types.ts:17](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L17)* ___ @@ -46,7 +46,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderDirection](icommonqueryoptions.md#optional-orderdirection)* -*Defined in [types.ts:18](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L18)* ___ @@ -56,7 +56,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[skip](icommonqueryoptions.md#optional-skip)* -*Defined in [types.ts:15](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L15)* ___ @@ -66,4 +66,4 @@ ___ *Overrides [ICommonQueryOptions](icommonqueryoptions.md).[where](icommonqueryoptions.md#optional-where)* -*Defined in [queue.ts:23](https://github.com/daostack/client/blob/7361fcc/src/queue.ts#L23)* +*Defined in [queue.ts:23](https://github.com/daostack/client/blob/1bc237e/src/queue.ts#L23)* diff --git a/docs/interfaces/iqueuestate.md b/docs/interfaces/iqueuestate.md index 5abdc60b..2186f335 100644 --- a/docs/interfaces/iqueuestate.md +++ b/docs/interfaces/iqueuestate.md @@ -27,7 +27,7 @@ *Inherited from [IQueueStaticState](iqueuestaticstate.md).[dao](iqueuestaticstate.md#dao)* -*Defined in [queue.ts:11](https://github.com/daostack/client/blob/7361fcc/src/queue.ts#L11)* +*Defined in [queue.ts:11](https://github.com/daostack/client/blob/1bc237e/src/queue.ts#L11)* ___ @@ -37,7 +37,7 @@ ___ *Inherited from [IQueueStaticState](iqueuestaticstate.md).[id](iqueuestaticstate.md#id)* -*Defined in [queue.ts:12](https://github.com/daostack/client/blob/7361fcc/src/queue.ts#L12)* +*Defined in [queue.ts:12](https://github.com/daostack/client/blob/1bc237e/src/queue.ts#L12)* ___ @@ -47,7 +47,7 @@ ___ *Inherited from [IQueueStaticState](iqueuestaticstate.md).[name](iqueuestaticstate.md#name)* -*Defined in [queue.ts:13](https://github.com/daostack/client/blob/7361fcc/src/queue.ts#L13)* +*Defined in [queue.ts:13](https://github.com/daostack/client/blob/1bc237e/src/queue.ts#L13)* ___ @@ -55,7 +55,7 @@ ___ • **scheme**: *ISchemeState* -*Defined in [queue.ts:17](https://github.com/daostack/client/blob/7361fcc/src/queue.ts#L17)* +*Defined in [queue.ts:17](https://github.com/daostack/client/blob/1bc237e/src/queue.ts#L17)* ___ @@ -63,7 +63,7 @@ ___ • **threshold**: *number* -*Defined in [queue.ts:18](https://github.com/daostack/client/blob/7361fcc/src/queue.ts#L18)* +*Defined in [queue.ts:18](https://github.com/daostack/client/blob/1bc237e/src/queue.ts#L18)* ___ @@ -71,4 +71,4 @@ ___ • **votingMachine**: *[Address](../globals.md#address)* -*Defined in [queue.ts:19](https://github.com/daostack/client/blob/7361fcc/src/queue.ts#L19)* +*Defined in [queue.ts:19](https://github.com/daostack/client/blob/1bc237e/src/queue.ts#L19)* diff --git a/docs/interfaces/iqueuestaticstate.md b/docs/interfaces/iqueuestaticstate.md index e1e98ebc..acf548d2 100644 --- a/docs/interfaces/iqueuestaticstate.md +++ b/docs/interfaces/iqueuestaticstate.md @@ -22,7 +22,7 @@ • **dao**: *[DAO](../classes/dao.md)* -*Defined in [queue.ts:11](https://github.com/daostack/client/blob/7361fcc/src/queue.ts#L11)* +*Defined in [queue.ts:11](https://github.com/daostack/client/blob/1bc237e/src/queue.ts#L11)* ___ @@ -30,7 +30,7 @@ ___ • **id**: *string* -*Defined in [queue.ts:12](https://github.com/daostack/client/blob/7361fcc/src/queue.ts#L12)* +*Defined in [queue.ts:12](https://github.com/daostack/client/blob/1bc237e/src/queue.ts#L12)* ___ @@ -38,4 +38,4 @@ ___ • **name**: *string* -*Defined in [queue.ts:13](https://github.com/daostack/client/blob/7361fcc/src/queue.ts#L13)* +*Defined in [queue.ts:13](https://github.com/daostack/client/blob/1bc237e/src/queue.ts#L13)* diff --git a/docs/interfaces/ireputationqueryoptions.md b/docs/interfaces/ireputationqueryoptions.md index aeae77e8..48236f41 100644 --- a/docs/interfaces/ireputationqueryoptions.md +++ b/docs/interfaces/ireputationqueryoptions.md @@ -30,7 +30,7 @@ • **dao**? : *[Address](../globals.md#address)* -*Defined in [reputation.ts:19](https://github.com/daostack/client/blob/7361fcc/src/reputation.ts#L19)* +*Defined in [reputation.ts:19](https://github.com/daostack/client/blob/1bc237e/src/reputation.ts#L19)* ___ @@ -40,7 +40,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[first](icommonqueryoptions.md#optional-first)* -*Defined in [types.ts:16](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L16)* ___ @@ -48,7 +48,7 @@ ___ • **id**? : *undefined | string* -*Defined in [reputation.ts:18](https://github.com/daostack/client/blob/7361fcc/src/reputation.ts#L18)* +*Defined in [reputation.ts:18](https://github.com/daostack/client/blob/1bc237e/src/reputation.ts#L18)* ___ @@ -58,7 +58,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderBy](icommonqueryoptions.md#optional-orderby)* -*Defined in [types.ts:17](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L17)* ___ @@ -68,7 +68,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderDirection](icommonqueryoptions.md#optional-orderdirection)* -*Defined in [types.ts:18](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L18)* ___ @@ -78,7 +78,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[skip](icommonqueryoptions.md#optional-skip)* -*Defined in [types.ts:15](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L15)* ___ @@ -88,4 +88,4 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[where](icommonqueryoptions.md#optional-where)* -*Defined in [types.ts:19](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L19)* diff --git a/docs/interfaces/ireputationstate.md b/docs/interfaces/ireputationstate.md index 44e24d50..a68bdcdd 100644 --- a/docs/interfaces/ireputationstate.md +++ b/docs/interfaces/ireputationstate.md @@ -20,7 +20,7 @@ • **address**: *[Address](../globals.md#address)* -*Defined in [reputation.ts:12](https://github.com/daostack/client/blob/7361fcc/src/reputation.ts#L12)* +*Defined in [reputation.ts:12](https://github.com/daostack/client/blob/1bc237e/src/reputation.ts#L12)* ___ @@ -28,7 +28,7 @@ ___ • **dao**: *[Address](../globals.md#address)* -*Defined in [reputation.ts:14](https://github.com/daostack/client/blob/7361fcc/src/reputation.ts#L14)* +*Defined in [reputation.ts:14](https://github.com/daostack/client/blob/1bc237e/src/reputation.ts#L14)* ___ @@ -36,4 +36,4 @@ ___ • **totalSupply**: *BN* -*Defined in [reputation.ts:13](https://github.com/daostack/client/blob/7361fcc/src/reputation.ts#L13)* +*Defined in [reputation.ts:13](https://github.com/daostack/client/blob/1bc237e/src/reputation.ts#L13)* diff --git a/docs/interfaces/irewardqueryoptions.md b/docs/interfaces/irewardqueryoptions.md index 45754ab8..4e49eb1e 100644 --- a/docs/interfaces/irewardqueryoptions.md +++ b/docs/interfaces/irewardqueryoptions.md @@ -26,7 +26,7 @@ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[first](icommonqueryoptions.md#optional-first)* -*Defined in [types.ts:16](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L16)* ___ @@ -36,7 +36,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderBy](icommonqueryoptions.md#optional-orderby)* -*Defined in [types.ts:17](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L17)* ___ @@ -46,7 +46,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderDirection](icommonqueryoptions.md#optional-orderdirection)* -*Defined in [types.ts:18](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L18)* ___ @@ -56,7 +56,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[skip](icommonqueryoptions.md#optional-skip)* -*Defined in [types.ts:15](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L15)* ___ @@ -66,4 +66,4 @@ ___ *Overrides [ICommonQueryOptions](icommonqueryoptions.md).[where](icommonqueryoptions.md#optional-where)* -*Defined in [reward.ts:29](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L29)* +*Defined in [reward.ts:29](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L29)* diff --git a/docs/interfaces/irewardstate.md b/docs/interfaces/irewardstate.md index 67549957..136e66bb 100644 --- a/docs/interfaces/irewardstate.md +++ b/docs/interfaces/irewardstate.md @@ -34,7 +34,7 @@ *Inherited from [IRewardStaticState](irewardstaticstate.md).[beneficiary](irewardstaticstate.md#beneficiary)* -*Defined in [reward.ts:11](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L11)* +*Defined in [reward.ts:11](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L11)* ___ @@ -44,7 +44,7 @@ ___ *Inherited from [IRewardStaticState](irewardstaticstate.md).[createdAt](irewardstaticstate.md#createdat)* -*Defined in [reward.ts:12](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L12)* +*Defined in [reward.ts:12](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L12)* ___ @@ -54,7 +54,7 @@ ___ *Inherited from [IRewardStaticState](irewardstaticstate.md).[daoBountyForStaker](irewardstaticstate.md#daobountyforstaker)* -*Defined in [reward.ts:16](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L16)* +*Defined in [reward.ts:16](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L16)* ___ @@ -62,7 +62,7 @@ ___ • **daoBountyForStakerRedeemedAt**: *number* -*Defined in [reward.ts:25](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L25)* +*Defined in [reward.ts:25](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L25)* ___ @@ -72,7 +72,7 @@ ___ *Inherited from [IRewardStaticState](irewardstaticstate.md).[id](irewardstaticstate.md#id)* -*Defined in [reward.ts:10](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L10)* +*Defined in [reward.ts:10](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L10)* ___ @@ -82,7 +82,7 @@ ___ *Inherited from [IRewardStaticState](irewardstaticstate.md).[proposalId](irewardstaticstate.md#proposalid)* -*Defined in [reward.ts:13](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L13)* +*Defined in [reward.ts:13](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L13)* ___ @@ -92,7 +92,7 @@ ___ *Inherited from [IRewardStaticState](irewardstaticstate.md).[reputationForProposer](irewardstaticstate.md#reputationforproposer)* -*Defined in [reward.ts:17](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L17)* +*Defined in [reward.ts:17](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L17)* ___ @@ -100,7 +100,7 @@ ___ • **reputationForProposerRedeemedAt**: *number* -*Defined in [reward.ts:24](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L24)* +*Defined in [reward.ts:24](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L24)* ___ @@ -110,7 +110,7 @@ ___ *Inherited from [IRewardStaticState](irewardstaticstate.md).[reputationForVoter](irewardstaticstate.md#reputationforvoter)* -*Defined in [reward.ts:14](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L14)* +*Defined in [reward.ts:14](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L14)* ___ @@ -118,7 +118,7 @@ ___ • **reputationForVoterRedeemedAt**: *number* -*Defined in [reward.ts:22](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L22)* +*Defined in [reward.ts:22](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L22)* ___ @@ -128,7 +128,7 @@ ___ *Inherited from [IRewardStaticState](irewardstaticstate.md).[tokenAddress](irewardstaticstate.md#tokenaddress)* -*Defined in [reward.ts:18](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L18)* +*Defined in [reward.ts:18](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L18)* ___ @@ -138,7 +138,7 @@ ___ *Inherited from [IRewardStaticState](irewardstaticstate.md).[tokensForStaker](irewardstaticstate.md#tokensforstaker)* -*Defined in [reward.ts:15](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L15)* +*Defined in [reward.ts:15](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L15)* ___ @@ -146,4 +146,4 @@ ___ • **tokensForStakerRedeemedAt**: *number* -*Defined in [reward.ts:23](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L23)* +*Defined in [reward.ts:23](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L23)* diff --git a/docs/interfaces/irewardstaticstate.md b/docs/interfaces/irewardstaticstate.md index f533ed60..23650a4c 100644 --- a/docs/interfaces/irewardstaticstate.md +++ b/docs/interfaces/irewardstaticstate.md @@ -28,7 +28,7 @@ • **beneficiary**: *[Address](../globals.md#address)* -*Defined in [reward.ts:11](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L11)* +*Defined in [reward.ts:11](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L11)* ___ @@ -36,7 +36,7 @@ ___ • **createdAt**: *Date* -*Defined in [reward.ts:12](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L12)* +*Defined in [reward.ts:12](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L12)* ___ @@ -44,7 +44,7 @@ ___ • **daoBountyForStaker**: *BN* -*Defined in [reward.ts:16](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L16)* +*Defined in [reward.ts:16](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L16)* ___ @@ -52,7 +52,7 @@ ___ • **id**: *string* -*Defined in [reward.ts:10](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L10)* +*Defined in [reward.ts:10](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L10)* ___ @@ -60,7 +60,7 @@ ___ • **proposalId**: *string* -*Defined in [reward.ts:13](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L13)* +*Defined in [reward.ts:13](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L13)* ___ @@ -68,7 +68,7 @@ ___ • **reputationForProposer**: *BN* -*Defined in [reward.ts:17](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L17)* +*Defined in [reward.ts:17](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L17)* ___ @@ -76,7 +76,7 @@ ___ • **reputationForVoter**: *BN* -*Defined in [reward.ts:14](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L14)* +*Defined in [reward.ts:14](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L14)* ___ @@ -84,7 +84,7 @@ ___ • **tokenAddress**: *[Address](../globals.md#address)* -*Defined in [reward.ts:18](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L18)* +*Defined in [reward.ts:18](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L18)* ___ @@ -92,4 +92,4 @@ ___ • **tokensForStaker**: *BN* -*Defined in [reward.ts:15](https://github.com/daostack/client/blob/7361fcc/src/reward.ts#L15)* +*Defined in [reward.ts:15](https://github.com/daostack/client/blob/1bc237e/src/reward.ts#L15)* diff --git a/docs/interfaces/ischemequeryoptions.md b/docs/interfaces/ischemequeryoptions.md index ed506c8f..76ed2481 100644 --- a/docs/interfaces/ischemequeryoptions.md +++ b/docs/interfaces/ischemequeryoptions.md @@ -34,7 +34,7 @@ *Overrides [ICommonQueryOptions](icommonqueryoptions.md).[first](icommonqueryoptions.md#optional-first)* -*Defined in [types.ts:16](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L16)* ___ @@ -46,7 +46,7 @@ ___ *Overrides [ICommonQueryOptions](icommonqueryoptions.md).[orderBy](icommonqueryoptions.md#optional-orderby)* -*Defined in [types.ts:17](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L17)* ___ @@ -58,7 +58,7 @@ ___ *Overrides [ICommonQueryOptions](icommonqueryoptions.md).[orderDirection](icommonqueryoptions.md#optional-orderdirection)* -*Defined in [types.ts:18](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L18)* ___ @@ -70,7 +70,7 @@ ___ *Overrides [ICommonQueryOptions](icommonqueryoptions.md).[skip](icommonqueryoptions.md#optional-skip)* -*Defined in [types.ts:15](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L15)* ___ @@ -80,10 +80,10 @@ ___ *Overrides [ICommonQueryOptions](icommonqueryoptions.md).[where](icommonqueryoptions.md#optional-where)* -*Defined in [schemes/base.ts:73](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L73)* +*Defined in [schemes/base.ts:73](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L73)* -*Defined in [schemes/base.ts:88](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L88)* +*Defined in [schemes/base.ts:88](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L88)* -*Defined in [scheme.ts:76](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L76)* +*Defined in [scheme.ts:76](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L76)* -*Defined in [scheme.ts:91](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L91)* +*Defined in [scheme.ts:91](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L91)* diff --git a/docs/interfaces/ischemeregisterparams.md b/docs/interfaces/ischemeregisterparams.md index 0d600716..cbee9e35 100644 --- a/docs/interfaces/ischemeregisterparams.md +++ b/docs/interfaces/ischemeregisterparams.md @@ -20,9 +20,9 @@ • **contractToCall**: *[Address](../globals.md#address)* -*Defined in [schemes/base.ts:68](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L68)* +*Defined in [schemes/base.ts:68](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L68)* -*Defined in [scheme.ts:71](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L71)* +*Defined in [scheme.ts:71](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L71)* ___ @@ -30,9 +30,9 @@ ___ • **voteParams**: *[IGenesisProtocolParams](igenesisprotocolparams.md)* -*Defined in [schemes/base.ts:69](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L69)* +*Defined in [schemes/base.ts:69](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L69)* -*Defined in [scheme.ts:72](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L72)* +*Defined in [scheme.ts:72](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L72)* ___ @@ -40,6 +40,6 @@ ___ • **votingMachine**: *[Address](../globals.md#address)* -*Defined in [schemes/base.ts:67](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L67)* +*Defined in [schemes/base.ts:67](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L67)* -*Defined in [scheme.ts:70](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L70)* +*Defined in [scheme.ts:70](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L70)* diff --git a/docs/interfaces/ischemeregistrar.md b/docs/interfaces/ischemeregistrar.md index 9abee959..4cdc93d1 100644 --- a/docs/interfaces/ischemeregistrar.md +++ b/docs/interfaces/ischemeregistrar.md @@ -25,7 +25,7 @@ • **decision**: *number* -*Defined in [schemes/schemeRegistrar.ts:11](https://github.com/daostack/client/blob/7361fcc/src/schemes/schemeRegistrar.ts#L11)* +*Defined in [schemes/schemeRegistrar.ts:11](https://github.com/daostack/client/blob/1bc237e/src/schemes/schemeRegistrar.ts#L11)* ___ @@ -33,7 +33,7 @@ ___ • **id**: *string* -*Defined in [schemes/schemeRegistrar.ts:6](https://github.com/daostack/client/blob/7361fcc/src/schemes/schemeRegistrar.ts#L6)* +*Defined in [schemes/schemeRegistrar.ts:6](https://github.com/daostack/client/blob/1bc237e/src/schemes/schemeRegistrar.ts#L6)* ___ @@ -41,7 +41,7 @@ ___ • **schemeRegistered**: *boolean* -*Defined in [schemes/schemeRegistrar.ts:12](https://github.com/daostack/client/blob/7361fcc/src/schemes/schemeRegistrar.ts#L12)* +*Defined in [schemes/schemeRegistrar.ts:12](https://github.com/daostack/client/blob/1bc237e/src/schemes/schemeRegistrar.ts#L12)* ___ @@ -49,7 +49,7 @@ ___ • **schemeRemoved**: *boolean* -*Defined in [schemes/schemeRegistrar.ts:13](https://github.com/daostack/client/blob/7361fcc/src/schemes/schemeRegistrar.ts#L13)* +*Defined in [schemes/schemeRegistrar.ts:13](https://github.com/daostack/client/blob/1bc237e/src/schemes/schemeRegistrar.ts#L13)* ___ @@ -57,7 +57,7 @@ ___ • **schemeToRegister**: *[Address](../globals.md#address)* -*Defined in [schemes/schemeRegistrar.ts:7](https://github.com/daostack/client/blob/7361fcc/src/schemes/schemeRegistrar.ts#L7)* +*Defined in [schemes/schemeRegistrar.ts:7](https://github.com/daostack/client/blob/1bc237e/src/schemes/schemeRegistrar.ts#L7)* ___ @@ -65,7 +65,7 @@ ___ • **schemeToRegisterParamsHash**: *string* -*Defined in [schemes/schemeRegistrar.ts:8](https://github.com/daostack/client/blob/7361fcc/src/schemes/schemeRegistrar.ts#L8)* +*Defined in [schemes/schemeRegistrar.ts:8](https://github.com/daostack/client/blob/1bc237e/src/schemes/schemeRegistrar.ts#L8)* ___ @@ -73,7 +73,7 @@ ___ • **schemeToRegisterPermission**: *string* -*Defined in [schemes/schemeRegistrar.ts:9](https://github.com/daostack/client/blob/7361fcc/src/schemes/schemeRegistrar.ts#L9)* +*Defined in [schemes/schemeRegistrar.ts:9](https://github.com/daostack/client/blob/1bc237e/src/schemes/schemeRegistrar.ts#L9)* ___ @@ -81,4 +81,4 @@ ___ • **schemeToRemove**: *string* -*Defined in [schemes/schemeRegistrar.ts:10](https://github.com/daostack/client/blob/7361fcc/src/schemes/schemeRegistrar.ts#L10)* +*Defined in [schemes/schemeRegistrar.ts:10](https://github.com/daostack/client/blob/1bc237e/src/schemes/schemeRegistrar.ts#L10)* diff --git a/docs/interfaces/ischemestate.md b/docs/interfaces/ischemestate.md index 0a136bb2..20eea7f2 100644 --- a/docs/interfaces/ischemestate.md +++ b/docs/interfaces/ischemestate.md @@ -44,7 +44,7 @@ *Overrides void* -*Defined in [schemes/base.ts:21](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L21)* +*Defined in [schemes/base.ts:21](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L21)* ___ @@ -52,9 +52,9 @@ ___ • **canDelegateCall**: *boolean* -*Defined in [schemes/base.ts:29](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L29)* +*Defined in [schemes/base.ts:29](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L29)* -*Defined in [scheme.ts:32](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L32)* +*Defined in [scheme.ts:32](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L32)* ___ @@ -62,9 +62,9 @@ ___ • **canManageGlobalConstraints**: *boolean* -*Defined in [schemes/base.ts:32](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L32)* +*Defined in [schemes/base.ts:32](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L32)* -*Defined in [scheme.ts:35](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L35)* +*Defined in [scheme.ts:35](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L35)* ___ @@ -72,9 +72,9 @@ ___ • **canRegisterSchemes**: *boolean* -*Defined in [schemes/base.ts:30](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L30)* +*Defined in [schemes/base.ts:30](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L30)* -*Defined in [scheme.ts:33](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L33)* +*Defined in [scheme.ts:33](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L33)* ___ @@ -82,9 +82,9 @@ ___ • **canUpgradeController**: *boolean* -*Defined in [schemes/base.ts:31](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L31)* +*Defined in [schemes/base.ts:31](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L31)* -*Defined in [scheme.ts:34](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L34)* +*Defined in [scheme.ts:34](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L34)* ___ @@ -92,9 +92,9 @@ ___ • **contributionRewardExtParams**? : *[IContributionRewardExtParams](icontributionrewardextparams.md)* -*Defined in [schemes/base.ts:36](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L36)* +*Defined in [schemes/base.ts:36](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L36)* -*Defined in [scheme.ts:39](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L39)* +*Defined in [scheme.ts:39](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L39)* ___ @@ -102,9 +102,9 @@ ___ • **contributionRewardParams**? : *[IContributionRewardParams](icontributionrewardparams.md)* -*Defined in [schemes/base.ts:35](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L35)* +*Defined in [schemes/base.ts:35](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L35)* -*Defined in [scheme.ts:38](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L38)* +*Defined in [scheme.ts:38](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L38)* ___ @@ -114,9 +114,9 @@ ___ *Overrides [ISchemeStaticState](ischemestaticstate.md).[dao](ischemestaticstate.md#dao)* -*Defined in [schemes/base.ts:33](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L33)* +*Defined in [schemes/base.ts:33](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L33)* -*Defined in [scheme.ts:36](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L36)* +*Defined in [scheme.ts:36](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L36)* ___ @@ -124,9 +124,9 @@ ___ • **genericSchemeParams**? : *[IGenericSchemeParams](igenericschemeparams.md)* -*Defined in [schemes/base.ts:37](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L37)* +*Defined in [schemes/base.ts:37](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L37)* -*Defined in [scheme.ts:40](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L40)* +*Defined in [scheme.ts:40](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L40)* ___ @@ -138,7 +138,7 @@ ___ *Overrides void* -*Defined in [schemes/base.ts:20](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L20)* +*Defined in [schemes/base.ts:20](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L20)* ___ @@ -150,7 +150,7 @@ ___ *Overrides void* -*Defined in [schemes/base.ts:23](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L23)* +*Defined in [schemes/base.ts:23](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L23)* ___ @@ -158,9 +158,9 @@ ___ • **numberOfBoostedProposals**: *number* -*Defined in [schemes/base.ts:45](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L45)* +*Defined in [schemes/base.ts:45](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L45)* -*Defined in [scheme.ts:48](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L48)* +*Defined in [scheme.ts:48](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L48)* ___ @@ -168,9 +168,9 @@ ___ • **numberOfPreBoostedProposals**: *number* -*Defined in [schemes/base.ts:44](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L44)* +*Defined in [schemes/base.ts:44](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L44)* -*Defined in [scheme.ts:47](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L47)* +*Defined in [scheme.ts:47](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L47)* ___ @@ -178,9 +178,9 @@ ___ • **numberOfQueuedProposals**: *number* -*Defined in [schemes/base.ts:43](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L43)* +*Defined in [schemes/base.ts:43](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L43)* -*Defined in [scheme.ts:46](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L46)* +*Defined in [scheme.ts:46](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L46)* ___ @@ -190,9 +190,9 @@ ___ *Overrides [ISchemeStaticState](ischemestaticstate.md).[paramsHash](ischemestaticstate.md#paramshash)* -*Defined in [schemes/base.ts:34](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L34)* +*Defined in [schemes/base.ts:34](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L34)* -*Defined in [scheme.ts:37](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L37)* +*Defined in [scheme.ts:37](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L37)* ___ @@ -200,9 +200,9 @@ ___ • **schemeParams**? : *IGenericSchemeParams | IContributionRewardParams | IContributionRewardExtParams | ISchemeRegisterParams* -*Defined in [schemes/base.ts:47](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L47)* +*Defined in [schemes/base.ts:47](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L47)* -*Defined in [scheme.ts:50](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L50)* +*Defined in [scheme.ts:50](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L50)* ___ @@ -210,9 +210,9 @@ ___ • **schemeRegistrarParams**? : *object | null* -*Defined in [schemes/base.ts:38](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L38)* +*Defined in [schemes/base.ts:38](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L38)* -*Defined in [scheme.ts:41](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L41)* +*Defined in [scheme.ts:41](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L41)* ___ @@ -220,9 +220,9 @@ ___ • **uGenericSchemeParams**? : *[IGenericSchemeParams](igenericschemeparams.md)* -*Defined in [schemes/base.ts:46](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L46)* +*Defined in [schemes/base.ts:46](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L46)* -*Defined in [scheme.ts:49](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L49)* +*Defined in [scheme.ts:49](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L49)* ___ @@ -234,4 +234,4 @@ ___ *Overrides void* -*Defined in [schemes/base.ts:25](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L25)* +*Defined in [schemes/base.ts:25](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L25)* diff --git a/docs/interfaces/ischemestaticstate.md b/docs/interfaces/ischemestaticstate.md index 1f25947d..96e2c786 100644 --- a/docs/interfaces/ischemestaticstate.md +++ b/docs/interfaces/ischemestaticstate.md @@ -25,9 +25,9 @@ • **address**: *[Address](../globals.md#address)* -*Defined in [schemes/base.ts:21](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L21)* +*Defined in [schemes/base.ts:21](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L21)* -*Defined in [scheme.ts:24](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L24)* +*Defined in [scheme.ts:24](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L24)* ___ @@ -35,9 +35,9 @@ ___ • **dao**: *[Address](../globals.md#address)* -*Defined in [schemes/base.ts:22](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L22)* +*Defined in [schemes/base.ts:22](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L22)* -*Defined in [scheme.ts:25](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L25)* +*Defined in [scheme.ts:25](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L25)* ___ @@ -45,9 +45,9 @@ ___ • **id**: *string* -*Defined in [schemes/base.ts:20](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L20)* +*Defined in [schemes/base.ts:20](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L20)* -*Defined in [scheme.ts:23](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L23)* +*Defined in [scheme.ts:23](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L23)* ___ @@ -55,9 +55,9 @@ ___ • **name**: *string* -*Defined in [schemes/base.ts:23](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L23)* +*Defined in [schemes/base.ts:23](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L23)* -*Defined in [scheme.ts:26](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L26)* +*Defined in [scheme.ts:26](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L26)* ___ @@ -65,9 +65,9 @@ ___ • **paramsHash**: *string* -*Defined in [schemes/base.ts:24](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L24)* +*Defined in [schemes/base.ts:24](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L24)* -*Defined in [scheme.ts:27](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L27)* +*Defined in [scheme.ts:27](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L27)* ___ @@ -75,6 +75,6 @@ ___ • **version**: *string* -*Defined in [schemes/base.ts:25](https://github.com/daostack/client/blob/7361fcc/src/schemes/base.ts#L25)* +*Defined in [schemes/base.ts:25](https://github.com/daostack/client/blob/1bc237e/src/schemes/base.ts#L25)* -*Defined in [scheme.ts:28](https://github.com/daostack/client/blob/7361fcc/src/scheme.ts#L28)* +*Defined in [scheme.ts:28](https://github.com/daostack/client/blob/1bc237e/src/scheme.ts#L28)* diff --git a/docs/interfaces/istakequeryoptions.md b/docs/interfaces/istakequeryoptions.md index e1975ee1..8417793e 100644 --- a/docs/interfaces/istakequeryoptions.md +++ b/docs/interfaces/istakequeryoptions.md @@ -26,7 +26,7 @@ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[first](icommonqueryoptions.md#optional-first)* -*Defined in [types.ts:16](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L16)* ___ @@ -36,7 +36,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderBy](icommonqueryoptions.md#optional-orderby)* -*Defined in [types.ts:17](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L17)* ___ @@ -46,7 +46,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderDirection](icommonqueryoptions.md#optional-orderdirection)* -*Defined in [types.ts:18](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L18)* ___ @@ -56,7 +56,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[skip](icommonqueryoptions.md#optional-skip)* -*Defined in [types.ts:15](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L15)* ___ @@ -66,4 +66,4 @@ ___ *Overrides [ICommonQueryOptions](icommonqueryoptions.md).[where](icommonqueryoptions.md#optional-where)* -*Defined in [stake.ts:24](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L24)* +*Defined in [stake.ts:24](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L24)* diff --git a/docs/interfaces/istakestate.md b/docs/interfaces/istakestate.md index 4b280c0d..a7513e89 100644 --- a/docs/interfaces/istakestate.md +++ b/docs/interfaces/istakestate.md @@ -27,7 +27,7 @@ *Inherited from [IStakeStaticState](istakestaticstate.md).[amount](istakestaticstate.md#amount)* -*Defined in [stake.ts:15](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L15)* +*Defined in [stake.ts:15](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L15)* ___ @@ -37,7 +37,7 @@ ___ *Inherited from [IStakeStaticState](istakestaticstate.md).[createdAt](istakestaticstate.md#createdat)* -*Defined in [stake.ts:13](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L13)* +*Defined in [stake.ts:13](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L13)* ___ @@ -47,7 +47,7 @@ ___ *Overrides [IStakeStaticState](istakestaticstate.md).[id](istakestaticstate.md#optional-id)* -*Defined in [stake.ts:20](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L20)* +*Defined in [stake.ts:20](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L20)* ___ @@ -57,7 +57,7 @@ ___ *Inherited from [IStakeStaticState](istakestaticstate.md).[outcome](istakestaticstate.md#outcome)* -*Defined in [stake.ts:14](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L14)* +*Defined in [stake.ts:14](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L14)* ___ @@ -67,7 +67,7 @@ ___ *Inherited from [IStakeStaticState](istakestaticstate.md).[proposal](istakestaticstate.md#proposal)* -*Defined in [stake.ts:16](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L16)* +*Defined in [stake.ts:16](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L16)* ___ @@ -77,4 +77,4 @@ ___ *Inherited from [IStakeStaticState](istakestaticstate.md).[staker](istakestaticstate.md#staker)* -*Defined in [stake.ts:12](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L12)* +*Defined in [stake.ts:12](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L12)* diff --git a/docs/interfaces/istakestaticstate.md b/docs/interfaces/istakestaticstate.md index 49cdd9c4..9dbd4fec 100644 --- a/docs/interfaces/istakestaticstate.md +++ b/docs/interfaces/istakestaticstate.md @@ -25,7 +25,7 @@ • **amount**: *BN* -*Defined in [stake.ts:15](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L15)* +*Defined in [stake.ts:15](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L15)* ___ @@ -33,7 +33,7 @@ ___ • **createdAt**: *Date | undefined* -*Defined in [stake.ts:13](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L13)* +*Defined in [stake.ts:13](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L13)* ___ @@ -41,7 +41,7 @@ ___ • **id**? : *undefined | string* -*Defined in [stake.ts:11](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L11)* +*Defined in [stake.ts:11](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L11)* ___ @@ -49,7 +49,7 @@ ___ • **outcome**: *[IProposalOutcome](../enums/iproposaloutcome.md)* -*Defined in [stake.ts:14](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L14)* +*Defined in [stake.ts:14](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L14)* ___ @@ -57,7 +57,7 @@ ___ • **proposal**: *string* -*Defined in [stake.ts:16](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L16)* +*Defined in [stake.ts:16](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L16)* ___ @@ -65,4 +65,4 @@ ___ • **staker**: *[Address](../globals.md#address)* -*Defined in [stake.ts:12](https://github.com/daostack/client/blob/7361fcc/src/stake.ts#L12)* +*Defined in [stake.ts:12](https://github.com/daostack/client/blob/1bc237e/src/stake.ts#L12)* diff --git a/docs/interfaces/istateful.md b/docs/interfaces/istateful.md index 3c64d0da..689d0b64 100644 --- a/docs/interfaces/istateful.md +++ b/docs/interfaces/istateful.md @@ -39,7 +39,7 @@ • **state**: *function* -*Defined in [types.ts:11](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L11)* #### Type declaration: diff --git a/docs/interfaces/itagqueryoptions.md b/docs/interfaces/itagqueryoptions.md index 5547b327..b797fee7 100644 --- a/docs/interfaces/itagqueryoptions.md +++ b/docs/interfaces/itagqueryoptions.md @@ -26,7 +26,7 @@ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[first](icommonqueryoptions.md#optional-first)* -*Defined in [types.ts:16](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L16)* ___ @@ -36,7 +36,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderBy](icommonqueryoptions.md#optional-orderby)* -*Defined in [types.ts:17](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L17)* ___ @@ -46,7 +46,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderDirection](icommonqueryoptions.md#optional-orderdirection)* -*Defined in [types.ts:18](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L18)* ___ @@ -56,7 +56,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[skip](icommonqueryoptions.md#optional-skip)* -*Defined in [types.ts:15](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L15)* ___ @@ -66,4 +66,4 @@ ___ *Overrides [ICommonQueryOptions](icommonqueryoptions.md).[where](icommonqueryoptions.md#optional-where)* -*Defined in [tag.ts:20](https://github.com/daostack/client/blob/7361fcc/src/tag.ts#L20)* +*Defined in [tag.ts:20](https://github.com/daostack/client/blob/1bc237e/src/tag.ts#L20)* diff --git a/docs/interfaces/itagstate.md b/docs/interfaces/itagstate.md index 6b853500..ae371436 100644 --- a/docs/interfaces/itagstate.md +++ b/docs/interfaces/itagstate.md @@ -24,7 +24,7 @@ *Overrides [ITagStaticState](itagstaticstate.md).[id](itagstaticstate.md#id)* -*Defined in [tag.ts:15](https://github.com/daostack/client/blob/7361fcc/src/tag.ts#L15)* +*Defined in [tag.ts:15](https://github.com/daostack/client/blob/1bc237e/src/tag.ts#L15)* ___ @@ -34,7 +34,7 @@ ___ *Inherited from [ITagStaticState](itagstaticstate.md).[numberOfProposals](itagstaticstate.md#numberofproposals)* -*Defined in [tag.ts:11](https://github.com/daostack/client/blob/7361fcc/src/tag.ts#L11)* +*Defined in [tag.ts:11](https://github.com/daostack/client/blob/1bc237e/src/tag.ts#L11)* ___ @@ -42,4 +42,4 @@ ___ • **proposals**: *[Proposal](../classes/proposal.md)[]* -*Defined in [tag.ts:16](https://github.com/daostack/client/blob/7361fcc/src/tag.ts#L16)* +*Defined in [tag.ts:16](https://github.com/daostack/client/blob/1bc237e/src/tag.ts#L16)* diff --git a/docs/interfaces/itagstaticstate.md b/docs/interfaces/itagstaticstate.md index 4bc282e9..0ec116ef 100644 --- a/docs/interfaces/itagstaticstate.md +++ b/docs/interfaces/itagstaticstate.md @@ -21,7 +21,7 @@ • **id**: *string* -*Defined in [tag.ts:10](https://github.com/daostack/client/blob/7361fcc/src/tag.ts#L10)* +*Defined in [tag.ts:10](https://github.com/daostack/client/blob/1bc237e/src/tag.ts#L10)* ___ @@ -29,4 +29,4 @@ ___ • **numberOfProposals**: *number* -*Defined in [tag.ts:11](https://github.com/daostack/client/blob/7361fcc/src/tag.ts#L11)* +*Defined in [tag.ts:11](https://github.com/daostack/client/blob/1bc237e/src/tag.ts#L11)* diff --git a/docs/interfaces/itokenqueryoptions.md b/docs/interfaces/itokenqueryoptions.md index 880d70a6..1a0b6df5 100644 --- a/docs/interfaces/itokenqueryoptions.md +++ b/docs/interfaces/itokenqueryoptions.md @@ -26,7 +26,7 @@ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[first](icommonqueryoptions.md#optional-first)* -*Defined in [types.ts:16](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L16)* ___ @@ -36,7 +36,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderBy](icommonqueryoptions.md#optional-orderby)* -*Defined in [types.ts:17](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L17)* ___ @@ -46,7 +46,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderDirection](icommonqueryoptions.md#optional-orderdirection)* -*Defined in [types.ts:18](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L18)* ___ @@ -56,7 +56,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[skip](icommonqueryoptions.md#optional-skip)* -*Defined in [types.ts:15](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L15)* ___ @@ -66,4 +66,4 @@ ___ *Overrides [ICommonQueryOptions](icommonqueryoptions.md).[where](icommonqueryoptions.md#optional-where)* -*Defined in [token.ts:19](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L19)* +*Defined in [token.ts:19](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L19)* diff --git a/docs/interfaces/itokenstate.md b/docs/interfaces/itokenstate.md index bff94292..cf1a2e32 100644 --- a/docs/interfaces/itokenstate.md +++ b/docs/interfaces/itokenstate.md @@ -22,7 +22,7 @@ • **address**: *[Address](../globals.md#address)* -*Defined in [token.ts:11](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L11)* +*Defined in [token.ts:11](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L11)* ___ @@ -30,7 +30,7 @@ ___ • **name**: *string* -*Defined in [token.ts:12](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L12)* +*Defined in [token.ts:12](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L12)* ___ @@ -38,7 +38,7 @@ ___ • **owner**: *[Address](../globals.md#address)* -*Defined in [token.ts:13](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L13)* +*Defined in [token.ts:13](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L13)* ___ @@ -46,7 +46,7 @@ ___ • **symbol**: *string* -*Defined in [token.ts:14](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L14)* +*Defined in [token.ts:14](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L14)* ___ @@ -54,4 +54,4 @@ ___ • **totalSupply**: *BN* -*Defined in [token.ts:15](https://github.com/daostack/client/blob/7361fcc/src/token.ts#L15)* +*Defined in [token.ts:15](https://github.com/daostack/client/blob/1bc237e/src/token.ts#L15)* diff --git a/docs/interfaces/itransactionupdate.md b/docs/interfaces/itransactionupdate.md index 79a58eb8..5db9cf0c 100644 --- a/docs/interfaces/itransactionupdate.md +++ b/docs/interfaces/itransactionupdate.md @@ -28,7 +28,7 @@ A transaction update is a snapshot of the state of a transaction at a particular • **confirmations**? : *undefined | number* -*Defined in [operation.ts:23](https://github.com/daostack/client/blob/7361fcc/src/operation.ts#L23)* +*Defined in [operation.ts:23](https://github.com/daostack/client/blob/1bc237e/src/operation.ts#L23)* number of confirmations @@ -38,7 +38,7 @@ ___ • **receipt**? : *undefined | object* -*Defined in [operation.ts:19](https://github.com/daostack/client/blob/7361fcc/src/operation.ts#L19)* +*Defined in [operation.ts:19](https://github.com/daostack/client/blob/1bc237e/src/operation.ts#L19)* ___ @@ -46,7 +46,7 @@ ___ • **result**? : *[T](undefined)* -*Defined in [operation.ts:28](https://github.com/daostack/client/blob/7361fcc/src/operation.ts#L28)* +*Defined in [operation.ts:28](https://github.com/daostack/client/blob/1bc237e/src/operation.ts#L28)* Parsed return value from the method call or contract address in the case of contract creation tx. @@ -57,7 +57,7 @@ ___ • **state**: *[ITransactionState](../enums/itransactionstate.md)* -*Defined in [operation.ts:17](https://github.com/daostack/client/blob/7361fcc/src/operation.ts#L17)* +*Defined in [operation.ts:17](https://github.com/daostack/client/blob/1bc237e/src/operation.ts#L17)* ___ @@ -65,4 +65,4 @@ ___ • **transactionHash**? : *undefined | string* -*Defined in [operation.ts:18](https://github.com/daostack/client/blob/7361fcc/src/operation.ts#L18)* +*Defined in [operation.ts:18](https://github.com/daostack/client/blob/1bc237e/src/operation.ts#L18)* diff --git a/docs/interfaces/iugenericscheme.md b/docs/interfaces/iugenericscheme.md index b0aef381..399c5888 100644 --- a/docs/interfaces/iugenericscheme.md +++ b/docs/interfaces/iugenericscheme.md @@ -22,7 +22,7 @@ • **callData**: *string* -*Defined in [schemes/uGenericScheme.ts:14](https://github.com/daostack/client/blob/7361fcc/src/schemes/uGenericScheme.ts#L14)* +*Defined in [schemes/uGenericScheme.ts:14](https://github.com/daostack/client/blob/1bc237e/src/schemes/uGenericScheme.ts#L14)* ___ @@ -30,7 +30,7 @@ ___ • **contractToCall**: *[Address](../globals.md#address)* -*Defined in [schemes/uGenericScheme.ts:13](https://github.com/daostack/client/blob/7361fcc/src/schemes/uGenericScheme.ts#L13)* +*Defined in [schemes/uGenericScheme.ts:13](https://github.com/daostack/client/blob/1bc237e/src/schemes/uGenericScheme.ts#L13)* ___ @@ -38,7 +38,7 @@ ___ • **executed**: *boolean* -*Defined in [schemes/uGenericScheme.ts:15](https://github.com/daostack/client/blob/7361fcc/src/schemes/uGenericScheme.ts#L15)* +*Defined in [schemes/uGenericScheme.ts:15](https://github.com/daostack/client/blob/1bc237e/src/schemes/uGenericScheme.ts#L15)* ___ @@ -46,7 +46,7 @@ ___ • **id**: *string* -*Defined in [schemes/uGenericScheme.ts:12](https://github.com/daostack/client/blob/7361fcc/src/schemes/uGenericScheme.ts#L12)* +*Defined in [schemes/uGenericScheme.ts:12](https://github.com/daostack/client/blob/1bc237e/src/schemes/uGenericScheme.ts#L12)* ___ @@ -54,4 +54,4 @@ ___ • **returnValue**: *string* -*Defined in [schemes/uGenericScheme.ts:16](https://github.com/daostack/client/blob/7361fcc/src/schemes/uGenericScheme.ts#L16)* +*Defined in [schemes/uGenericScheme.ts:16](https://github.com/daostack/client/blob/1bc237e/src/schemes/uGenericScheme.ts#L16)* diff --git a/docs/interfaces/iugenericschemeinfo.md b/docs/interfaces/iugenericschemeinfo.md index 619b1fb4..098b1b6e 100644 --- a/docs/interfaces/iugenericschemeinfo.md +++ b/docs/interfaces/iugenericschemeinfo.md @@ -20,7 +20,7 @@ • **contractToCall**: *[Address](../globals.md#address)* -*Defined in [schemes/uGenericScheme.ts:7](https://github.com/daostack/client/blob/7361fcc/src/schemes/uGenericScheme.ts#L7)* +*Defined in [schemes/uGenericScheme.ts:7](https://github.com/daostack/client/blob/1bc237e/src/schemes/uGenericScheme.ts#L7)* ___ @@ -28,7 +28,7 @@ ___ • **id**: *string* -*Defined in [schemes/uGenericScheme.ts:6](https://github.com/daostack/client/blob/7361fcc/src/schemes/uGenericScheme.ts#L6)* +*Defined in [schemes/uGenericScheme.ts:6](https://github.com/daostack/client/blob/1bc237e/src/schemes/uGenericScheme.ts#L6)* ___ @@ -36,4 +36,4 @@ ___ • **votingMachine**: *[Address](../globals.md#address)* -*Defined in [schemes/uGenericScheme.ts:8](https://github.com/daostack/client/blob/7361fcc/src/schemes/uGenericScheme.ts#L8)* +*Defined in [schemes/uGenericScheme.ts:8](https://github.com/daostack/client/blob/1bc237e/src/schemes/uGenericScheme.ts#L8)* diff --git a/docs/interfaces/ivotequeryoptions.md b/docs/interfaces/ivotequeryoptions.md index 97682047..486fd020 100644 --- a/docs/interfaces/ivotequeryoptions.md +++ b/docs/interfaces/ivotequeryoptions.md @@ -26,7 +26,7 @@ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[first](icommonqueryoptions.md#optional-first)* -*Defined in [types.ts:16](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L16)* ___ @@ -36,7 +36,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderBy](icommonqueryoptions.md#optional-orderby)* -*Defined in [types.ts:17](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L17)* ___ @@ -46,7 +46,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[orderDirection](icommonqueryoptions.md#optional-orderdirection)* -*Defined in [types.ts:18](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L18)* ___ @@ -56,7 +56,7 @@ ___ *Inherited from [ICommonQueryOptions](icommonqueryoptions.md).[skip](icommonqueryoptions.md#optional-skip)* -*Defined in [types.ts:15](https://github.com/daostack/client/blob/7361fcc/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/daostack/client/blob/1bc237e/src/types.ts#L15)* ___ @@ -66,4 +66,4 @@ ___ *Overrides [ICommonQueryOptions](icommonqueryoptions.md).[where](icommonqueryoptions.md#optional-where)* -*Defined in [vote.ts:25](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L25)* +*Defined in [vote.ts:25](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L25)* diff --git a/docs/interfaces/ivotestate.md b/docs/interfaces/ivotestate.md index a0f3817c..046ef616 100644 --- a/docs/interfaces/ivotestate.md +++ b/docs/interfaces/ivotestate.md @@ -28,7 +28,7 @@ *Inherited from [IVoteStaticState](ivotestaticstate.md).[amount](ivotestaticstate.md#amount)* -*Defined in [vote.ts:15](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L15)* +*Defined in [vote.ts:15](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L15)* ___ @@ -38,7 +38,7 @@ ___ *Inherited from [IVoteStaticState](ivotestaticstate.md).[createdAt](ivotestaticstate.md#createdat)* -*Defined in [vote.ts:13](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L13)* +*Defined in [vote.ts:13](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L13)* ___ @@ -48,7 +48,7 @@ ___ *Inherited from [IVoteStaticState](ivotestaticstate.md).[dao](ivotestaticstate.md#optional-dao)* -*Defined in [vote.ts:17](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L17)* +*Defined in [vote.ts:17](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L17)* ___ @@ -58,7 +58,7 @@ ___ *Overrides [IVoteStaticState](ivotestaticstate.md).[id](ivotestaticstate.md#optional-id)* -*Defined in [vote.ts:21](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L21)* +*Defined in [vote.ts:21](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L21)* ___ @@ -68,7 +68,7 @@ ___ *Inherited from [IVoteStaticState](ivotestaticstate.md).[outcome](ivotestaticstate.md#outcome)* -*Defined in [vote.ts:14](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L14)* +*Defined in [vote.ts:14](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L14)* ___ @@ -78,7 +78,7 @@ ___ *Inherited from [IVoteStaticState](ivotestaticstate.md).[proposal](ivotestaticstate.md#proposal)* -*Defined in [vote.ts:16](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L16)* +*Defined in [vote.ts:16](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L16)* ___ @@ -88,4 +88,4 @@ ___ *Inherited from [IVoteStaticState](ivotestaticstate.md).[voter](ivotestaticstate.md#voter)* -*Defined in [vote.ts:12](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L12)* +*Defined in [vote.ts:12](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L12)* diff --git a/docs/interfaces/ivotestaticstate.md b/docs/interfaces/ivotestaticstate.md index 646b1fe0..20f5f968 100644 --- a/docs/interfaces/ivotestaticstate.md +++ b/docs/interfaces/ivotestaticstate.md @@ -26,7 +26,7 @@ • **amount**: *BN* -*Defined in [vote.ts:15](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L15)* +*Defined in [vote.ts:15](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L15)* ___ @@ -34,7 +34,7 @@ ___ • **createdAt**: *[Date](../globals.md#date) | undefined* -*Defined in [vote.ts:13](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L13)* +*Defined in [vote.ts:13](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L13)* ___ @@ -42,7 +42,7 @@ ___ • **dao**? : *[Address](../globals.md#address)* -*Defined in [vote.ts:17](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L17)* +*Defined in [vote.ts:17](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L17)* ___ @@ -50,7 +50,7 @@ ___ • **id**? : *undefined | string* -*Defined in [vote.ts:11](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L11)* +*Defined in [vote.ts:11](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L11)* ___ @@ -58,7 +58,7 @@ ___ • **outcome**: *[IProposalOutcome](../enums/iproposaloutcome.md)* -*Defined in [vote.ts:14](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L14)* +*Defined in [vote.ts:14](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L14)* ___ @@ -66,7 +66,7 @@ ___ • **proposal**: *string* -*Defined in [vote.ts:16](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L16)* +*Defined in [vote.ts:16](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L16)* ___ @@ -74,4 +74,4 @@ ___ • **voter**: *[Address](../globals.md#address)* -*Defined in [vote.ts:12](https://github.com/daostack/client/blob/7361fcc/src/vote.ts#L12)* +*Defined in [vote.ts:12](https://github.com/daostack/client/blob/1bc237e/src/vote.ts#L12)* diff --git a/package-lock.json b/package-lock.json index dd0ff2d7..49d1cb43 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@daostack/client", - "version": "0.2.44", + "version": "0.2.46", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 7a952235..e9987b63 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@daostack/client", - "version": "0.2.44", + "version": "0.2.46", "description": "", "keywords": [], "main": "dist/lib/index.js", diff --git a/src/arc.ts b/src/arc.ts index 2f9efc76..0f442dd0 100644 --- a/src/arc.ts +++ b/src/arc.ts @@ -413,9 +413,10 @@ export class Arc extends GraphNodeObserver { public sendTransaction( transaction: any, mapToObject: (receipt: web3receipt) => T, - errorHandler: (error: Error) => Promise | Error = (error) => error + errorHandler?: (error: Error) => Promise | Error ): Operation { - return sendTransaction(transaction, mapToObject, errorHandler, this) + + return sendTransaction(this, transaction, mapToObject, errorHandler) } /** diff --git a/src/operation.ts b/src/operation.ts index e6d31b66..b1ce421d 100644 --- a/src/operation.ts +++ b/src/operation.ts @@ -40,28 +40,42 @@ export type Operation = IOperationObservable> export type web3receipt = object /** - * send a transaction to the ethereumblockchain, and return a observable of ITransactionUpdatessend + * + * * send a transaction to the ethereumblockchain, and return a observable of ITransactionUpdatessend * for example: - * sendTransaction(.....).subscribe((txUpdate) => { + * ```sendTransaction(.....).subscribe((txUpdate) => { * if (txUpdate.state === 'sent' ) { notify("your transaction has been sent, waitin'for it to be mnied") } * if (txUpdate.state === 'mined'} { * notify("your transaction has been mined! It was confirmed ${txUpdate.confirmations} times"} * // and we also ahve the txUpdate.receipt and the txUpdate.result to do stuff with * } - * }) + * })``` * - * @parameter transaction A web3 transaction, or an (async) function that returns a transaction - * @parameter map A function that takes the receipt of the transaction and returns an object - * @parameter errorHandler A function that takes an error, and either returns or throws a more informative Error - * @parameter context An instance of Arc - * @return An observable with ITransactionUpdate instnces + * @export + * @template T + * @param {Arc} context An instance of Arc + * @param {*} transaction A Web3 transaction object to send + * @param {((receipt: web3receipt) => T | Promise)} mapReceipt A function that takes the receipt of + * the transaction and returns an object + * @param {((error: Error) => Promise | Error)} [errorHandler] + * A function that takes an error, and either returns or throws a more informative Error + * if errorHander is not provided, a default error handler will throw any errors thrown by calling `transaction.call()` + * @returns {Operation} */ export function sendTransaction( + context: Arc, transaction: any, mapReceipt: (receipt: web3receipt) => T | Promise, - errorHandler: (error: Error) => Promise | Error = (error) => error, - context: Arc + errorHandler?: (error: Error) => Promise | Error ): Operation { + + if (!errorHandler) { + errorHandler = async (err: Error) => { + await transaction.call() + return err + } + } + const observable = Observable.create(async (observer: Observer>) => { let transactionHash: string let result: any @@ -82,13 +96,12 @@ export function sendTransaction( try { gasEstimate = await tx.estimateGas({ from }) } catch (error) { - let errToReturn: Error try { - errToReturn = await errorHandler(error) + error = await (errorHandler as (error: Error) => Promise | Error)(error) } catch (err) { - errToReturn = err + error = err } - observer.error(errToReturn) + observer.error(error) return } let gas: number @@ -126,8 +139,13 @@ export function sendTransaction( .once('receipt', async (receipt: any) => { try { result = await mapReceipt(receipt) - } catch (err) { - observer.error(err) + } catch (error) { + try { + error = await (errorHandler as (error: Error) => Promise | Error)(error) + } catch (err) { + error = err + } + observer.error(error) } if (confirmationCount === 0) { Logger.debug(`transaction mined!`) @@ -144,8 +162,13 @@ export function sendTransaction( if (!result) { try { result = await mapReceipt(receipt) - } catch (err) { - observer.error(err) + } catch (error) { + try { + error = await (errorHandler as (error: Error) => Promise | Error)(error) + } catch (err) { + error = err + } + observer.error(error) } } if (confirmationCount === 0) { @@ -164,13 +187,12 @@ export function sendTransaction( } }) .on('error', async (error: Error) => { - let errToReturn: Error try { - errToReturn = await errorHandler(error) + error = await (errorHandler as (error: Error) => Promise | Error)(error) } catch (err) { - errToReturn = err + error = err } - observer.error(errToReturn) + observer.error(error) }) } ) diff --git a/src/proposal.ts b/src/proposal.ts index 18005e10..42661d70 100644 --- a/src/proposal.ts +++ b/src/proposal.ts @@ -622,31 +622,31 @@ export class Proposal implements IStateful { const observable = from(this.votingMachine()).pipe( concatMap((votingMachine) => { - const errorHandler = async (error: Error) => { - if (error.message.match(/revert/)) { - const proposal = this - const proposalDataFromVotingMachine = await votingMachine.methods.proposals(proposal.id).call() - if (proposalDataFromVotingMachine.proposer === NULL_ADDRESS ) { - return Error(`Error in vote(): unknown proposal with id ${proposal.id}`) - } - - if (proposalDataFromVotingMachine.state === '2') { - const msg = `Error in vote(): proposal ${proposal.id} already executed` - return Error(msg) - } - } - // if we have found no known error, we return the original error - return error - } - - const voteMethod = votingMachine.methods.vote( + const voteMethod = votingMachine.methods.vote( this.id, // proposalId outcome, // a value between 0 to and the proposal number of choices. amount.toString(), // amount of reputation to vote with . if _amount == 0 it will use all voter reputation. NULL_ADDRESS ) - return this.context.sendTransaction(voteMethod, mapReceipt, errorHandler) + const errorHandler = async (error: Error) => { + const proposal = this + const proposalDataFromVotingMachine = await votingMachine.methods.proposals(proposal.id).call() + if (proposalDataFromVotingMachine.proposer === NULL_ADDRESS ) { + return Error(`Error in vote(): unknown proposal with id ${proposal.id}`) + } + + if (proposalDataFromVotingMachine.state === '2') { + const msg = `Error in vote(): proposal ${proposal.id} already executed` + return Error(msg) + } + // call the method, so we collect any errors from the EVM + await voteMethod.call() + // if everything seems fine, just return the oroginal error + return error + } + + return this.context.sendTransaction(voteMethod, mapReceipt, errorHandler) }) ) @@ -669,59 +669,67 @@ export class Proposal implements IStateful { * @param amount the amount, in GEN, to stake * @return An observable that can be sent, or subscribed to */ - public stake(outcome: IProposalOutcome, amount: BN ): Operation { - const map = (receipt: any) => { // map extracts Stake instance from receipt - const event = receipt.events.Stake - if (!event) { - // for some reason, a transaction was mined but no error was raised before - throw new Error(`Error staking: no "Stake" event was found - ${Object.keys(receipt.events)}`) - } + public stake(outcome: IProposalOutcome, amount: BN): Operation { + const observable = from(this.votingMachine()).pipe( + concatMap((votingMachine) => { - return new Stake({ - amount: event.returnValues._reputation, // amount - // createdAt is "about now", but we cannot calculate the data that will be indexed by the subgraph - createdAt: undefined, - outcome, - proposal: this.id, // proposalID - staker: event.returnValues._staker - }, this.context) - } + const map = (receipt: any) => { // map extracts Stake instance from receipt - const errorHandler = async (error: Error) => { - if (error.message.match(/revert/)) { - const proposal = this - const stakingToken = this.stakingToken() - const prop = await (await this.votingMachine()).methods.proposals(proposal.id).call() - if (prop.proposer === NULL_ADDRESS ) { - return new Error(`Unknown proposal with id ${proposal.id}`) + const event = receipt.events.Stake + if (!event) { + // for some reason, a transaction was mined but no error was raised before + throw new Error(`Error staking: no "Stake" event was found - ${Object.keys(receipt.events)}`) + } + return new Stake({ + amount: event.returnValues._reputation, // amount + // createdAt is "about now", but we cannot calculate the data that will be indexed by the subgraph + createdAt: undefined, + outcome, + proposal: this.id, // proposalID + staker: event.returnValues._staker + }, this.context) } - // staker has sufficient balance - const defaultAccount = await this.context.getAccount().pipe(first()).toPromise() - const balance = new BN(await stakingToken.contract().methods.balanceOf(defaultAccount).call()) - const amountBN = new BN(amount) - if (balance.lt(amountBN)) { - const msg = `Staker ${defaultAccount} has insufficient balance to stake ${amount.toString()} - (balance is ${balance.toString()})` - return new Error(msg) - } + const errorHandler = async (error: Error) => { + const proposal = this + const proposalState = await (await this.votingMachine()).methods.proposals(proposal.id).call() + const stakingToken = this.stakingToken() + if (proposalState.proposer === NULL_ADDRESS ) { + return new Error(`Unknown proposal with id ${proposal.id}`) + } + // staker has sufficient balance + const defaultAccount = await this.context.getAccount().pipe(first()).toPromise() + const balance = new BN(await stakingToken.contract().methods.balanceOf(defaultAccount).call()) + const amountBN = new BN(amount) + if (balance.lt(amountBN)) { + const msg = `Staker ${defaultAccount} has insufficient balance to stake ${amount.toString()} + (balance is ${balance.toString()})` + return new Error(msg) + } + + // staker has approved the token spend + const allowance = new BN(await stakingToken.contract().methods.allowance( + defaultAccount, votingMachine.options.address + ).call()) + if (allowance.lt(amountBN)) { + return new Error( + `Staker has insufficient allowance to stake ${amount.toString()} + (allowance for ${votingMachine.options.address} is ${allowance.toString()})` + ) + } - // staker has approved the token spend - const votingMachine = await this.votingMachine() - const allowance = new BN(await stakingToken.contract().methods.allowance( - defaultAccount, votingMachine.options.address - ).call()) - if (allowance.lt(amountBN)) { - return new Error(`Staker has insufficient allowance to stake ${amount.toString()} - (allowance is ${allowance.toString()})`) + // call the stake function and bubble up any solidity errors + await stakeMethod.call() + if (!!error.message.match(/event was found/)) { + if (proposalState.state === IProposalStage.Boosted) { + return new Error(`Staking failed because the proposal is boosted`) + } + } + // if we have found no known error, we return the original error + + return error } - } - // if we have found no known error, we return the original error - return error - } - const observable = from(this.votingMachine()).pipe( - concatMap((votingMachine) => { const stakeMethod = votingMachine.methods.stake( this.id, // proposalId outcome, // a value between 0 to and the proposal number of choices. @@ -752,7 +760,7 @@ export class Proposal implements IStateful { * if undefined will only redeem the ContributionReward rewards * @return an Operation */ - public claimRewards(beneficiary ?: Address): Operation { + public claimRewards(beneficiary?: Address): Operation { if (!beneficiary) { beneficiary = NULL_ADDRESS @@ -818,6 +826,7 @@ export class Proposal implements IStateful { const msg = `Error in proposal.execute(): proposal ${this.id} already executed` return Error(msg) } + await transaction.call() return err } return this.context.sendTransaction(transaction, map, errorHandler) diff --git a/src/reputation.ts b/src/reputation.ts index 53c2cbd7..c2ded399 100644 --- a/src/reputation.ts +++ b/src/reputation.ts @@ -133,6 +133,7 @@ export class Reputation implements IStateful { return Error(`Minting failed: sender ${sender} is not the owner of the contract at ${contract._address}` + `(which is ${owner})`) } + await transaction.call() return err } return this.context.sendTransaction(transaction, mapReceipt, errHandler) diff --git a/src/scheme.ts b/src/scheme.ts index a7c3da17..2084b904 100644 --- a/src/scheme.ts +++ b/src/scheme.ts @@ -326,7 +326,6 @@ export class Scheme extends SchemeBase { const context = this.context let createTransaction: () => any = () => null let map: any - const errHandler = (err: Error) => err const state = await this.fetchStaticState() switch (state.name) { @@ -379,7 +378,7 @@ export class Scheme extends SchemeBase { throw Error(msg) } - const sendTransactionObservable = context.sendTransaction(createTransaction, map, errHandler) + const sendTransactionObservable = context.sendTransaction(createTransaction, map) const sub = sendTransactionObservable.subscribe(observer) return () => sub.unsubscribe() diff --git a/src/schemes/competition.ts b/src/schemes/competition.ts index 1f8776bd..3c46fe9b 100644 --- a/src/schemes/competition.ts +++ b/src/schemes/competition.ts @@ -336,6 +336,9 @@ export class CompetitionScheme extends SchemeBase { if (reputationOfUser.isZero()) { throw Error(`Cannot vote because the user ${sender} does not have any reputation in the DAO at ${dao.id}`) } + // get any solidity-defined errors + const tx = await createTransaction() + await tx.call() return err } const observable = this.context.sendTransaction(createTransaction, mapReceipt, errorHandler) @@ -463,6 +466,8 @@ export class Competition { // extends Proposal { if (!proposal) { throw Error(`A proposal with id ${this.id} does not exist`) } + const tx = await createTransaction() + await tx.call() return err } const observable = this.context.sendTransaction(createTransaction, mapReceipt, errorHandler) diff --git a/test/proposal-stake.spec.ts b/test/proposal-stake.spec.ts index f3fe27ad..2b75665b 100644 --- a/test/proposal-stake.spec.ts +++ b/test/proposal-stake.spec.ts @@ -1,9 +1,9 @@ +import BN = require('bn.js') import { first } from 'rxjs/operators' import { Arc } from '../src/arc' import { DAO } from '../src/dao' -import { IProposalOutcome, Proposal } from '../src/proposal' +import { IProposalOutcome, IProposalStage, Proposal } from '../src/proposal' import { Stake } from '../src/stake' -import BN = require('bn.js') import { createAProposal, // getTestAddresses, getTestDAO, @@ -21,16 +21,12 @@ describe('Stake on a ContributionReward', () => { let accounts: any // let addresses: ITestAddresses let dao: DAO - // let executedProposal: Proposal beforeAll(async () => { arc = await newArc() web3 = arc.web3 accounts = web3.eth.accounts.wallet - // addresses = getTestAddresses(arc) dao = await getTestDAO() - // const { executedProposalId} = addresses.test - // executedProposal = await dao.proposal(executedProposalId) }) it('works and gets indexed', async () => { @@ -90,11 +86,26 @@ describe('Stake on a ContributionReward', () => { ) proposal.context.web3.eth.defaultAccount = accounts[2].address - await expect(proposal.stake(IProposalOutcome.Pass, toWei('10000000')).send()).rejects.toThrow( + await expect(proposal.stake(IProposalOutcome.Pass, new BN(10000000)).send()).rejects.toThrow( /No proposal/i ) }) + it.skip('throws a meaningful error if the proposal is boosted', async () => { + // Skipping this test, because the "stake" function actually also changes the proposal state sometimes + const boostedProposals = await arc.proposals({where: {stage: IProposalStage.Boosted}}).pipe(first()).toPromise() + if (boostedProposals.length === 0) { + throw Error(`No boosted proposals were found, so this test fails... (perhap restart docker containers?)`) + } + const boostedProposal = boostedProposals[0] + const state = await boostedProposal.state().pipe(first()).toPromise() + console.log(state) + expect(state.stage).toEqual(IProposalStage.Boosted) + await expect(boostedProposal.stake(IProposalOutcome.Pass, new BN(10000000)).send()).rejects.toThrow( + /boosted/i + ) + }) + it('stake gets correctly indexed on the proposal entity', async () => { const proposal = await createAProposal()