metaTx.handler

@bosonprotocol/core-sdk / Exports / metaTx / handler

Namespace: handler

metaTx.handler

Table of contents

Type Aliases

• BaseMetaTxArgs
• SignedMetaTx

Functions

• getResubmitted
• relayMetaTransaction
• signMetaTx
• signMetaTxCancelVoucher
• signMetaTxCommitToOffer
• signMetaTxCompleteExchange
• signMetaTxCompleteExchangeBatch
• signMetaTxCreateGroup
• signMetaTxCreateOffer
• signMetaTxCreateOfferBatch
• signMetaTxCreateOfferWithCondition
• signMetaTxCreateSeller
• signMetaTxDepositFunds
• signMetaTxEscalateDispute
• signMetaTxExpireVoucher
• signMetaTxExtendDisputeTimeout
• signMetaTxRaiseDispute
• signMetaTxRedeemVoucher
• signMetaTxResolveDispute
• signMetaTxRetractDispute
• signMetaTxRevokeVoucher
• signMetaTxVoidOffer
• signMetaTxVoidOfferBatch
• signMetaTxWithdrawFunds

Type Aliases

BaseMetaTxArgs

Ƭ BaseMetaTxArgs: Object

Type declaration

Name	Type
chainId	number
metaTxHandlerAddress	string
nonce	BigNumberish
web3Lib	Web3LibAdapter

Defined in

src/meta-tx/handler.ts:32

---

SignedMetaTx

Ƭ SignedMetaTx: Object

Type declaration

Name	Type
functionName	string
functionSignature	string
r	string
s	string
v	number

Defined in

src/meta-tx/handler.ts:39

Functions

getResubmitted

▸ getResubmitted(args): Promise<GetRetriedHashesData>

Parameters

Name	Type
args	Object
args.chainId	number
args.metaTx	Object
args.metaTx.config	Partial<Omit<MetaTxConfig, "apiIds"> & { apiId: string }>
args.metaTx.originalHash	string

Returns

Promise<GetRetriedHashesData>

Defined in

src/meta-tx/handler.ts:686

---

relayMetaTransaction

▸ relayMetaTransaction(args): Promise<TransactionResponse>

Parameters

Name	Type
args	Object
args.chainId	number
args.contractAddress	string
args.metaTx	Object
args.metaTx.config	Omit<MetaTxConfig, "apiIds"> & { apiId: string }
args.metaTx.params	Object
args.metaTx.params.functionName	string
args.metaTx.params.functionSignature	BytesLike
args.metaTx.params.nonce	BigNumberish
args.metaTx.params.sigR	BytesLike
args.metaTx.params.sigS	BytesLike
args.metaTx.params.sigV	BigNumberish
args.metaTx.params.userAddress	string
args.web3LibAdapter	Web3LibAdapter

Returns

Promise<TransactionResponse>

Defined in

src/meta-tx/handler.ts:626

---

signMetaTx

▸ signMetaTx(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { functionName: string ; functionSignature: string }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:47

---

signMetaTxCancelVoucher

▸ signMetaTxCancelVoucher(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { exchangeId: BigNumberish }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:331

---

signMetaTxCommitToOffer

▸ signMetaTxCommitToOffer(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { offerId: BigNumberish }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:275

---

signMetaTxCompleteExchange

▸ signMetaTxCompleteExchange(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { exchangeId: BigNumberish }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:347

---

signMetaTxCompleteExchangeBatch

▸ signMetaTxCompleteExchangeBatch(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { exchangeIds: BigNumberish[] }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:188

---

signMetaTxCreateGroup

▸ signMetaTxCreateGroup(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { createGroupArgs: CreateGroupArgs }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:233

---

signMetaTxCreateOffer

▸ signMetaTxCreateOffer(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { createOfferArgs: CreateOfferArgs ; metadataStorage?: MetadataStorage ; theGraphStorage?: MetadataStorage }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:103

---

signMetaTxCreateOfferBatch

▸ signMetaTxCreateOfferBatch(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { createOffersArgs: CreateOfferArgs[] ; metadataStorage?: MetadataStorage ; theGraphStorage?: MetadataStorage }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:128

---

signMetaTxCreateOfferWithCondition

▸ signMetaTxCreateOfferWithCondition(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { condition: ConditionStruct ; metadataStorage?: MetadataStorage ; offerToCreate: CreateOfferArgs ; theGraphStorage?: MetadataStorage }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:246

---

signMetaTxCreateSeller

▸ signMetaTxCreateSeller(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { createSellerArgs: CreateSellerArgs }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:90

---

signMetaTxDepositFunds

▸ signMetaTxDepositFunds(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { fundsAmount: BigNumberish ; fundsTokenAddress: string ; sellerId: BigNumberish }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:536

---

signMetaTxEscalateDispute

▸ signMetaTxEscalateDispute(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { exchangeId: BigNumberish }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:366

---

signMetaTxExpireVoucher

▸ signMetaTxExpireVoucher(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { exchangeId: BigNumberish }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:203

---

signMetaTxExtendDisputeTimeout

▸ signMetaTxExtendDisputeTimeout(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { exchangeId: BigNumberish ; newTimeout: BigNumberish }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:461

---

signMetaTxRaiseDispute

▸ signMetaTxRaiseDispute(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { exchangeId: BigNumberish }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:377

---

signMetaTxRedeemVoucher

▸ signMetaTxRedeemVoucher(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { exchangeId: BigNumberish }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:339

---

signMetaTxResolveDispute

▸ signMetaTxResolveDispute(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { buyerPercent: BigNumberish ; counterpartySig: { r: string ; s: string ; v: number } ; exchangeId: BigNumberish }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:388

---

signMetaTxRetractDispute

▸ signMetaTxRetractDispute(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { exchangeId: BigNumberish }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:355

---

signMetaTxRevokeVoucher

▸ signMetaTxRevokeVoucher(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { exchangeId: BigNumberish }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:218

---

signMetaTxVoidOffer

▸ signMetaTxVoidOffer(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { offerId: BigNumberish }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:159

---

signMetaTxVoidOfferBatch

▸ signMetaTxVoidOfferBatch(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { offerIds: BigNumberish[] }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:173

---

signMetaTxWithdrawFunds

▸ signMetaTxWithdrawFunds(args): Promise<SignedMetaTx>

Parameters

Name	Type
args	BaseMetaTxArgs & { entityId: BigNumberish ; tokenAmounts: BigNumberish[] ; tokenList: string[] }

Returns

Promise<SignedMetaTx>

Defined in

src/meta-tx/handler.ts:477