@bosonprotocol/core-sdk 1.23.0-alpha.8 → 1.23.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/accounts/mixin.d.ts +194 -0
- package/dist/cjs/accounts/mixin.d.ts.map +1 -0
- package/dist/cjs/accounts/mixin.js +426 -0
- package/dist/cjs/accounts/mixin.js.map +1 -0
- package/dist/cjs/core-sdk.d.ts +16 -818
- package/dist/cjs/core-sdk.d.ts.map +1 -1
- package/dist/cjs/core-sdk.js +26 -1579
- package/dist/cjs/core-sdk.js.map +1 -1
- package/dist/cjs/disputes/mixin.d.ts +113 -0
- package/dist/cjs/disputes/mixin.d.ts.map +1 -0
- package/dist/cjs/disputes/mixin.js +203 -0
- package/dist/cjs/disputes/mixin.js.map +1 -0
- package/dist/cjs/erc1155/handler.d.ts +9 -0
- package/dist/cjs/erc1155/handler.d.ts.map +1 -0
- package/dist/cjs/erc1155/handler.js +28 -0
- package/dist/cjs/erc1155/handler.js.map +1 -0
- package/dist/cjs/erc1155/index.d.ts +3 -0
- package/dist/cjs/erc1155/index.d.ts.map +1 -0
- package/dist/cjs/erc1155/index.js +29 -0
- package/dist/cjs/erc1155/index.js.map +1 -0
- package/dist/cjs/erc1155/interface.d.ts +3 -0
- package/dist/cjs/erc1155/interface.d.ts.map +1 -0
- package/dist/cjs/erc1155/interface.js +7 -0
- package/dist/cjs/erc1155/interface.js.map +1 -0
- package/dist/cjs/erc20/handler.d.ts +5 -0
- package/dist/cjs/erc20/handler.d.ts.map +1 -1
- package/dist/cjs/erc20/handler.js +12 -1
- package/dist/cjs/erc20/handler.js.map +1 -1
- package/dist/cjs/erc721/handler.d.ts +5 -0
- package/dist/cjs/erc721/handler.d.ts.map +1 -1
- package/dist/cjs/erc721/handler.js +12 -1
- package/dist/cjs/erc721/handler.js.map +1 -1
- package/dist/cjs/event-logs/mixin.d.ts +11 -0
- package/dist/cjs/event-logs/mixin.d.ts.map +1 -0
- package/dist/cjs/event-logs/mixin.js +28 -0
- package/dist/cjs/event-logs/mixin.js.map +1 -0
- package/dist/cjs/exchanges/mixin.d.ts +77 -0
- package/dist/cjs/exchanges/mixin.d.ts.map +1 -0
- package/dist/cjs/exchanges/mixin.js +172 -0
- package/dist/cjs/exchanges/mixin.js.map +1 -0
- package/dist/cjs/funds/mixin.d.ts +42 -0
- package/dist/cjs/funds/mixin.d.ts.map +1 -0
- package/dist/cjs/funds/mixin.js +95 -0
- package/dist/cjs/funds/mixin.js.map +1 -0
- package/dist/cjs/groups/mixin.d.ts +14 -0
- package/dist/cjs/groups/mixin.d.ts.map +1 -0
- package/dist/cjs/groups/mixin.js +33 -0
- package/dist/cjs/groups/mixin.js.map +1 -0
- package/dist/cjs/meta-tx/mixin.d.ts +176 -0
- package/dist/cjs/meta-tx/mixin.d.ts.map +1 -0
- package/dist/cjs/meta-tx/mixin.js +296 -0
- package/dist/cjs/meta-tx/mixin.js.map +1 -0
- package/dist/cjs/metadata/mixin.d.ts +42 -0
- package/dist/cjs/metadata/mixin.d.ts.map +1 -0
- package/dist/cjs/metadata/mixin.js +89 -0
- package/dist/cjs/metadata/mixin.js.map +1 -0
- package/dist/cjs/metadata/subgraph.d.ts +3 -1
- package/dist/cjs/metadata/subgraph.d.ts.map +1 -1
- package/dist/cjs/metadata/subgraph.js +17 -1
- package/dist/cjs/metadata/subgraph.js.map +1 -1
- package/dist/cjs/mixins/base-core-sdk.d.ts +41 -0
- package/dist/cjs/mixins/base-core-sdk.d.ts.map +1 -0
- package/dist/cjs/mixins/base-core-sdk.js +51 -0
- package/dist/cjs/mixins/base-core-sdk.js.map +1 -0
- package/dist/cjs/native-meta-tx/mixin.d.ts +35 -0
- package/dist/cjs/native-meta-tx/mixin.d.ts.map +1 -0
- package/dist/cjs/native-meta-tx/mixin.js +68 -0
- package/dist/cjs/native-meta-tx/mixin.js.map +1 -0
- package/dist/cjs/offers/mixin.d.ts +133 -0
- package/dist/cjs/offers/mixin.d.ts.map +1 -0
- package/dist/cjs/offers/mixin.js +338 -0
- package/dist/cjs/offers/mixin.js.map +1 -0
- package/dist/cjs/orchestration/mixin.d.ts +28 -0
- package/dist/cjs/orchestration/mixin.d.ts.map +1 -0
- package/dist/cjs/orchestration/mixin.js +59 -0
- package/dist/cjs/orchestration/mixin.js.map +1 -0
- package/dist/cjs/subgraph.d.ts +3747 -1529
- package/dist/cjs/subgraph.d.ts.map +1 -1
- package/dist/cjs/subgraph.js +115 -4
- package/dist/cjs/subgraph.js.map +1 -1
- package/dist/cjs/utils/graphql.d.ts +14 -0
- package/dist/cjs/utils/graphql.d.ts.map +1 -1
- package/dist/cjs/utils/tokenInfoManager.d.ts +8 -3
- package/dist/cjs/utils/tokenInfoManager.d.ts.map +1 -1
- package/dist/cjs/utils/tokenInfoManager.js +58 -15
- package/dist/cjs/utils/tokenInfoManager.js.map +1 -1
- package/dist/esm/accounts/mixin.d.ts +194 -0
- package/dist/esm/accounts/mixin.d.ts.map +1 -0
- package/dist/esm/accounts/mixin.js +342 -0
- package/dist/esm/accounts/mixin.js.map +1 -0
- package/dist/esm/core-sdk.d.ts +16 -818
- package/dist/esm/core-sdk.d.ts.map +1 -1
- package/dist/esm/core-sdk.js +27 -1483
- package/dist/esm/core-sdk.js.map +1 -1
- package/dist/esm/disputes/mixin.d.ts +113 -0
- package/dist/esm/disputes/mixin.d.ts.map +1 -0
- package/dist/esm/disputes/mixin.js +173 -0
- package/dist/esm/disputes/mixin.js.map +1 -0
- package/dist/esm/erc1155/handler.d.ts +9 -0
- package/dist/esm/erc1155/handler.d.ts.map +1 -0
- package/dist/esm/erc1155/handler.js +13 -0
- package/dist/esm/erc1155/handler.js.map +1 -0
- package/dist/esm/erc1155/index.d.ts +3 -0
- package/dist/esm/erc1155/index.d.ts.map +1 -0
- package/dist/esm/erc1155/index.js +3 -0
- package/dist/esm/erc1155/index.js.map +1 -0
- package/dist/esm/erc1155/interface.d.ts +3 -0
- package/dist/esm/erc1155/interface.d.ts.map +1 -0
- package/dist/esm/erc1155/interface.js +4 -0
- package/dist/esm/erc1155/interface.js.map +1 -0
- package/dist/esm/erc20/handler.d.ts +5 -0
- package/dist/esm/erc20/handler.d.ts.map +1 -1
- package/dist/esm/erc20/handler.js +8 -0
- package/dist/esm/erc20/handler.js.map +1 -1
- package/dist/esm/erc721/handler.d.ts +5 -0
- package/dist/esm/erc721/handler.d.ts.map +1 -1
- package/dist/esm/erc721/handler.js +8 -0
- package/dist/esm/erc721/handler.js.map +1 -1
- package/dist/esm/event-logs/mixin.d.ts +11 -0
- package/dist/esm/event-logs/mixin.d.ts.map +1 -0
- package/dist/esm/event-logs/mixin.js +13 -0
- package/dist/esm/event-logs/mixin.js.map +1 -0
- package/dist/esm/exchanges/mixin.d.ts +77 -0
- package/dist/esm/exchanges/mixin.d.ts.map +1 -0
- package/dist/esm/exchanges/mixin.js +141 -0
- package/dist/esm/exchanges/mixin.js.map +1 -0
- package/dist/esm/funds/mixin.d.ts +42 -0
- package/dist/esm/funds/mixin.d.ts.map +1 -0
- package/dist/esm/funds/mixin.js +72 -0
- package/dist/esm/funds/mixin.js.map +1 -0
- package/dist/esm/groups/mixin.d.ts +14 -0
- package/dist/esm/groups/mixin.d.ts.map +1 -0
- package/dist/esm/groups/mixin.js +18 -0
- package/dist/esm/groups/mixin.js.map +1 -0
- package/dist/esm/meta-tx/mixin.d.ts +176 -0
- package/dist/esm/meta-tx/mixin.d.ts.map +1 -0
- package/dist/esm/meta-tx/mixin.js +351 -0
- package/dist/esm/meta-tx/mixin.js.map +1 -0
- package/dist/esm/metadata/mixin.d.ts +42 -0
- package/dist/esm/metadata/mixin.d.ts.map +1 -0
- package/dist/esm/metadata/mixin.js +60 -0
- package/dist/esm/metadata/mixin.js.map +1 -0
- package/dist/esm/metadata/subgraph.d.ts +3 -1
- package/dist/esm/metadata/subgraph.d.ts.map +1 -1
- package/dist/esm/metadata/subgraph.js +14 -0
- package/dist/esm/metadata/subgraph.js.map +1 -1
- package/dist/esm/mixins/base-core-sdk.d.ts +41 -0
- package/dist/esm/mixins/base-core-sdk.d.ts.map +1 -0
- package/dist/esm/mixins/base-core-sdk.js +54 -0
- package/dist/esm/mixins/base-core-sdk.js.map +1 -0
- package/dist/esm/native-meta-tx/mixin.d.ts +35 -0
- package/dist/esm/native-meta-tx/mixin.d.ts.map +1 -0
- package/dist/esm/native-meta-tx/mixin.js +51 -0
- package/dist/esm/native-meta-tx/mixin.js.map +1 -0
- package/dist/esm/offers/mixin.d.ts +133 -0
- package/dist/esm/offers/mixin.d.ts.map +1 -0
- package/dist/esm/offers/mixin.js +276 -0
- package/dist/esm/offers/mixin.js.map +1 -0
- package/dist/esm/orchestration/mixin.d.ts +28 -0
- package/dist/esm/orchestration/mixin.d.ts.map +1 -0
- package/dist/esm/orchestration/mixin.js +42 -0
- package/dist/esm/orchestration/mixin.js.map +1 -0
- package/dist/esm/subgraph.d.ts +3747 -1529
- package/dist/esm/subgraph.d.ts.map +1 -1
- package/dist/esm/subgraph.js +112 -1
- package/dist/esm/subgraph.js.map +1 -1
- package/dist/esm/utils/graphql.d.ts +14 -0
- package/dist/esm/utils/graphql.d.ts.map +1 -1
- package/dist/esm/utils/tokenInfoManager.d.ts +8 -3
- package/dist/esm/utils/tokenInfoManager.d.ts.map +1 -1
- package/dist/esm/utils/tokenInfoManager.js +58 -15
- package/dist/esm/utils/tokenInfoManager.js.map +1 -1
- package/package.json +3 -3
- package/src/accounts/mixin.ts +484 -0
- package/src/core-sdk.ts +42 -2102
- package/src/disputes/mixin.ts +240 -0
- package/src/erc1155/handler.ts +21 -0
- package/src/erc1155/index.ts +2 -0
- package/src/erc1155/interface.ts +4 -0
- package/src/erc20/handler.ts +14 -0
- package/src/erc721/handler.ts +14 -0
- package/src/event-logs/mixin.ts +16 -0
- package/src/exchanges/mixin.ts +184 -0
- package/src/funds/mixin.ts +99 -0
- package/src/groups/mixin.ts +24 -0
- package/src/meta-tx/mixin.ts +515 -0
- package/src/metadata/mixin.ts +97 -0
- package/src/metadata/product-v1.graphql +77 -1
- package/src/metadata/subgraph.ts +31 -1
- package/src/mixins/base-core-sdk.ts +96 -0
- package/src/native-meta-tx/mixin.ts +77 -0
- package/src/offers/mixin.ts +376 -0
- package/src/offers/queries.graphql +1 -1
- package/src/orchestration/mixin.ts +57 -0
- package/src/subgraph.ts +4396 -2052
- package/src/utils/tokenInfoManager.ts +71 -16
package/dist/cjs/core-sdk.d.ts
CHANGED
|
@@ -1,38 +1,18 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
1
|
+
import { OrchestrationMixin } from "./orchestration/mixin";
|
|
2
|
+
import { GroupsMixin } from "./groups/mixin";
|
|
3
|
+
import { NativeMetaTxMixin } from "./native-meta-tx/mixin";
|
|
4
|
+
import { MetaTxMixin } from "./meta-tx/mixin";
|
|
5
|
+
import { DisputesMixin } from "./disputes/mixin";
|
|
6
|
+
import { BaseCoreSDK } from "./mixins/base-core-sdk";
|
|
7
|
+
import { Web3LibAdapter, MetadataStorage, MetaTxConfig } from "@bosonprotocol/common";
|
|
5
8
|
import { EnvironmentType } from "@bosonprotocol/common/src/types";
|
|
6
|
-
import
|
|
7
|
-
import
|
|
8
|
-
import
|
|
9
|
-
import
|
|
10
|
-
import
|
|
11
|
-
import {
|
|
12
|
-
export declare class CoreSDK {
|
|
13
|
-
private _web3Lib;
|
|
14
|
-
private _metadataStorage?;
|
|
15
|
-
private _theGraphStorage?;
|
|
16
|
-
private _subgraphUrl;
|
|
17
|
-
private _protocolDiamond;
|
|
18
|
-
private _chainId;
|
|
19
|
-
private _tokenInfoManager;
|
|
20
|
-
private _metaTxConfig?;
|
|
21
|
-
private _lensContracts?;
|
|
22
|
-
/**
|
|
23
|
-
* Creates an instance of `CoreSDK`
|
|
24
|
-
* @param args - Constructor args
|
|
25
|
-
*/
|
|
26
|
-
constructor(opts: {
|
|
27
|
-
web3Lib: Web3LibAdapter;
|
|
28
|
-
subgraphUrl: string;
|
|
29
|
-
protocolDiamond: string;
|
|
30
|
-
metadataStorage?: MetadataStorage;
|
|
31
|
-
theGraphStorage?: MetadataStorage;
|
|
32
|
-
chainId: number;
|
|
33
|
-
metaTx?: Partial<MetaTxConfig>;
|
|
34
|
-
lensContracts?: LensContracts;
|
|
35
|
-
});
|
|
9
|
+
import { MetadataMixin } from "./metadata/mixin";
|
|
10
|
+
import { AccountsMixin } from "./accounts/mixin";
|
|
11
|
+
import { OfferMixin } from "./offers/mixin";
|
|
12
|
+
import { FundsMixin } from "./funds/mixin";
|
|
13
|
+
import { ExchangesMixin } from "./exchanges/mixin";
|
|
14
|
+
import { EventLogsMixin } from "./event-logs/mixin";
|
|
15
|
+
export declare class CoreSDK extends BaseCoreSDK {
|
|
36
16
|
/**
|
|
37
17
|
* Creates an instance of `CoreSDK` by using default values derived either from
|
|
38
18
|
* `args.envName` or `args.chainId`.
|
|
@@ -62,789 +42,7 @@ export declare class CoreSDK {
|
|
|
62
42
|
contractAddress?: string;
|
|
63
43
|
metaTransactionMethod?: string;
|
|
64
44
|
}): boolean;
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
* at construction.
|
|
68
|
-
* @param metadata - Offer metadata of type `BASE` or `PRODUCT_V1`.
|
|
69
|
-
* @returns Metadata hash / identifier.
|
|
70
|
-
*/
|
|
71
|
-
storeMetadata(metadata: AnyMetadata): Promise<string>;
|
|
72
|
-
/**
|
|
73
|
-
* Returns supported offer metadata from passed in `MetadataStorage` instance.
|
|
74
|
-
* @param metadataHashOrUri - Metadata hash or uri that can be handled by the
|
|
75
|
-
* storage instance.
|
|
76
|
-
* @returns Offer metadata.
|
|
77
|
-
*/
|
|
78
|
-
getMetadata(metadataHashOrUri: string): Promise<AnyMetadata>;
|
|
79
|
-
/**
|
|
80
|
-
* Returns `BASE` type offer metadata entities from subgraph.
|
|
81
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
82
|
-
* @returns BaseMetadataEntities from subgraph.
|
|
83
|
-
*/
|
|
84
|
-
getBaseMetadataEntities(queryVars?: subgraph.GetBaseMetadataEntitiesQueryQueryVariables): Promise<subgraph.BaseMetadataEntityFieldsFragment[]>;
|
|
85
|
-
/**
|
|
86
|
-
* Returns `PRODUCT_V1` type offer metadata entities from subgraph.
|
|
87
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
88
|
-
* @returns ProductV1MetadataEntities from subgraph.
|
|
89
|
-
*/
|
|
90
|
-
getProductV1MetadataEntities(queryVars?: subgraph.GetProductV1MetadataEntitiesQueryQueryVariables): Promise<subgraph.ProductV1MetadataEntityFieldsFragment[]>;
|
|
91
|
-
getProductV1Products(queryVars?: subgraph.GetProductV1ProductsQueryQueryVariables): Promise<subgraph.BaseProductV1ProductFieldsFragment[]>;
|
|
92
|
-
getProductWithVariants(productUuid: string): Promise<{
|
|
93
|
-
product: subgraph.BaseProductV1ProductFieldsFragment;
|
|
94
|
-
variants: Array<{
|
|
95
|
-
offer: subgraph.OfferFieldsFragment;
|
|
96
|
-
variations: Array<subgraph.ProductV1Variation>;
|
|
97
|
-
}>;
|
|
98
|
-
} | null>;
|
|
99
|
-
/**
|
|
100
|
-
* Returns seller entity from subgraph.
|
|
101
|
-
* @param sellerId - ID of seller entity to query for.
|
|
102
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
103
|
-
* @returns Seller entity from subgraph.
|
|
104
|
-
*/
|
|
105
|
-
getSellerById(sellerId: BigNumberish, queryVars?: accounts.subgraph.SingleSellerQueryVariables): Promise<subgraph.SellerFieldsFragment>;
|
|
106
|
-
/**
|
|
107
|
-
* Returns seller entity from subgraph.
|
|
108
|
-
* @param operator - Operator address of seller entity to query for.
|
|
109
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
110
|
-
* @returns Seller entity from subgraph.
|
|
111
|
-
*/
|
|
112
|
-
getSellerByOperator(operator: string, queryVars?: subgraph.GetSellersQueryQueryVariables): Promise<subgraph.SellerFieldsFragment>;
|
|
113
|
-
/**
|
|
114
|
-
* Returns seller entity from subgraph.
|
|
115
|
-
* @param clerk - Clerk address of seller entity to query for.
|
|
116
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
117
|
-
* @returns Seller entity from subgraph.
|
|
118
|
-
*/
|
|
119
|
-
getSellerByClerk(clerk: string, queryVars?: subgraph.GetSellersQueryQueryVariables): Promise<subgraph.SellerFieldsFragment>;
|
|
120
|
-
/**
|
|
121
|
-
* Returns seller entity from subgraph.
|
|
122
|
-
* @param admin - Admin address of seller entity to query for.
|
|
123
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
124
|
-
* @returns Seller entity from subgraph.
|
|
125
|
-
*/
|
|
126
|
-
getSellerByAdmin(admin: string, queryVars?: subgraph.GetSellersQueryQueryVariables): Promise<subgraph.SellerFieldsFragment>;
|
|
127
|
-
/**
|
|
128
|
-
* Returns seller entity from subgraph.
|
|
129
|
-
* @param treasury - Treasury address of seller entity to query for.
|
|
130
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
131
|
-
* @returns Seller entity from subgraph.
|
|
132
|
-
*/
|
|
133
|
-
getSellerByTreasury(treasury: string, queryVars?: subgraph.GetSellersQueryQueryVariables): Promise<subgraph.SellerFieldsFragment>;
|
|
134
|
-
/**
|
|
135
|
-
* Returns seller entity from subgraph. Matches `operator`, `clerk`, `admin` or `treasury`.
|
|
136
|
-
* @param address - Address of seller entity to query for.
|
|
137
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
138
|
-
* @returns Seller entity from subgraph.
|
|
139
|
-
*/
|
|
140
|
-
getSellersByAddress(address: string, queryVars?: subgraph.GetSellersQueryQueryVariables): Promise<subgraph.SellerFieldsFragment[]>;
|
|
141
|
-
/**
|
|
142
|
-
* Returns the array of LENS tokenIds owned by a specified address
|
|
143
|
-
* @param address - Address of seller entity to query for.
|
|
144
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
145
|
-
* @returns Array of tokenIds
|
|
146
|
-
*/
|
|
147
|
-
fetchUserAuthTokens(address: string, tokenType: number): Promise<Array<string>>;
|
|
148
|
-
/**
|
|
149
|
-
* Returns seller entity from subgraph that owns the given auth token (if any).
|
|
150
|
-
* @param tokenId - tokenId of the Auth Token.
|
|
151
|
-
* @param tokenType - Type of the Auth Token (1 for LENS, ...).
|
|
152
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
153
|
-
* @returns Seller entity from subgraph.
|
|
154
|
-
*/
|
|
155
|
-
getSellerByAuthToken(tokenId: string, tokenType: number, queryVars?: subgraph.GetSellersQueryQueryVariables): Promise<subgraph.SellerFieldsFragment>;
|
|
156
|
-
/**
|
|
157
|
-
* Returns seller entities from subgraph.
|
|
158
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
159
|
-
* @returns Seller entities from subgraph.
|
|
160
|
-
*/
|
|
161
|
-
getSellers(queryVars?: subgraph.GetSellersQueryQueryVariables): Promise<subgraph.SellerFieldsFragment[]>;
|
|
162
|
-
/**
|
|
163
|
-
* Creates seller account by calling the `AccountHandlerFacet` contract.
|
|
164
|
-
* @param sellerToCreate - Addresses and contract URI to set in the seller account.
|
|
165
|
-
* @param overrides - Optional overrides.
|
|
166
|
-
* @returns Transaction response.
|
|
167
|
-
*/
|
|
168
|
-
createSeller(sellerToCreate: accounts.CreateSellerArgs, overrides?: Partial<{
|
|
169
|
-
contractAddress: string;
|
|
170
|
-
}>): Promise<TransactionResponse>;
|
|
171
|
-
/**
|
|
172
|
-
* Creates seller account and offer by calling the `OrchestrationHandlerFacet` contract.
|
|
173
|
-
* This transaction only succeeds if there is no existing seller account for the connected signer.
|
|
174
|
-
* @param sellerToCreate - Addresses to set in the seller account.
|
|
175
|
-
* @param offerToCreate - Offer arguments.
|
|
176
|
-
* @param overrides - Optional overrides.
|
|
177
|
-
* @returns Transaction response.
|
|
178
|
-
*/
|
|
179
|
-
createSellerAndOffer(sellerToCreate: accounts.CreateSellerArgs, offerToCreate: offers.CreateOfferArgs, overrides?: Partial<{
|
|
180
|
-
contractAddress: string;
|
|
181
|
-
}>): Promise<TransactionResponse>;
|
|
182
|
-
/**
|
|
183
|
-
* Updates seller account by calling the `AccountHandlerFacet` contract. Only callable
|
|
184
|
-
* by admin.
|
|
185
|
-
* @param sellerUpdates - Values to update.
|
|
186
|
-
* @param overrides - Optional overrides.
|
|
187
|
-
* @returns Transaction response.
|
|
188
|
-
*/
|
|
189
|
-
updateSeller(sellerUpdates: accounts.UpdateSellerArgs, overrides?: Partial<{
|
|
190
|
-
contractAddress: string;
|
|
191
|
-
}>): Promise<TransactionResponse>;
|
|
192
|
-
/**
|
|
193
|
-
* Returns buyer entity from subgraph.
|
|
194
|
-
* @param buyerId - ID of buyer entity to query for.
|
|
195
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
196
|
-
* @returns Buyer entity from subgraph.
|
|
197
|
-
*/
|
|
198
|
-
getBuyerById(buyerId: BigNumberish, queryVars?: accounts.subgraph.SingleBuyerQueryVariables): Promise<subgraph.BuyerFieldsFragment>;
|
|
199
|
-
/**
|
|
200
|
-
* Returns buyer entities from subgraph.
|
|
201
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
202
|
-
* @returns Buyer entities from subgraph.
|
|
203
|
-
*/
|
|
204
|
-
getBuyers(queryVars?: subgraph.GetBuyersQueryQueryVariables): Promise<subgraph.BuyerFieldsFragment[]>;
|
|
205
|
-
/**
|
|
206
|
-
* Creates a dispute resolver account by calling the `AccountHandlerFacet` contract.
|
|
207
|
-
* @param disputeResolverToCreate - Dispute resolver arguments.
|
|
208
|
-
* @returns Transaction response.
|
|
209
|
-
*/
|
|
210
|
-
createDisputeResolver(disputeResolverToCreate: accounts.CreateDisputeResolverArgs): Promise<TransactionResponse>;
|
|
211
|
-
/**
|
|
212
|
-
* Utility method to retrieve the created `exchangeId` from logs after calling `commitToOffer`.
|
|
213
|
-
* @param logs - Logs to search in.
|
|
214
|
-
* @returns Created exchange id.
|
|
215
|
-
*/
|
|
216
|
-
getDisputeResolverIdFromLogs(logs: Log[]): string | null;
|
|
217
|
-
/**
|
|
218
|
-
* Updates a dispute resolver account by calling the `AccountHandlerFacet` contract.
|
|
219
|
-
* Note, that the caller must be the specified `admin` address of the dispute resolver account.
|
|
220
|
-
* @param disputeResolverId - Id of dispute resolver to update.
|
|
221
|
-
* @param updates - Values to update for the given dispute resolver.
|
|
222
|
-
* @returns Transaction response.
|
|
223
|
-
*/
|
|
224
|
-
updateDisputeResolver(disputeResolverId: BigNumberish, updates: accounts.DisputeResolverUpdates): Promise<TransactionResponse>;
|
|
225
|
-
/**
|
|
226
|
-
* Activates a dispute resolver account by calling the `AccountHandlerFacet` contract.
|
|
227
|
-
* Note, that the caller needs to have the ADMIN role.
|
|
228
|
-
* @param disputeResolverId - Id of dispute resolver to activate.
|
|
229
|
-
* @returns Transaction response.
|
|
230
|
-
*/
|
|
231
|
-
activateDisputeResolver(disputeResolverId: BigNumberish): Promise<TransactionResponse>;
|
|
232
|
-
/**
|
|
233
|
-
* Adds fees to a dispute resolver account by calling the `AccountHandlerFacet`
|
|
234
|
-
* contract. Note, that the caller must be the specified `admin` address of the dispute
|
|
235
|
-
* resolver account.
|
|
236
|
-
* @param disputeResolverId - Id of dispute resolver.
|
|
237
|
-
* @param fees - Dispute resolution fees. Should only contain token addresses that are
|
|
238
|
-
* not already specified.
|
|
239
|
-
* @returns Transaction response.
|
|
240
|
-
*/
|
|
241
|
-
addFeesToDisputeResolver(disputeResolverId: BigNumberish, fees: accounts.DisputeResolutionFee[]): Promise<TransactionResponse>;
|
|
242
|
-
/**
|
|
243
|
-
* Adds sellers to the allow list of a dispute resolver account by calling the
|
|
244
|
-
* `AccountHandlerFacet` contract. Note, that the caller must be the specified
|
|
245
|
-
* `admin` address of the dispute resolver account.
|
|
246
|
-
* @param disputeResolverId - Id of dispute resolver.
|
|
247
|
-
* @param sellerAllowList - List of seller ids that are allowed to use the dispute resolver.
|
|
248
|
-
* Should only contain seller ids that are not part of the current allow list.
|
|
249
|
-
* @returns Transaction response.
|
|
250
|
-
*/
|
|
251
|
-
addSellersToDisputeResolverAllowList(disputeResolverId: BigNumberish, sellerAllowList: BigNumberish[]): Promise<TransactionResponse>;
|
|
252
|
-
/**
|
|
253
|
-
* Removes fees from a dispute resolver account by calling the `AccountHandlerFacet`
|
|
254
|
-
* contract. Note, that the caller must be the specified `admin` address of the dispute
|
|
255
|
-
* resolver account.
|
|
256
|
-
* @param disputeResolverId - Id of dispute resolver.
|
|
257
|
-
* @param feeTokenAddresses - Addresses of fee tokens to remove.
|
|
258
|
-
* @returns Transaction response.
|
|
259
|
-
*/
|
|
260
|
-
removeFeesFromDisputeResolver(disputeResolverId: BigNumberish, feeTokenAddresses: string[]): Promise<TransactionResponse>;
|
|
261
|
-
/**
|
|
262
|
-
* Removes sellers from the allow list of a dispute resolver account by calling the
|
|
263
|
-
* `AccountHandlerFacet` contract. Note, that the caller must be the specified
|
|
264
|
-
* `admin` address of the dispute resolver account.
|
|
265
|
-
* @param disputeResolverId - Id of dispute resolver.
|
|
266
|
-
* @param sellerAllowList - List of seller ids that should be removed from the allow
|
|
267
|
-
* list of a dispute resolver.
|
|
268
|
-
* @returns Transaction response.
|
|
269
|
-
*/
|
|
270
|
-
removeSellersFromDisputeResolverAllowList(disputeResolverId: BigNumberish, sellerAllowList: string[]): Promise<TransactionResponse>;
|
|
271
|
-
/**
|
|
272
|
-
* Returns dispute resolver entity from subgraph.
|
|
273
|
-
* @param disputeResolverId - ID of dispute resolver entity to query for.
|
|
274
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
275
|
-
* @returns Dispute resolver entity from subgraph.
|
|
276
|
-
*/
|
|
277
|
-
getDisputeResolverById(disputeResolverId: BigNumberish, queryVars?: accounts.subgraph.SingleDisputeResolverQueryVariables): Promise<subgraph.DisputeResolverFieldsFragment>;
|
|
278
|
-
/**
|
|
279
|
-
* Returns dispute resolver entities from subgraph.
|
|
280
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
281
|
-
* @returns Dispute resolver entities from subgraph.
|
|
282
|
-
*/
|
|
283
|
-
getDisputeResolvers(queryVars?: subgraph.GetDisputeResolversQueryQueryVariables): Promise<subgraph.DisputeResolverFieldsFragment[]>;
|
|
284
|
-
/**
|
|
285
|
-
* Creates offer by calling the `OfferHandlerFacet` contract.
|
|
286
|
-
* This transaction only succeeds if there is an existing seller account for connected signer.
|
|
287
|
-
* @param offerToCreate - Offer arguments.
|
|
288
|
-
* @param overrides - Optional overrides.
|
|
289
|
-
* @returns Transaction response.
|
|
290
|
-
*/
|
|
291
|
-
createOffer(offerToCreate: offers.CreateOfferArgs, overrides?: Partial<{
|
|
292
|
-
contractAddress: string;
|
|
293
|
-
}>): Promise<TransactionResponse>;
|
|
294
|
-
/**
|
|
295
|
-
* Creates a batch of offers by calling the `OfferHandlerFacet` contract.
|
|
296
|
-
* This transaction only succeeds if there is an existing seller account for connected signer.
|
|
297
|
-
* @param offersToCreate - Offer arguments.
|
|
298
|
-
* @param overrides - Optional overrides.
|
|
299
|
-
* @returns Transaction response.
|
|
300
|
-
*/
|
|
301
|
-
createOfferBatch(offersToCreate: offers.CreateOfferArgs[], overrides?: Partial<{
|
|
302
|
-
contractAddress: string;
|
|
303
|
-
}>): Promise<TransactionResponse>;
|
|
304
|
-
/**
|
|
305
|
-
* Utility method to retrieve the created `offerId` from logs after calling `createOffer`
|
|
306
|
-
* or `createOfferAndSeller`.
|
|
307
|
-
* @param logs - Logs to search in.
|
|
308
|
-
* @returns Created offer id.
|
|
309
|
-
*/
|
|
310
|
-
getCreatedOfferIdFromLogs(logs: Log[]): string | null;
|
|
311
|
-
/**
|
|
312
|
-
* Utility method to retrieve the created `offerIds` from logs after calling `createOfferBatch`
|
|
313
|
-
* @param logs - Logs to search in.
|
|
314
|
-
* @returns Array of created offerIds.
|
|
315
|
-
*/
|
|
316
|
-
getCreatedOfferIdsFromLogs(logs: Log[]): string[];
|
|
317
|
-
/**
|
|
318
|
-
* Utility method to retrieve the created `groupIds` from logs after calling `createGroup`
|
|
319
|
-
* @param logs - Logs to search in.
|
|
320
|
-
* @returns Array of group Ids.
|
|
321
|
-
*/
|
|
322
|
-
getCreatedGroupIdsFromLogs(logs: Log[]): string[];
|
|
323
|
-
/**
|
|
324
|
-
* Utility method to retrieve the created `sellerId` from logs after calling `createSeller`
|
|
325
|
-
* or `createOfferAndSeller`.
|
|
326
|
-
* @param logs - Logs to search in.
|
|
327
|
-
* @returns Created offer id.
|
|
328
|
-
*/
|
|
329
|
-
getCreatedSellerIdFromLogs(logs: Log[]): string | null;
|
|
330
|
-
/**
|
|
331
|
-
* Voids an existing offer by calling the `OfferHandlerFacet` contract.
|
|
332
|
-
* This transaction only succeeds if the connected signer is the `operator`.
|
|
333
|
-
* @param offerId - ID of offer to void.
|
|
334
|
-
* @param overrides - Optional overrides.
|
|
335
|
-
* @returns Transaction response.
|
|
336
|
-
*/
|
|
337
|
-
voidOffer(offerId: BigNumberish, overrides?: Partial<{
|
|
338
|
-
contractAddress: string;
|
|
339
|
-
}>): Promise<TransactionResponse>;
|
|
340
|
-
/**
|
|
341
|
-
* Voids a batch of existing offers by calling the `OfferHandlerFacet` contract.
|
|
342
|
-
* This transaction only succeeds if the connected signer is the `operator` of all
|
|
343
|
-
* provided offers.
|
|
344
|
-
* @param offerIds - IDs of offers to void.
|
|
345
|
-
* @param overrides - Optional overrides.
|
|
346
|
-
* @returns Transaction response.
|
|
347
|
-
*/
|
|
348
|
-
voidOfferBatch(offerIds: BigNumberish[], overrides?: Partial<{
|
|
349
|
-
contractAddress: string;
|
|
350
|
-
}>): Promise<TransactionResponse>;
|
|
351
|
-
/**
|
|
352
|
-
* Returns offer from subgraph.
|
|
353
|
-
* @param offerId - ID of offer.
|
|
354
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
355
|
-
* @returns Offer entity from subgraph.
|
|
356
|
-
*/
|
|
357
|
-
getOfferById(offerId: BigNumberish, queryVars?: offers.subgraph.SingleOfferQueryVariables): Promise<subgraph.OfferFieldsFragment>;
|
|
358
|
-
/**
|
|
359
|
-
* Returns offers from subgraph.
|
|
360
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
361
|
-
* @returns Offer entities from subgraph.
|
|
362
|
-
*/
|
|
363
|
-
getOffers(queryVars?: subgraph.GetOffersQueryQueryVariables): Promise<subgraph.OfferFieldsFragment[]>;
|
|
364
|
-
/**
|
|
365
|
-
* Renders contractual agreement for given offer.
|
|
366
|
-
* @param offerId - Id of offer to render agreement for.
|
|
367
|
-
* @returns Contractual agreement as string.
|
|
368
|
-
*/
|
|
369
|
-
renderContractualAgreementForOffer(offerId: BigNumberish): Promise<string>;
|
|
370
|
-
/**
|
|
371
|
-
* Renders contractual agreement for given offer.
|
|
372
|
-
* @param template - Mustache syntax based template.
|
|
373
|
-
* @param offerData - Offer data.
|
|
374
|
-
* @returns Contractual agreement as string.
|
|
375
|
-
*/
|
|
376
|
-
renderContractualAgreement(template: string, offerData: offers.CreateOfferArgs, offerMetadata: offers.AdditionalOfferMetadata): Promise<string>;
|
|
377
|
-
/**
|
|
378
|
-
* Returns the current allowance of the given token by calling the contract.
|
|
379
|
-
* @param exchangeToken - Address of exchange token.
|
|
380
|
-
* @param overrides - Optional overrides.
|
|
381
|
-
* @returns Allowance for given signer.
|
|
382
|
-
*/
|
|
383
|
-
getExchangeTokenAllowance(exchangeToken: string, overrides?: Partial<{
|
|
384
|
-
spender: string;
|
|
385
|
-
owner: string;
|
|
386
|
-
}>): Promise<string>;
|
|
387
|
-
/**
|
|
388
|
-
* Returns `name`, `decimals` and `symbol` of the given token by calling the contract.
|
|
389
|
-
* @param exchangeToken - Address exchange token.
|
|
390
|
-
* @returns Decimals, name and symbol.
|
|
391
|
-
*/
|
|
392
|
-
getExchangeTokenInfo(exchangeToken: string): Promise<ITokenInfo>;
|
|
393
|
-
/**
|
|
394
|
-
* Approves the given amount for the main protocol contract.
|
|
395
|
-
* @param exchangeToken - Address of token to approve.
|
|
396
|
-
* @param value - Amount of allowance.
|
|
397
|
-
* @param overrides - Optional overrides.
|
|
398
|
-
* @returns Transaction response.
|
|
399
|
-
*/
|
|
400
|
-
approveExchangeToken(exchangeToken: string, value: BigNumberish, overrides?: Partial<{
|
|
401
|
-
spender: string;
|
|
402
|
-
}>): Promise<TransactionResponse>;
|
|
403
|
-
getProtocolAllowance(exchangeToken: string, overrides?: Partial<{
|
|
404
|
-
spender: string;
|
|
405
|
-
owner: string;
|
|
406
|
-
}>): Promise<string>;
|
|
407
|
-
/**
|
|
408
|
-
* Deposit funds by calling the `FundsHandlerFacet` contract.
|
|
409
|
-
* @param sellerId - ID of seller account to deposit funds for.
|
|
410
|
-
* @param fundsAmount - Amount of funds.
|
|
411
|
-
* @param fundsTokenAddress - Address of funds token.
|
|
412
|
-
* @returns Transaction response.
|
|
413
|
-
*/
|
|
414
|
-
depositFunds(sellerId: BigNumberish, fundsAmount: BigNumberish, fundsTokenAddress?: string): Promise<TransactionResponse>;
|
|
415
|
-
/**
|
|
416
|
-
* Returns funds entity from subgraph.
|
|
417
|
-
* @param fundsId - ID of funds entity.
|
|
418
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
419
|
-
* @returns Funds entity from subgraph.
|
|
420
|
-
*/
|
|
421
|
-
getFundsById(fundsId: BigNumberish, queryVars?: subgraph.GetFundsByIdQueryVariables): Promise<subgraph.FundsEntityFieldsFragment>;
|
|
422
|
-
/**
|
|
423
|
-
* Returns funds entities from subgraph.
|
|
424
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
425
|
-
* @returns Funds entities from subgraph.
|
|
426
|
-
*/
|
|
427
|
-
getFunds(queryVars?: subgraph.GetFundsQueryVariables): Promise<subgraph.FundsEntityFieldsFragment[]>;
|
|
428
|
-
/**
|
|
429
|
-
* Withdraw selected funds by calling the `FundsHandlerFacet` contract.
|
|
430
|
-
* @param sellerId - ID of seller account to withdraw funds for.
|
|
431
|
-
* @param tokensToWithdraw - Addresses of funds tokens to withdraw.
|
|
432
|
-
* @param amountsToWithdraw - Amounts of funds token to withdraw.
|
|
433
|
-
* @returns Transaction response.
|
|
434
|
-
*/
|
|
435
|
-
withdrawFunds(sellerId: BigNumberish, tokensToWithdraw: Array<string>, amountsToWithdraw: Array<BigNumberish>): Promise<TransactionResponse>;
|
|
436
|
-
/**
|
|
437
|
-
* Withdraw all available funds by calling the `FundsHandlerFacet` contract.
|
|
438
|
-
* @param sellerId - ID of seller account to withdraw funds for.
|
|
439
|
-
* @returns Transaction response.
|
|
440
|
-
*/
|
|
441
|
-
withdrawAllAvailableFunds(sellerId: BigNumberish): Promise<TransactionResponse>;
|
|
442
|
-
/**
|
|
443
|
-
* Returns exchange entity from subgraph.
|
|
444
|
-
* @param exchangeId - ID of exchange entity.
|
|
445
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
446
|
-
* @returns Exchange entity from subgraph.
|
|
447
|
-
*/
|
|
448
|
-
getExchangeById(exchangeId: BigNumberish, queryVars?: subgraph.GetExchangeByIdQueryQueryVariables): Promise<subgraph.ExchangeFieldsFragment>;
|
|
449
|
-
/**
|
|
450
|
-
* Returns exchange entities from subgraph.
|
|
451
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
452
|
-
* @returns Exchange entities from subgraph.
|
|
453
|
-
*/
|
|
454
|
-
getExchanges(queryVars?: subgraph.GetExchangesQueryQueryVariables): Promise<subgraph.ExchangeFieldsFragment[]>;
|
|
455
|
-
/**
|
|
456
|
-
* Commits to an offer by calling the `ExchangeHandlerContract`.
|
|
457
|
-
* This transaction only succeeds if the seller has deposited funds.
|
|
458
|
-
* @param offerId - ID of offer to commit to.
|
|
459
|
-
* @param overrides - Optional overrides.
|
|
460
|
-
* @returns Transaction response.
|
|
461
|
-
*/
|
|
462
|
-
commitToOffer(offerId: BigNumberish, overrides?: Partial<{
|
|
463
|
-
buyer: string;
|
|
464
|
-
}>): Promise<TransactionResponse>;
|
|
465
|
-
/**
|
|
466
|
-
* Utility method to retrieve the created `exchangeId` from logs after calling `commitToOffer`.
|
|
467
|
-
* @param logs - Logs to search in.
|
|
468
|
-
* @returns Created exchange id.
|
|
469
|
-
*/
|
|
470
|
-
getCommittedExchangeIdFromLogs(logs: Log[]): string | null;
|
|
471
|
-
/**
|
|
472
|
-
* Revokes an existing voucher by calling the `ExchangeHandlerContract`.
|
|
473
|
-
* Callable by seller `operator`.
|
|
474
|
-
* @param exchangeId - ID of exchange to revoke.
|
|
475
|
-
* @returns Transaction response.
|
|
476
|
-
*/
|
|
477
|
-
revokeVoucher(exchangeId: BigNumberish): Promise<TransactionResponse>;
|
|
478
|
-
/**
|
|
479
|
-
* Cancels an existing voucher by calling the `ExchangeHandlerContract`.
|
|
480
|
-
* Callable by buyer.
|
|
481
|
-
* @param exchangeId - ID of exchange to cancel.
|
|
482
|
-
* @returns Transaction response.
|
|
483
|
-
*/
|
|
484
|
-
cancelVoucher(exchangeId: BigNumberish): Promise<TransactionResponse>;
|
|
485
|
-
/**
|
|
486
|
-
* Redeems an existing voucher by calling the `ExchangeHandlerContract`.
|
|
487
|
-
* Callable by buyer.
|
|
488
|
-
* @param exchangeId - ID of exchange to redeem.
|
|
489
|
-
* @returns Transaction response.
|
|
490
|
-
*/
|
|
491
|
-
redeemVoucher(exchangeId: BigNumberish): Promise<TransactionResponse>;
|
|
492
|
-
/**
|
|
493
|
-
* Completes an existing voucher by calling the `ExchangeHandlerContract`.
|
|
494
|
-
* Callable by buyer or seller operator.
|
|
495
|
-
* @param exchangeId - ID of exchange to complete.
|
|
496
|
-
* @returns Transaction response.
|
|
497
|
-
*/
|
|
498
|
-
completeExchange(exchangeId: BigNumberish): Promise<TransactionResponse>;
|
|
499
|
-
/**
|
|
500
|
-
* Completes a batch of existing vouchers by calling the `ExchangeHandlerContract`.
|
|
501
|
-
* Callable by buyer or seller operator.
|
|
502
|
-
* @param exchangeIds - IDs of exchange to complete.
|
|
503
|
-
* @returns Transaction response.
|
|
504
|
-
*/
|
|
505
|
-
completeExchangeBatch(exchangeIds: BigNumberish[]): Promise<TransactionResponse>;
|
|
506
|
-
/**
|
|
507
|
-
* Expires an existing voucher by calling the `ExchangeHandlerContract`.
|
|
508
|
-
* @param exchangeId - ID of exchange to expire.
|
|
509
|
-
* @returns Transaction response.
|
|
510
|
-
*/
|
|
511
|
-
expireVoucher(exchangeId: BigNumberish): Promise<TransactionResponse>;
|
|
512
|
-
/**
|
|
513
|
-
* Returns dispute entity from subgraph.
|
|
514
|
-
* @param disputeId - ID of dispute entity.
|
|
515
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
516
|
-
* @returns Dispute entity from subgraph.
|
|
517
|
-
*/
|
|
518
|
-
getDisputeById(disputeId: BigNumberish, queryVars?: disputes.subgraph.SingleDisputeQueryVariables): Promise<subgraph.DisputeFieldsFragment>;
|
|
519
|
-
/**
|
|
520
|
-
* Returns dispute entities from subgraph.
|
|
521
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
522
|
-
* @returns Dispute entities from subgraph.
|
|
523
|
-
*/
|
|
524
|
-
getDisputes(queryVars?: subgraph.GetDisputesQueryQueryVariables): Promise<subgraph.DisputeFieldsFragment[]>;
|
|
525
|
-
/**
|
|
526
|
-
* Raises a dispute by calling the `DisputeHandlerContract`.
|
|
527
|
-
* @param exchangeId - ID of exchange to dispute.
|
|
528
|
-
* @returns Transaction response.
|
|
529
|
-
*/
|
|
530
|
-
raiseDispute(exchangeId: BigNumberish): Promise<TransactionResponse>;
|
|
531
|
-
/**
|
|
532
|
-
* Retracts a dispute by calling the `DisputeHandlerContract`.
|
|
533
|
-
* @param exchangeId - ID of disputed exchange.
|
|
534
|
-
* @returns Transaction response.
|
|
535
|
-
*/
|
|
536
|
-
retractDispute(exchangeId: BigNumberish): Promise<TransactionResponse>;
|
|
537
|
-
/**
|
|
538
|
-
* Extends the dispute timeout by calling the `DisputeHandlerContract`.
|
|
539
|
-
* @param exchangeId - ID of disputed exchange.
|
|
540
|
-
* @param newDisputeTimeout - New dispute timeout in seconds.
|
|
541
|
-
* @returns Transaction response.
|
|
542
|
-
*/
|
|
543
|
-
extendDisputeTimeout(exchangeId: BigNumberish, newDisputeTimeout: BigNumberish): Promise<TransactionResponse>;
|
|
544
|
-
/**
|
|
545
|
-
* Expires a dispute by calling the `DisputeHandlerContract`.
|
|
546
|
-
* @param exchangeId - ID of disputed exchange.
|
|
547
|
-
* @returns Transaction response.
|
|
548
|
-
*/
|
|
549
|
-
expireDispute(exchangeId: BigNumberish): Promise<TransactionResponse>;
|
|
550
|
-
/**
|
|
551
|
-
* Expires many disputes by calling the `DisputeHandlerContract`.
|
|
552
|
-
* @param exchangeIds - IDs of disputed exchanges.
|
|
553
|
-
* @returns Transaction response.
|
|
554
|
-
*/
|
|
555
|
-
expireDisputeBatch(exchangeIds: BigNumberish[]): Promise<TransactionResponse>;
|
|
556
|
-
/**
|
|
557
|
-
* Resolves dispute by calling the `DisputeHandlerContract`. If caller is `buyer` then
|
|
558
|
-
* signature of `seller` is required as an argument. If caller if `seller` then vice-versa.
|
|
559
|
-
* The signature can be retrieved by calling the method
|
|
560
|
-
* `CoreSDK.signDisputeResolutionProposal`.
|
|
561
|
-
* @param args - Dispute resolve arguments:
|
|
562
|
-
* - `args.exchangeId` - ID of disputed exchange.
|
|
563
|
-
* - `args.buyerPercent` - Percentage of deposit the buyer gets.
|
|
564
|
-
* - `args.sigR` - r signature value of counterparty.
|
|
565
|
-
* - `args.sigS` - s signature value of counterparty.
|
|
566
|
-
* - `args.sigV` - v signature value of counterparty.
|
|
567
|
-
* @returns Transaction response.
|
|
568
|
-
*/
|
|
569
|
-
resolveDispute(args: {
|
|
570
|
-
exchangeId: BigNumberish;
|
|
571
|
-
buyerPercentBasisPoints: BigNumberish;
|
|
572
|
-
sigR: BytesLike;
|
|
573
|
-
sigS: BytesLike;
|
|
574
|
-
sigV: BigNumberish;
|
|
575
|
-
}): Promise<TransactionResponse>;
|
|
576
|
-
/**
|
|
577
|
-
* Escalates dispute by calling the `DisputeHandlerContract`.
|
|
578
|
-
* @param exchangeId - ID of disputed exchange.
|
|
579
|
-
* @returns Transaction response.
|
|
580
|
-
*/
|
|
581
|
-
escalateDispute(exchangeId: BigNumberish): Promise<TransactionResponse>;
|
|
582
|
-
/**
|
|
583
|
-
* Decides dispute by calling the `DisputeHandlerContract`.
|
|
584
|
-
* @param exchangeId - ID of disputed exchange.
|
|
585
|
-
* @param buyerPercent - Percentage of deposit buyer gets.
|
|
586
|
-
* @returns Transaction response.
|
|
587
|
-
*/
|
|
588
|
-
decideDispute(exchangeId: BigNumberish, buyerPercent: BigNumberish): Promise<TransactionResponse>;
|
|
589
|
-
/**
|
|
590
|
-
* Refuses escalated dispute by calling the `DisputeHandlerContract`.
|
|
591
|
-
* @param exchangeId - ID of disputed exchange.
|
|
592
|
-
* @returns Transaction response.
|
|
593
|
-
*/
|
|
594
|
-
refuseEscalatedDispute(exchangeId: BigNumberish): Promise<TransactionResponse>;
|
|
595
|
-
/**
|
|
596
|
-
* Expires escalated dispute by calling the `DisputeHandlerContract`.
|
|
597
|
-
* @param exchangeId - ID of disputed exchange.
|
|
598
|
-
* @returns Transaction response.
|
|
599
|
-
*/
|
|
600
|
-
expireEscalatedDispute(exchangeId: BigNumberish): Promise<TransactionResponse>;
|
|
601
|
-
/**
|
|
602
|
-
* Signs dispute resolution message.
|
|
603
|
-
* @param args - Dispute resolve arguments:
|
|
604
|
-
* - `args.exchangeId` - ID of disputed exchange.
|
|
605
|
-
* - `args.buyerPercentBasisPoints` - Percentage of deposit the buyer gets.
|
|
606
|
-
* @returns Signature.
|
|
607
|
-
*/
|
|
608
|
-
signDisputeResolutionProposal(args: {
|
|
609
|
-
exchangeId: BigNumberish;
|
|
610
|
-
buyerPercentBasisPoints: BigNumberish;
|
|
611
|
-
}): Promise<{
|
|
612
|
-
r: string;
|
|
613
|
-
s: string;
|
|
614
|
-
v: number;
|
|
615
|
-
}>;
|
|
616
|
-
/**
|
|
617
|
-
* Encodes and signs a meta transaction that can be relayed.
|
|
618
|
-
* @param args - Meta transaction args.
|
|
619
|
-
* @returns Signature.
|
|
620
|
-
*/
|
|
621
|
-
signMetaTx(args: Omit<Parameters<typeof metaTx.handler.signMetaTx>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
622
|
-
/**
|
|
623
|
-
* Encodes and signs a meta transaction for `createSeller` that can be relayed.
|
|
624
|
-
* @param args - Meta transaction args.
|
|
625
|
-
* @returns Signature.
|
|
626
|
-
*/
|
|
627
|
-
signMetaTxCreateSeller(args: Omit<Parameters<typeof metaTx.handler.signMetaTxCreateSeller>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
628
|
-
/**
|
|
629
|
-
* Encodes and signs a meta transaction for `createOffer` that can be relayed.
|
|
630
|
-
* @param args - Meta transaction args.
|
|
631
|
-
* @returns Signature.
|
|
632
|
-
*/
|
|
633
|
-
signMetaTxCreateOffer(args: Omit<Parameters<typeof metaTx.handler.signMetaTxCreateOffer>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
634
|
-
/**
|
|
635
|
-
* Encodes and signs a meta transaction for `createOfferBatch` that can be relayed.
|
|
636
|
-
* @param args - Meta transaction args.
|
|
637
|
-
* @returns Signature.
|
|
638
|
-
*/
|
|
639
|
-
signMetaTxCreateOfferBatch(args: Omit<Parameters<typeof metaTx.handler.signMetaTxCreateOfferBatch>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
640
|
-
/**
|
|
641
|
-
* Encodes and signs a meta transaction for `createGroup` that can be relayed.
|
|
642
|
-
* @param args - Meta transaction args.
|
|
643
|
-
* @returns Signature.
|
|
644
|
-
*/
|
|
645
|
-
signMetaTxCreateGroup(args: Omit<Parameters<typeof metaTx.handler.signMetaTxCreateGroup>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
646
|
-
/**
|
|
647
|
-
* Encodes and signs a meta transaction for `createOfferWithCondition` that can be relayed.
|
|
648
|
-
* @param args - Meta transaction args.
|
|
649
|
-
* @returns Signature.
|
|
650
|
-
*/
|
|
651
|
-
signMetaTxCreateOfferWithCondition(args: Omit<Parameters<typeof metaTx.handler.signMetaTxCreateOfferWithCondition>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
652
|
-
/**
|
|
653
|
-
* Encodes and signs a meta transaction for `voidOffer` that can be relayed.
|
|
654
|
-
* @param args - Meta transaction args.
|
|
655
|
-
* @returns Signature.
|
|
656
|
-
*/
|
|
657
|
-
signMetaTxVoidOffer(args: Omit<Parameters<typeof metaTx.handler.signMetaTxVoidOffer>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
658
|
-
/**
|
|
659
|
-
* Encodes and signs a meta transaction for `voidOfferBatch` that can be relayed.
|
|
660
|
-
* @param args - Meta transaction args.
|
|
661
|
-
* @returns Signature.
|
|
662
|
-
*/
|
|
663
|
-
signMetaTxVoidOfferBatch(args: Omit<Parameters<typeof metaTx.handler.signMetaTxVoidOfferBatch>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
664
|
-
/**
|
|
665
|
-
* Encodes and signs a meta transaction for `completeExchangeBatch` that can be relayed.
|
|
666
|
-
* @param args - Meta transaction args.
|
|
667
|
-
* @returns Signature.
|
|
668
|
-
*/
|
|
669
|
-
signMetaTxCompleteExchange(args: Omit<Parameters<typeof metaTx.handler.signMetaTxCompleteExchange>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
670
|
-
/**
|
|
671
|
-
* Encodes and signs a meta transaction for `completeExchangeBatch` that can be relayed.
|
|
672
|
-
* @param args - Meta transaction args.
|
|
673
|
-
* @returns Signature.
|
|
674
|
-
*/
|
|
675
|
-
signMetaTxCompleteExchangeBatch(args: Omit<Parameters<typeof metaTx.handler.signMetaTxCompleteExchangeBatch>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
676
|
-
/**
|
|
677
|
-
* Encodes and signs a meta transaction for `commitToOffer` that can be relayed.
|
|
678
|
-
* @param args - Meta transaction args.
|
|
679
|
-
* @returns Signature.
|
|
680
|
-
*/
|
|
681
|
-
signMetaTxCommitToOffer(args: Omit<Parameters<typeof metaTx.handler.signMetaTxCommitToOffer>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
682
|
-
/**
|
|
683
|
-
* Encodes and signs a meta transaction for `cancelVoucher` that can be relayed.
|
|
684
|
-
* @param args - Meta transaction args.
|
|
685
|
-
* @returns Signature.
|
|
686
|
-
*/
|
|
687
|
-
signMetaTxCancelVoucher(args: Omit<Parameters<typeof metaTx.handler.signMetaTxCancelVoucher>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
688
|
-
/**
|
|
689
|
-
* Encodes and signs a meta transaction for `redeemVoucher` that can be relayed.
|
|
690
|
-
* @param args - Meta transaction args.
|
|
691
|
-
* @returns Signature.
|
|
692
|
-
*/
|
|
693
|
-
signMetaTxRedeemVoucher(args: Omit<Parameters<typeof metaTx.handler.signMetaTxRedeemVoucher>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
694
|
-
/**
|
|
695
|
-
* Encodes and signs a meta transaction for `expireVoucher` that can be relayed.
|
|
696
|
-
* @param args - Meta transaction args.
|
|
697
|
-
* @returns Signature.
|
|
698
|
-
*/
|
|
699
|
-
signMetaTxExpireVoucher(args: Omit<Parameters<typeof metaTx.handler.signMetaTxExpireVoucher>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
700
|
-
/**
|
|
701
|
-
* Encodes and signs a meta transaction for `revokeVoucher` that can be relayed.
|
|
702
|
-
* @param args - Meta transaction args.
|
|
703
|
-
* @returns Signature.
|
|
704
|
-
*/
|
|
705
|
-
signMetaTxRevokeVoucher(args: Omit<Parameters<typeof metaTx.handler.signMetaTxRevokeVoucher>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
706
|
-
/**
|
|
707
|
-
* Encodes and signs a meta transaction for `retractDispute` that can be relayed.
|
|
708
|
-
* @param args - Meta transaction args.
|
|
709
|
-
* @returns Signature.
|
|
710
|
-
*/
|
|
711
|
-
signMetaTxRetractDispute(args: Omit<Parameters<typeof metaTx.handler.signMetaTxRetractDispute>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
712
|
-
/**
|
|
713
|
-
* Encodes and signs a meta transaction for `escalateDispute` that can be relayed.
|
|
714
|
-
* @param args - Meta transaction args.
|
|
715
|
-
* @returns Signature.
|
|
716
|
-
*/
|
|
717
|
-
signMetaTxEscalateDispute(args: Omit<Parameters<typeof metaTx.handler.signMetaTxEscalateDispute>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
718
|
-
/**
|
|
719
|
-
* Encodes and signs a meta transaction for `raiseDispute` that can be relayed.
|
|
720
|
-
* @param args - Meta transaction args.
|
|
721
|
-
* @returns Signature.
|
|
722
|
-
*/
|
|
723
|
-
signMetaTxRaiseDispute(args: Omit<Parameters<typeof metaTx.handler.signMetaTxRaiseDispute>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
724
|
-
/**
|
|
725
|
-
* Encodes and signs a meta transaction for `resolveDispute` that can be relayed.
|
|
726
|
-
* @param args - Meta transaction args.
|
|
727
|
-
* @returns Signature.
|
|
728
|
-
*/
|
|
729
|
-
signMetaTxResolveDispute(args: Omit<Parameters<typeof metaTx.handler.signMetaTxResolveDispute>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
730
|
-
/**
|
|
731
|
-
* Encodes and signs a meta transaction for `extendDisputeTimeout` that can be relayed.
|
|
732
|
-
* @param args - Meta transaction args.
|
|
733
|
-
* @returns Signature.
|
|
734
|
-
*/
|
|
735
|
-
signMetaTxExtendDisputeTimeout(args: Omit<Parameters<typeof metaTx.handler.signMetaTxExtendDisputeTimeout>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
736
|
-
/**
|
|
737
|
-
* Encodes and signs a meta transaction for `withdrawFunds` that can be relayed.
|
|
738
|
-
* @param args - Meta transaction args.
|
|
739
|
-
* @returns Signature.
|
|
740
|
-
*/
|
|
741
|
-
signMetaTxWithdrawFunds(args: Omit<Parameters<typeof metaTx.handler.signMetaTxWithdrawFunds>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
742
|
-
/**
|
|
743
|
-
* Encodes and signs a meta transaction for `depositFunds` that can be relayed.
|
|
744
|
-
* @param args - Meta transaction args.
|
|
745
|
-
* @returns Signature.
|
|
746
|
-
*/
|
|
747
|
-
signMetaTxDepositFunds(args: Omit<Parameters<typeof metaTx.handler.signMetaTxDepositFunds>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<metaTx.handler.SignedMetaTx>;
|
|
748
|
-
/**
|
|
749
|
-
* Relay a meta transaction,
|
|
750
|
-
* @param metaTxParams - Required params for meta transaction.
|
|
751
|
-
* @param overrides - Optional overrides.
|
|
752
|
-
* @returns Transaction response.
|
|
753
|
-
*/
|
|
754
|
-
relayMetaTransaction(metaTxParams: {
|
|
755
|
-
functionName: string;
|
|
756
|
-
functionSignature: BytesLike;
|
|
757
|
-
nonce: BigNumberish;
|
|
758
|
-
sigR: BytesLike;
|
|
759
|
-
sigS: BytesLike;
|
|
760
|
-
sigV: BigNumberish;
|
|
761
|
-
}, overrides?: Partial<{
|
|
762
|
-
userAddress: string;
|
|
763
|
-
contractAddress: string;
|
|
764
|
-
metaTxConfig: Partial<Omit<MetaTxConfig, "apiIds"> & {
|
|
765
|
-
apiId: string;
|
|
766
|
-
}>;
|
|
767
|
-
metaTransactionMethod: string;
|
|
768
|
-
}>): Promise<TransactionResponse>;
|
|
769
|
-
/**
|
|
770
|
-
* Encodes and signs a native "token.approve()" meta transaction that can be relayed.
|
|
771
|
-
* @param exchangeToken - The address of the token contract.
|
|
772
|
-
* @param value - The value to be approved.
|
|
773
|
-
* @param overrides - Optionally specify a spender address (default is the protocol contract address).
|
|
774
|
-
* @returns Signature.
|
|
775
|
-
*/
|
|
776
|
-
signNativeMetaTxApproveExchangeToken(exchangeToken: string, value: BigNumberish, overrides?: Partial<{
|
|
777
|
-
spender: string;
|
|
778
|
-
}>): Promise<metaTx.handler.SignedMetaTx>;
|
|
779
|
-
/**
|
|
780
|
-
* Relay a native meta transaction,
|
|
781
|
-
* @param metaTxParams - Required params for meta transaction.
|
|
782
|
-
* @param overrides - Optional overrides.
|
|
783
|
-
* @returns Transaction response.
|
|
784
|
-
*/
|
|
785
|
-
relayNativeMetaTransaction(contractAddress: string, metaTxParams: {
|
|
786
|
-
functionSignature: BytesLike;
|
|
787
|
-
sigR: BytesLike;
|
|
788
|
-
sigS: BytesLike;
|
|
789
|
-
sigV: BigNumberish;
|
|
790
|
-
}, overrides?: Partial<{
|
|
791
|
-
userAddress: string;
|
|
792
|
-
metaTxConfig: Partial<Omit<MetaTxConfig, "apiIds"> & {
|
|
793
|
-
apiId: string;
|
|
794
|
-
}>;
|
|
795
|
-
metaTransactionMethod: string;
|
|
796
|
-
}>): Promise<TransactionResponse>;
|
|
797
|
-
/**
|
|
798
|
-
* Returns information of submitted meta transaction.
|
|
799
|
-
* See https://docs.biconomy.io/api/native-meta-tx/get-retried-hashes.
|
|
800
|
-
* @param originalMetaTxHash - Original meta transaction as returned by `coreSDK.relayMetaTransaction`
|
|
801
|
-
* @param overrides - Optional overrides for meta transaction config.
|
|
802
|
-
* @returns - Additional meta transaction information.
|
|
803
|
-
*/
|
|
804
|
-
getResubmittedMetaTx(originalMetaTxHash: string, overrides?: Partial<{
|
|
805
|
-
contractAddress: string;
|
|
806
|
-
metaTxConfig: Partial<Omit<MetaTxConfig, "apiIds"> & {
|
|
807
|
-
apiId: string;
|
|
808
|
-
}>;
|
|
809
|
-
metaTransactionMethod: string;
|
|
810
|
-
}>): Promise<GetRetriedHashesData>;
|
|
811
|
-
private assertAndGetMetaTxConfig;
|
|
812
|
-
/**
|
|
813
|
-
* Returns event logs from subgraph.
|
|
814
|
-
* @param queryVars - Optional query variables to skip, order or filter.
|
|
815
|
-
* @returns Event log entities from subgraph.
|
|
816
|
-
*/
|
|
817
|
-
getEventLogs(queryVars?: subgraph.GetEventLogsQueryQueryVariables): Promise<subgraph.BaseEventLogFieldsFragment[]>;
|
|
818
|
-
/**
|
|
819
|
-
* Creates a group of contract addresses
|
|
820
|
-
* @param groupToCreate - group with the contract condition
|
|
821
|
-
* @param overrides - Optional overrides.
|
|
822
|
-
* @returns Transaction response.
|
|
823
|
-
*/
|
|
824
|
-
createGroup(groupToCreate: CreateGroupArgs, overrides?: Partial<{
|
|
825
|
-
contractAddress: string;
|
|
826
|
-
}>): Promise<TransactionResponse>;
|
|
827
|
-
/**
|
|
828
|
-
* Creates an offer with a specific conditions
|
|
829
|
-
* @param offerToCreate - Offer arguments.
|
|
830
|
-
* @param condition - contract condition applied to the offer
|
|
831
|
-
* @param overrides - Optional overrides.
|
|
832
|
-
* @returns Transaction response.
|
|
833
|
-
*/
|
|
834
|
-
createOfferWithCondition(offerToCreate: offers.CreateOfferArgs, condition: ConditionStruct, overrides?: Partial<{
|
|
835
|
-
contractAddress: string;
|
|
836
|
-
}>): Promise<TransactionResponse>;
|
|
837
|
-
/**
|
|
838
|
-
* Creates a seller account and offer with a specific conditions
|
|
839
|
-
* This transaction only succeeds if there is no existing seller account for the connected signer.
|
|
840
|
-
* @param sellerToCreate - Addresses to set in the seller account.
|
|
841
|
-
* @param offerToCreate - Offer arguments.
|
|
842
|
-
* @param condition - contract condition applied to the offer
|
|
843
|
-
* @param overrides - Optional overrides.
|
|
844
|
-
* @returns Transaction response.
|
|
845
|
-
*/
|
|
846
|
-
createSellerAndOfferWithCondition(sellerToCreate: accounts.CreateSellerArgs, offerToCreate: offers.CreateOfferArgs, condition: ConditionStruct, overrides?: Partial<{
|
|
847
|
-
contractAddress: string;
|
|
848
|
-
}>): Promise<TransactionResponse>;
|
|
45
|
+
}
|
|
46
|
+
export interface CoreSDK extends MetadataMixin, AccountsMixin, OfferMixin, FundsMixin, ExchangesMixin, DisputesMixin, MetaTxMixin, NativeMetaTxMixin, GroupsMixin, OrchestrationMixin, EventLogsMixin {
|
|
849
47
|
}
|
|
850
48
|
//# sourceMappingURL=core-sdk.d.ts.map
|