


#  API Reference

## Index

### Enumerations

* [BinaryVoteResult](enums/BinaryVoteResult.md)
* [ExecutionState](enums/ExecutionState.md)
* [GlobalConstraintProposalType](enums/GlobalConstraintProposalType.md)
* [LogLevel](enums/LogLevel.md)
* [ProposalState](enums/ProposalState.md)
* [RewardType](enums/RewardType.md)
* [SchemePermissions](enums/SchemePermissions.md)
* [SchemeRegistrarProposalType](enums/SchemeRegistrarProposalType.md)
* [TransactionStage](enums/TransactionStage.md)
* [UpgradeSchemeProposalType](enums/UpgradeSchemeProposalType.md)


### Classes

* [AbsoluteVoteWrapper](classes/AbsoluteVoteWrapper.md)
* [AccountService](classes/AccountService.md)
* [ArcTransactionAgreementResult](classes/ArcTransactionAgreementResult.md)
* [ArcTransactionDataResult](classes/ArcTransactionDataResult.md)
* [ArcTransactionProposalResult](classes/ArcTransactionProposalResult.md)
* [ArcTransactionResult](classes/ArcTransactionResult.md)
* [AvatarService](classes/AvatarService.md)
* [ConfigService](classes/ConfigService.md)
* [ContractWrapperBase](classes/ContractWrapperBase.md)
* [ContractWrapperFactory](classes/ContractWrapperFactory.md)
* [ContributionRewardWrapper](classes/ContributionRewardWrapper.md)
* [ControllerService](classes/ControllerService.md)
* [DAO](classes/DAO.md)
* [DaoCreatorFactoryType](classes/DaoCreatorFactoryType.md)
* [DaoCreatorWrapper](classes/DaoCreatorWrapper.md)
* [DaoTokenFactoryType](classes/DaoTokenFactoryType.md)
* [DaoTokenWrapper](classes/DaoTokenWrapper.md)
* [DefaultSchemePermissions](classes/DefaultSchemePermissions.md)
* [EventSubscription](classes/EventSubscription.md)
* [GenesisDaoCreator](classes/GenesisDaoCreator.md)
* [GenesisProtocolFactoryType](classes/GenesisProtocolFactoryType.md)
* [GenesisProtocolWrapper](classes/GenesisProtocolWrapper.md)
* [GlobalConstraintRegistrarWrapper](classes/GlobalConstraintRegistrarWrapper.md)
* [IntVoteInterfaceFactoryType](classes/IntVoteInterfaceFactoryType.md)
* [IntVoteInterfaceWrapper](classes/IntVoteInterfaceWrapper.md)
* [LoggingService](classes/LoggingService.md)
* [MintableTokenFactoryType](classes/MintableTokenFactoryType.md)
* [MintableTokenWrapper](classes/MintableTokenWrapper.md)
* [PromiseEventService](classes/PromiseEventService.md)
* [ProposalGeneratorBase](classes/ProposalGeneratorBase.md)
* [ProposalService](classes/ProposalService.md)
* [PubSubEventService](classes/PubSubEventService.md)
* [RedeemerFactoryType](classes/RedeemerFactoryType.md)
* [RedeemerWrapper](classes/RedeemerWrapper.md)
* [ReputationFactoryType](classes/ReputationFactoryType.md)
* [ReputationWrapper](classes/ReputationWrapper.md)
* [SchemeRegistrarWrapper](classes/SchemeRegistrarWrapper.md)
* [StandardTokenFactoryType](classes/StandardTokenFactoryType.md)
* [StandardTokenWrapper](classes/StandardTokenWrapper.md)
* [SubscriptionCollection](classes/SubscriptionCollection.md)
* [TokenCapGCWrapper](classes/TokenCapGCWrapper.md)
* [TransactionService](classes/TransactionService.md)
* [UpgradeSchemeWrapper](classes/UpgradeSchemeWrapper.md)
* [Utils](classes/Utils.md)
* [UtilsInternal](classes/UtilsInternal.md)
* [VestingSchemeWrapper](classes/VestingSchemeWrapper.md)
* [VoteInOrganizationSchemeWrapper](classes/VoteInOrganizationSchemeWrapper.md)
* [Web3EventService](classes/Web3EventService.md)
* [Web3EventSubscription](classes/Web3EventSubscription.md)
* [WrapperService](classes/WrapperService.md)


### Interfaces

* [AVVoteProposalEventResult](interfaces/AVVoteProposalEventResult.md)
* [AbsoluteVoteParams](interfaces/AbsoluteVoteParams.md)
* [AbsoluteVoteParamsResult](interfaces/AbsoluteVoteParamsResult.md)
* [Agreement](interfaces/Agreement.md)
* [AgreementBase](interfaces/AgreementBase.md)
* [AgreementCancelEventResult](interfaces/AgreementCancelEventResult.md)
* [AgreementProposal](interfaces/AgreementProposal.md)
* [AgreementProposalEventResult](interfaces/AgreementProposalEventResult.md)
* [AllowanceOptions](interfaces/AllowanceOptions.md)
* [ApprovalEventResult](interfaces/ApprovalEventResult.md)
* [ApproveAndCallOptions](interfaces/ApproveAndCallOptions.md)
* [ArcWrapperFactories](interfaces/ArcWrapperFactories.md)
* [ArcWrappers](interfaces/ArcWrappers.md)
* [ArcWrappersByType](interfaces/ArcWrappersByType.md)
* [BurnEventResult](interfaces/BurnEventResult.md)
* [BurnableTokenBurnOptions](interfaces/BurnableTokenBurnOptions.md)
* [CancelProposalEventResult](interfaces/CancelProposalEventResult.md)
* [CancelVotingEventResult](interfaces/CancelVotingEventResult.md)
* [ChangeApprovalAndCallOptions](interfaces/ChangeApprovalAndCallOptions.md)
* [ChangeUpgradeSchemeProposalEventResult](interfaces/ChangeUpgradeSchemeProposalEventResult.md)
* [CollectEventResult](interfaces/CollectEventResult.md)
* [CollectVestingAgreementConfig](interfaces/CollectVestingAgreementConfig.md)
* [CommonVestingAgreementConfig](interfaces/CommonVestingAgreementConfig.md)
* [ContributionProposal](interfaces/ContributionProposal.md)
* [ContributionRewardParams](interfaces/ContributionRewardParams.md)
* [ContributionRewardParamsReturn](interfaces/ContributionRewardParamsReturn.md)
* [ContributionRewardRedeemParams](interfaces/ContributionRewardRedeemParams.md)
* [ContributionRewardSpecifiedRedemptionParams](interfaces/ContributionRewardSpecifiedRedemptionParams.md)
* [ControllerAddGlobalConstraintsEventLogEntry](interfaces/ControllerAddGlobalConstraintsEventLogEntry.md)
* [ControllerRegisterSchemeEventLogEntry](interfaces/ControllerRegisterSchemeEventLogEntry.md)
* [CreateVestingAgreementConfig](interfaces/CreateVestingAgreementConfig.md)
* [DaoGlobalConstraintInfo](interfaces/DaoGlobalConstraintInfo.md)
* [DaoSchemeInfo](interfaces/DaoSchemeInfo.md)
* [DaoTokenBurnOptions](interfaces/DaoTokenBurnOptions.md)
* [DaoTokenMintOptions](interfaces/DaoTokenMintOptions.md)
* [EntityFetcher](interfaces/EntityFetcher.md)
* [EventFetcher](interfaces/EventFetcher.md)
* [EventFetcherFilterObject](interfaces/EventFetcherFilterObject.md)
* [EventHasPropertyId](interfaces/EventHasPropertyId.md)
* [EventPreProcessorReturn](interfaces/EventPreProcessorReturn.md)
* [ExecuteProposalEventResult](interfaces/ExecuteProposalEventResult.md)
* [ExecutedGenesisProposal](interfaces/ExecutedGenesisProposal.md)
* [ExecutedProposal](interfaces/ExecutedProposal.md)
* [ForgeOrgConfig](interfaces/ForgeOrgConfig.md)
* [ForgedDaoInfo](interfaces/ForgedDaoInfo.md)
* [FounderConfig](interfaces/FounderConfig.md)
* [GPExecuteProposalEventResult](interfaces/GPExecuteProposalEventResult.md)
* [GenesisProtocolDaoTokenBalances](interfaces/GenesisProtocolDaoTokenBalances.md)
* [GenesisProtocolParams](interfaces/GenesisProtocolParams.md)
* [GenesisProtocolProposal](interfaces/GenesisProtocolProposal.md)
* [GetAgreementParams](interfaces/GetAgreementParams.md)
* [GetAllowedRangeOfChoicesResult](interfaces/GetAllowedRangeOfChoicesResult.md)
* [GetBeneficiaryRewardsParams](interfaces/GetBeneficiaryRewardsParams.md)
* [GetDaosOptions](interfaces/GetDaosOptions.md)
* [GetGenesisProtocolParamsResult](interfaces/GetGenesisProtocolParamsResult.md)
* [GetNumberOfChoicesConfig](interfaces/GetNumberOfChoicesConfig.md)
* [GetParticipantsOptions](interfaces/GetParticipantsOptions.md)
* [GetProposalAvatarConfig](interfaces/GetProposalAvatarConfig.md)
* [GetProposalEventsOptions](interfaces/GetProposalEventsOptions.md)
* [GetProposalStatusConfig](interfaces/GetProposalStatusConfig.md)
* [GetProposalStatusResult](interfaces/GetProposalStatusResult.md)
* [GetScoreConfig](interfaces/GetScoreConfig.md)
* [GetScoreThresholdParamsConfig](interfaces/GetScoreThresholdParamsConfig.md)
* [GetScoreThresholdParamsResult](interfaces/GetScoreThresholdParamsResult.md)
* [GetStakerInfoConfig](interfaces/GetStakerInfoConfig.md)
* [GetStakerInfoResult](interfaces/GetStakerInfoResult.md)
* [GetStateConfig](interfaces/GetStateConfig.md)
* [GetThresholdConfig](interfaces/GetThresholdConfig.md)
* [GetTokenBalancesOptions](interfaces/GetTokenBalancesOptions.md)
* [GetTokenCapGcParamsResult](interfaces/GetTokenCapGcParamsResult.md)
* [GetTotalReputationSupplyConfig](interfaces/GetTotalReputationSupplyConfig.md)
* [GetVoteStatusConfig](interfaces/GetVoteStatusConfig.md)
* [GetVoterInfoConfig](interfaces/GetVoterInfoConfig.md)
* [GetVoterInfoResult](interfaces/GetVoterInfoResult.md)
* [GetWinningVoteConfig](interfaces/GetWinningVoteConfig.md)
* [IBurnableTokenWrapper](interfaces/IBurnableTokenWrapper.md)
* [IConfigService](interfaces/IConfigService.md)
* [IContractWrapper](interfaces/IContractWrapper.md)
* [IContractWrapperFactory](interfaces/IContractWrapperFactory.md)
* [IErc827TokenWrapper](interfaces/IErc827TokenWrapper.md)
* [IEventSubscription](interfaces/IEventSubscription.md)
* [IIntVoteInterface](interfaces/IIntVoteInterface.md)
* [ILogger](interfaces/ILogger.md)
* [ISchemeWrapper](interfaces/ISchemeWrapper.md)
* [ITruffleContractFunction](interfaces/ITruffleContractFunction.md)
* [IUniversalSchemeWrapper](interfaces/IUniversalSchemeWrapper.md)
* [IVotingMachineWrapper](interfaces/IVotingMachineWrapper.md)
* [InitialSchemesSetEventResult](interfaces/InitialSchemesSetEventResult.md)
* [InitializeArcOptions](interfaces/InitializeArcOptions.md)
* [MintEventResult](interfaces/MintEventResult.md)
* [MintFinishedEventResult](interfaces/MintFinishedEventResult.md)
* [MintableTokenMintOptions](interfaces/MintableTokenMintOptions.md)
* [NewContributionProposalEventResult](interfaces/NewContributionProposalEventResult.md)
* [NewDaoConfig](interfaces/NewDaoConfig.md)
* [NewDaoVotingMachineConfig](interfaces/NewDaoVotingMachineConfig.md)
* [NewGlobalConstraintsProposalEventResult](interfaces/NewGlobalConstraintsProposalEventResult.md)
* [NewOrgEventResult](interfaces/NewOrgEventResult.md)
* [NewProposalEventResult](interfaces/NewProposalEventResult.md)
* [NewSchemeProposalEventResult](interfaces/NewSchemeProposalEventResult.md)
* [NewUpgradeProposalEventResult](interfaces/NewUpgradeProposalEventResult.md)
* [NewVestedAgreementEventResult](interfaces/NewVestedAgreementEventResult.md)
* [NewVoteProposalEventResult](interfaces/NewVoteProposalEventResult.md)
* [OwnerVoteOptions](interfaces/OwnerVoteOptions.md)
* [Participant](interfaces/Participant.md)
* [ProposalDeletedEventResult](interfaces/ProposalDeletedEventResult.md)
* [ProposalEntity](interfaces/ProposalEntity.md)
* [ProposalExecutedEventResult](interfaces/ProposalExecutedEventResult.md)
* [ProposalIdOption](interfaces/ProposalIdOption.md)
* [ProposalRewards](interfaces/ProposalRewards.md)
* [ProposeContributionRewardParams](interfaces/ProposeContributionRewardParams.md)
* [ProposeControllerParams](interfaces/ProposeControllerParams.md)
* [ProposeOptions](interfaces/ProposeOptions.md)
* [ProposeToAddModifyGlobalConstraintParams](interfaces/ProposeToAddModifyGlobalConstraintParams.md)
* [ProposeToAddModifySchemeParams](interfaces/ProposeToAddModifySchemeParams.md)
* [ProposeToRemoveGlobalConstraintParams](interfaces/ProposeToRemoveGlobalConstraintParams.md)
* [ProposeToRemoveSchemeParams](interfaces/ProposeToRemoveSchemeParams.md)
* [ProposeUpgradingSchemeParams](interfaces/ProposeUpgradingSchemeParams.md)
* [ProposeVestingAgreementConfig](interfaces/ProposeVestingAgreementConfig.md)
* [ProposedVestedAgreementEventResult](interfaces/ProposedVestedAgreementEventResult.md)
* [RedeeemableResult](interfaces/RedeeemableResult.md)
* [RedeemConfig](interfaces/RedeemConfig.md)
* [RedeemEventResult](interfaces/RedeemEventResult.md)
* [RedeemerOptions](interfaces/RedeemerOptions.md)
* [RedeemerRedeemEventResult](interfaces/RedeemerRedeemEventResult.md)
* [RefreshReputationEventResult](interfaces/RefreshReputationEventResult.md)
* [RemoveGlobalConstraintsProposalEventResult](interfaces/RemoveGlobalConstraintsProposalEventResult.md)
* [RemoveSchemeProposalEventResult](interfaces/RemoveSchemeProposalEventResult.md)
* [ReputationBurnEventResult](interfaces/ReputationBurnEventResult.md)
* [ReputationBurnOptions](interfaces/ReputationBurnOptions.md)
* [ReputationMintEventResult](interfaces/ReputationMintEventResult.md)
* [ReputationMintOptions](interfaces/ReputationMintOptions.md)
* [RevokeSignToCancelAgreementEventResult](interfaces/RevokeSignToCancelAgreementEventResult.md)
* [RevokeSignToCancelVestingAgreementConfig](interfaces/RevokeSignToCancelVestingAgreementConfig.md)
* [SchemeConfig](interfaces/SchemeConfig.md)
* [SchemeProposalExecuted](interfaces/SchemeProposalExecuted.md)
* [SchemeProposalExecutedEventResult](interfaces/SchemeProposalExecutedEventResult.md)
* [SchemeRegistrarParams](interfaces/SchemeRegistrarParams.md)
* [SchemesConfig](interfaces/SchemesConfig.md)
* [SetSchemesConfig](interfaces/SetSchemesConfig.md)
* [ShouldBoostConfig](interfaces/ShouldBoostConfig.md)
* [SignToCancelAgreementEventResult](interfaces/SignToCancelAgreementEventResult.md)
* [SignToCancelVestingAgreementConfig](interfaces/SignToCancelVestingAgreementConfig.md)
* [StakeConfig](interfaces/StakeConfig.md)
* [StakeEventResult](interfaces/StakeEventResult.md)
* [StandardSchemeParams](interfaces/StandardSchemeParams.md)
* [StandardTokenAllowanceOptions](interfaces/StandardTokenAllowanceOptions.md)
* [StandardTokenApproveOptions](interfaces/StandardTokenApproveOptions.md)
* [StandardTokenChangeApprovalOptions](interfaces/StandardTokenChangeApprovalOptions.md)
* [StandardTokenTransferFromOptions](interfaces/StandardTokenTransferFromOptions.md)
* [StandardTokenTransferOptions](interfaces/StandardTokenTransferOptions.md)
* [TokenCapGcParams](interfaces/TokenCapGcParams.md)
* [TransactionReceiptTruffle](interfaces/TransactionReceiptTruffle.md)
* [TransactionReceiptsEventInfo](interfaces/TransactionReceiptsEventInfo.md)
* [TransferAndCallOptions](interfaces/TransferAndCallOptions.md)
* [TransferEventResult](interfaces/TransferEventResult.md)
* [TransferFromAndCallOptions](interfaces/TransferFromAndCallOptions.md)
* [TruffleContract](interfaces/TruffleContract.md)
* [VestingSchemeSchemeProposalExecuted](interfaces/VestingSchemeSchemeProposalExecuted.md)
* [VotableGlobalConstraintProposal](interfaces/VotableGlobalConstraintProposal.md)
* [VotableProposal](interfaces/VotableProposal.md)
* [VotableSchemeRegistrarProposal](interfaces/VotableSchemeRegistrarProposal.md)
* [VotableUpgradeSchemeProposal](interfaces/VotableUpgradeSchemeProposal.md)
* [VotableVoteInOrganizationProposal](interfaces/VotableVoteInOrganizationProposal.md)
* [VoteInOrganizationProposeVoteConfig](interfaces/VoteInOrganizationProposeVoteConfig.md)
* [VoteOnBehalfEventResult](interfaces/VoteOnBehalfEventResult.md)
* [VoteOptions](interfaces/VoteOptions.md)
* [VoteProposalEventResult](interfaces/VoteProposalEventResult.md)
* [VoteStatusOptions](interfaces/VoteStatusOptions.md)
* [VoteWithSpecifiedAmountsOptions](interfaces/VoteWithSpecifiedAmountsOptions.md)
* [Web3EventFetcher](interfaces/Web3EventFetcher.md)
* [WrapperFilter](interfaces/WrapperFilter.md)
* [WrapperServiceInitializeOptions](interfaces/WrapperServiceInitializeOptions.md)


### Type aliases

* [Address](#Address)
* [EntityFetcherFactory](#EntityFetcherFactory)
* [EntityGetCallback](#EntityGetCallback)
* [EntityWatchCallback](#EntityWatchCallback)
* [EntityWatchSubscriptionCallback](#EntityWatchSubscriptionCallback)
* [EventFetcherFactory](#EventFetcherFactory)
* [EventGetCallback](#EventGetCallback)
* [EventSubscriptionCallback](#EventSubscriptionCallback)
* [EventSubscriptionKey](#EventSubscriptionKey)
* [EventWatchCallback](#EventWatchCallback)
* [EventWatchSubscriptionCallback](#EventWatchSubscriptionCallback)
* [GasPriceAdjustor](#GasPriceAdjustor)
* [Hash](#Hash)
* [PerDaoCallback](#PerDaoCallback)
* [PreProcessEventCallback](#PreProcessEventCallback)
* [TransformEventCallback](#TransformEventCallback)
* [TruffleContractFunction](#TruffleContractFunction)
* [fnVoid](#fnVoid)


### Variables

* [AbsoluteVoteFactory](#AbsoluteVoteFactory)
* [ContractWrapperFactories](#ContractWrapperFactories)
* [ContractWrappers](#ContractWrappers)
* [ContractWrappersByAddress](#ContractWrappersByAddress)
* [ContractWrappersByType](#ContractWrappersByType)
* [ContributionRewardFactory](#ContributionRewardFactory)
* [DaoCreatorFactory](#DaoCreatorFactory)
* [DaoTokenFactory](#DaoTokenFactory)
* [GenesisProtocolFactory](#GenesisProtocolFactory)
* [GlobalConstraintRegistrarFactory](#GlobalConstraintRegistrarFactory)
* [IntVoteInterfaceFactory](#IntVoteInterfaceFactory)
* [MintableTokenFactory](#MintableTokenFactory)
* [RedeemerFactory](#RedeemerFactory)
* [ReputationFactory](#ReputationFactory)
* [SchemeRegistrarFactory](#SchemeRegistrarFactory)
* [StandardTokenFactory](#StandardTokenFactory)
* [TokenCapGCFactory](#TokenCapGCFactory)
* [UpgradeSchemeFactory](#UpgradeSchemeFactory)
* [VestingSchemeFactory](#VestingSchemeFactory)
* [VoteInOrganizationSchemeFactory](#VoteInOrganizationSchemeFactory)
* [computeForgeOrgGasLimit](#computeForgeOrgGasLimit)


### Functions

* [GetDefaultGenesisProtocolParameters](#GetDefaultGenesisProtocolParameters)
* [InitializeArcJs](#InitializeArcJs)
* [arcJsDeployer](#arcJsDeployer)



---
# Type aliases
<a id="Address"></a>

###  Address

**Τ Address**:  *`string`* 

*Defined in [commonTypes.ts:5](https://github.com/daostack/arc.js/blob/f343aa24/lib/commonTypes.ts#L5)*





___

<a id="EntityFetcherFactory"></a>

###  EntityFetcherFactory

**Τ EntityFetcherFactory**:  *`function`* 

*Defined in [web3EventService.ts:393](https://github.com/daostack/arc.js/blob/f343aa24/lib/web3EventService.ts#L393)*



Function that returns an `EntityFetcher<TEntity>`.
*__type__*: TEntity The type returns to the callback.


#### Type declaration
►(argsFilter?: *`any`*, filterObject?: *[EventFetcherFilterObject](interfaces/EventFetcherFilterObject.md)*, callback?: *[EntityWatchCallback](#EntityWatchCallback)`TDest`*, requiredDepth?: *`number`*): [EntityFetcher](interfaces/EntityFetcher.md)`TDest`, `TSrc`



**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| argsFilter | `any`   |  - |
| filterObject | [EventFetcherFilterObject](interfaces/EventFetcherFilterObject.md)   |  - |
| callback | [EntityWatchCallback](#EntityWatchCallback)`TDest`   |  - |
| requiredDepth | `number`   |  - |





**Returns:** [EntityFetcher](interfaces/EntityFetcher.md)`TDest`, `TSrc`






___

<a id="EntityGetCallback"></a>

###  EntityGetCallback

**Τ EntityGetCallback**:  *`function`* 

*Defined in [web3EventService.ts:421](https://github.com/daostack/arc.js/blob/f343aa24/lib/web3EventService.ts#L421)*


#### Type declaration
►(error: *`Error`*, entity: *`Promise`.<`Array`.<`TEntity`>>*): `void`



**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| error | `Error`   |  - |
| entity | `Promise`.<`Array`.<`TEntity`>>   |  - |





**Returns:** `void`






___

<a id="EntityWatchCallback"></a>

###  EntityWatchCallback

**Τ EntityWatchCallback**:  *`function`* 

*Defined in [web3EventService.ts:420](https://github.com/daostack/arc.js/blob/f343aa24/lib/web3EventService.ts#L420)*


#### Type declaration
►(error: *`Error`*, entity: *`TEntity`*): `void`



**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| error | `Error`   |  - |
| entity | `TEntity`   |  - |





**Returns:** `void`






___

<a id="EntityWatchSubscriptionCallback"></a>

###  EntityWatchSubscriptionCallback

**Τ EntityWatchSubscriptionCallback**:  *`function`* 

*Defined in [web3EventService.ts:422](https://github.com/daostack/arc.js/blob/f343aa24/lib/web3EventService.ts#L422)*


#### Type declaration
►(eventName: *`string`*, payload: *`TEntity`*): `void`



**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| eventName | `string`   |  - |
| payload | `TEntity`   |  - |





**Returns:** `void`






___

<a id="EventFetcherFactory"></a>

###  EventFetcherFactory

**Τ EventFetcherFactory**:  *`function`* 

*Defined in [web3EventService.ts:473](https://github.com/daostack/arc.js/blob/f343aa24/lib/web3EventService.ts#L473)*



Function that returns an `EventFetcher<TEventArgs>`.
*__type__*: TEventArgs The type of the `args` object.


#### Type declaration
►(argsFilter?: *`any`*, filterObject?: *[EventFetcherFilterObject](interfaces/EventFetcherFilterObject.md)*, callback?: *[EventWatchCallback](#EventWatchCallback)`TEventArgs`*, requiredDepth?: *`number`*): [EventFetcher](interfaces/EventFetcher.md)`TEventArgs`



**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| argsFilter | `any`   |  - |
| filterObject | [EventFetcherFilterObject](interfaces/EventFetcherFilterObject.md)   |  - |
| callback | [EventWatchCallback](#EventWatchCallback)`TEventArgs`   |  - |
| requiredDepth | `number`   |  - |





**Returns:** [EventFetcher](interfaces/EventFetcher.md)`TEventArgs`






___

<a id="EventGetCallback"></a>

###  EventGetCallback

**Τ EventGetCallback**:  *`function`* 

*Defined in [web3EventService.ts:499](https://github.com/daostack/arc.js/blob/f343aa24/lib/web3EventService.ts#L499)*


#### Type declaration
►(error: *`Error`*, args: *`Array`.<`DecodedLogEntryEvent`.<`TEventArgs`>>*): `void`



**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| error | `Error`   |  - |
| args | `Array`.<`DecodedLogEntryEvent`.<`TEventArgs`>>   |  - |





**Returns:** `void`






___

<a id="EventSubscriptionCallback"></a>

###  EventSubscriptionCallback

**Τ EventSubscriptionCallback**:  *`function`* 

*Defined in [pubSubEventService.ts:196](https://github.com/daostack/arc.js/blob/f343aa24/lib/pubSubEventService.ts#L196)*


#### Type declaration
►(topic: *`string`*, payload: *`any`*): `any`



**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| topic | `string`   |  - |
| payload | `any`   |  - |





**Returns:** `any`






___

<a id="EventSubscriptionKey"></a>

###  EventSubscriptionKey

**Τ EventSubscriptionKey**:  *`string`⎮[EventSubscriptionCallback](#EventSubscriptionCallback)* 

*Defined in [pubSubEventService.ts:197](https://github.com/daostack/arc.js/blob/f343aa24/lib/pubSubEventService.ts#L197)*





___

<a id="EventWatchCallback"></a>

###  EventWatchCallback

**Τ EventWatchCallback**:  *`function`* 

*Defined in [web3EventService.ts:497](https://github.com/daostack/arc.js/blob/f343aa24/lib/web3EventService.ts#L497)*


#### Type declaration
►(error: *`Error`*, args: *`DecodedLogEntryEvent`.<`TEventArgs`>*): `void`



**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| error | `Error`   |  - |
| args | `DecodedLogEntryEvent`.<`TEventArgs`>   |  - |





**Returns:** `void`






___

<a id="EventWatchSubscriptionCallback"></a>

###  EventWatchSubscriptionCallback

**Τ EventWatchSubscriptionCallback**:  *`function`* 

*Defined in [web3EventService.ts:501](https://github.com/daostack/arc.js/blob/f343aa24/lib/web3EventService.ts#L501)*


#### Type declaration
►(eventName: *`string`*, payload: *`DecodedLogEntryEvent`.<`TEventArgs`>*): `void`



**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| eventName | `string`   |  - |
| payload | `DecodedLogEntryEvent`.<`TEventArgs`>   |  - |





**Returns:** `void`






___

<a id="GasPriceAdjustor"></a>

###  GasPriceAdjustor

**Τ GasPriceAdjustor**:  *`function`* 

*Defined in [iContractWrapperBase.ts:213](https://github.com/daostack/arc.js/blob/f343aa24/lib/iContractWrapperBase.ts#L213)*



The value of the global config setting `gasPriceAdjustor` This function will be invoked to obtain promise of a desired gas price given the current default gas price which will be determined by the x latest blocks median gas price.

#### Type declaration
►(defaultGasPrice: *`BigNumber`*): `Promise`.<`BigNumber`⎮`string`>



**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| defaultGasPrice | `BigNumber`   |  - |





**Returns:** `Promise`.<`BigNumber`⎮`string`>






___

<a id="Hash"></a>

###  Hash

**Τ Hash**:  *`string`* 

*Defined in [commonTypes.ts:4](https://github.com/daostack/arc.js/blob/f343aa24/lib/commonTypes.ts#L4)*





___

<a id="PerDaoCallback"></a>

###  PerDaoCallback

**Τ PerDaoCallback**:  *`function`* 

*Defined in dao.ts:433*


#### Type declaration
►(avatarAddress: *[Address](#Address)*): `void`⎮`Promise`.<`boolean`>



**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| avatarAddress | [Address](#Address)   |  - |





**Returns:** `void`⎮`Promise`.<`boolean`>






___

<a id="PreProcessEventCallback"></a>

###  PreProcessEventCallback

**Τ PreProcessEventCallback**:  *`function`* 

*Defined in [web3EventService.ts:383](https://github.com/daostack/arc.js/blob/f343aa24/lib/web3EventService.ts#L383)*


#### Type declaration
►(error: *`Error`*, log: *`Array`.<`DecodedLogEntryEvent`.<`TEventArgs`>>*): [EventPreProcessorReturn](interfaces/EventPreProcessorReturn.md)`TEventArgs`



**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| error | `Error`   |  - |
| log | `Array`.<`DecodedLogEntryEvent`.<`TEventArgs`>>   |  - |





**Returns:** [EventPreProcessorReturn](interfaces/EventPreProcessorReturn.md)`TEventArgs`






___

<a id="TransformEventCallback"></a>

###  TransformEventCallback

**Τ TransformEventCallback**:  *`function`* 

*Defined in [web3EventService.ts:386](https://github.com/daostack/arc.js/blob/f343aa24/lib/web3EventService.ts#L386)*


#### Type declaration
►(event: *`DecodedLogEntryEvent`.<`TSrc`>*): `Promise`.<`TDest`⎮`undefined`>



**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| event | `DecodedLogEntryEvent`.<`TSrc`>   |  - |





**Returns:** `Promise`.<`TDest`⎮`undefined`>






___

<a id="TruffleContractFunction"></a>

###  TruffleContractFunction

**Τ TruffleContractFunction**:  *`function`* 

*Defined in [contractWrapperBase.ts:377](https://github.com/daostack/arc.js/blob/f343aa24/lib/contractWrapperBase.ts#L377)*


#### Type declaration
►(args?: *`Array`.<`any`>*): `Promise`.<[Hash](#Hash)>



**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| args | `Array`.<`any`>   |  - |





**Returns:** `Promise`.<[Hash](#Hash)>






___

<a id="fnVoid"></a>

###  fnVoid

**Τ fnVoid**:  *`function`* 

*Defined in [commonTypes.ts:3](https://github.com/daostack/arc.js/blob/f343aa24/lib/commonTypes.ts#L3)*


#### Type declaration
►(): `void`





**Returns:** `void`






___


# Variables
<a id="AbsoluteVoteFactory"></a>

### «Const» AbsoluteVoteFactory

**●  AbsoluteVoteFactory**:  *[ContractWrapperFactory](classes/ContractWrapperFactory.md)[AbsoluteVoteWrapper](classes/AbsoluteVoteWrapper.md)*  = 
  new ContractWrapperFactory("AbsoluteVote", AbsoluteVoteWrapper, new Web3EventService())

*Defined in [wrappers/absoluteVote.ts:168](https://github.com/daostack/arc.js/blob/f343aa24/lib/wrappers/absoluteVote.ts#L168)*





___

<a id="ContractWrapperFactories"></a>

### «Const» ContractWrapperFactories

**●  ContractWrapperFactories**:  *[ArcWrapperFactories](interfaces/ArcWrapperFactories.md)*  =  WrapperService.factories

*Defined in [wrapperService.ts:379](https://github.com/daostack/arc.js/blob/f343aa24/lib/wrapperService.ts#L379)*



for quicker access to the contract wrapper factories




___

<a id="ContractWrappers"></a>

### «Const» ContractWrappers

**●  ContractWrappers**:  *[ArcWrappers](interfaces/ArcWrappers.md)*  =  WrapperService.wrappers

*Defined in [wrapperService.ts:375](https://github.com/daostack/arc.js/blob/f343aa24/lib/wrapperService.ts#L375)*



for quicker access to the contract wrappers




___

<a id="ContractWrappersByAddress"></a>

### «Const» ContractWrappersByAddress

**●  ContractWrappersByAddress**:  *`Map`.<[Address](#Address)>,.<[IContractWrapper](interfaces/IContractWrapper.md)>*  =  WrapperService.wrappersByAddress

*Defined in [wrapperService.ts:387](https://github.com/daostack/arc.js/blob/f343aa24/lib/wrapperService.ts#L387)*



for quicker access to the contract wrappers by address




___

<a id="ContractWrappersByType"></a>

### «Const» ContractWrappersByType

**●  ContractWrappersByType**:  *[ArcWrappersByType](interfaces/ArcWrappersByType.md)*  =  WrapperService.wrappersByType

*Defined in [wrapperService.ts:383](https://github.com/daostack/arc.js/blob/f343aa24/lib/wrapperService.ts#L383)*



for quicker access to the contract wrapper types




___

<a id="ContributionRewardFactory"></a>

### «Const» ContributionRewardFactory

**●  ContributionRewardFactory**:  *[ContractWrapperFactory](classes/ContractWrapperFactory.md)[ContributionRewardWrapper](classes/ContributionRewardWrapper.md)*  = 
  new ContractWrapperFactory("ContributionReward", ContributionRewardWrapper, new Web3EventService())

*Defined in [wrappers/contributionReward.ts:565](https://github.com/daostack/arc.js/blob/f343aa24/lib/wrappers/contributionReward.ts#L565)*





___

<a id="DaoCreatorFactory"></a>

### «Const» DaoCreatorFactory

**●  DaoCreatorFactory**:  *[DaoCreatorFactoryType](classes/DaoCreatorFactoryType.md)*  = 
  new DaoCreatorFactoryType("DaoCreator", DaoCreatorWrapper, new Web3EventService()) as DaoCreatorFactoryType

*Defined in [wrappers/daoCreator.ts:496](https://github.com/daostack/arc.js/blob/f343aa24/lib/wrappers/daoCreator.ts#L496)*





___

<a id="DaoTokenFactory"></a>

### «Const» DaoTokenFactory

**●  DaoTokenFactory**:  *[DaoTokenFactoryType](classes/DaoTokenFactoryType.md)*  = 
  new DaoTokenFactoryType(
    "DAOToken",
    DaoTokenWrapper,
    new Web3EventService()) as DaoTokenFactoryType

*Defined in [wrappers/daoToken.ts:358](https://github.com/daostack/arc.js/blob/f343aa24/lib/wrappers/daoToken.ts#L358)*





___

<a id="GenesisProtocolFactory"></a>

### «Const» GenesisProtocolFactory

**●  GenesisProtocolFactory**:  *[GenesisProtocolFactoryType](classes/GenesisProtocolFactoryType.md)*  = 
  new GenesisProtocolFactoryType(
    "GenesisProtocol",
    GenesisProtocolWrapper,
    new Web3EventService()) as GenesisProtocolFactoryType

*Defined in [wrappers/genesisProtocol.ts:961](https://github.com/daostack/arc.js/blob/f343aa24/lib/wrappers/genesisProtocol.ts#L961)*





___

<a id="GlobalConstraintRegistrarFactory"></a>

### «Const» GlobalConstraintRegistrarFactory

**●  GlobalConstraintRegistrarFactory**:  *[ContractWrapperFactory](classes/ContractWrapperFactory.md)[GlobalConstraintRegistrarWrapper](classes/GlobalConstraintRegistrarWrapper.md)*  =  new ContractWrapperFactory(
  "GlobalConstraintRegistrar", GlobalConstraintRegistrarWrapper, new Web3EventService())

*Defined in [wrappers/globalConstraintRegistrar.ts:232](https://github.com/daostack/arc.js/blob/f343aa24/lib/wrappers/globalConstraintRegistrar.ts#L232)*





___

<a id="IntVoteInterfaceFactory"></a>

### «Const» IntVoteInterfaceFactory

**●  IntVoteInterfaceFactory**:  *[IntVoteInterfaceFactoryType](classes/IntVoteInterfaceFactoryType.md)*  = 
  new IntVoteInterfaceFactoryType(
    "IntVoteInterface",
    IntVoteInterfaceWrapper,
    new Web3EventService()) as IntVoteInterfaceFactoryType

*Defined in [wrappers/intVoteInterface.ts:382](https://github.com/daostack/arc.js/blob/f343aa24/lib/wrappers/intVoteInterface.ts#L382)*





___

<a id="MintableTokenFactory"></a>

### «Const» MintableTokenFactory

**●  MintableTokenFactory**:  *[MintableTokenFactoryType](classes/MintableTokenFactoryType.md)*  = 
  new MintableTokenFactoryType(
    "MintableToken",
    MintableTokenWrapper,
    new Web3EventService()) as MintableTokenFactoryType

*Defined in [wrappers/mintableToken.ts:127](https://github.com/daostack/arc.js/blob/f343aa24/lib/wrappers/mintableToken.ts#L127)*





___

<a id="RedeemerFactory"></a>

### «Const» RedeemerFactory

**●  RedeemerFactory**:  *[RedeemerFactoryType](classes/RedeemerFactoryType.md)*  = 
  new RedeemerFactoryType(
    "Redeemer",
    RedeemerWrapper,
    new Web3EventService()) as RedeemerFactoryType

*Defined in [wrappers/redeemer.ts:107](https://github.com/daostack/arc.js/blob/f343aa24/lib/wrappers/redeemer.ts#L107)*





___

<a id="ReputationFactory"></a>

### «Const» ReputationFactory

**●  ReputationFactory**:  *[ReputationFactoryType](classes/ReputationFactoryType.md)*  = 
  new ReputationFactoryType(
    "Reputation",
    ReputationWrapper,
    new Web3EventService()) as ReputationFactoryType

*Defined in [wrappers/reputation.ts:104](https://github.com/daostack/arc.js/blob/f343aa24/lib/wrappers/reputation.ts#L104)*





___

<a id="SchemeRegistrarFactory"></a>

### «Const» SchemeRegistrarFactory

**●  SchemeRegistrarFactory**:  *[ContractWrapperFactory](classes/ContractWrapperFactory.md)[SchemeRegistrarWrapper](classes/SchemeRegistrarWrapper.md)*  = 
  new ContractWrapperFactory("SchemeRegistrar", SchemeRegistrarWrapper, new Web3EventService())

*Defined in [wrappers/schemeRegistrar.ts:271](https://github.com/daostack/arc.js/blob/f343aa24/lib/wrappers/schemeRegistrar.ts#L271)*





___

<a id="StandardTokenFactory"></a>

### «Const» StandardTokenFactory

**●  StandardTokenFactory**:  *[StandardTokenFactoryType](classes/StandardTokenFactoryType.md)*  = 
  new StandardTokenFactoryType(
    "StandardToken",
    StandardTokenWrapper,
    new Web3EventService()) as StandardTokenFactoryType

*Defined in [wrappers/standardToken.ts:227](https://github.com/daostack/arc.js/blob/f343aa24/lib/wrappers/standardToken.ts#L227)*





___

<a id="TokenCapGCFactory"></a>

### «Const» TokenCapGCFactory

**●  TokenCapGCFactory**:  *[ContractWrapperFactory](classes/ContractWrapperFactory.md)[TokenCapGCWrapper](classes/TokenCapGCWrapper.md)*  = 
  new ContractWrapperFactory("TokenCapGC", TokenCapGCWrapper, new Web3EventService())

*Defined in [wrappers/tokenCapGC.ts:61](https://github.com/daostack/arc.js/blob/f343aa24/lib/wrappers/tokenCapGC.ts#L61)*





___

<a id="UpgradeSchemeFactory"></a>

### «Const» UpgradeSchemeFactory

**●  UpgradeSchemeFactory**:  *[ContractWrapperFactory](classes/ContractWrapperFactory.md)[UpgradeSchemeWrapper](classes/UpgradeSchemeWrapper.md)*  = 
  new ContractWrapperFactory("UpgradeScheme", UpgradeSchemeWrapper, new Web3EventService())

*Defined in [wrappers/upgradeScheme.ts:225](https://github.com/daostack/arc.js/blob/f343aa24/lib/wrappers/upgradeScheme.ts#L225)*





___

<a id="VestingSchemeFactory"></a>

### «Const» VestingSchemeFactory

**●  VestingSchemeFactory**:  *[ContractWrapperFactory](classes/ContractWrapperFactory.md)[VestingSchemeWrapper](classes/VestingSchemeWrapper.md)*  = 
  new ContractWrapperFactory("VestingScheme", VestingSchemeWrapper, new Web3EventService())

*Defined in [wrappers/vestingScheme.ts:442](https://github.com/daostack/arc.js/blob/f343aa24/lib/wrappers/vestingScheme.ts#L442)*





___

<a id="VoteInOrganizationSchemeFactory"></a>

### «Const» VoteInOrganizationSchemeFactory

**●  VoteInOrganizationSchemeFactory**:  *[ContractWrapperFactory](classes/ContractWrapperFactory.md)[VoteInOrganizationSchemeWrapper](classes/VoteInOrganizationSchemeWrapper.md)*  = 
  new ContractWrapperFactory(
    "VoteInOrganizationScheme",
    VoteInOrganizationSchemeWrapper,
    new Web3EventService())

*Defined in [wrappers/voteInOrganizationScheme.ts:183](https://github.com/daostack/arc.js/blob/f343aa24/lib/wrappers/voteInOrganizationScheme.ts#L183)*





___

<a id="computeForgeOrgGasLimit"></a>

### «Const» computeForgeOrgGasLimit

**●  computeForgeOrgGasLimit**:  *`any`*  =  require("../gasLimits.js").computeForgeOrgGasLimit

*Defined in index.ts:47*





___


# Functions
<a id="GetDefaultGenesisProtocolParameters"></a>

### «Const» GetDefaultGenesisProtocolParameters

► **GetDefaultGenesisProtocolParameters**(): `Promise`.<[GenesisProtocolParams](interfaces/GenesisProtocolParams.md)>



*Defined in [wrappers/genesisProtocol.ts:1304](https://github.com/daostack/arc.js/blob/f343aa24/lib/wrappers/genesisProtocol.ts#L1304)*





**Returns:** `Promise`.<[GenesisProtocolParams](interfaces/GenesisProtocolParams.md)>





___

<a id="InitializeArcJs"></a>

###  InitializeArcJs

► **InitializeArcJs**(options?: *[InitializeArcOptions](interfaces/InitializeArcOptions.md)*): `Promise`.<`Web3`>



*Defined in index.ts:79*



You must call `InitializeArcJs` before doing anything else with Arc.js. Call it again whenever the current chain changes.


**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| options | [InitializeArcOptions](interfaces/InitializeArcOptions.md)   |  - |





**Returns:** `Promise`.<`Web3`>
Promise of the `Web3` object for the current chain.






___

<a id="arcJsDeployer"></a>

### «Const» arcJsDeployer

► **arcJsDeployer**(web3: *`Web3`*, artifacts: *`any`*, deployer: *`any`*): `void`



*Defined in migrations/2_deploy_schemes.ts:14*



Migration callback


**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| web3 | `Web3`   |  - |
| artifacts | `any`   |  - |
| deployer | `any`   |  - |





**Returns:** `void`





___


