contracts.IBosonOfferHandler

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

Interface: IBosonOfferHandler

contracts.IBosonOfferHandler

Hierarchy

• BaseContract

  ↳ IBosonOfferHandler

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
• createOffer
• createOfferBatch
• deployed
• emit
• extendOffer
• extendOfferBatch
• fallback
• getAgentIdByOffer
• getNextOfferId
• getOffer
• isOfferVoided
• listenerCount
• listeners
• queryFilter
• removeAllListeners
• voidOffer
• voidOfferBatch

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
createOffer	(_offer: OfferStruct, _offerDates: OfferDatesStruct, _offerDurations: OfferDurationsStruct, _disputeResolverId: BigNumberish, _agentId: BigNumberish, overrides?: CallOverrides) => Promise<void>
createOfferBatch	(_offers: OfferStruct[], _offerDates: OfferDatesStruct[], _offerDurations: OfferDurationsStruct[], _disputeResolverIds: BigNumberish[], _agentIds: BigNumberish[], overrides?: CallOverrides) => Promise<void>
extendOffer	(_offerId: BigNumberish, _validUntilDate: BigNumberish, overrides?: CallOverrides) => Promise<void>
extendOfferBatch	(_offerIds: BigNumberish[], _validUntilDate: BigNumberish, overrides?: CallOverrides) => Promise<void>
getAgentIdByOffer	(_offerId: BigNumberish, overrides?: CallOverrides) => Promise<[boolean, BigNumber] & { agentId: BigNumber ; exists: boolean }>
getNextOfferId	(overrides?: CallOverrides) => Promise<BigNumber>
getOffer	(_offerId: BigNumberish, overrides?: CallOverrides) => Promise<[boolean, OfferStructOutput, OfferDatesStructOutput, OfferDurationsStructOutput, DisputeResolutionTermsStructOutput, OfferFeesStructOutput] & { disputeResolutionTerms: DisputeResolutionTermsStructOutput ; exists: boolean ; offer: OfferStructOutput ; offerDates: OfferDatesStructOutput ; offerDurations: OfferDurationsStructOutput ; offerFees: OfferFeesStructOutput }>
isOfferVoided	(_offerId: BigNumberish, overrides?: CallOverrides) => Promise<[boolean, boolean] & { exists: boolean ; offerVoided: boolean }>
voidOffer	(_offerId: BigNumberish, overrides?: CallOverrides) => Promise<void>
voidOfferBatch	(_offerIds: BigNumberish[], overrides?: CallOverrides) => Promise<void>

Overrides

BaseContract.callStatic

Defined in

src/contracts/IBosonOfferHandler.ts:456

---

contractName

• contractName: "IBosonOfferHandler"

Defined in

src/contracts/IBosonOfferHandler.ts:280

---

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
createOffer	(_offer: OfferStruct, _offerDates: OfferDatesStruct, _offerDurations: OfferDurationsStruct, _disputeResolverId: BigNumberish, _agentId: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
createOfferBatch	(_offers: OfferStruct[], _offerDates: OfferDatesStruct[], _offerDurations: OfferDurationsStruct[], _disputeResolverIds: BigNumberish[], _agentIds: BigNumberish[], overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
extendOffer	(_offerId: BigNumberish, _validUntilDate: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
extendOfferBatch	(_offerIds: BigNumberish[], _validUntilDate: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
getAgentIdByOffer	(_offerId: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
getNextOfferId	(overrides?: CallOverrides) => Promise<BigNumber>
getOffer	(_offerId: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
isOfferVoided	(_offerId: BigNumberish, overrides?: CallOverrides) => Promise<BigNumber>
voidOffer	(_offerId: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>
voidOfferBatch	(_offerIds: BigNumberish[], overrides?: Overrides & { from?: string | Promise<string> }) => Promise<BigNumber>

Overrides

BaseContract.estimateGas

Defined in

src/contracts/IBosonOfferHandler.ts:577

---

filters

• filters: Object

Type declaration

Name	Type
OfferCreated	(offerId?: BigNumberish, sellerId?: BigNumberish, offer?: null, offerDates?: null, offerDurations?: null, disputeResolutionTerms?: null, offerFees?: null, agentId?: BigNumberish, executedBy?: null) => OfferCreatedEventFilter
OfferCreated(uint256,uint256,tuple,tuple,tuple,tuple,tuple,uint256,address)	(offerId?: BigNumberish, sellerId?: BigNumberish, offer?: null, offerDates?: null, offerDurations?: null, disputeResolutionTerms?: null, offerFees?: null, agentId?: BigNumberish, executedBy?: null) => OfferCreatedEventFilter
OfferExtended	(offerId?: BigNumberish, sellerId?: BigNumberish, validUntilDate?: null, executedBy?: string) => OfferExtendedEventFilter
OfferExtended(uint256,uint256,uint256,address)	(offerId?: BigNumberish, sellerId?: BigNumberish, validUntilDate?: null, executedBy?: string) => OfferExtendedEventFilter
OfferVoided	(offerId?: BigNumberish, sellerId?: BigNumberish, executedBy?: string) => OfferVoidedEventFilter
OfferVoided(uint256,uint256,address)	(offerId?: BigNumberish, sellerId?: BigNumberish, executedBy?: string) => OfferVoidedEventFilter

Overrides

BaseContract.filters

Defined in

src/contracts/IBosonOfferHandler.ts:528

---

functions

• functions: Object

Type declaration

Name	Type
createOffer	(_offer: OfferStruct, _offerDates: OfferDatesStruct, _offerDurations: OfferDurationsStruct, _disputeResolverId: BigNumberish, _agentId: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
createOfferBatch	(_offers: OfferStruct[], _offerDates: OfferDatesStruct[], _offerDurations: OfferDurationsStruct[], _disputeResolverIds: BigNumberish[], _agentIds: BigNumberish[], overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
extendOffer	(_offerId: BigNumberish, _validUntilDate: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
extendOfferBatch	(_offerIds: BigNumberish[], _validUntilDate: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
getAgentIdByOffer	(_offerId: BigNumberish, overrides?: CallOverrides) => Promise<[boolean, BigNumber] & { agentId: BigNumber ; exists: boolean }>
getNextOfferId	(overrides?: CallOverrides) => Promise<[BigNumber] & { nextOfferId: BigNumber }>
getOffer	(_offerId: BigNumberish, overrides?: CallOverrides) => Promise<[boolean, OfferStructOutput, OfferDatesStructOutput, OfferDurationsStructOutput, DisputeResolutionTermsStructOutput, OfferFeesStructOutput] & { disputeResolutionTerms: DisputeResolutionTermsStructOutput ; exists: boolean ; offer: OfferStructOutput ; offerDates: OfferDatesStructOutput ; offerDurations: OfferDurationsStructOutput ; offerFees: OfferFeesStructOutput }>
isOfferVoided	(_offerId: BigNumberish, overrides?: CallOverrides) => Promise<[boolean, boolean] & { exists: boolean ; offerVoided: boolean }>
voidOffer	(_offerId: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>
voidOfferBatch	(_offerIds: BigNumberish[], overrides?: Overrides & { from?: string | Promise<string> }) => Promise<ContractTransaction>

Overrides

BaseContract.functions

Defined in

src/contracts/IBosonOfferHandler.ts:306

---

interface

• interface: IBosonOfferHandlerInterface

Overrides

BaseContract.interface

Defined in

src/contracts/IBosonOfferHandler.ts:285

---

off

• off: OnEvent<IBosonOfferHandler>

Overrides

BaseContract.off

Defined in

src/contracts/IBosonOfferHandler.ts:301

---

on

• on: OnEvent<IBosonOfferHandler>

Overrides

BaseContract.on

Defined in

src/contracts/IBosonOfferHandler.ts:302

---

once

• once: OnEvent<IBosonOfferHandler>

Overrides

BaseContract.once

Defined in

src/contracts/IBosonOfferHandler.ts:303

---

populateTransaction

• populateTransaction: Object

Type declaration

Name	Type
createOffer	(_offer: OfferStruct, _offerDates: OfferDatesStruct, _offerDurations: OfferDurationsStruct, _disputeResolverId: BigNumberish, _agentId: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
createOfferBatch	(_offers: OfferStruct[], _offerDates: OfferDatesStruct[], _offerDurations: OfferDurationsStruct[], _disputeResolverIds: BigNumberish[], _agentIds: BigNumberish[], overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
extendOffer	(_offerId: BigNumberish, _validUntilDate: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
extendOfferBatch	(_offerIds: BigNumberish[], _validUntilDate: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
getAgentIdByOffer	(_offerId: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
getNextOfferId	(overrides?: CallOverrides) => Promise<PopulatedTransaction>
getOffer	(_offerId: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
isOfferVoided	(_offerId: BigNumberish, overrides?: CallOverrides) => Promise<PopulatedTransaction>
voidOffer	(_offerId: BigNumberish, overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>
voidOfferBatch	(_offerIds: BigNumberish[], overrides?: Overrides & { from?: string | Promise<string> }) => Promise<PopulatedTransaction>

Overrides

BaseContract.populateTransaction

Defined in

src/contracts/IBosonOfferHandler.ts:636

---

provider

• Readonly provider: Provider

Inherited from

BaseContract.provider

Defined in

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

---

removeListener

• removeListener: OnEvent<IBosonOfferHandler>

Overrides

BaseContract.removeListener

Defined in

src/contracts/IBosonOfferHandler.ts:304

---

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): IBosonOfferHandler

Parameters

Name	Type
addressOrName	string

Returns

IBosonOfferHandler

Overrides

BaseContract.attach

Defined in

src/contracts/IBosonOfferHandler.ts:282

---

connect

▸ connect(signerOrProvider): IBosonOfferHandler

Parameters

Name	Type
signerOrProvider	string | Signer | Provider

Returns

IBosonOfferHandler

Overrides

BaseContract.connect

Defined in

src/contracts/IBosonOfferHandler.ts:281

---

createOffer

▸ createOffer(_offer, _offerDates, _offerDurations, _disputeResolverId, _agentId, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
_offer	OfferStruct
_offerDates	OfferDatesStruct
_offerDurations	OfferDurationsStruct
_disputeResolverId	BigNumberish
_agentId	BigNumberish
overrides?	Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Defined in

src/contracts/IBosonOfferHandler.ts:383

---

createOfferBatch

▸ createOfferBatch(_offers, _offerDates, _offerDurations, _disputeResolverIds, _agentIds, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
_offers	OfferStruct[]
_offerDates	OfferDatesStruct[]
_offerDurations	OfferDurationsStruct[]
_disputeResolverIds	BigNumberish[]
_agentIds	BigNumberish[]
overrides?	Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Defined in

src/contracts/IBosonOfferHandler.ts:392

---

deployed

▸ deployed(): Promise<IBosonOfferHandler>

Returns

Promise<IBosonOfferHandler>

Overrides

BaseContract.deployed

Defined in

src/contracts/IBosonOfferHandler.ts:283

---

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

---

extendOffer

▸ extendOffer(_offerId, _validUntilDate, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
_offerId	BigNumberish
_validUntilDate	BigNumberish
overrides?	Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Defined in

src/contracts/IBosonOfferHandler.ts:401

---

extendOfferBatch

▸ extendOfferBatch(_offerIds, _validUntilDate, overrides?): Promise<ContractTransaction>

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

src/contracts/IBosonOfferHandler.ts:407

---

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

---

getAgentIdByOffer

▸ getAgentIdByOffer(_offerId, overrides?): Promise<[boolean, BigNumber] & { agentId: BigNumber ; exists: boolean }>

Parameters

Name	Type
_offerId	BigNumberish
overrides?	CallOverrides

Returns

Promise<[boolean, BigNumber] & { agentId: BigNumber ; exists: boolean }>

Defined in

src/contracts/IBosonOfferHandler.ts:413

---

getNextOfferId

▸ getNextOfferId(overrides?): Promise<BigNumber>

Parameters

Name	Type
overrides?	CallOverrides

Returns

Promise<BigNumber>

Defined in

src/contracts/IBosonOfferHandler.ts:418

---

getOffer

▸ getOffer(_offerId, overrides?): Promise<[boolean, OfferStructOutput, OfferDatesStructOutput, OfferDurationsStructOutput, DisputeResolutionTermsStructOutput, OfferFeesStructOutput] & { disputeResolutionTerms: DisputeResolutionTermsStructOutput ; exists: boolean ; offer: OfferStructOutput ; offerDates: OfferDatesStructOutput ; offerDurations: OfferDurationsStructOutput ; offerFees: OfferFeesStructOutput }>

Parameters

Name	Type
_offerId	BigNumberish
overrides?	CallOverrides

Returns

Promise<[boolean, OfferStructOutput, OfferDatesStructOutput, OfferDurationsStructOutput, DisputeResolutionTermsStructOutput, OfferFeesStructOutput] & { disputeResolutionTerms: DisputeResolutionTermsStructOutput ; exists: boolean ; offer: OfferStructOutput ; offerDates: OfferDatesStructOutput ; offerDurations: OfferDurationsStructOutput ; offerFees: OfferFeesStructOutput }>

Defined in

src/contracts/IBosonOfferHandler.ts:420

---

isOfferVoided

▸ isOfferVoided(_offerId, overrides?): Promise<[boolean, boolean] & { exists: boolean ; offerVoided: boolean }>

Parameters

Name	Type
_offerId	BigNumberish
overrides?	CallOverrides

Returns

Promise<[boolean, boolean] & { exists: boolean ; offerVoided: boolean }>

Defined in

src/contracts/IBosonOfferHandler.ts:441

---

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/IBosonOfferHandler.ts:293

▸ listeners(eventName?): Listener[]

Parameters

Name	Type
eventName?	string

Returns

Listener[]

Overrides

BaseContract.listeners

Defined in

src/contracts/IBosonOfferHandler.ts:296

---

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/IBosonOfferHandler.ts:287

---

removeAllListeners

▸ removeAllListeners<TEvent>(eventFilter): IBosonOfferHandler

Type parameters

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

Parameters

Name	Type
eventFilter	TypedEventFilter<TEvent>

Returns

IBosonOfferHandler

Overrides

BaseContract.removeAllListeners

Defined in

src/contracts/IBosonOfferHandler.ts:297

▸ removeAllListeners(eventName?): IBosonOfferHandler

Parameters

Name	Type
eventName?	string

Returns

IBosonOfferHandler

Overrides

BaseContract.removeAllListeners

Defined in

src/contracts/IBosonOfferHandler.ts:300

---

voidOffer

▸ voidOffer(_offerId, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
_offerId	BigNumberish
overrides?	Overrides & { from?: string | Promise<string> }

Returns

Promise<ContractTransaction>

Defined in

src/contracts/IBosonOfferHandler.ts:446

---

voidOfferBatch

▸ voidOfferBatch(_offerIds, overrides?): Promise<ContractTransaction>

Parameters

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

Returns

Promise<ContractTransaction>

Defined in

src/contracts/IBosonOfferHandler.ts:451