Skip to main content

Interface: StreamingPaymentsClientV2

Hierarchy

  • AugmentedStreamingPayments<StreamingPayments>

    StreamingPaymentsClientV2

Properties

_deployedPromise

_deployedPromise: Promise<Contract>

Inherited from

AugmentedStreamingPayments._deployedPromise


_runningEvents

_runningEvents: Object

Index signature

[eventTag: string]: RunningEvent

Inherited from

AugmentedStreamingPayments._runningEvents


_wrappedEmits

_wrappedEmits: Object

Index signature

[eventTag: string]: (...args: any[]) => void

Inherited from

AugmentedStreamingPayments._wrappedEmits


address

Readonly address: string

Inherited from

AugmentedStreamingPayments.address


callStatic

callStatic: Object

Type declaration

NameType
addToken(_fundingPermissionDomainId: BigNumberish, _fundingChildSkillIndex: BigNumberish, _id: BigNumberish, _token: string, _amount: BigNumberish, overrides?: CallOverrides) => Promise<void>
addToken(uint256,uint256,uint256,address,uint256)(_fundingPermissionDomainId: BigNumberish, _fundingChildSkillIndex: BigNumberish, _id: BigNumberish, _token: string, _amount: BigNumberish, overrides?: CallOverrides) => Promise<void>
authority(overrides?: CallOverrides) => Promise<string>
authority()(overrides?: CallOverrides) => Promise<string>
cancel(_adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _id: BigNumberish, overrides?: CallOverrides) => Promise<void>
cancel(uint256,uint256,uint256)(_adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _id: BigNumberish, overrides?: CallOverrides) => Promise<void>
cancelAndWaive(_id: BigNumberish, _tokens: string[], overrides?: CallOverrides) => Promise<void>
cancelAndWaive(uint256,address[])(_id: BigNumberish, _tokens: string[], overrides?: CallOverrides) => Promise<void>
claim(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _fromChildSkillIndex: BigNumberish, _toChildSkillIndex: BigNumberish, _id: BigNumberish, _tokens: string[], overrides?: CallOverrides) => Promise<void>
claim(uint256,uint256,uint256,uint256,uint256,address[])(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _fromChildSkillIndex: BigNumberish, _toChildSkillIndex: BigNumberish, _id: BigNumberish, _tokens: string[], overrides?: CallOverrides) => Promise<void>
create(_fundingPermissionDomainId: BigNumberish, _fundingChildSkillIndex: BigNumberish, _adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _domainId: BigNumberish, _startTime: BigNumberish, _endTime: BigNumberish, _interval: BigNumberish, _recipient: string, _tokens: string[], _amounts: BigNumberish[], overrides?: CallOverrides) => Promise<void>
create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])(_fundingPermissionDomainId: BigNumberish, _fundingChildSkillIndex: BigNumberish, _adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _domainId: BigNumberish, _startTime: BigNumberish, _endTime: BigNumberish, _interval: BigNumberish, _recipient: string, _tokens: string[], _amounts: BigNumberish[], overrides?: CallOverrides) => Promise<void>
deprecate(_deprecated: boolean, overrides?: CallOverrides) => Promise<void>
deprecate(bool)(_deprecated: boolean, overrides?: CallOverrides) => Promise<void>
executeMetaTransaction(_user: string, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: CallOverrides) => Promise<string>
executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)(_user: string, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: CallOverrides) => Promise<string>
finishUpgrade(overrides?: CallOverrides) => Promise<void>
finishUpgrade()(overrides?: CallOverrides) => Promise<void>
getAmountEntitledFromStart(_id: BigNumberish, _token: string, overrides?: CallOverrides) => Promise<BigNumber>
getAmountEntitledFromStart(uint256,address)(_id: BigNumberish, _token: string, overrides?: CallOverrides) => Promise<BigNumber>
getCapabilityRoles(_sig: BytesLike, overrides?: CallOverrides) => Promise<string>
getCapabilityRoles(bytes4)(_sig: BytesLike, overrides?: CallOverrides) => Promise<string>
getChainId(overrides?: CallOverrides) => Promise<BigNumber>
getChainId()(overrides?: CallOverrides) => Promise<BigNumber>
getColony(overrides?: CallOverrides) => Promise<string>
getColony()(overrides?: CallOverrides) => Promise<string>
getDeprecated(overrides?: CallOverrides) => Promise<boolean>
getDeprecated()(overrides?: CallOverrides) => Promise<boolean>
getMetatransactionNonce(_user: string, overrides?: CallOverrides) => Promise<BigNumber>
getMetatransactionNonce(address)(_user: string, overrides?: CallOverrides) => Promise<BigNumber>
getNumStreamingPayments(overrides?: CallOverrides) => Promise<BigNumber>
getNumStreamingPayments()(overrides?: CallOverrides) => Promise<BigNumber>
getPaymentToken(_id: BigNumberish, _token: string, overrides?: CallOverrides) => Promise<PaymentTokenStructOutput>
getPaymentToken(uint256,address)(_id: BigNumberish, _token: string, overrides?: CallOverrides) => Promise<PaymentTokenStructOutput>
getStreamingPayment(_id: BigNumberish, overrides?: CallOverrides) => Promise<StreamingPaymentStructOutput>
getStreamingPayment(uint256)(_id: BigNumberish, overrides?: CallOverrides) => Promise<StreamingPaymentStructOutput>
identifier(overrides?: CallOverrides) => Promise<string>
identifier()(overrides?: CallOverrides) => Promise<string>
install(_colony: string, overrides?: CallOverrides) => Promise<void>
install(address)(_colony: string, overrides?: CallOverrides) => Promise<void>
multicall(data: BytesLike[], overrides?: CallOverrides) => Promise<string[]>
multicall(bytes[])(data: BytesLike[], overrides?: CallOverrides) => Promise<string[]>
owner(overrides?: CallOverrides) => Promise<string>
owner()(overrides?: CallOverrides) => Promise<string>
setAuthority(authority_: string, overrides?: CallOverrides) => Promise<void>
setAuthority(address)(authority_: string, overrides?: CallOverrides) => Promise<void>
setEndTime(_adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _id: BigNumberish, _endTime: BigNumberish, overrides?: CallOverrides) => Promise<void>
setEndTime(uint256,uint256,uint256,uint256)(_adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _id: BigNumberish, _endTime: BigNumberish, overrides?: CallOverrides) => Promise<void>
setOwner(owner_: string, overrides?: CallOverrides) => Promise<void>
setOwner(address)(owner_: string, overrides?: CallOverrides) => Promise<void>
setStartTime(_adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _id: BigNumberish, _startTime: BigNumberish, overrides?: CallOverrides) => Promise<void>
setStartTime(uint256,uint256,uint256,uint256)(_adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _id: BigNumberish, _startTime: BigNumberish, overrides?: CallOverrides) => Promise<void>
setTokenAmount(_fundingPermissionDomainId: BigNumberish, _fundingChildSkillIndex: BigNumberish, _permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _fromChildSkillIndex: BigNumberish, _toChildSkillIndex: BigNumberish, _id: BigNumberish, _token: string, _amount: BigNumberish, overrides?: CallOverrides) => Promise<void>
setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)(_fundingPermissionDomainId: BigNumberish, _fundingChildSkillIndex: BigNumberish, _permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _fromChildSkillIndex: BigNumberish, _toChildSkillIndex: BigNumberish, _id: BigNumberish, _token: string, _amount: BigNumberish, overrides?: CallOverrides) => Promise<void>
uninstall(overrides?: CallOverrides) => Promise<void>
uninstall()(overrides?: CallOverrides) => Promise<void>
verify(_owner: string, _nonce: BigNumberish, _chainId: BigNumberish, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: CallOverrides) => Promise<boolean>
verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)(_owner: string, _nonce: BigNumberish, _chainId: BigNumberish, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: CallOverrides) => Promise<boolean>
version(overrides?: CallOverrides) => Promise<BigNumber>
version()(overrides?: CallOverrides) => Promise<BigNumber>

Inherited from

AugmentedStreamingPayments.callStatic


clientType

clientType: StreamingPaymentsClient

Inherited from

AugmentedStreamingPayments.clientType


clientVersion

clientVersion: 2

Overrides

AugmentedStreamingPayments.clientVersion


colonyClient

colonyClient: AugmentedIColony<ValidColony>

An instance of the corresponding ColonyClient

Inherited from

AugmentedStreamingPayments.colonyClient


deployTransaction

Readonly deployTransaction: TransactionResponse

Inherited from

AugmentedStreamingPayments.deployTransaction


estimateGas

estimateGas: Object

Inherited from

AugmentedStreamingPayments.estimateGas


filters

filters: Object

Type declaration

NameType
ExtensionInitialised() => ExtensionInitialisedEventFilter
ExtensionInitialised()() => ExtensionInitialisedEventFilter
LogSetAuthority(authority?: null | string) => LogSetAuthorityEventFilter
LogSetAuthority(address)(authority?: null | string) => LogSetAuthorityEventFilter
LogSetOwner(owner?: null | string) => LogSetOwnerEventFilter
LogSetOwner(address)(owner?: null | string) => LogSetOwnerEventFilter
MetaTransactionExecuted(user?: null, relayerAddress?: null, functionSignature?: null) => MetaTransactionExecutedEventFilter
MetaTransactionExecuted(address,address,bytes)(user?: null, relayerAddress?: null, functionSignature?: null) => MetaTransactionExecutedEventFilter
PaymentTokenUpdated(agent?: null, streamingPaymentId?: null | BigNumberish, token?: null, amount?: null) => PaymentTokenUpdatedEventFilter
PaymentTokenUpdated(address,uint256,address,uint256)(agent?: null, streamingPaymentId?: null | BigNumberish, token?: null, amount?: null) => PaymentTokenUpdatedEventFilter
StreamingPaymentClaimed(agent?: null, streamingPaymentId?: null | BigNumberish, token?: null, amount?: null) => StreamingPaymentClaimedEventFilter
StreamingPaymentClaimed(address,uint256,address,uint256)(agent?: null, streamingPaymentId?: null | BigNumberish, token?: null, amount?: null) => StreamingPaymentClaimedEventFilter
StreamingPaymentCreated(agent?: null, streamingPaymentId?: null) => StreamingPaymentCreatedEventFilter
StreamingPaymentCreated(address,uint256)(agent?: null, streamingPaymentId?: null) => StreamingPaymentCreatedEventFilter

Inherited from

AugmentedStreamingPayments.filters


functions

functions: Object

Type declaration

NameType
addToken(_fundingPermissionDomainId: BigNumberish, _fundingChildSkillIndex: BigNumberish, _id: BigNumberish, _token: string, _amount: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
addToken(uint256,uint256,uint256,address,uint256)(_fundingPermissionDomainId: BigNumberish, _fundingChildSkillIndex: BigNumberish, _id: BigNumberish, _token: string, _amount: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
authority(overrides?: CallOverrides) => Promise<[string]>
authority()(overrides?: CallOverrides) => Promise<[string]>
cancel(_adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _id: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
cancel(uint256,uint256,uint256)(_adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _id: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
cancelAndWaive(_id: BigNumberish, _tokens: string[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
cancelAndWaive(uint256,address[])(_id: BigNumberish, _tokens: string[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
claim(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _fromChildSkillIndex: BigNumberish, _toChildSkillIndex: BigNumberish, _id: BigNumberish, _tokens: string[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
claim(uint256,uint256,uint256,uint256,uint256,address[])(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _fromChildSkillIndex: BigNumberish, _toChildSkillIndex: BigNumberish, _id: BigNumberish, _tokens: string[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
create(_fundingPermissionDomainId: BigNumberish, _fundingChildSkillIndex: BigNumberish, _adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _domainId: BigNumberish, _startTime: BigNumberish, _endTime: BigNumberish, _interval: BigNumberish, _recipient: string, _tokens: string[], _amounts: BigNumberish[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])(_fundingPermissionDomainId: BigNumberish, _fundingChildSkillIndex: BigNumberish, _adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _domainId: BigNumberish, _startTime: BigNumberish, _endTime: BigNumberish, _interval: BigNumberish, _recipient: string, _tokens: string[], _amounts: BigNumberish[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
deprecate(_deprecated: boolean, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
deprecate(bool)(_deprecated: boolean, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
executeMetaTransaction(_user: string, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: PayableOverrides & { from?: string }) => Promise<ContractTransaction>
executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)(_user: string, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: PayableOverrides & { from?: string }) => Promise<ContractTransaction>
finishUpgrade(overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
finishUpgrade()(overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
getAmountEntitledFromStart(_id: BigNumberish, _token: string, overrides?: CallOverrides) => Promise<[BigNumber] & { amount: BigNumber }>
getAmountEntitledFromStart(uint256,address)(_id: BigNumberish, _token: string, overrides?: CallOverrides) => Promise<[BigNumber] & { amount: BigNumber }>
getCapabilityRoles(_sig: BytesLike, overrides?: CallOverrides) => Promise<[string]>
getCapabilityRoles(bytes4)(_sig: BytesLike, overrides?: CallOverrides) => Promise<[string]>
getChainId(overrides?: CallOverrides) => Promise<[BigNumber]>
getChainId()(overrides?: CallOverrides) => Promise<[BigNumber]>
getColony(overrides?: CallOverrides) => Promise<[string]>
getColony()(overrides?: CallOverrides) => Promise<[string]>
getDeprecated(overrides?: CallOverrides) => Promise<[boolean]>
getDeprecated()(overrides?: CallOverrides) => Promise<[boolean]>
getMetatransactionNonce(_user: string, overrides?: CallOverrides) => Promise<[BigNumber] & { nonce: BigNumber }>
getMetatransactionNonce(address)(_user: string, overrides?: CallOverrides) => Promise<[BigNumber] & { nonce: BigNumber }>
getNumStreamingPayments(overrides?: CallOverrides) => Promise<[BigNumber] & { numPayments: BigNumber }>
getNumStreamingPayments()(overrides?: CallOverrides) => Promise<[BigNumber] & { numPayments: BigNumber }>
getPaymentToken(_id: BigNumberish, _token: string, overrides?: CallOverrides) => Promise<[PaymentTokenStructOutput] & { paymentToken: PaymentTokenStructOutput }>
getPaymentToken(uint256,address)(_id: BigNumberish, _token: string, overrides?: CallOverrides) => Promise<[PaymentTokenStructOutput] & { paymentToken: PaymentTokenStructOutput }>
getStreamingPayment(_id: BigNumberish, overrides?: CallOverrides) => Promise<[StreamingPaymentStructOutput] & { streamingPayment: StreamingPaymentStructOutput }>
getStreamingPayment(uint256)(_id: BigNumberish, overrides?: CallOverrides) => Promise<[StreamingPaymentStructOutput] & { streamingPayment: StreamingPaymentStructOutput }>
identifier(overrides?: CallOverrides) => Promise<[string] & { _identifier: string }>
identifier()(overrides?: CallOverrides) => Promise<[string] & { _identifier: string }>
install(_colony: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
install(address)(_colony: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
multicall(data: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
multicall(bytes[])(data: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
owner(overrides?: CallOverrides) => Promise<[string]>
owner()(overrides?: CallOverrides) => Promise<[string]>
setAuthority(authority_: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setAuthority(address)(authority_: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setEndTime(_adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _id: BigNumberish, _endTime: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setEndTime(uint256,uint256,uint256,uint256)(_adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _id: BigNumberish, _endTime: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setOwner(owner_: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setOwner(address)(owner_: string, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setStartTime(_adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _id: BigNumberish, _startTime: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setStartTime(uint256,uint256,uint256,uint256)(_adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _id: BigNumberish, _startTime: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setTokenAmount(_fundingPermissionDomainId: BigNumberish, _fundingChildSkillIndex: BigNumberish, _permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _fromChildSkillIndex: BigNumberish, _toChildSkillIndex: BigNumberish, _id: BigNumberish, _token: string, _amount: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)(_fundingPermissionDomainId: BigNumberish, _fundingChildSkillIndex: BigNumberish, _permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _fromChildSkillIndex: BigNumberish, _toChildSkillIndex: BigNumberish, _id: BigNumberish, _token: string, _amount: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
uninstall(overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
uninstall()(overrides?: Overrides & { from?: string }) => Promise<ContractTransaction>
verify(_owner: string, _nonce: BigNumberish, _chainId: BigNumberish, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: CallOverrides) => Promise<[boolean]>
verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)(_owner: string, _nonce: BigNumberish, _chainId: BigNumberish, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: CallOverrides) => Promise<[boolean]>
version(overrides?: CallOverrides) => Promise<[BigNumber] & { _version: BigNumber }>
version()(overrides?: CallOverrides) => Promise<[BigNumber] & { _version: BigNumber }>

Inherited from

AugmentedStreamingPayments.functions


interface

interface: StreamingPaymentsInterface

Inherited from

AugmentedStreamingPayments.interface


off

off: OnEvent<StreamingPaymentsClientV2>

Inherited from

AugmentedStreamingPayments.off


on

on: OnEvent<StreamingPaymentsClientV2>

Inherited from

AugmentedStreamingPayments.on


once

once: OnEvent<StreamingPaymentsClientV2>

Inherited from

AugmentedStreamingPayments.once


populateTransaction

populateTransaction: Object

Type declaration

NameType
addToken(_fundingPermissionDomainId: BigNumberish, _fundingChildSkillIndex: BigNumberish, _id: BigNumberish, _token: string, _amount: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
addToken(uint256,uint256,uint256,address,uint256)(_fundingPermissionDomainId: BigNumberish, _fundingChildSkillIndex: BigNumberish, _id: BigNumberish, _token: string, _amount: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
authority(overrides?: CallOverrides) => Promise<PopulatedTransaction>
authority()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
cancel(_adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _id: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
cancel(uint256,uint256,uint256)(_adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _id: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
cancelAndWaive(_id: BigNumberish, _tokens: string[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
cancelAndWaive(uint256,address[])(_id: BigNumberish, _tokens: string[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
claim(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _fromChildSkillIndex: BigNumberish, _toChildSkillIndex: BigNumberish, _id: BigNumberish, _tokens: string[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
claim(uint256,uint256,uint256,uint256,uint256,address[])(_permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _fromChildSkillIndex: BigNumberish, _toChildSkillIndex: BigNumberish, _id: BigNumberish, _tokens: string[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
create(_fundingPermissionDomainId: BigNumberish, _fundingChildSkillIndex: BigNumberish, _adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _domainId: BigNumberish, _startTime: BigNumberish, _endTime: BigNumberish, _interval: BigNumberish, _recipient: string, _tokens: string[], _amounts: BigNumberish[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])(_fundingPermissionDomainId: BigNumberish, _fundingChildSkillIndex: BigNumberish, _adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _domainId: BigNumberish, _startTime: BigNumberish, _endTime: BigNumberish, _interval: BigNumberish, _recipient: string, _tokens: string[], _amounts: BigNumberish[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
deprecate(_deprecated: boolean, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
deprecate(bool)(_deprecated: boolean, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
executeMetaTransaction(_user: string, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: PayableOverrides & { from?: string }) => Promise<PopulatedTransaction>
executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)(_user: string, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: PayableOverrides & { from?: string }) => Promise<PopulatedTransaction>
finishUpgrade(overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
finishUpgrade()(overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
getAmountEntitledFromStart(_id: BigNumberish, _token: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getAmountEntitledFromStart(uint256,address)(_id: BigNumberish, _token: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getCapabilityRoles(_sig: BytesLike, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getCapabilityRoles(bytes4)(_sig: BytesLike, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getChainId(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getChainId()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getColony(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getColony()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getDeprecated(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getDeprecated()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getMetatransactionNonce(_user: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getMetatransactionNonce(address)(_user: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getNumStreamingPayments(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getNumStreamingPayments()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getPaymentToken(_id: BigNumberish, _token: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getPaymentToken(uint256,address)(_id: BigNumberish, _token: string, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getStreamingPayment(_id: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getStreamingPayment(uint256)(_id: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
identifier(overrides?: CallOverrides) => Promise<PopulatedTransaction>
identifier()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
install(_colony: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
install(address)(_colony: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
multicall(data: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
multicall(bytes[])(data: BytesLike[], overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
owner(overrides?: CallOverrides) => Promise<PopulatedTransaction>
owner()(overrides?: CallOverrides) => Promise<PopulatedTransaction>
setAuthority(authority_: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setAuthority(address)(authority_: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setEndTime(_adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _id: BigNumberish, _endTime: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setEndTime(uint256,uint256,uint256,uint256)(_adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _id: BigNumberish, _endTime: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setOwner(owner_: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setOwner(address)(owner_: string, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setStartTime(_adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _id: BigNumberish, _startTime: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setStartTime(uint256,uint256,uint256,uint256)(_adminPermissionDomainId: BigNumberish, _adminChildSkillIndex: BigNumberish, _id: BigNumberish, _startTime: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setTokenAmount(_fundingPermissionDomainId: BigNumberish, _fundingChildSkillIndex: BigNumberish, _permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _fromChildSkillIndex: BigNumberish, _toChildSkillIndex: BigNumberish, _id: BigNumberish, _token: string, _amount: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)(_fundingPermissionDomainId: BigNumberish, _fundingChildSkillIndex: BigNumberish, _permissionDomainId: BigNumberish, _childSkillIndex: BigNumberish, _fromChildSkillIndex: BigNumberish, _toChildSkillIndex: BigNumberish, _id: BigNumberish, _token: string, _amount: BigNumberish, overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
uninstall(overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
uninstall()(overrides?: Overrides & { from?: string }) => Promise<PopulatedTransaction>
verify(_owner: string, _nonce: BigNumberish, _chainId: BigNumberish, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)(_owner: string, _nonce: BigNumberish, _chainId: BigNumberish, _payload: BytesLike, _sigR: BytesLike, _sigS: BytesLike, _sigV: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
version(overrides?: CallOverrides) => Promise<PopulatedTransaction>
version()(overrides?: CallOverrides) => Promise<PopulatedTransaction>

Inherited from

AugmentedStreamingPayments.populateTransaction


provider

Readonly provider: Provider

Inherited from

AugmentedStreamingPayments.provider


removeListener

removeListener: OnEvent<StreamingPaymentsClientV2>

Inherited from

AugmentedStreamingPayments.removeListener


resolvedAddress

Readonly resolvedAddress: Promise<string>

Inherited from

AugmentedStreamingPayments.resolvedAddress


signer

Readonly signer: Signer

Inherited from

AugmentedStreamingPayments.signer


stakedExpenditureEvents

stakedExpenditureEvents: StreamingPaymentsEvents

The stakedExpenditureEvents contract supports all events across all versions. Isn't that amazing? It's an ethers contract with only events to filter

Inherited from

AugmentedStreamingPayments.stakedExpenditureEvents

Methods

_checkRunningEvents

_checkRunningEvents(runningEvent): void

Parameters

NameType
runningEventRunningEvent

Returns

void

Inherited from

AugmentedStreamingPayments._checkRunningEvents


_deployed

_deployed(blockTag?): Promise<Contract>

Parameters

NameType
blockTag?BlockTag

Returns

Promise<Contract>

Inherited from

AugmentedStreamingPayments._deployed


_wrapEvent

_wrapEvent(runningEvent, log, listener): Event

Parameters

NameType
runningEventRunningEvent
logLog
listenerListener

Returns

Event

Inherited from

AugmentedStreamingPayments._wrapEvent


addToken

addToken(_fundingPermissionDomainId, _fundingChildSkillIndex, _id, _token, _amount, overrides?): Promise<ContractTransaction>

Add a new token/amount pair

Parameters

NameTypeDescription
_fundingPermissionDomainIdBigNumberishThe domain in which the caller holds the funding permission
_fundingChildSkillIndexBigNumberishThe index linking the fundingPermissionDomainId to the domainId
_idBigNumberishThe id of the streaming payment
_tokenstringThe address of the token
_amountBigNumberishThe amount to pay out
overrides?Overrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.addToken


addToken(uint256,uint256,uint256,address,uint256)

addToken(uint256,uint256,uint256,address,uint256)(_fundingPermissionDomainId, _fundingChildSkillIndex, _id, _token, _amount, overrides?): Promise<ContractTransaction>

Add a new token/amount pair

Parameters

NameTypeDescription
_fundingPermissionDomainIdBigNumberishThe domain in which the caller holds the funding permission
_fundingChildSkillIndexBigNumberishThe index linking the fundingPermissionDomainId to the domainId
_idBigNumberishThe id of the streaming payment
_tokenstringThe address of the token
_amountBigNumberishThe amount to pay out
overrides?Overrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.addToken(uint256,uint256,uint256,address,uint256)


addTokenWithProofs

addTokenWithProofs(_id, _token, _amount, overrides?): Promise<ContractTransaction>

Same as addToken, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.

Parameters

NameTypeDescription
_idBigNumberishThe id of the streaming payment
_tokenstringThe address of the token
_amountBigNumberishThe amount to pay out
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.addTokenWithProofs


attach

attach(addressOrName): StreamingPaymentsClientV2

Parameters

NameType
addressOrNamestring

Returns

StreamingPaymentsClientV2

Inherited from

AugmentedStreamingPayments.attach


authority

authority(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedStreamingPayments.authority


authority()

authority()(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedStreamingPayments.authority()


cancel

cancel(_adminPermissionDomainId, _adminChildSkillIndex, _id, overrides?): Promise<ContractTransaction>

Cancel the streaming payment, specifically by setting endTime to block.timestamp

Parameters

NameTypeDescription
_adminPermissionDomainIdBigNumberishThe domain in which the caller holds the admin permission
_adminChildSkillIndexBigNumberishThe index linking the adminPermissionDomainId to the domainId
_idBigNumberishThe id of the streaming payment
overrides?Overrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.cancel


cancel(uint256,uint256,uint256)

cancel(uint256,uint256,uint256)(_adminPermissionDomainId, _adminChildSkillIndex, _id, overrides?): Promise<ContractTransaction>

Cancel the streaming payment, specifically by setting endTime to block.timestamp

Parameters

NameTypeDescription
_adminPermissionDomainIdBigNumberishThe domain in which the caller holds the admin permission
_adminChildSkillIndexBigNumberishThe index linking the adminPermissionDomainId to the domainId
_idBigNumberishThe id of the streaming payment
overrides?Overrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.cancel(uint256,uint256,uint256)


cancelAndWaive

cancelAndWaive(_id, _tokens, overrides?): Promise<ContractTransaction>

Cancel the streaming payment, specifically by setting endTime to block.timestamp, and waive claim to specified tokens already earned. Only callable by the recipient.

Parameters

NameTypeDescription
_idBigNumberishThe id of the streaming payment
_tokensstring[]The tokens to waive any claims to.
overrides?Overrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.cancelAndWaive


cancelAndWaive(uint256,address[])

cancelAndWaive(uint256,address[])(_id, _tokens, overrides?): Promise<ContractTransaction>

Cancel the streaming payment, specifically by setting endTime to block.timestamp, and waive claim to specified tokens already earned. Only callable by the recipient.

Parameters

NameTypeDescription
_idBigNumberishThe id of the streaming payment
_tokensstring[]The tokens to waive any claims to.
overrides?Overrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.cancelAndWaive(uint256,address[])


cancelWithProofs

cancelWithProofs(_id, overrides?): Promise<ContractTransaction>

Same as cancel, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.

Parameters

NameTypeDescription
_idBigNumberishThe id of the streaming payment
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.cancelWithProofs


claim

claim(_permissionDomainId, _childSkillIndex, _fromChildSkillIndex, _toChildSkillIndex, _id, _tokens, overrides?): Promise<ContractTransaction>

Claim a streaming payment

Parameters

NameTypeDescription
_permissionDomainIdBigNumberishThe domain in which the extension holds the funding & admin permissions
_childSkillIndexBigNumberishThe index linking the permissionDomainId to the domainId the payment is in
_fromChildSkillIndexBigNumberishThe linking the domainId to the fromPot domain
_toChildSkillIndexBigNumberishThe linking the domainId to the toPot domain
_idBigNumberishThe id of the streaming payment
_tokensstring[]The tokens to be paid out
overrides?Overrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.claim


claim(uint256,uint256,uint256,uint256,uint256,address[])

claim(uint256,uint256,uint256,uint256,uint256,address[])(_permissionDomainId, _childSkillIndex, _fromChildSkillIndex, _toChildSkillIndex, _id, _tokens, overrides?): Promise<ContractTransaction>

Claim a streaming payment

Parameters

NameTypeDescription
_permissionDomainIdBigNumberishThe domain in which the extension holds the funding & admin permissions
_childSkillIndexBigNumberishThe index linking the permissionDomainId to the domainId the payment is in
_fromChildSkillIndexBigNumberishThe linking the domainId to the fromPot domain
_toChildSkillIndexBigNumberishThe linking the domainId to the toPot domain
_idBigNumberishThe id of the streaming payment
_tokensstring[]The tokens to be paid out
overrides?Overrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.claim(uint256,uint256,uint256,uint256,uint256,address[])


claimWithProofs

claimWithProofs(_id, _tokens, overrides?): Promise<ContractTransaction>

Same as claim, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.

Parameters

NameTypeDescription
_idBigNumberishThe id of the streaming payment
_tokensstring[]The tokens to be paid out
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.claimWithProofs


connect

connect(signerOrProvider): StreamingPaymentsClientV2

Parameters

NameType
signerOrProviderstring | Signer | Provider

Returns

StreamingPaymentsClientV2

Inherited from

AugmentedStreamingPayments.connect


create

create(_fundingPermissionDomainId, _fundingChildSkillIndex, _adminPermissionDomainId, _adminChildSkillIndex, _domainId, _startTime, _endTime, _interval, _recipient, _tokens, _amounts, overrides?): Promise<ContractTransaction>

Creates a new streaming payment

Parameters

NameTypeDescription
_fundingPermissionDomainIdBigNumberishThe domain in which the caller holds the funding permission
_fundingChildSkillIndexBigNumberishThe index linking the fundingPermissionDomainId to the domainId
_adminPermissionDomainIdBigNumberishThe domain in which the caller holds the admin permission
_adminChildSkillIndexBigNumberishThe index linking the adminPermissionDomainId to the domainId
_domainIdBigNumberishThe domain out of which the streaming payment will be paid
_startTimeBigNumberishThe time at which the payment begins paying out
_endTimeBigNumberishThe time at which the payment ends paying out
_intervalBigNumberishThe period of time over which _amounts are paid out
_recipientstringThe recipient of the streaming payment
_tokensstring[]The tokens to be paid out
_amountsBigNumberish[]The amounts to be paid out (per _interval of time)
overrides?Overrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.create


create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])

create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])(_fundingPermissionDomainId, _fundingChildSkillIndex, _adminPermissionDomainId, _adminChildSkillIndex, _domainId, _startTime, _endTime, _interval, _recipient, _tokens, _amounts, overrides?): Promise<ContractTransaction>

Creates a new streaming payment

Parameters

NameTypeDescription
_fundingPermissionDomainIdBigNumberishThe domain in which the caller holds the funding permission
_fundingChildSkillIndexBigNumberishThe index linking the fundingPermissionDomainId to the domainId
_adminPermissionDomainIdBigNumberishThe domain in which the caller holds the admin permission
_adminChildSkillIndexBigNumberishThe index linking the adminPermissionDomainId to the domainId
_domainIdBigNumberishThe domain out of which the streaming payment will be paid
_startTimeBigNumberishThe time at which the payment begins paying out
_endTimeBigNumberishThe time at which the payment ends paying out
_intervalBigNumberishThe period of time over which _amounts are paid out
_recipientstringThe recipient of the streaming payment
_tokensstring[]The tokens to be paid out
_amountsBigNumberish[]The amounts to be paid out (per _interval of time)
overrides?Overrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.create(uint256,uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,address[],uint256[])


createWithProofs

createWithProofs(_domainId, _startTime, _endTime, _interval, _recipient, _tokens, _amounts, overrides?): Promise<ContractTransaction>

Same as create, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.

Parameters

NameTypeDescription
_domainIdBigNumberishThe domain out of which the streaming payment will be paid
_startTimeBigNumberishThe time at which the payment begins paying out
_endTimeBigNumberishThe time at which the payment ends paying out
_intervalBigNumberishThe period of time over which _amounts are paid out
_recipientstringThe recipient of the streaming payment
_tokensstring[]The tokens to be paid out
_amountsBigNumberish[]The amounts to be paid out (per _interval of time)
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.createWithProofs


deployed

deployed(): Promise<StreamingPaymentsClientV2>

Returns

Promise<StreamingPaymentsClientV2>

Inherited from

AugmentedStreamingPayments.deployed


deprecate

deprecate(_deprecated, overrides?): Promise<ContractTransaction>

Called when deprecating (or undeprecating) the extension

Parameters

NameTypeDescription
_deprecatedbooleanIndicates whether the extension should be deprecated or undeprecated
overrides?Overrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.deprecate


deprecate(bool)

deprecate(bool)(_deprecated, overrides?): Promise<ContractTransaction>

Called when deprecating (or undeprecating) the extension

Parameters

NameTypeDescription
_deprecatedbooleanIndicates whether the extension should be deprecated or undeprecated
overrides?Overrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.deprecate(bool)


emit

emit(eventName, ...args): boolean

Parameters

NameType
eventNamestring | EventFilter
...argsany[]

Returns

boolean

Inherited from

AugmentedStreamingPayments.emit


executeMetaTransaction

executeMetaTransaction(_user, _payload, _sigR, _sigS, _sigV, overrides?): Promise<ContractTransaction>

Main function to be called when user wants to execute meta transaction. The actual function to be called should be passed as param with name functionSignature Here the basic signature recovery is being used. Signature is expected to be generated using personal_sign method.

Parameters

NameTypeDescription
_userstringAddress of user trying to do meta transaction
_payloadBytesLikeFunction call to make via meta transaction
_sigRBytesLikeR part of the signature
_sigSBytesLikeS part of the signature
_sigVBigNumberishV part of the signature
overrides?PayableOverrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.executeMetaTransaction


executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)

executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)(_user, _payload, _sigR, _sigS, _sigV, overrides?): Promise<ContractTransaction>

Main function to be called when user wants to execute meta transaction. The actual function to be called should be passed as param with name functionSignature Here the basic signature recovery is being used. Signature is expected to be generated using personal_sign method.

Parameters

NameTypeDescription
_userstringAddress of user trying to do meta transaction
_payloadBytesLikeFunction call to make via meta transaction
_sigRBytesLikeR part of the signature
_sigSBytesLikeS part of the signature
_sigVBigNumberishV part of the signature
overrides?PayableOverrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.executeMetaTransaction(address,bytes,bytes32,bytes32,uint8)


fallback

fallback(overrides?): Promise<TransactionResponse>

Parameters

NameType
overrides?TransactionRequest

Returns

Promise<TransactionResponse>

Inherited from

AugmentedStreamingPayments.fallback


finishUpgrade

finishUpgrade(overrides?): Promise<ContractTransaction>

Called when upgrading the extension

Parameters

NameType
overrides?Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.finishUpgrade


finishUpgrade()

finishUpgrade()(overrides?): Promise<ContractTransaction>

Called when upgrading the extension

Parameters

NameType
overrides?Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.finishUpgrade()


getAmountEntitledFromStart

getAmountEntitledFromStart(_id, _token, overrides?): Promise<BigNumber>

Get the amount entitled to claim from the start of the stream

Parameters

NameTypeDescription
_idBigNumberishThe id of the streaming payment
_tokenstringThe address of the token
overrides?CallOverrides-

Returns

Promise<BigNumber>

Inherited from

AugmentedStreamingPayments.getAmountEntitledFromStart


getAmountEntitledFromStart(uint256,address)

getAmountEntitledFromStart(uint256,address)(_id, _token, overrides?): Promise<BigNumber>

Get the amount entitled to claim from the start of the stream

Parameters

NameTypeDescription
_idBigNumberishThe id of the streaming payment
_tokenstringThe address of the token
overrides?CallOverrides-

Returns

Promise<BigNumber>

Inherited from

AugmentedStreamingPayments.getAmountEntitledFromStart(uint256,address)


getCapabilityRoles

getCapabilityRoles(_sig, overrides?): Promise<string>

Parameters

NameType
_sigBytesLike
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedStreamingPayments.getCapabilityRoles


getCapabilityRoles(bytes4)

getCapabilityRoles(bytes4)(_sig, overrides?): Promise<string>

Parameters

NameType
_sigBytesLike
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedStreamingPayments.getCapabilityRoles(bytes4)


getChainId

getChainId(overrides?): Promise<BigNumber>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedStreamingPayments.getChainId


getChainId()

getChainId()(overrides?): Promise<BigNumber>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedStreamingPayments.getChainId()


getColony

getColony(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedStreamingPayments.getColony


getColony()

getColony()(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedStreamingPayments.getColony()


getDeprecated

getDeprecated(overrides?): Promise<boolean>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedStreamingPayments.getDeprecated


getDeprecated()

getDeprecated()(overrides?): Promise<boolean>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedStreamingPayments.getDeprecated()


getMetatransactionNonce

getMetatransactionNonce(_user, overrides?): Promise<BigNumber>

Parameters

NameType
_userstring
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedStreamingPayments.getMetatransactionNonce


getMetatransactionNonce(address)

getMetatransactionNonce(address)(_user, overrides?): Promise<BigNumber>

Parameters

NameType
_userstring
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedStreamingPayments.getMetatransactionNonce(address)


getNumStreamingPayments

getNumStreamingPayments(overrides?): Promise<BigNumber>

Get the total number of streaming payments

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedStreamingPayments.getNumStreamingPayments


getNumStreamingPayments()

getNumStreamingPayments()(overrides?): Promise<BigNumber>

Get the total number of streaming payments

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedStreamingPayments.getNumStreamingPayments()


getPaymentToken

getPaymentToken(_id, _token, overrides?): Promise<PaymentTokenStructOutput>

Get the payment token struct by Id and token

Parameters

NameTypeDescription
_idBigNumberishThe id of the streaming payment
_tokenstringThe address of the token
overrides?CallOverrides-

Returns

Promise<PaymentTokenStructOutput>

Inherited from

AugmentedStreamingPayments.getPaymentToken


getPaymentToken(uint256,address)

getPaymentToken(uint256,address)(_id, _token, overrides?): Promise<PaymentTokenStructOutput>

Get the payment token struct by Id and token

Parameters

NameTypeDescription
_idBigNumberishThe id of the streaming payment
_tokenstringThe address of the token
overrides?CallOverrides-

Returns

Promise<PaymentTokenStructOutput>

Inherited from

AugmentedStreamingPayments.getPaymentToken(uint256,address)


getStreamingPayment

getStreamingPayment(_id, overrides?): Promise<StreamingPaymentStructOutput>

Get the streaming payment struct by Id

Parameters

NameTypeDescription
_idBigNumberishThe id of the streaming payment
overrides?CallOverrides-

Returns

Promise<StreamingPaymentStructOutput>

Inherited from

AugmentedStreamingPayments.getStreamingPayment


getStreamingPayment(uint256)

getStreamingPayment(uint256)(_id, overrides?): Promise<StreamingPaymentStructOutput>

Get the streaming payment struct by Id

Parameters

NameTypeDescription
_idBigNumberishThe id of the streaming payment
overrides?CallOverrides-

Returns

Promise<StreamingPaymentStructOutput>

Inherited from

AugmentedStreamingPayments.getStreamingPayment(uint256)


identifier

identifier(overrides?): Promise<string>

Returns the identifier of the extension

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedStreamingPayments.identifier


identifier()

identifier()(overrides?): Promise<string>

Returns the identifier of the extension

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedStreamingPayments.identifier()


install

install(_colony, overrides?): Promise<ContractTransaction>

Configures the extension

Parameters

NameTypeDescription
_colonystringThe colony in which the extension holds permissions
overrides?Overrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.install


install(address)

install(address)(_colony, overrides?): Promise<ContractTransaction>

Configures the extension

Parameters

NameTypeDescription
_colonystringThe colony in which the extension holds permissions
overrides?Overrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.install(address)


listenerCount

listenerCount(eventName?): number

Parameters

NameType
eventName?string | EventFilter

Returns

number

Inherited from

AugmentedStreamingPayments.listenerCount


listeners

listeners<TEvent>(eventFilter?): TypedListener<TEvent>[]

Type parameters

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters

NameType
eventFilter?TypedEventFilter<TEvent>

Returns

TypedListener<TEvent>[]

Inherited from

AugmentedStreamingPayments.listeners

listeners(eventName?): Listener[]

Parameters

NameType
eventName?string

Returns

Listener[]

Inherited from

AugmentedStreamingPayments.listeners


multicall

multicall(data, overrides?): Promise<ContractTransaction>

Parameters

NameType
dataBytesLike[]
overrides?Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.multicall


multicall(bytes[])

multicall(bytes[])(data, overrides?): Promise<ContractTransaction>

Parameters

NameType
dataBytesLike[]
overrides?Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.multicall(bytes[])


owner

owner(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedStreamingPayments.owner


owner()

owner()(overrides?): Promise<string>

Parameters

NameType
overrides?CallOverrides

Returns

Promise<string>

Inherited from

AugmentedStreamingPayments.owner()


queryFilter

queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>

Type parameters

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters

NameType
eventTypedEventFilter<TEvent>
fromBlockOrBlockhash?string | number
toBlock?string | number

Returns

Promise<TEvent[]>

Inherited from

AugmentedStreamingPayments.queryFilter


removeAllListeners

removeAllListeners<TEvent>(eventFilter): StreamingPaymentsClientV2

Type parameters

NameType
TEventextends TypedEvent<any, any, TEvent>

Parameters

NameType
eventFilterTypedEventFilter<TEvent>

Returns

StreamingPaymentsClientV2

Inherited from

AugmentedStreamingPayments.removeAllListeners

removeAllListeners(eventName?): StreamingPaymentsClientV2

Parameters

NameType
eventName?string

Returns

StreamingPaymentsClientV2

Inherited from

AugmentedStreamingPayments.removeAllListeners


setAuthority

setAuthority(authority_, overrides?): Promise<ContractTransaction>

Parameters

NameType
authority_string
overrides?Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.setAuthority


setAuthority(address)

setAuthority(address)(authority_, overrides?): Promise<ContractTransaction>

Parameters

NameType
authority_string
overrides?Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.setAuthority(address)


setEndTime

setEndTime(_adminPermissionDomainId, _adminChildSkillIndex, _id, _endTime, overrides?): Promise<ContractTransaction>

Update the endTime, only if the new endTime is in the future

Parameters

NameTypeDescription
_adminPermissionDomainIdBigNumberishThe domain in which the caller holds the admin permission
_adminChildSkillIndexBigNumberishThe index linking the adminPermissionDomainId to the domainId
_idBigNumberishThe id of the streaming payment
_endTimeBigNumberishThe new endTime to set
overrides?Overrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.setEndTime


setEndTime(uint256,uint256,uint256,uint256)

setEndTime(uint256,uint256,uint256,uint256)(_adminPermissionDomainId, _adminChildSkillIndex, _id, _endTime, overrides?): Promise<ContractTransaction>

Update the endTime, only if the new endTime is in the future

Parameters

NameTypeDescription
_adminPermissionDomainIdBigNumberishThe domain in which the caller holds the admin permission
_adminChildSkillIndexBigNumberishThe index linking the adminPermissionDomainId to the domainId
_idBigNumberishThe id of the streaming payment
_endTimeBigNumberishThe new endTime to set
overrides?Overrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.setEndTime(uint256,uint256,uint256,uint256)


setEndTimeWithProofs

setEndTimeWithProofs(_id, _endTime, overrides?): Promise<ContractTransaction>

Same as setEndTime, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.

Parameters

NameTypeDescription
_idBigNumberishThe id of the streaming payment
_endTimeBigNumberishThe new endTime to set
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.setEndTimeWithProofs


setOwner

setOwner(owner_, overrides?): Promise<ContractTransaction>

Parameters

NameType
owner_string
overrides?Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.setOwner


setOwner(address)

setOwner(address)(owner_, overrides?): Promise<ContractTransaction>

Parameters

NameType
owner_string
overrides?Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.setOwner(address)


setStartTime

setStartTime(_adminPermissionDomainId, _adminChildSkillIndex, _id, _startTime, overrides?): Promise<ContractTransaction>

Update the startTime, only if the current startTime is in the future

Parameters

NameTypeDescription
_adminPermissionDomainIdBigNumberishThe domain in which the caller holds the admin permission
_adminChildSkillIndexBigNumberishThe index linking the adminPermissionDomainId to the domainId
_idBigNumberishThe id of the streaming payment
_startTimeBigNumberishThe new startTime to set
overrides?Overrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.setStartTime


setStartTime(uint256,uint256,uint256,uint256)

setStartTime(uint256,uint256,uint256,uint256)(_adminPermissionDomainId, _adminChildSkillIndex, _id, _startTime, overrides?): Promise<ContractTransaction>

Update the startTime, only if the current startTime is in the future

Parameters

NameTypeDescription
_adminPermissionDomainIdBigNumberishThe domain in which the caller holds the admin permission
_adminChildSkillIndexBigNumberishThe index linking the adminPermissionDomainId to the domainId
_idBigNumberishThe id of the streaming payment
_startTimeBigNumberishThe new startTime to set
overrides?Overrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.setStartTime(uint256,uint256,uint256,uint256)


setStartTimeWithProofs

setStartTimeWithProofs(_id, _startTime, overrides?): Promise<ContractTransaction>

Same as setStartTime, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.

Parameters

NameTypeDescription
_idBigNumberishThe id of the streaming payment
_startTimeBigNumberishThe new startTime to set
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.setStartTimeWithProofs


setTokenAmount

setTokenAmount(_fundingPermissionDomainId, _fundingChildSkillIndex, _permissionDomainId, _childSkillIndex, _fromChildSkillIndex, _toChildSkillIndex, _id, _token, _amount, overrides?): Promise<ContractTransaction>

Update the token amount to be paid out. Claims existing payout prior to the change

Parameters

NameTypeDescription
_fundingPermissionDomainIdBigNumberishThe domain in which the caller holds the funding permission
_fundingChildSkillIndexBigNumberishThe index linking the fundingPermissionDomainId to the domainId
_permissionDomainIdBigNumberishThe domain in which the extension holds the funding & admin permissions
_childSkillIndexBigNumberishThe index linking the permissionDomainId to the domainId
_fromChildSkillIndexBigNumberishThe linking the domainId to the fromPot domain
_toChildSkillIndexBigNumberishThe linking the domainId to the toPot domain
_idBigNumberishThe id of the streaming payment
_tokenstringThe address of the token
_amountBigNumberishThe new amount to pay out
overrides?Overrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.setTokenAmount


setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)

setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)(_fundingPermissionDomainId, _fundingChildSkillIndex, _permissionDomainId, _childSkillIndex, _fromChildSkillIndex, _toChildSkillIndex, _id, _token, _amount, overrides?): Promise<ContractTransaction>

Update the token amount to be paid out. Claims existing payout prior to the change

Parameters

NameTypeDescription
_fundingPermissionDomainIdBigNumberishThe domain in which the caller holds the funding permission
_fundingChildSkillIndexBigNumberishThe index linking the fundingPermissionDomainId to the domainId
_permissionDomainIdBigNumberishThe domain in which the extension holds the funding & admin permissions
_childSkillIndexBigNumberishThe index linking the permissionDomainId to the domainId
_fromChildSkillIndexBigNumberishThe linking the domainId to the fromPot domain
_toChildSkillIndexBigNumberishThe linking the domainId to the toPot domain
_idBigNumberishThe id of the streaming payment
_tokenstringThe address of the token
_amountBigNumberishThe new amount to pay out
overrides?Overrides & { from?: string }-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.setTokenAmount(uint256,uint256,uint256,uint256,uint256,uint256,uint256,address,uint256)


setTokenAmountWithProofs

setTokenAmountWithProofs(_id, _token, _amount, overrides?): Promise<ContractTransaction>

Same as setTokenAmount, but let colonyJS figure out the permission proofs for you. Always prefer this method, except when you have good reason not to.

Parameters

NameTypeDescription
_idBigNumberishThe id of the streaming payment
_tokenstringThe address of the token
_amountBigNumberishThe new amount to pay out
overrides?TxOverrides-

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.setTokenAmountWithProofs


uninstall

uninstall(overrides?): Promise<ContractTransaction>

Called when uninstalling the extension

Parameters

NameType
overrides?Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.uninstall


uninstall()

uninstall()(overrides?): Promise<ContractTransaction>

Called when uninstalling the extension

Parameters

NameType
overrides?Overrides & { from?: string }

Returns

Promise<ContractTransaction>

Inherited from

AugmentedStreamingPayments.uninstall()


verify

verify(_owner, _nonce, _chainId, _payload, _sigR, _sigS, _sigV, overrides?): Promise<boolean>

Parameters

NameType
_ownerstring
_nonceBigNumberish
_chainIdBigNumberish
_payloadBytesLike
_sigRBytesLike
_sigSBytesLike
_sigVBigNumberish
overrides?CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedStreamingPayments.verify


verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)

verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)(_owner, _nonce, _chainId, _payload, _sigR, _sigS, _sigV, overrides?): Promise<boolean>

Parameters

NameType
_ownerstring
_nonceBigNumberish
_chainIdBigNumberish
_payloadBytesLike
_sigRBytesLike
_sigSBytesLike
_sigVBigNumberish
overrides?CallOverrides

Returns

Promise<boolean>

Inherited from

AugmentedStreamingPayments.verify(address,uint256,uint256,bytes,bytes32,bytes32,uint8)


version

version(overrides?): Promise<BigNumber>

Returns the version of the extension

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedStreamingPayments.version


version()

version()(overrides?): Promise<BigNumber>

Returns the version of the extension

Parameters

NameType
overrides?CallOverrides

Returns

Promise<BigNumber>

Inherited from

AugmentedStreamingPayments.version()