contracts.IBosonFundsHandler

@bosonprotocol/ethers-sdk / Exports / contracts / IBosonFundsHandler

Interface: IBosonFundsHandler

contracts.IBosonFundsHandler

Hierarchy

• BaseContract

  ↳ IBosonFundsHandler

Table of contents

Properties

• _deployedPromise
• _runningEvents
• _wrappedEmits
• address
• callStatic
• contractName
• deployTransaction
• estimateGas
• filters
• functions
• interface
• off
• on
• once
• populateTransaction
• provider
• removeListener
• resolvedAddress
• signer

Methods

• _checkRunningEvents
• _deployed
• _wrapEvent
• attach
• connect
• deployed
• depositFunds
• emit
• fallback
• getAvailableFunds
• listenerCount
• listeners
• queryFilter
• removeAllListeners
• withdrawFunds
• withdrawProtocolFees

Properties

_deployedPromise

• _deployedPromise: Promise<Contract>

Inherited from

BaseContract._deployedPromise

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:100

---

_runningEvents

• _runningEvents: Object

Index signature

▪ [eventTag: string]: RunningEvent

Inherited from

BaseContract._runningEvents

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:101

---

_wrappedEmits

• _wrappedEmits: Object

Index signature

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

Inherited from

BaseContract._wrappedEmits

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:104

---

address

• Readonly address: string

Inherited from

BaseContract.address

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:79

---

callStatic

• callStatic: Object

Type declaration

Name	Type
depositFunds	(_sellerId: BigNumberish, _tokenAddress: string, _amount: BigNumberish, overrides?: CallOverrides) => Promise<void>
getAvailableFunds	(_entityId: BigNumberish, overrides?: CallOverrides) => Promise<FundsStructOutput[]>
withdrawFunds	(_entityId: BigNumberish, _tokenList: string[], _tokenAmounts: BigNumberish[], overrides?: CallOverrides) => Promise<void>
withdrawProtocolFees	(_tokenList: string[], _tokenAmounts: BigNumberish[], overrides?: CallOverrides) => Promise<void>

Overrides

BaseContract.callStatic

Defined in

src/contracts/IBosonFundsHandler.ts:239

---

contractName

• contractName: "IBosonFundsHandler"

Defined in

src/contracts/IBosonFundsHandler.ts:157

---

deployTransaction

• Readonly deployTransaction: TransactionResponse

Inherited from

BaseContract.deployTransaction

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:99

---

estimateGas

• estimateGas: Object

Type declaration

Name	Type
depositFunds	(_sellerId: BigNumberish, _tokenAddress: string, _amount: BigNumberish, overrides?: PayableOverrides & { from?: string | Promise<string> }) => Promise<BigNumber>
getAvailableFunds	(_entityId: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
withdrawFunds	(_entityId: BigNumberish, _tokenList: string[], _tokenAmounts: BigNumberish[], overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
withdrawProtocolFees	(_tokenList: string[], _tokenAmounts: BigNumberish[], overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>

Overrides

BaseContract.estimateGas

Defined in

src/contracts/IBosonFundsHandler.ts:337

---

filters

• filters: Object

Type declaration

Name	Type
FundsDeposited	(sellerId?: BigNumberish, executedBy?: string, tokenAddress?: string, amount?: null) => FundsDepositedEventFilter
FundsDeposited(uint256,address,address,uint256)	(sellerId?: BigNumberish, executedBy?: string, tokenAddress?: string, amount?: null) => FundsDepositedEventFilter
FundsEncumbered	(entityId?: BigNumberish, exchangeToken?: string, amount?: null, executedBy?: string) => FundsEncumberedEventFilter
FundsEncumbered(uint256,address,uint256,address)	(entityId?: BigNumberish, exchangeToken?: string, amount?: null, executedBy?: string) => FundsEncumberedEventFilter
FundsReleased	(exchangeId?: BigNumberish, entityId?: BigNumberish, exchangeToken?: string, amount?: null, executedBy?: null) => FundsReleasedEventFilter
FundsReleased(uint256,uint256,address,uint256,address)	(exchangeId?: BigNumberish, entityId?: BigNumberish, exchangeToken?: string, amount?: null, executedBy?: null) => FundsReleasedEventFilter
FundsWithdrawn	(sellerId?: BigNumberish, withdrawnTo?: string, tokenAddress?: string, amount?: null, executedBy?: null) => FundsWithdrawnEventFilter
FundsWithdrawn(uint256,address,address,uint256,address)	(sellerId?: BigNumberish, withdrawnTo?: string, tokenAddress?: string, amount?: null, executedBy?: null) => FundsWithdrawnEventFilter
ProtocolFeeCollected	(exchangeId?: BigNumberish, exchangeToken?: string, amount?: null, executedBy?: string) => ProtocolFeeCollectedEventFilter
ProtocolFeeCollected(uint256,address,uint256,address)	(exchangeId?: BigNumberish, exchangeToken?: string, amount?: null, executedBy?: string) => ProtocolFeeCollectedEventFilter

Overrides

BaseContract.filters

Defined in

src/contracts/IBosonFundsHandler.ts:266

---

functions

• functions: Object

Type declaration

Name	Type
depositFunds	(_sellerId: BigNumberish, _tokenAddress: string, _amount: BigNumberish, overrides?: PayableOverrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
getAvailableFunds	(_entityId: BigNumberish, overrides?: CallOverrides) => Promise<[FundsStructOutput[]] & { availableFunds: FundsStructOutput[] }>
withdrawFunds	(_entityId: BigNumberish, _tokenList: string[], _tokenAmounts: BigNumberish[], overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
withdrawProtocolFees	(_tokenList: string[], _tokenAmounts: BigNumberish[], overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>

Overrides

BaseContract.functions

Defined in

src/contracts/IBosonFundsHandler.ts:183

---

interface

• interface: IBosonFundsHandlerInterface

Overrides

BaseContract.interface

Defined in

src/contracts/IBosonFundsHandler.ts:162

---

off

• off: OnEvent<IBosonFundsHandler>

Overrides

BaseContract.off

Defined in

src/contracts/IBosonFundsHandler.ts:178

---

on

• on: OnEvent<IBosonFundsHandler>

Overrides

BaseContract.on

Defined in

src/contracts/IBosonFundsHandler.ts:179

---

once

• once: OnEvent<IBosonFundsHandler>

Overrides

BaseContract.once

Defined in

src/contracts/IBosonFundsHandler.ts:180

---

populateTransaction

• populateTransaction: Object

Type declaration

Name	Type
depositFunds	(_sellerId: BigNumberish, _tokenAddress: string, _amount: BigNumberish, overrides?: PayableOverrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
getAvailableFunds	(_entityId: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
withdrawFunds	(_entityId: BigNumberish, _tokenList: string[], _tokenAmounts: BigNumberish[], overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
withdrawProtocolFees	(_tokenList: string[], _tokenAmounts: BigNumberish[], overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>

Overrides

BaseContract.populateTransaction

Defined in

src/contracts/IBosonFundsHandler.ts:364

---

provider

• Readonly provider: Provider

Inherited from

BaseContract.provider

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:82

---

removeListener

• removeListener: OnEvent<IBosonFundsHandler>

Overrides

BaseContract.removeListener

Defined in

src/contracts/IBosonFundsHandler.ts:181

---

resolvedAddress

• Readonly resolvedAddress: Promise<string>

Inherited from

BaseContract.resolvedAddress

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:98

---

signer

• Readonly signer: Signer

Inherited from

BaseContract.signer

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:81

Methods

_checkRunningEvents

▸ _checkRunningEvents(runningEvent): void

Parameters

Name	Type
runningEvent	RunningEvent

Returns

void

Inherited from

BaseContract._checkRunningEvents

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:121

---

_deployed

▸ _deployed(blockTag?): Promise<Contract>

Parameters

Name	Type
blockTag?	BlockTag

Returns

Promise<Contract>

Inherited from

BaseContract._deployed

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:114

---

_wrapEvent

▸ _wrapEvent(runningEvent, log, listener): Event

Parameters

Name	Type
runningEvent	RunningEvent
log	Log
listener	Listener

Returns

Event

Inherited from

BaseContract._wrapEvent

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:122

---

attach

▸ attach(addressOrName): IBosonFundsHandler

Parameters

Name	Type
addressOrName	string

Returns

IBosonFundsHandler

Overrides

BaseContract.attach

Defined in

src/contracts/IBosonFundsHandler.ts:159

---

connect

▸ connect(signerOrProvider): IBosonFundsHandler

Parameters

Name	Type
signerOrProvider	string | Signer | Provider

Returns

IBosonFundsHandler

Overrides

BaseContract.connect

Defined in

src/contracts/IBosonFundsHandler.ts:158

---

deployed

▸ deployed(): Promise<IBosonFundsHandler>

Returns

Promise<IBosonFundsHandler>

Overrides

BaseContract.deployed

Defined in

src/contracts/IBosonFundsHandler.ts:160

---

depositFunds

▸ depositFunds(_sellerId, _tokenAddress, _amount, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
_sellerId	BigNumberish
_tokenAddress	string
_amount	BigNumberish
overrides?	PayableOverrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Defined in

src/contracts/IBosonFundsHandler.ts:214

---

emit

▸ emit(eventName, ...args): boolean

Parameters

Name	Type
eventName	string | EventFilter
...args	any[]

Returns

boolean

Inherited from

BaseContract.emit

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:127

---

fallback

▸ fallback(overrides?): Promise<TransactionResponse>

Parameters

Name	Type
overrides?	TransactionRequest

Returns

Promise<TransactionResponse>

Inherited from

BaseContract.fallback

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:115

---

getAvailableFunds

▸ getAvailableFunds(_entityId, overrides?): Promise<FundsStructOutput[]>

Parameters

Name	Type
_entityId	BigNumberish
overrides?	CallOverrides

Returns

Promise<FundsStructOutput[]>

Defined in

src/contracts/IBosonFundsHandler.ts:221

---

listenerCount

▸ listenerCount(eventName?): number

Parameters

Name	Type
eventName?	string | EventFilter

Returns

number

Inherited from

BaseContract.listenerCount

Defined in

node_modules/@ethersproject/contracts/lib/index.d.ts:128

---

listeners

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

Type parameters

Name	Type
TEvent	extends TypedEvent<any, any, TEvent>

Parameters

Name	Type
eventFilter?	TypedEventFilter<TEvent>

Returns

TypedListener<TEvent>[]

Overrides

BaseContract.listeners

Defined in

src/contracts/IBosonFundsHandler.ts:170

▸ listeners(eventName?): Listener[]

Parameters

Name	Type
eventName?	string

Returns

Listener[]

Overrides

BaseContract.listeners

Defined in

src/contracts/IBosonFundsHandler.ts:173

---

queryFilter

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

Type parameters

Name	Type
TEvent	extends TypedEvent<any, any, TEvent>

Parameters

Name	Type
event	TypedEventFilter<TEvent>
fromBlockOrBlockhash?	string | number
toBlock?	string | number

Returns

Promise<TEvent[]>

Overrides

BaseContract.queryFilter

Defined in

src/contracts/IBosonFundsHandler.ts:164

---

removeAllListeners

▸ removeAllListeners<TEvent>(eventFilter): IBosonFundsHandler

Type parameters

Name	Type
TEvent	extends TypedEvent<any, any, TEvent>

Parameters

Name	Type
eventFilter	TypedEventFilter<TEvent>

Returns

IBosonFundsHandler

Overrides

BaseContract.removeAllListeners

Defined in

src/contracts/IBosonFundsHandler.ts:174

▸ removeAllListeners(eventName?): IBosonFundsHandler

Parameters

Name	Type
eventName?	string

Returns

IBosonFundsHandler

Overrides

BaseContract.removeAllListeners

Defined in

src/contracts/IBosonFundsHandler.ts:177

---

withdrawFunds

▸ withdrawFunds(_entityId, _tokenList, _tokenAmounts, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
_entityId	BigNumberish
_tokenList	string[]
_tokenAmounts	BigNumberish[]
overrides?	Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Defined in

src/contracts/IBosonFundsHandler.ts:226

---

withdrawProtocolFees

▸ withdrawProtocolFees(_tokenList, _tokenAmounts, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
_tokenList	string[]
_tokenAmounts	BigNumberish[]
overrides?	Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Defined in

src/contracts/IBosonFundsHandler.ts:233