@opensea/sdk 11.7.2 → 11.9.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.
Files changed (87) hide show
  1. package/README.md +46 -14
  2. package/lib/abi/abis.d.ts +16 -0
  3. package/lib/abi/abis.js +13 -1
  4. package/lib/abi/abis.js.map +1 -1
  5. package/lib/api/api.d.ts +11 -3
  6. package/lib/api/api.js +17 -5
  7. package/lib/api/api.js.map +1 -1
  8. package/lib/api/collections.d.ts +7 -0
  9. package/lib/api/collections.js +10 -1
  10. package/lib/api/collections.js.map +1 -1
  11. package/lib/api/fetcher.d.ts +5 -2
  12. package/lib/api/walletAuth.d.ts +7 -0
  13. package/lib/api/walletAuth.js +8 -1
  14. package/lib/api/walletAuth.js.map +1 -1
  15. package/lib/constants.d.ts +6 -0
  16. package/lib/constants.js +7 -1
  17. package/lib/constants.js.map +1 -1
  18. package/lib/index.d.ts +1 -1
  19. package/lib/orders/erc20Fulfillment.d.ts +41 -0
  20. package/lib/orders/erc20Fulfillment.js +190 -0
  21. package/lib/orders/erc20Fulfillment.js.map +1 -0
  22. package/lib/orders/orderUseCase.d.ts +18 -0
  23. package/lib/orders/orderUseCase.js +29 -0
  24. package/lib/orders/orderUseCase.js.map +1 -0
  25. package/lib/orders/privateListings.js +8 -0
  26. package/lib/orders/privateListings.js.map +1 -1
  27. package/lib/sdk/base.d.ts +19 -7
  28. package/lib/sdk/base.js +19 -7
  29. package/lib/sdk/base.js.map +1 -1
  30. package/lib/sdk/cancellation.d.ts +2 -1
  31. package/lib/sdk/cancellation.js +2 -0
  32. package/lib/sdk/cancellation.js.map +1 -1
  33. package/lib/sdk/fulfillment.d.ts +57 -3
  34. package/lib/sdk/fulfillment.js +147 -4
  35. package/lib/sdk/fulfillment.js.map +1 -1
  36. package/lib/sdk/orders.d.ts +16 -3
  37. package/lib/sdk/orders.js +27 -13
  38. package/lib/sdk/orders.js.map +1 -1
  39. package/lib/stream/client.d.ts +67 -0
  40. package/lib/stream/client.js +174 -0
  41. package/lib/stream/client.js.map +1 -0
  42. package/lib/stream/constants.d.ts +3 -0
  43. package/lib/stream/constants.js +8 -0
  44. package/lib/stream/constants.js.map +1 -0
  45. package/lib/stream/helpers.d.ts +1 -0
  46. package/lib/stream/helpers.js +8 -0
  47. package/lib/stream/helpers.js.map +1 -0
  48. package/lib/stream/index.d.ts +17 -0
  49. package/lib/stream/index.js +34 -0
  50. package/lib/stream/index.js.map +1 -0
  51. package/lib/stream/transport/phoenix.d.ts +121 -0
  52. package/lib/stream/transport/phoenix.js +642 -0
  53. package/lib/stream/transport/phoenix.js.map +1 -0
  54. package/lib/stream/transport/types.d.ts +85 -0
  55. package/lib/stream/transport/types.js +24 -0
  56. package/lib/stream/transport/types.js.map +1 -0
  57. package/lib/stream/types.d.ts +269 -0
  58. package/lib/stream/types.js +29 -0
  59. package/lib/stream/types.js.map +1 -0
  60. package/lib/types.d.ts +14 -0
  61. package/lib/utils/units.d.ts +5 -0
  62. package/lib/utils/units.js +48 -9
  63. package/lib/utils/units.js.map +1 -1
  64. package/package.json +11 -10
  65. package/src/abi/abis.ts +13 -0
  66. package/src/api/api.ts +21 -5
  67. package/src/api/collections.ts +14 -1
  68. package/src/api/fetcher.ts +5 -2
  69. package/src/api/walletAuth.ts +9 -0
  70. package/src/constants.ts +8 -0
  71. package/src/index.ts +1 -1
  72. package/src/orders/erc20Fulfillment.ts +218 -0
  73. package/src/orders/orderUseCase.ts +34 -0
  74. package/src/orders/privateListings.ts +15 -0
  75. package/src/sdk/base.ts +20 -6
  76. package/src/sdk/cancellation.ts +4 -1
  77. package/src/sdk/fulfillment.ts +188 -6
  78. package/src/sdk/orders.ts +27 -15
  79. package/src/stream/client.ts +277 -0
  80. package/src/stream/constants.ts +5 -0
  81. package/src/stream/helpers.ts +3 -0
  82. package/src/stream/index.ts +18 -0
  83. package/src/stream/transport/phoenix.ts +815 -0
  84. package/src/stream/transport/types.ts +91 -0
  85. package/src/stream/types.ts +314 -0
  86. package/src/types.ts +14 -0
  87. package/src/utils/units.ts +54 -9
@@ -0,0 +1,190 @@
1
+ "use strict";
2
+ /**
3
+ * Helpers for ERC20-denominated listing fulfillment.
4
+ *
5
+ * When a listing is priced in an ERC20 token instead of the native currency,
6
+ * `transaction.value` is `0` and Seaport pulls the payment from the buyer with
7
+ * `transferFrom`. That only works if the buyer has already approved the spender,
8
+ * so the fulfillment reverts with a bare "execution reverted" when they haven't.
9
+ * These helpers read the payment token and amount out of the API's fulfillment
10
+ * input data so the SDK can check the allowance before spending gas.
11
+ */
12
+ Object.defineProperty(exports, "__esModule", { value: true });
13
+ exports.ZERO_CONDUIT_KEY = void 0;
14
+ exports.toBigInt = toBigInt;
15
+ exports.getErc20Payment = getErc20Payment;
16
+ exports.getFulfillerConduitKey = getFulfillerConduitKey;
17
+ exports.isZeroConduitKey = isZeroConduitKey;
18
+ /** Seaport `ItemType` for an ERC20 item. 0 is native, and anything >= 2 is an NFT. */
19
+ const ITEM_TYPE_ERC20 = 1;
20
+ /**
21
+ * Seaport `BasicOrderRouteType` values where the fulfiller pays with an ERC20
22
+ * token: `ERC20_TO_ERC721` (2) and `ERC20_TO_ERC1155` (3). Routes 0-1 are
23
+ * native-priced listings; routes 4-5 are offer fulfillments, where the fulfiller
24
+ * provides the NFT and the ERC20 comes from the offerer instead.
25
+ */
26
+ const ERC20_PAYMENT_ROUTES = new Set([2, 3]);
27
+ /** A `bytes32(0)` conduit key means Seaport transfers directly, with no conduit. */
28
+ exports.ZERO_CONDUIT_KEY = `0x${"0".repeat(64)}`;
29
+ /**
30
+ * Coerce a value an RPC adapter may return as a bigint, a decimal string, or a
31
+ * number into a bigint. Returns null for anything else.
32
+ */
33
+ function toBigInt(value) {
34
+ if (typeof value === "bigint") {
35
+ return value;
36
+ }
37
+ if (typeof value === "number" && Number.isInteger(value)) {
38
+ return BigInt(value);
39
+ }
40
+ if (typeof value === "string" && /^\d+$/.test(value.trim())) {
41
+ return BigInt(value.trim());
42
+ }
43
+ return null;
44
+ }
45
+ function toNumber(value) {
46
+ const asBigInt = toBigInt(value);
47
+ return asBigInt === null ? null : Number(asBigInt);
48
+ }
49
+ function isRecord(value) {
50
+ return typeof value === "object" && value !== null;
51
+ }
52
+ /**
53
+ * Sum the ERC20 consideration items of a listing, which together are what the
54
+ * fulfiller pays (seller proceeds plus marketplace and creator fees).
55
+ *
56
+ * Returns null unless every consideration item is the same ERC20 token. A native
57
+ * item means the listing is native-priced, an NFT item means this is an offer
58
+ * fulfillment rather than a purchase, and mixed tokens are not something we can
59
+ * express as a single allowance.
60
+ */
61
+ function sumErc20Consideration(consideration) {
62
+ if (!Array.isArray(consideration) || consideration.length === 0) {
63
+ return null;
64
+ }
65
+ let token = null;
66
+ let total = 0n;
67
+ for (const rawItem of consideration) {
68
+ if (!isRecord(rawItem)) {
69
+ return null;
70
+ }
71
+ const itemType = toNumber(rawItem.itemType);
72
+ if (itemType !== ITEM_TYPE_ERC20) {
73
+ // Native payment, an NFT in the consideration, or an unreadable item type.
74
+ return null;
75
+ }
76
+ const itemToken = rawItem.token;
77
+ if (typeof itemToken !== "string") {
78
+ return null;
79
+ }
80
+ if (token === null) {
81
+ token = itemToken;
82
+ }
83
+ else if (token.toLowerCase() !== itemToken.toLowerCase()) {
84
+ return null;
85
+ }
86
+ const amount = toBigInt(rawItem.startAmount);
87
+ if (amount === null) {
88
+ return null;
89
+ }
90
+ total += amount;
91
+ }
92
+ return token === null ? null : { token, amount: total };
93
+ }
94
+ /**
95
+ * Sum the ERC20 payment for a basic order, whose consideration is flattened into
96
+ * `considerationAmount` plus one entry per `additionalRecipients` fee.
97
+ */
98
+ function basicOrderErc20Payment(basicOrderParameters) {
99
+ if (!isRecord(basicOrderParameters)) {
100
+ return null;
101
+ }
102
+ const basicOrderType = toNumber(basicOrderParameters.basicOrderType);
103
+ if (basicOrderType === null) {
104
+ return null;
105
+ }
106
+ // Four order types share each route: full/partial x open/restricted.
107
+ if (!ERC20_PAYMENT_ROUTES.has(Math.floor(basicOrderType / 4))) {
108
+ return null;
109
+ }
110
+ const token = basicOrderParameters.considerationToken;
111
+ if (typeof token !== "string") {
112
+ return null;
113
+ }
114
+ let total = toBigInt(basicOrderParameters.considerationAmount);
115
+ if (total === null) {
116
+ return null;
117
+ }
118
+ const additionalRecipients = basicOrderParameters.additionalRecipients;
119
+ if (additionalRecipients !== undefined) {
120
+ if (!Array.isArray(additionalRecipients)) {
121
+ return null;
122
+ }
123
+ for (const recipient of additionalRecipients) {
124
+ if (!isRecord(recipient)) {
125
+ return null;
126
+ }
127
+ const amount = toBigInt(recipient.amount);
128
+ if (amount === null) {
129
+ return null;
130
+ }
131
+ total += amount;
132
+ }
133
+ }
134
+ return { token, amount: total };
135
+ }
136
+ /**
137
+ * Read the ERC20 payment a fulfiller owes from the `inputData` of an OpenSea
138
+ * fulfillment response.
139
+ *
140
+ * Returns null whenever the payment is not a single ERC20 amount we can read
141
+ * with confidence, including native-priced listings and offer fulfillments.
142
+ * Callers must treat null as "no preflight possible" and submit the transaction
143
+ * unchanged, so an unfamiliar response shape can never block a working purchase.
144
+ */
145
+ function getErc20Payment(inputData) {
146
+ if (!isRecord(inputData)) {
147
+ return null;
148
+ }
149
+ if ("basicOrderParameters" in inputData) {
150
+ return basicOrderErc20Payment(inputData.basicOrderParameters);
151
+ }
152
+ const order = isRecord(inputData.advancedOrder)
153
+ ? inputData.advancedOrder
154
+ : isRecord(inputData.order)
155
+ ? inputData.order
156
+ : null;
157
+ if (!order || !isRecord(order.parameters)) {
158
+ return null;
159
+ }
160
+ return sumErc20Consideration(order.parameters.consideration);
161
+ }
162
+ /**
163
+ * Read the fulfiller's conduit key, which decides who the buyer must approve:
164
+ * the resolved conduit for a non-zero key, or Seaport itself for `bytes32(0)`.
165
+ * Returns null when the response does not carry one.
166
+ */
167
+ function getFulfillerConduitKey(inputData) {
168
+ if (!isRecord(inputData)) {
169
+ return null;
170
+ }
171
+ const direct = inputData.fulfillerConduitKey;
172
+ if (typeof direct === "string") {
173
+ return direct;
174
+ }
175
+ if (isRecord(inputData.basicOrderParameters)) {
176
+ const fromBasicOrder = inputData.basicOrderParameters.fulfillerConduitKey;
177
+ if (typeof fromBasicOrder === "string") {
178
+ return fromBasicOrder;
179
+ }
180
+ }
181
+ return null;
182
+ }
183
+ /** Whether a conduit key means "transfer directly from Seaport, no conduit". */
184
+ function isZeroConduitKey(conduitKey) {
185
+ if (!conduitKey) {
186
+ return true;
187
+ }
188
+ return conduitKey.toLowerCase() === exports.ZERO_CONDUIT_KEY;
189
+ }
190
+ //# sourceMappingURL=erc20Fulfillment.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"erc20Fulfillment.js","sourceRoot":"","sources":["../../src/orders/erc20Fulfillment.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;AAiCH,4BAWC;AAmHD,0CAmBC;AAOD,wDAeC;AAGD,4CAKC;AA9MD,sFAAsF;AACtF,MAAM,eAAe,GAAG,CAAC,CAAA;AAEzB;;;;;GAKG;AACH,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AAE5C,oFAAoF;AACvE,QAAA,gBAAgB,GAAG,KAAK,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAA;AAerD;;;GAGG;AACH,SAAgB,QAAQ,CAAC,KAAc;IACrC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAA;IACd,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;QACzD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;IACtB,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QAC5D,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAA;IAC7B,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;IAChC,OAAO,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;AACpD,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAA;AACpD,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,qBAAqB,CAAC,aAAsB;IACnD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChE,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,KAAK,GAAkB,IAAI,CAAA;IAC/B,IAAI,KAAK,GAAG,EAAE,CAAA;IAEd,KAAK,MAAM,OAAO,IAAI,aAAwC,EAAE,CAAC;QAC/D,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YACvB,OAAO,IAAI,CAAA;QACb,CAAC;QACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;QAC3C,IAAI,QAAQ,KAAK,eAAe,EAAE,CAAC;YACjC,2EAA2E;YAC3E,OAAO,IAAI,CAAA;QACb,CAAC;QACD,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAA;QAC/B,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;YAClC,OAAO,IAAI,CAAA;QACb,CAAC;QACD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACnB,KAAK,GAAG,SAAS,CAAA;QACnB,CAAC;aAAM,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC;YAC3D,OAAO,IAAI,CAAA;QACb,CAAC;QACD,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;QAC5C,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACpB,OAAO,IAAI,CAAA;QACb,CAAC;QACD,KAAK,IAAI,MAAM,CAAA;IACjB,CAAC;IAED,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAA;AACzD,CAAC;AAED;;;GAGG;AACH,SAAS,sBAAsB,CAC7B,oBAA6B;IAE7B,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAAE,CAAC;QACpC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,cAAc,GAAG,QAAQ,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAA;IACpE,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAA;IACb,CAAC;IACD,qEAAqE;IACrE,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9D,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,KAAK,GAAG,oBAAoB,CAAC,kBAAkB,CAAA;IACrD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,KAAK,GAAG,QAAQ,CAAC,oBAAoB,CAAC,mBAAmB,CAAC,CAAA;IAC9D,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,oBAAoB,GAAG,oBAAoB,CAAC,oBAAoB,CAAA;IACtE,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;QACvC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAAE,CAAC;YACzC,OAAO,IAAI,CAAA;QACb,CAAC;QACD,KAAK,MAAM,SAAS,IAAI,oBAAoB,EAAE,CAAC;YAC7C,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;gBACzB,OAAO,IAAI,CAAA;YACb,CAAC;YACD,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;YACzC,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;gBACpB,OAAO,IAAI,CAAA;YACb,CAAC;YACD,KAAK,IAAI,MAAM,CAAA;QACjB,CAAC;IACH,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAA;AACjC,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAAC,SAAkB;IAChD,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QACzB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,sBAAsB,IAAI,SAAS,EAAE,CAAC;QACxC,OAAO,sBAAsB,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAA;IAC/D,CAAC;IAED,MAAM,KAAK,GAAG,QAAQ,CAAC,SAAS,CAAC,aAAa,CAAC;QAC7C,CAAC,CAAC,SAAS,CAAC,aAAa;QACzB,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC;YACzB,CAAC,CAAC,SAAS,CAAC,KAAK;YACjB,CAAC,CAAC,IAAI,CAAA;IACV,IAAI,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO,qBAAqB,CAAC,KAAK,CAAC,UAAU,CAAC,aAAa,CAAC,CAAA;AAC9D,CAAC;AAED;;;;GAIG;AACH,SAAgB,sBAAsB,CAAC,SAAkB;IACvD,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QACzB,OAAO,IAAI,CAAA;IACb,CAAC;IACD,MAAM,MAAM,GAAG,SAAS,CAAC,mBAAmB,CAAA;IAC5C,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,MAAM,CAAA;IACf,CAAC;IACD,IAAI,QAAQ,CAAC,SAAS,CAAC,oBAAoB,CAAC,EAAE,CAAC;QAC7C,MAAM,cAAc,GAAG,SAAS,CAAC,oBAAoB,CAAC,mBAAmB,CAAA;QACzE,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;YACvC,OAAO,cAAc,CAAA;QACvB,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,gFAAgF;AAChF,SAAgB,gBAAgB,CAAC,UAAyB;IACxD,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,IAAI,CAAA;IACb,CAAC;IACD,OAAO,UAAU,CAAC,WAAW,EAAE,KAAK,wBAAgB,CAAA;AACtD,CAAC"}
@@ -0,0 +1,18 @@
1
+ import type { CreateOrderAction, OrderComponents, OrderUseCase } from "@opensea/seaport-js/lib/types";
2
+ /**
3
+ * Run the approval transactions from a seaport-js create-order use case and
4
+ * return the resulting order components, without asking the wallet to sign.
5
+ *
6
+ * `executeAllActions()` also requests an EIP-712 signature. Callers that
7
+ * validate the order onchain have no use for one, since Seaport's `validate()`
8
+ * takes the transaction sender as proof the offerer approved the order.
9
+ * Requesting it anyway costs an extra wallet prompt for a signature that is
10
+ * discarded, and shuts out contract accounts that cannot produce an offchain
11
+ * signature at all.
12
+ *
13
+ * @param useCase The use case returned by `seaport.createOrder`
14
+ * @returns Order components ready for onchain validation
15
+ *
16
+ * @throws Error if the use case has no create-order action.
17
+ */
18
+ export declare const executeApprovalsAndGetOrderComponents: (useCase: OrderUseCase<CreateOrderAction>) => Promise<OrderComponents>;
@@ -0,0 +1,29 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.executeApprovalsAndGetOrderComponents = void 0;
4
+ /**
5
+ * Run the approval transactions from a seaport-js create-order use case and
6
+ * return the resulting order components, without asking the wallet to sign.
7
+ *
8
+ * `executeAllActions()` also requests an EIP-712 signature. Callers that
9
+ * validate the order onchain have no use for one, since Seaport's `validate()`
10
+ * takes the transaction sender as proof the offerer approved the order.
11
+ * Requesting it anyway costs an extra wallet prompt for a signature that is
12
+ * discarded, and shuts out contract accounts that cannot produce an offchain
13
+ * signature at all.
14
+ *
15
+ * @param useCase The use case returned by `seaport.createOrder`
16
+ * @returns Order components ready for onchain validation
17
+ *
18
+ * @throws Error if the use case has no create-order action.
19
+ */
20
+ const executeApprovalsAndGetOrderComponents = async (useCase) => {
21
+ await useCase.executeApprovals();
22
+ const createAction = useCase.actions.find(action => action.type === "create");
23
+ if (!createAction) {
24
+ throw new Error("Seaport create-order use case has no create action");
25
+ }
26
+ return createAction.orderComponents;
27
+ };
28
+ exports.executeApprovalsAndGetOrderComponents = executeApprovalsAndGetOrderComponents;
29
+ //# sourceMappingURL=orderUseCase.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"orderUseCase.js","sourceRoot":"","sources":["../../src/orders/orderUseCase.ts"],"names":[],"mappings":";;;AAMA;;;;;;;;;;;;;;;GAeG;AACI,MAAM,qCAAqC,GAAG,KAAK,EACxD,OAAwC,EACd,EAAE;IAC5B,MAAM,OAAO,CAAC,gBAAgB,EAAE,CAAA;IAEhC,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAA;IAC7E,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAA;IACvE,CAAC;IAED,OAAO,YAAY,CAAC,eAAe,CAAA;AACrC,CAAC,CAAA;AAXY,QAAA,qCAAqC,yCAWjD"}
@@ -38,6 +38,14 @@ const constructPrivateListingCounterOrder = (order, privateSaleRecipient) => {
38
38
  if (!paymentItems.every(item => item.itemType === paymentItems[0].itemType)) {
39
39
  throw new Error("Not all currency items were the same for private order");
40
40
  }
41
+ // The counter order below sums every payment item into a single offer item
42
+ // denominated in the first item's token, so two different ERC-20s would be
43
+ // aggregated as if they were one. Seaport then rejects the match because
44
+ // the offer and consideration components disagree on token, surfacing as an
45
+ // onchain revert rather than as this error.
46
+ if (!paymentItems.every(item => item.token.toLowerCase() === paymentItems[0].token.toLowerCase())) {
47
+ throw new Error("Not all currency items were the same for private order: payment items must all use the same token");
48
+ }
41
49
  }
42
50
  const { aggregatedStartAmount, aggregatedEndAmount } = paymentItems.reduce(({ aggregatedStartAmount, aggregatedEndAmount }, item) => ({
43
51
  aggregatedStartAmount: aggregatedStartAmount + BigInt(item.startAmount),
@@ -1 +1 @@
1
- {"version":3,"file":"privateListings.js","sourceRoot":"","sources":["../../src/orders/privateListings.ts"],"names":[],"mappings":";;;AAAA,iEAA4D;AAQ5D,6DAAmE;AACnE,+DAAwE;AACxE,4CAA2C;AAE3C;;;;;;GAMG;AACI,MAAM,0BAA0B,GAAG,CACxC,KAAuB,EACvB,YAAoB,EACZ,EAAE;IACV,OAAO,KAAK,CAAC,UAAU,CAAC,aAAa;SAClC,MAAM,CACL,IAAI,CAAC,EAAE,CACL,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,KAAK,YAAY,CAAC,WAAW,EAAE;QAC3D,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,wBAAY,CAAC,WAAW,EAAE;QACvD,IAAI,CAAC,QAAQ,KAAK,oBAAQ,CAAC,MAAM,CACpC;SACA,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,CAAC,CAAA;AAC9D,CAAC,CAAA;AAZY,QAAA,0BAA0B,8BAYtC;AAEM,MAAM,+BAA+B,GAAG,CAC7C,KAAwB,EACxB,oBAA4B,EACF,EAAE;IAC5B,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;QACtB,OAAO,EAAE,GAAG,IAAI,EAAE,SAAS,EAAE,oBAAoB,EAAE,CAAA;IACrD,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AAPY,QAAA,+BAA+B,mCAO3C;AAEM,MAAM,mCAAmC,GAAG,CACjD,KAAuB,EACvB,oBAA4B,EACrB,EAAE;IACT,6EAA6E;IAC7E,oEAAoE;IACpE,MAAM,YAAY,GAAG,KAAK,CAAC,UAAU,CAAC,aAAa,CAAC,MAAM,CACxD,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,KAAK,oBAAoB,CAAC,WAAW,EAAE,CAC5E,CAAA;IAED,yFAAyF;IACzF,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,IAAA,qBAAc,EAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACtD,MAAM,IAAI,KAAK,CACb,+EAA+E,CAChF,CAAA;QACH,CAAC;QACD,IACE,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EACvE,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAA;QAC3E,CAAC;IACH,CAAC;IAED,MAAM,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,GAAG,YAAY,CAAC,MAAM,CACxE,CAAC,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QACzD,qBAAqB,EAAE,qBAAqB,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC;QACvE,mBAAmB,EAAE,mBAAmB,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;KAClE,CAAC,EACF;QACE,qBAAqB,EAAE,EAAE;QACzB,mBAAmB,EAAE,EAAE;KACxB,CACF,CAAA;IAED,MAAM,YAAY,GAAU;QAC1B,UAAU,EAAE;YACV,GAAG,KAAK,CAAC,UAAU;YACnB,OAAO,EAAE,oBAAoB;YAC7B,kFAAkF;YAClF,KAAK,EACH,YAAY,CAAC,MAAM,GAAG,CAAC;gBACrB,CAAC,CAAC;oBACE;wBACE,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,QAAQ;wBAClC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,KAAK;wBAC5B,oBAAoB,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,oBAAoB;wBAC1D,WAAW,EAAE,qBAAqB,CAAC,QAAQ,EAAE;wBAC7C,SAAS,EAAE,mBAAmB,CAAC,QAAQ,EAAE;qBAC1C;iBACF;gBACH,CAAC,CAAC,EAAE;YACR,iFAAiF;YACjF,kDAAkD;YAClD,aAAa,EAAE,EAAE;YACjB,IAAI,EAAE,IAAA,0BAAkB,GAAE;YAC1B,+BAA+B,EAAE,CAAC;SACnC;QACD,SAAS,EAAE,IAAI;KAChB,CAAA;IAED,OAAO,YAAY,CAAA;AACrB,CAAC,CAAA;AA9DY,QAAA,mCAAmC,uCA8D/C;AAEM,MAAM,6BAA6B,GAAG,CAC3C,mBAAqC,EACX,EAAE;IAC5B,MAAM,sBAAsB,GAA6B,EAAE,CAAA;IAE3D,4FAA4F;IAC5F,0EAA0E;IAC1E,mBAAmB,CAAC,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,UAAU,EAAE,EAAE;QACrE,MAAM,kBAAkB,GACtB,mBAAmB,CAAC,UAAU,CAAC,aAAa,CAAC,SAAS,CACpD,iBAAiB,CAAC,EAAE,CAClB,iBAAiB,CAAC,QAAQ,KAAK,SAAS,CAAC,QAAQ;YACjD,iBAAiB,CAAC,KAAK,KAAK,SAAS,CAAC,KAAK;YAC3C,iBAAiB,CAAC,oBAAoB;gBACpC,SAAS,CAAC,oBAAoB,CACnC,CAAA;QACH,IAAI,kBAAkB,KAAK,CAAC,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CACb,6EAA6E,CAC9E,CAAA;QACH,CAAC;QACD,sBAAsB,CAAC,IAAI,CAAC;YAC1B,eAAe,EAAE;gBACf;oBACE,UAAU,EAAE,CAAC;oBACb,SAAS,EAAE,UAAU;iBACtB;aACF;YACD,uBAAuB,EAAE;gBACvB;oBACE,UAAU,EAAE,CAAC;oBACb,SAAS,EAAE,kBAAkB;iBAC9B;aACF;SACF,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,MAAM,2BAA2B,GAA6B,EAAE,CAAA;IAEhE,4FAA4F;IAC5F,0EAA0E;IAC1E,mBAAmB,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAClD,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,EAAE;QACxC,IAAI,CAAC,IAAA,qBAAc,EAAC,iBAAiB,CAAC,EAAE,CAAC;YACvC,OAAM;QACR,CAAC;QACD,0EAA0E;QAC1E,uDAAuD;QACvD,2BAA2B,CAAC,IAAI,CAAC;YAC/B,eAAe,EAAE;gBACf;oBACE,UAAU,EAAE,CAAC;oBACb,SAAS,EAAE,CAAC;iBACb;aACF;YACD,uBAAuB,EAAE;gBACvB;oBACE,UAAU,EAAE,CAAC;oBACb,SAAS,EAAE,kBAAkB;iBAC9B;aACF;SACF,CAAC,CAAA;IACJ,CAAC,CACF,CAAA;IAED,OAAO,CAAC,GAAG,sBAAsB,EAAE,GAAG,2BAA2B,CAAC,CAAA;AACpE,CAAC,CAAA;AAlEY,QAAA,6BAA6B,iCAkEzC"}
1
+ {"version":3,"file":"privateListings.js","sourceRoot":"","sources":["../../src/orders/privateListings.ts"],"names":[],"mappings":";;;AAAA,iEAA4D;AAQ5D,6DAAmE;AACnE,+DAAwE;AACxE,4CAA2C;AAE3C;;;;;;GAMG;AACI,MAAM,0BAA0B,GAAG,CACxC,KAAuB,EACvB,YAAoB,EACZ,EAAE;IACV,OAAO,KAAK,CAAC,UAAU,CAAC,aAAa;SAClC,MAAM,CACL,IAAI,CAAC,EAAE,CACL,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,KAAK,YAAY,CAAC,WAAW,EAAE;QAC3D,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,wBAAY,CAAC,WAAW,EAAE;QACvD,IAAI,CAAC,QAAQ,KAAK,oBAAQ,CAAC,MAAM,CACpC;SACA,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,CAAC,CAAA;AAC9D,CAAC,CAAA;AAZY,QAAA,0BAA0B,8BAYtC;AAEM,MAAM,+BAA+B,GAAG,CAC7C,KAAwB,EACxB,oBAA4B,EACF,EAAE;IAC5B,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;QACtB,OAAO,EAAE,GAAG,IAAI,EAAE,SAAS,EAAE,oBAAoB,EAAE,CAAA;IACrD,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AAPY,QAAA,+BAA+B,mCAO3C;AAEM,MAAM,mCAAmC,GAAG,CACjD,KAAuB,EACvB,oBAA4B,EACrB,EAAE;IACT,6EAA6E;IAC7E,oEAAoE;IACpE,MAAM,YAAY,GAAG,KAAK,CAAC,UAAU,CAAC,aAAa,CAAC,MAAM,CACxD,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,KAAK,oBAAoB,CAAC,WAAW,EAAE,CAC5E,CAAA;IAED,yFAAyF;IACzF,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,IAAA,qBAAc,EAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACtD,MAAM,IAAI,KAAK,CACb,+EAA+E,CAChF,CAAA;QACH,CAAC;QACD,IACE,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EACvE,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAA;QAC3E,CAAC;QACD,2EAA2E;QAC3E,2EAA2E;QAC3E,yEAAyE;QACzE,4EAA4E;QAC5E,4CAA4C;QAC5C,IACE,CAAC,YAAY,CAAC,KAAK,CACjB,IAAI,CAAC,EAAE,CACL,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CACnE,EACD,CAAC;YACD,MAAM,IAAI,KAAK,CACb,mGAAmG,CACpG,CAAA;QACH,CAAC;IACH,CAAC;IAED,MAAM,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,GAAG,YAAY,CAAC,MAAM,CACxE,CAAC,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QACzD,qBAAqB,EAAE,qBAAqB,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC;QACvE,mBAAmB,EAAE,mBAAmB,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;KAClE,CAAC,EACF;QACE,qBAAqB,EAAE,EAAE;QACzB,mBAAmB,EAAE,EAAE;KACxB,CACF,CAAA;IAED,MAAM,YAAY,GAAU;QAC1B,UAAU,EAAE;YACV,GAAG,KAAK,CAAC,UAAU;YACnB,OAAO,EAAE,oBAAoB;YAC7B,kFAAkF;YAClF,KAAK,EACH,YAAY,CAAC,MAAM,GAAG,CAAC;gBACrB,CAAC,CAAC;oBACE;wBACE,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,QAAQ;wBAClC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,KAAK;wBAC5B,oBAAoB,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,oBAAoB;wBAC1D,WAAW,EAAE,qBAAqB,CAAC,QAAQ,EAAE;wBAC7C,SAAS,EAAE,mBAAmB,CAAC,QAAQ,EAAE;qBAC1C;iBACF;gBACH,CAAC,CAAC,EAAE;YACR,iFAAiF;YACjF,kDAAkD;YAClD,aAAa,EAAE,EAAE;YACjB,IAAI,EAAE,IAAA,0BAAkB,GAAE;YAC1B,+BAA+B,EAAE,CAAC;SACnC;QACD,SAAS,EAAE,IAAI;KAChB,CAAA;IAED,OAAO,YAAY,CAAA;AACrB,CAAC,CAAA;AA7EY,QAAA,mCAAmC,uCA6E/C;AAEM,MAAM,6BAA6B,GAAG,CAC3C,mBAAqC,EACX,EAAE;IAC5B,MAAM,sBAAsB,GAA6B,EAAE,CAAA;IAE3D,4FAA4F;IAC5F,0EAA0E;IAC1E,mBAAmB,CAAC,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,UAAU,EAAE,EAAE;QACrE,MAAM,kBAAkB,GACtB,mBAAmB,CAAC,UAAU,CAAC,aAAa,CAAC,SAAS,CACpD,iBAAiB,CAAC,EAAE,CAClB,iBAAiB,CAAC,QAAQ,KAAK,SAAS,CAAC,QAAQ;YACjD,iBAAiB,CAAC,KAAK,KAAK,SAAS,CAAC,KAAK;YAC3C,iBAAiB,CAAC,oBAAoB;gBACpC,SAAS,CAAC,oBAAoB,CACnC,CAAA;QACH,IAAI,kBAAkB,KAAK,CAAC,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CACb,6EAA6E,CAC9E,CAAA;QACH,CAAC;QACD,sBAAsB,CAAC,IAAI,CAAC;YAC1B,eAAe,EAAE;gBACf;oBACE,UAAU,EAAE,CAAC;oBACb,SAAS,EAAE,UAAU;iBACtB;aACF;YACD,uBAAuB,EAAE;gBACvB;oBACE,UAAU,EAAE,CAAC;oBACb,SAAS,EAAE,kBAAkB;iBAC9B;aACF;SACF,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,MAAM,2BAA2B,GAA6B,EAAE,CAAA;IAEhE,4FAA4F;IAC5F,0EAA0E;IAC1E,mBAAmB,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAClD,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,EAAE;QACxC,IAAI,CAAC,IAAA,qBAAc,EAAC,iBAAiB,CAAC,EAAE,CAAC;YACvC,OAAM;QACR,CAAC;QACD,0EAA0E;QAC1E,uDAAuD;QACvD,2BAA2B,CAAC,IAAI,CAAC;YAC/B,eAAe,EAAE;gBACf;oBACE,UAAU,EAAE,CAAC;oBACb,SAAS,EAAE,CAAC;iBACb;aACF;YACD,uBAAuB,EAAE;gBACvB;oBACE,UAAU,EAAE,CAAC;oBACb,SAAS,EAAE,kBAAkB;iBAC9B;aACF;SACF,CAAC,CAAA;IACJ,CAAC,CACF,CAAA;IAED,OAAO,CAAC,GAAG,sBAAsB,EAAE,GAAG,2BAA2B,CAAC,CAAA;AACpE,CAAC,CAAA;AAlEY,QAAA,6BAA6B,iCAkEzC"}
package/lib/sdk/base.d.ts CHANGED
@@ -51,7 +51,7 @@ export declare class BaseOpenSeaSDK {
51
51
  /**
52
52
  * Request a free-tier OpenSea API key without authentication. The returned
53
53
  * key can be passed as `apiKey` into the SDK constructor to bootstrap usage.
54
- * Rate limited to 3 keys per hour per IP; keys expire after 30 days.
54
+ * Keys expire after 7 days.
55
55
  *
56
56
  * @example
57
57
  * ```ts
@@ -300,9 +300,15 @@ export declare class BaseOpenSeaSDK {
300
300
  }): Promise<boolean>;
301
301
  /** Approve an order with an onchain transaction. */
302
302
  approveOrder(order: OrderV2, domain?: string): Promise<string>;
303
- /** Validates an order onchain using Seaport's validate() method. */
304
- validateOrderOnchain(orderComponents: OrderComponents, accountAddress: string): Promise<string>;
305
- /** Create and validate a listing onchain. */
303
+ /**
304
+ * Validates an order onchain using Seaport's validate() method, approving it
305
+ * without an offchain signature. Does not post the order to OpenSea.
306
+ */
307
+ validateOrderOnchain(orderComponents: OrderComponents, accountAddress: string, protocolAddress?: string): Promise<string>;
308
+ /**
309
+ * Create a listing and validate it onchain instead of signing it offchain.
310
+ * Does not post the listing to OpenSea. Returns a transaction hash.
311
+ */
306
312
  createListingAndValidateOnchain(options: {
307
313
  asset: AssetWithTokenId;
308
314
  accountAddress: string;
@@ -316,7 +322,10 @@ export declare class BaseOpenSeaSDK {
316
322
  includeOptionalCreatorFees?: boolean;
317
323
  zone?: string;
318
324
  }): Promise<string>;
319
- /** Create and validate an offer onchain. */
325
+ /**
326
+ * Create an offer and validate it onchain instead of signing it offchain.
327
+ * Does not post the offer to OpenSea. Returns a transaction hash.
328
+ */
320
329
  createOfferAndValidateOnchain(options: {
321
330
  asset: AssetWithTokenId;
322
331
  accountAddress: string;
@@ -346,14 +355,17 @@ export declare class BaseOpenSeaSDK {
346
355
  domain?: string;
347
356
  overrides?: Record<string, unknown>;
348
357
  }): Promise<string>;
349
- /** Cancel an order onchain, preventing it from ever being fulfilled. */
358
+ /**
359
+ * Cancel an order onchain, preventing it from ever being fulfilled.
360
+ * @returns Transaction hash of the cancellation.
361
+ */
350
362
  cancelOrder(options: {
351
363
  order?: OrderV2;
352
364
  orderHash?: string;
353
365
  accountAddress: string;
354
366
  protocolAddress?: string;
355
367
  domain?: string;
356
- }): Promise<void>;
368
+ }): Promise<string>;
357
369
  /** Offchain cancel an order by its order hash when protected by the SignedZone. */
358
370
  offchainCancelOrder(protocolAddress: string, orderHash: string, chain?: Chain, offererSignature?: string, useSignerToDeriveOffererSignature?: boolean): Promise<{
359
371
  lastSignatureIssuedValidUntil: string;
package/lib/sdk/base.js CHANGED
@@ -67,7 +67,7 @@ class BaseOpenSeaSDK {
67
67
  /**
68
68
  * Request a free-tier OpenSea API key without authentication. The returned
69
69
  * key can be passed as `apiKey` into the SDK constructor to bootstrap usage.
70
- * Rate limited to 3 keys per hour per IP; keys expire after 30 days.
70
+ * Keys expire after 7 days.
71
71
  *
72
72
  * @example
73
73
  * ```ts
@@ -247,15 +247,24 @@ class BaseOpenSeaSDK {
247
247
  async approveOrder(order, domain) {
248
248
  return this._fulfillmentManager.approveOrder(order, domain);
249
249
  }
250
- /** Validates an order onchain using Seaport's validate() method. */
251
- async validateOrderOnchain(orderComponents, accountAddress) {
252
- return this._fulfillmentManager.validateOrderOnchain(orderComponents, accountAddress);
250
+ /**
251
+ * Validates an order onchain using Seaport's validate() method, approving it
252
+ * without an offchain signature. Does not post the order to OpenSea.
253
+ */
254
+ async validateOrderOnchain(orderComponents, accountAddress, protocolAddress) {
255
+ return this._fulfillmentManager.validateOrderOnchain(orderComponents, accountAddress, protocolAddress);
253
256
  }
254
- /** Create and validate a listing onchain. */
257
+ /**
258
+ * Create a listing and validate it onchain instead of signing it offchain.
259
+ * Does not post the listing to OpenSea. Returns a transaction hash.
260
+ */
255
261
  async createListingAndValidateOnchain(options) {
256
262
  return this._fulfillmentManager.createListingAndValidateOnchain(options);
257
263
  }
258
- /** Create and validate an offer onchain. */
264
+ /**
265
+ * Create an offer and validate it onchain instead of signing it offchain.
266
+ * Does not post the offer to OpenSea. Returns a transaction hash.
267
+ */
259
268
  async createOfferAndValidateOnchain(options) {
260
269
  return this._fulfillmentManager.createOfferAndValidateOnchain(options);
261
270
  }
@@ -274,7 +283,10 @@ class BaseOpenSeaSDK {
274
283
  async cancelOrders(options) {
275
284
  return this._cancellationManager.cancelOrders(options);
276
285
  }
277
- /** Cancel an order onchain, preventing it from ever being fulfilled. */
286
+ /**
287
+ * Cancel an order onchain, preventing it from ever being fulfilled.
288
+ * @returns Transaction hash of the cancellation.
289
+ */
278
290
  async cancelOrder(options) {
279
291
  return this._cancellationManager.cancelOrder(options);
280
292
  }
@@ -1 +1 @@
1
- {"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/sdk/base.ts"],"names":[],"mappings":";;;AAAA,4CAA4C;AAI5C,oCAAuC;AAQvC,4CAA2C;AAU3C,oCAA+C;AAC/C,8CAAkD;AAClD,0CAA2C;AAC3C,qCAAwC;AACxC,iDAAoD;AACpD,+CAAkD;AAClD,qCAA8D;AAC9D,qCAAwC;AAiBxC;;;;GAIG;AACH,MAAa,cAAc;IACzB,+EAA+E;IACxE,OAAO,CAAS;IACvB,4CAA4C;IACrC,MAAM,CAAuB;IACpC,mBAAmB;IACH,GAAG,CAAY;IAC/B,2BAA2B;IACX,KAAK,CAAO;IAElB,OAAO,CAAe;IACtB,eAAe,CAAgB;IACjC,QAAQ,CAAc;IACtB,2BAA2B,CAA+B;IAC1D,qBAAqB,CAAyB;IAEtD,oBAAoB;IACZ,cAAc,CAAe;IAC7B,cAAc,CAAe;IAC7B,oBAAoB,CAAqB;IACzC,cAAc,CAAe;IAC7B,mBAAmB,CAAoB;IAE/C,YAAsB,MAAqB;QACzC,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;QACzB,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAA;QACrB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAA;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;QAC3B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAA;QAC5B,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,cAAc,CAAA;QAC5C,IAAI,CAAC,2BAA2B,GAAG,MAAM,CAAC,0BAA0B,CAAA;QACpE,IAAI,CAAC,qBAAqB,GAAG,MAAM,CAAC,oBAAoB,CAAA;QACxD,IAAI,CAAC,QAAQ,GAAG,IAAI,YAAY,EAAE,CAAA;QAElC,MAAM,OAAO,GAAG;YACd,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,cAAc,EAAE,IAAI,CAAC,eAAe;YACpC,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;YACnC,kBAAkB,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC;YACvD,yBAAyB,EAAE,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC;SACtE,CAAA;QAED,IAAI,CAAC,cAAc,GAAG,IAAI,sBAAa,CAAC,OAAO,CAAC,CAAA;QAChD,IAAI,CAAC,cAAc,GAAG,IAAI,sBAAa,CAAC,OAAO,CAAC,CAAA;QAChD,IAAI,CAAC,oBAAoB,GAAG,IAAI,kCAAmB,CAAC,OAAO,CAAC,CAAA;QAC5D,IAAI,CAAC,cAAc,GAAG,IAAI,sBAAa,CACrC,OAAO,EACP,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CACpC,CAAA;QACD,IAAI,CAAC,mBAAmB,GAAG,IAAI,gCAAkB,CAC/C,OAAO,EACP,IAAI,CAAC,cAAc,CACpB,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,MAAM,CAAC,KAAK,CAAC,oBAAoB,CACtC,UAAmB;QAEnB,OAAO,gBAAU,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAA;IACpD,CAAC;IAED,sEAAsE;IAEtE;;;;;OAKG;IACI,WAAW,CAChB,KAAgB,EAChB,QAAmC,EACnC,IAAI,GAAG,KAAK;QAEZ,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;QACrC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;QAC5C,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,KAAgB,EAAE,QAAmC;QACzE,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;IAC/C,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,KAAiB;QACzC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAA;IACzC,CAAC;IAED,sEAAsE;IAEtE;;;;;;OAMG;IACI,KAAK,CAAC,OAAO,CAAC,OAGpB;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IAC7C,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CAAC,OAGvB;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;IAChD,CAAC;IAED,sEAAsE;IAEtE;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,WAAW,CAAC,OASxB;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;IACjD,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,aAAa,CAAC,OAY1B;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;IACnD,CAAC;IAED,+EAA+E;IACxE,KAAK,CAAC,kBAAkB,CAAC,OAgB/B;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;IACxD,CAAC;IAED,6EAA6E;IACtE,KAAK,CAAC,gBAAgB,CAAC,OAa7B;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAA;IACtD,CAAC;IAED,4CAA4C;IACrC,KAAK,CAAC,qBAAqB,CAAC,OAalC;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAA;IAC3D,CAAC;IAED,sEAAsE;IAEtE;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,YAAY,CAAC,OASzB;QACC,OAAO,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;IACvD,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,mBAAmB,CAAC,OAKhC;QACC,OAAO,IAAI,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAA;IAC9D,CAAC;IAED;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,4BAA4B,CAAC,OAUzC;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,4BAA4B,CAAC;YAC3C,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gBACnC,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,KAAK,EAAE,CAAC,CAAC,KAAK;gBACd,eAAe,EAAE,CAAC,CAAC,eAAe;aACnC,CAAC,CAAC;YACH,SAAS,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,gBAAgB,EAAE;YAChD,OAAO,EAAE;gBACP,KAAK,EAAE,OAAO,CAAC,YAAY;gBAC3B,YAAY,EAAE,OAAO,CAAC,mBAAmB;aAC1C;YACD,GAAG,CAAC,OAAO,CAAC,gBAAgB;gBAC1B,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,gBAAgB,EAAE;gBACzC,CAAC,CAAC,EAAE,CAAC;SACR,CAAC,CAAA;IACJ,CAAC;IAED,+CAA+C;IACxC,KAAK,CAAC,kBAAkB,CAAC,OAG/B;QACC,OAAO,IAAI,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;IAC7D,CAAC;IAED,oDAAoD;IAC7C,KAAK,CAAC,YAAY,CAAC,KAAc,EAAE,MAAe;QACvD,OAAO,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;IAC7D,CAAC;IAED,oEAAoE;IAC7D,KAAK,CAAC,oBAAoB,CAC/B,eAAgC,EAChC,cAAsB;QAEtB,OAAO,IAAI,CAAC,mBAAmB,CAAC,oBAAoB,CAClD,eAAe,EACf,cAAc,CACf,CAAA;IACH,CAAC;IAED,6CAA6C;IACtC,KAAK,CAAC,+BAA+B,CAAC,OAY5C;QACC,OAAO,IAAI,CAAC,mBAAmB,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAA;IAC1E,CAAC;IAED,4CAA4C;IACrC,KAAK,CAAC,6BAA6B,CAAC,OAS1C;QACC,OAAO,IAAI,CAAC,mBAAmB,CAAC,6BAA6B,CAAC,OAAO,CAAC,CAAA;IACxE,CAAC;IAED,sEAAsE;IAEtE;;;;;;;;;;OAUG;IACI,KAAK,CAAC,YAAY,CAAC,OAOzB;QACC,OAAO,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;IACxD,CAAC;IAED,wEAAwE;IACjE,KAAK,CAAC,WAAW,CAAC,OAMxB;QACC,OAAO,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;IACvD,CAAC;IAED,mFAAmF;IAC5E,KAAK,CAAC,mBAAmB,CAC9B,eAAuB,EACvB,SAAiB,EACjB,QAAe,IAAI,CAAC,KAAK,EACzB,gBAAyB,EACzB,iCAA2C;QAE3C,OAAO,IAAI,CAAC,oBAAoB,CAAC,mBAAmB,CAClD,eAAe,EACf,SAAS,EACT,KAAK,EACL,gBAAgB,EAChB,iCAAiC,CAClC,CAAA;IACH,CAAC;IAED,sEAAsE;IAEtE;;OAEG;IACI,KAAK,CAAC,UAAU,CAAC,OAGvB;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;IAChD,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,QAAQ,CAAC,OAMrB;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;IAC9C,CAAC;IAED,6EAA6E;IACtE,KAAK,CAAC,YAAY,CAAC,OAQzB;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;IAClD,CAAC;IAED,yEAAyE;IAClE,KAAK,CAAC,kBAAkB,CAAC,OAO/B;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;IACxD,CAAC;IAED,sEAAsE;IAEtE;;OAEG;IACK,KAAK,CAAC,mBAAmB,CAC/B,SAAoB,EACpB,YAAoB,EACpB,MAAc;QAEd,YAAY,GAAG,YAAY,CAAC,WAAW,EAAE,CAAA;QACzC,MAAM,OAAO,GAAG,YAAY,KAAK,wBAAY,CAAA;QAC7C,IAAI,QAAQ,GAAG,EAAE,CAAA;QACjB,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,IAAI,YAAY,IAAI,IAAI,CAAC,2BAA2B,EAAE,CAAC;gBACrD,QAAQ,GAAG,IAAI,CAAC,2BAA2B,CAAC,YAAY,CAAC,CAAA;YAC3D,CAAC;iBAAM,CAAC;gBACN,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,YAAY,CAAC,CAAA;gBACjE,IAAI,CAAC,2BAA2B,CAAC,YAAY,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAA;gBACtE,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAA;YAClC,CAAC;QACH,CAAC;QAED,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;QACzD,CAAC;QACD,IAAI,OAAO,IAAI,SAAS,KAAK,iBAAS,CAAC,KAAK,EAAE,CAAC;YAC7C,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;QACpE,CAAC;QACD,MAAM,SAAS,GAAG,IAAA,kBAAU,EAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,QAAQ,CAAC,CAAA;QACzD,MAAM,SAAS,GAAG,SAAS,CAAA;QAC3B,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;QACzD,CAAC;QACD,OAAO,EAAE,SAAS,EAAE,CAAA;IACtB,CAAC;IAEO,SAAS,CAAC,KAAgB,EAAE,IAAe;QACjD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IACjC,CAAC;IAEO,KAAK,CAAC,0BAA0B,CAAC,cAAsB;QAC7D,MAAM,WAAW,GAAG,IAAA,yBAAe,EAAC,cAAc,CAAC,CAAA;QACnD,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAA;QAE5D,IAAI,iBAAiB,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YAC5C,OAAM;QACR,CAAC;QAED,MAAM,IAAI,KAAK,CACb,yEAAyE,WAAW,yBAClF,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAChE,EAAE,CACH,CAAA;IACH,CAAC;IAEO,KAAK,CAAC,mBAAmB,CAC/B,eAAuB,EACvB,KAAgB,EAChB,WAAmB;QAEnB,MAAM,oBAAoB,GAAG,EAAE,eAAe,EAAE,KAAK,EAAE,CAAA;QACvD,IAAI,CAAC,MAAM,CAAC,wBAAwB,WAAW,EAAE,CAAC,CAAA;QAElD,IAAI,CAAC;YACH,IAAI,CAAC,SAAS,CAAC,iBAAS,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,CAAA;YAClE,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAA;YAC/D,IAAI,CAAC,MAAM,CAAC,0BAA0B,WAAW,EAAE,CAAC,CAAA;YACpD,IAAI,CAAC,SAAS,CAAC,iBAAS,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,CAAA;QACtE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,uBAAuB,WAAW,EAAE,CAAC,CAAA;YACjD,IAAI,CAAC,SAAS,CAAC,iBAAS,CAAC,iBAAiB,EAAE;gBAC1C,GAAG,oBAAoB;gBACvB,KAAK;aACN,CAAC,CAAA;YACF,MAAM,KAAK,CAAA;QACb,CAAC;IACH,CAAC;CACF;AA/kBD,wCA+kBC"}
1
+ {"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/sdk/base.ts"],"names":[],"mappings":";;;AAAA,4CAA4C;AAI5C,oCAAuC;AAQvC,4CAA2C;AAU3C,oCAA+C;AAC/C,8CAAkD;AAClD,0CAA2C;AAC3C,qCAAwC;AACxC,iDAAoD;AACpD,+CAAkD;AAClD,qCAA8D;AAC9D,qCAAwC;AAiBxC;;;;GAIG;AACH,MAAa,cAAc;IACzB,+EAA+E;IACxE,OAAO,CAAS;IACvB,4CAA4C;IACrC,MAAM,CAAuB;IACpC,mBAAmB;IACH,GAAG,CAAY;IAC/B,2BAA2B;IACX,KAAK,CAAO;IAElB,OAAO,CAAe;IACtB,eAAe,CAAgB;IACjC,QAAQ,CAAc;IACtB,2BAA2B,CAA+B;IAC1D,qBAAqB,CAAyB;IAEtD,oBAAoB;IACZ,cAAc,CAAe;IAC7B,cAAc,CAAe;IAC7B,oBAAoB,CAAqB;IACzC,cAAc,CAAe;IAC7B,mBAAmB,CAAoB;IAE/C,YAAsB,MAAqB;QACzC,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;QACzB,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAA;QACrB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAA;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;QAC3B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAA;QAC5B,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,cAAc,CAAA;QAC5C,IAAI,CAAC,2BAA2B,GAAG,MAAM,CAAC,0BAA0B,CAAA;QACpE,IAAI,CAAC,qBAAqB,GAAG,MAAM,CAAC,oBAAoB,CAAA;QACxD,IAAI,CAAC,QAAQ,GAAG,IAAI,YAAY,EAAE,CAAA;QAElC,MAAM,OAAO,GAAG;YACd,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,cAAc,EAAE,IAAI,CAAC,eAAe;YACpC,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;YACnC,kBAAkB,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC;YACvD,yBAAyB,EAAE,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC;SACtE,CAAA;QAED,IAAI,CAAC,cAAc,GAAG,IAAI,sBAAa,CAAC,OAAO,CAAC,CAAA;QAChD,IAAI,CAAC,cAAc,GAAG,IAAI,sBAAa,CAAC,OAAO,CAAC,CAAA;QAChD,IAAI,CAAC,oBAAoB,GAAG,IAAI,kCAAmB,CAAC,OAAO,CAAC,CAAA;QAC5D,IAAI,CAAC,cAAc,GAAG,IAAI,sBAAa,CACrC,OAAO,EACP,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CACpC,CAAA;QACD,IAAI,CAAC,mBAAmB,GAAG,IAAI,gCAAkB,CAC/C,OAAO,EACP,IAAI,CAAC,cAAc,CACpB,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,MAAM,CAAC,KAAK,CAAC,oBAAoB,CACtC,UAAmB;QAEnB,OAAO,gBAAU,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAA;IACpD,CAAC;IAED,sEAAsE;IAEtE;;;;;OAKG;IACI,WAAW,CAChB,KAAgB,EAChB,QAAmC,EACnC,IAAI,GAAG,KAAK;QAEZ,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;QACrC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;QAC5C,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,KAAgB,EAAE,QAAmC;QACzE,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;IAC/C,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,KAAiB;QACzC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAA;IACzC,CAAC;IAED,sEAAsE;IAEtE;;;;;;OAMG;IACI,KAAK,CAAC,OAAO,CAAC,OAGpB;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IAC7C,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CAAC,OAGvB;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;IAChD,CAAC;IAED,sEAAsE;IAEtE;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,WAAW,CAAC,OASxB;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;IACjD,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,aAAa,CAAC,OAY1B;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;IACnD,CAAC;IAED,+EAA+E;IACxE,KAAK,CAAC,kBAAkB,CAAC,OAgB/B;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;IACxD,CAAC;IAED,6EAA6E;IACtE,KAAK,CAAC,gBAAgB,CAAC,OAa7B;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAA;IACtD,CAAC;IAED,4CAA4C;IACrC,KAAK,CAAC,qBAAqB,CAAC,OAalC;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAA;IAC3D,CAAC;IAED,sEAAsE;IAEtE;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,YAAY,CAAC,OASzB;QACC,OAAO,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;IACvD,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,mBAAmB,CAAC,OAKhC;QACC,OAAO,IAAI,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAA;IAC9D,CAAC;IAED;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,4BAA4B,CAAC,OAUzC;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,4BAA4B,CAAC;YAC3C,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gBACnC,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,KAAK,EAAE,CAAC,CAAC,KAAK;gBACd,eAAe,EAAE,CAAC,CAAC,eAAe;aACnC,CAAC,CAAC;YACH,SAAS,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,gBAAgB,EAAE;YAChD,OAAO,EAAE;gBACP,KAAK,EAAE,OAAO,CAAC,YAAY;gBAC3B,YAAY,EAAE,OAAO,CAAC,mBAAmB;aAC1C;YACD,GAAG,CAAC,OAAO,CAAC,gBAAgB;gBAC1B,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,gBAAgB,EAAE;gBACzC,CAAC,CAAC,EAAE,CAAC;SACR,CAAC,CAAA;IACJ,CAAC;IAED,+CAA+C;IACxC,KAAK,CAAC,kBAAkB,CAAC,OAG/B;QACC,OAAO,IAAI,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;IAC7D,CAAC;IAED,oDAAoD;IAC7C,KAAK,CAAC,YAAY,CAAC,KAAc,EAAE,MAAe;QACvD,OAAO,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;IAC7D,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,oBAAoB,CAC/B,eAAgC,EAChC,cAAsB,EACtB,eAAwB;QAExB,OAAO,IAAI,CAAC,mBAAmB,CAAC,oBAAoB,CAClD,eAAe,EACf,cAAc,EACd,eAAe,CAChB,CAAA;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,+BAA+B,CAAC,OAY5C;QACC,OAAO,IAAI,CAAC,mBAAmB,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAA;IAC1E,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,6BAA6B,CAAC,OAS1C;QACC,OAAO,IAAI,CAAC,mBAAmB,CAAC,6BAA6B,CAAC,OAAO,CAAC,CAAA;IACxE,CAAC;IAED,sEAAsE;IAEtE;;;;;;;;;;OAUG;IACI,KAAK,CAAC,YAAY,CAAC,OAOzB;QACC,OAAO,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;IACxD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,WAAW,CAAC,OAMxB;QACC,OAAO,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;IACvD,CAAC;IAED,mFAAmF;IAC5E,KAAK,CAAC,mBAAmB,CAC9B,eAAuB,EACvB,SAAiB,EACjB,QAAe,IAAI,CAAC,KAAK,EACzB,gBAAyB,EACzB,iCAA2C;QAE3C,OAAO,IAAI,CAAC,oBAAoB,CAAC,mBAAmB,CAClD,eAAe,EACf,SAAS,EACT,KAAK,EACL,gBAAgB,EAChB,iCAAiC,CAClC,CAAA;IACH,CAAC;IAED,sEAAsE;IAEtE;;OAEG;IACI,KAAK,CAAC,UAAU,CAAC,OAGvB;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;IAChD,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,QAAQ,CAAC,OAMrB;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;IAC9C,CAAC;IAED,6EAA6E;IACtE,KAAK,CAAC,YAAY,CAAC,OAQzB;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;IAClD,CAAC;IAED,yEAAyE;IAClE,KAAK,CAAC,kBAAkB,CAAC,OAO/B;QACC,OAAO,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;IACxD,CAAC;IAED,sEAAsE;IAEtE;;OAEG;IACK,KAAK,CAAC,mBAAmB,CAC/B,SAAoB,EACpB,YAAoB,EACpB,MAAc;QAEd,YAAY,GAAG,YAAY,CAAC,WAAW,EAAE,CAAA;QACzC,MAAM,OAAO,GAAG,YAAY,KAAK,wBAAY,CAAA;QAC7C,IAAI,QAAQ,GAAG,EAAE,CAAA;QACjB,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,IAAI,YAAY,IAAI,IAAI,CAAC,2BAA2B,EAAE,CAAC;gBACrD,QAAQ,GAAG,IAAI,CAAC,2BAA2B,CAAC,YAAY,CAAC,CAAA;YAC3D,CAAC;iBAAM,CAAC;gBACN,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,YAAY,CAAC,CAAA;gBACjE,IAAI,CAAC,2BAA2B,CAAC,YAAY,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAA;gBACtE,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAA;YAClC,CAAC;QACH,CAAC;QAED,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;QACzD,CAAC;QACD,IAAI,OAAO,IAAI,SAAS,KAAK,iBAAS,CAAC,KAAK,EAAE,CAAC;YAC7C,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;QACpE,CAAC;QACD,MAAM,SAAS,GAAG,IAAA,kBAAU,EAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,QAAQ,CAAC,CAAA;QACzD,MAAM,SAAS,GAAG,SAAS,CAAA;QAC3B,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;QACzD,CAAC;QACD,OAAO,EAAE,SAAS,EAAE,CAAA;IACtB,CAAC;IAEO,SAAS,CAAC,KAAgB,EAAE,IAAe;QACjD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IACjC,CAAC;IAEO,KAAK,CAAC,0BAA0B,CAAC,cAAsB;QAC7D,MAAM,WAAW,GAAG,IAAA,yBAAe,EAAC,cAAc,CAAC,CAAA;QACnD,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAA;QAE5D,IAAI,iBAAiB,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YAC5C,OAAM;QACR,CAAC;QAED,MAAM,IAAI,KAAK,CACb,yEAAyE,WAAW,yBAClF,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAChE,EAAE,CACH,CAAA;IACH,CAAC;IAEO,KAAK,CAAC,mBAAmB,CAC/B,eAAuB,EACvB,KAAgB,EAChB,WAAmB;QAEnB,MAAM,oBAAoB,GAAG,EAAE,eAAe,EAAE,KAAK,EAAE,CAAA;QACvD,IAAI,CAAC,MAAM,CAAC,wBAAwB,WAAW,EAAE,CAAC,CAAA;QAElD,IAAI,CAAC;YACH,IAAI,CAAC,SAAS,CAAC,iBAAS,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,CAAA;YAClE,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAA;YAC/D,IAAI,CAAC,MAAM,CAAC,0BAA0B,WAAW,EAAE,CAAC,CAAA;YACpD,IAAI,CAAC,SAAS,CAAC,iBAAS,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,CAAA;QACtE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,uBAAuB,WAAW,EAAE,CAAC,CAAA;YACjD,IAAI,CAAC,SAAS,CAAC,iBAAS,CAAC,iBAAiB,EAAE;gBAC1C,GAAG,oBAAoB;gBACvB,KAAK;aACN,CAAC,CAAA;YACF,MAAM,KAAK,CAAA;QACb,CAAC;IACH,CAAC;CACF;AA7lBD,wCA6lBC"}
@@ -18,6 +18,7 @@ export declare class CancellationManager {
18
18
  * @param options.accountAddress The account address that will be cancelling the order.
19
19
  * @param options.protocolAddress Required when using orderHash. The Seaport protocol address for the order.
20
20
  * @param options.domain An optional domain to be hashed and included at the end of fulfillment calldata. This can be used for onchain order attribution to assist with analytics.
21
+ * @returns Transaction hash of the cancellation.
21
22
  *
22
23
  * @throws Error if neither order nor orderHash is provided.
23
24
  * @throws Error if the accountAddress is not available through wallet or provider.
@@ -29,7 +30,7 @@ export declare class CancellationManager {
29
30
  accountAddress: string;
30
31
  protocolAddress?: string;
31
32
  domain?: string;
32
- }): Promise<void>;
33
+ }): Promise<string>;
33
34
  /**
34
35
  * Cancel multiple orders onchain, preventing them from being fulfilled.
35
36
  * This method accepts either full OrderV2 objects, OrderComponents, or order hashes with protocol address.
@@ -22,6 +22,7 @@ class CancellationManager {
22
22
  * @param options.accountAddress The account address that will be cancelling the order.
23
23
  * @param options.protocolAddress Required when using orderHash. The Seaport protocol address for the order.
24
24
  * @param options.domain An optional domain to be hashed and included at the end of fulfillment calldata. This can be used for onchain order attribution to assist with analytics.
25
+ * @returns Transaction hash of the cancellation.
25
26
  *
26
27
  * @throws Error if neither order nor orderHash is provided.
27
28
  * @throws Error if the accountAddress is not available through wallet or provider.
@@ -74,6 +75,7 @@ class CancellationManager {
74
75
  });
75
76
  // Await transaction confirmation
76
77
  await this.context.confirmTransaction(transactionHash, types_1.EventType.CancelOrder, "Cancelling order");
78
+ return transactionHash;
77
79
  }
78
80
  /**
79
81
  * Cancel multiple orders onchain, preventing them from being fulfilled.
@@ -1 +1 @@
1
- {"version":3,"file":"cancellation.js","sourceRoot":"","sources":["../../src/sdk/cancellation.ts"],"names":[],"mappings":";;;AAGA,2CAAkE;AAClE,oCAAgD;AAChD,0CAKuB;AAGvB;;GAEG;AACH,MAAa,mBAAmB;IACV;IAApB,YAAoB,OAAmB;QAAnB,YAAO,GAAP,OAAO,CAAY;IAAG,CAAC;IAE3C;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,WAAW,CAAC,EAChB,KAAK,EACL,SAAS,EACT,cAAc,EACd,eAAe,GAAG,wCAAgC,EAClD,MAAM,GAOP;QACC,iBAAiB;QACjB,IAAI,CAAC,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CACb,4DAA4D,CAC7D,CAAA;QACH,CAAC;QAED,wDAAwD;QACxD,MAAM,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,cAAc,CAAC,CAAA;QAE5D,IAAI,eAAgC,CAAA;QACpC,IAAI,wBAAgC,CAAA;QAEpC,IAAI,KAAK,EAAE,CAAC;YACV,gCAAgC;YAChC,IAAA,4BAAoB,EAAC,KAAK,CAAC,eAAe,CAAC,CAAA;YAC3C,wBAAwB,GAAG,KAAK,CAAC,eAAe,CAAA;YAChD,eAAe,GAAG,KAAK,CAAC,YAAY,CAAC,UAAU,CAAA;YAC/C,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAS,CAAC,WAAW,EAAE;gBAC3C,OAAO,EAAE,KAAK;gBACd,cAAc;aACf,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,SAAS,EAAE,CAAC;YACrB,wCAAwC;YACxC,IAAA,4BAAoB,EAAC,eAAe,CAAC,CAAA;YACrC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CACxD,SAAS,EACT,eAAe,EACf,IAAI,CAAC,OAAO,CAAC,KAAK,CACnB,CAAA;YACD,IAAI,CAAC,YAAY,CAAC,eAAe,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC;gBAChE,MAAM,IAAI,KAAK,CACb,SAAS,SAAS,8DAA8D,CACjF,CAAA;YACH,CAAC;YACD,IAAA,4BAAoB,EAAC,YAAY,CAAC,eAAe,CAAC,CAAA;YAClD,wBAAwB,GAAG,YAAY,CAAC,eAAe,CAAA;YACvD,eAAe,GAAG,YAAY,CAAC,YAAY,CAAC,UAAU,CAAA;YACtD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAS,CAAC,WAAW,EAAE;gBAC3C,KAAK,EAAE,YAAY;gBACnB,cAAc;aACf,CAAC,CAAA;QACJ,CAAC;aAAM,CAAC;YACN,oDAAoD;YACpD,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAA;QAClC,CAAC;QAED,wCAAwC;QACxC,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC;YACrD,MAAM,EAAE,CAAC,eAAe,CAAC;YACzB,cAAc;YACd,MAAM;YACN,eAAe,EAAE,wBAAwB;SAC1C,CAAC,CAAA;QAEF,iCAAiC;QACjC,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CACnC,eAAe,EACf,iBAAS,CAAC,WAAW,EACrB,kBAAkB,CACnB,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,YAAY,CAAC,EACjB,MAAM,EACN,WAAW,EACX,cAAc,EACd,eAAe,GAAG,wCAAgC,EAClD,MAAM,EACN,SAAS,GAQV;QACC,kDAAkD;QAClD,IAAI,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CACb,gEAAgE,CACjE,CAAA;QACH,CAAC;QAED,IAAI,MAAM,IAAI,WAAW,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CACb,0EAA0E,CAC3E,CAAA;QACH,CAAC;QAED,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;QACxD,CAAC;QAED,IAAI,WAAW,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;QAC7D,CAAC;QAED,IAAI,eAAkC,CAAA;QACtC,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAU,CAAA;QAC3C,IAAI,YAAiC,CAAA;QACrC,IAAI,iBAA8C,CAAA;QAElD,IAAA,4BAAoB,EAAC,eAAe,CAAC,CAAA;QAErC,MAAM,kBAAkB,GAAG,CAAC,KAAa,EAAE,EAAE;YAC3C,IAAA,4BAAoB,EAAC,KAAK,CAAC,CAAA;YAC3B,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QAC9B,CAAC,CAAA;QAED,IAAI,MAAM,EAAE,CAAC;YACX,sFAAsF;YACtF,eAAe,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;gBACnC,IAAI,cAAc,IAAI,KAAK,EAAE,CAAC;oBAC5B,yBAAyB;oBACzB,MAAM,OAAO,GAAG,KAAgB,CAAA;oBAChC,kBAAkB,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;oBAC3C,IAAI,CAAC,YAAY,EAAE,CAAC;wBAClB,YAAY,GAAG,OAAO,CAAA;oBACxB,CAAC;oBACD,OAAO,OAAO,CAAC,YAAY,CAAC,UAAU,CAAA;gBACxC,CAAC;qBAAM,CAAC;oBACN,+BAA+B;oBAC/B,kBAAkB,CAAC,eAAe,CAAC,CAAA;oBACnC,OAAO,KAAwB,CAAA;gBACjC,CAAC;YACH,CAAC,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,WAAW,EAAE,CAAC;YACvB,+CAA+C;YAC/C,MAAM,aAAa,GAAwB,EAAE,CAAA;YAC7C,KAAK,MAAM,IAAI,IAAI,WAAW,EAAE,CAAC;gBAC/B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CACnD,IAAI,EACJ,eAAe,EACf,IAAI,CAAC,OAAO,CAAC,KAAK,CACnB,CAAA;gBACD,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC7B,CAAC;YAED,kDAAkD;YAClD,eAAe,GAAG,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;gBAC5C,IAAI,CAAC,OAAO,CAAC,eAAe,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;oBACtD,MAAM,IAAI,KAAK,CACb,SAAS,OAAO,CAAC,SAAS,8DAA8D,CACzF,CAAA;gBACH,CAAC;gBACD,kBAAkB,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;gBAC3C,OAAO,OAAO,CAAC,YAAY,CAAC,UAAU,CAAA;YACxC,CAAC,CAAC,CAAA;YACF,iBAAiB,GAAG,aAAa,CAAC,CAAC,CAAC,CAAA;QACtC,CAAC;aAAM,CAAC;YACN,oDAAoD;YACpD,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAA;QAClC,CAAC;QAED,IAAI,iBAAiB,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CACb,0GAA0G,CAC3G,CAAA;QACH,CAAC;QAED,MAAM,wBAAwB,GAAG,iBAAiB,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAA;QACxE,IAAI,wBAAwB,IAAI,IAAI,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAA;QAClC,CAAC;QAED,wDAAwD;QACxD,MAAM,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,cAAc,CAAC,CAAA;QAE5D,IAAI,YAAY,EAAE,CAAC;YACjB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAS,CAAC,WAAW,EAAE;gBAC3C,OAAO,EAAE,YAAY;gBACrB,cAAc;aACf,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,iBAAiB,EAAE,CAAC;YAC7B,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAS,CAAC,WAAW,EAAE;gBAC3C,KAAK,EAAE,iBAAiB;gBACxB,cAAc;aACf,CAAC,CAAA;QACJ,CAAC;QAED,wCAAwC;QACxC,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC;YACrD,MAAM,EAAE,eAAe;YACvB,cAAc;YACd,MAAM;YACN,eAAe,EAAE,wBAAwB;YACzC,SAAS;SACV,CAAC,CAAA;QAEF,iCAAiC;QACjC,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CACnC,eAAe,EACf,iBAAS,CAAC,WAAW,EACrB,cAAc,eAAe,CAAC,MAAM,WAAW,CAChD,CAAA;QAED,OAAO,eAAe,CAAA;IACxB,CAAC;IAED;;;;;;;;;OASG;IACK,KAAK,CAAC,mBAAmB,CAAC,EAChC,MAAM,EACN,cAAc,EACd,MAAM,EACN,eAAe,GAAG,wCAAgC,EAClD,SAAS,GAOV;QACC,MAAM,OAAO,GAAG,IAAA,0BAAkB,EAAC,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAEzE,MAAM,WAAW,GAAG,MAAM,OAAO;aAC9B,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,CAAC;aACvD,QAAQ,EAAE,CAAA;QAEb,OAAO,WAAW,CAAC,IAAI,CAAA;IACzB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,mBAAmB,CACvB,eAAuB,EACvB,SAAiB,EACjB,KAAY;QAEZ,MAAM,OAAO,GAAG,IAAA,kBAAU,EAAC,KAAK,CAAC,CAAA;QACjC,MAAM,IAAI,GAAG,SAAS,CAAA;QACtB,MAAM,OAAO,GAAG,IAAA,yBAAiB,EAAC,eAAe,CAAC,CAAA;QAElD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAA;QAClC,IAAI,CAAC,CAAC,QAAQ,IAAI,MAAM,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CACb,mEAAmE,CACpE,CAAA;QACH,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,aAAa,CAChC,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,EAC9D,EAAE,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,EACvD,EAAE,SAAS,EAAE,CACd,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,mBAAmB,CACvB,eAAuB,EACvB,SAAiB,EACjB,QAAe,IAAI,CAAC,OAAO,CAAC,KAAK,EACjC,gBAAyB,EACzB,iCAA2C;QAE3C,IAAI,iCAAiC,EAAE,CAAC;YACtC,gBAAgB,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAC/C,eAAe,EACf,SAAS,EACT,KAAK,CACN,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,CACzC,eAAe,EACf,SAAS,EACT,KAAK,EACL,gBAAgB,CACjB,CAAA;IACH,CAAC;CACF;AA9VD,kDA8VC"}
1
+ {"version":3,"file":"cancellation.js","sourceRoot":"","sources":["../../src/sdk/cancellation.ts"],"names":[],"mappings":";;;AAGA,2CAAkE;AAClE,oCAAgD;AAChD,0CAKuB;AAGvB;;GAEG;AACH,MAAa,mBAAmB;IACV;IAApB,YAAoB,OAAmB;QAAnB,YAAO,GAAP,OAAO,CAAY;IAAG,CAAC;IAE3C;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,WAAW,CAAC,EAChB,KAAK,EACL,SAAS,EACT,cAAc,EACd,eAAe,GAAG,wCAAgC,EAClD,MAAM,GAOP;QACC,iBAAiB;QACjB,IAAI,CAAC,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CACb,4DAA4D,CAC7D,CAAA;QACH,CAAC;QAED,wDAAwD;QACxD,MAAM,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,cAAc,CAAC,CAAA;QAE5D,IAAI,eAAgC,CAAA;QACpC,IAAI,wBAAgC,CAAA;QAEpC,IAAI,KAAK,EAAE,CAAC;YACV,gCAAgC;YAChC,IAAA,4BAAoB,EAAC,KAAK,CAAC,eAAe,CAAC,CAAA;YAC3C,wBAAwB,GAAG,KAAK,CAAC,eAAe,CAAA;YAChD,eAAe,GAAG,KAAK,CAAC,YAAY,CAAC,UAAU,CAAA;YAC/C,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAS,CAAC,WAAW,EAAE;gBAC3C,OAAO,EAAE,KAAK;gBACd,cAAc;aACf,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,SAAS,EAAE,CAAC;YACrB,wCAAwC;YACxC,IAAA,4BAAoB,EAAC,eAAe,CAAC,CAAA;YACrC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CACxD,SAAS,EACT,eAAe,EACf,IAAI,CAAC,OAAO,CAAC,KAAK,CACnB,CAAA;YACD,IAAI,CAAC,YAAY,CAAC,eAAe,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC;gBAChE,MAAM,IAAI,KAAK,CACb,SAAS,SAAS,8DAA8D,CACjF,CAAA;YACH,CAAC;YACD,IAAA,4BAAoB,EAAC,YAAY,CAAC,eAAe,CAAC,CAAA;YAClD,wBAAwB,GAAG,YAAY,CAAC,eAAe,CAAA;YACvD,eAAe,GAAG,YAAY,CAAC,YAAY,CAAC,UAAU,CAAA;YACtD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAS,CAAC,WAAW,EAAE;gBAC3C,KAAK,EAAE,YAAY;gBACnB,cAAc;aACf,CAAC,CAAA;QACJ,CAAC;aAAM,CAAC;YACN,oDAAoD;YACpD,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAA;QAClC,CAAC;QAED,wCAAwC;QACxC,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC;YACrD,MAAM,EAAE,CAAC,eAAe,CAAC;YACzB,cAAc;YACd,MAAM;YACN,eAAe,EAAE,wBAAwB;SAC1C,CAAC,CAAA;QAEF,iCAAiC;QACjC,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CACnC,eAAe,EACf,iBAAS,CAAC,WAAW,EACrB,kBAAkB,CACnB,CAAA;QAED,OAAO,eAAe,CAAA;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,YAAY,CAAC,EACjB,MAAM,EACN,WAAW,EACX,cAAc,EACd,eAAe,GAAG,wCAAgC,EAClD,MAAM,EACN,SAAS,GAQV;QACC,kDAAkD;QAClD,IAAI,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CACb,gEAAgE,CACjE,CAAA;QACH,CAAC;QAED,IAAI,MAAM,IAAI,WAAW,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CACb,0EAA0E,CAC3E,CAAA;QACH,CAAC;QAED,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;QACxD,CAAC;QAED,IAAI,WAAW,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;QAC7D,CAAC;QAED,IAAI,eAAkC,CAAA;QACtC,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAU,CAAA;QAC3C,IAAI,YAAiC,CAAA;QACrC,IAAI,iBAA8C,CAAA;QAElD,IAAA,4BAAoB,EAAC,eAAe,CAAC,CAAA;QAErC,MAAM,kBAAkB,GAAG,CAAC,KAAa,EAAE,EAAE;YAC3C,IAAA,4BAAoB,EAAC,KAAK,CAAC,CAAA;YAC3B,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QAC9B,CAAC,CAAA;QAED,IAAI,MAAM,EAAE,CAAC;YACX,sFAAsF;YACtF,eAAe,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;gBACnC,IAAI,cAAc,IAAI,KAAK,EAAE,CAAC;oBAC5B,yBAAyB;oBACzB,MAAM,OAAO,GAAG,KAAgB,CAAA;oBAChC,kBAAkB,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;oBAC3C,IAAI,CAAC,YAAY,EAAE,CAAC;wBAClB,YAAY,GAAG,OAAO,CAAA;oBACxB,CAAC;oBACD,OAAO,OAAO,CAAC,YAAY,CAAC,UAAU,CAAA;gBACxC,CAAC;qBAAM,CAAC;oBACN,+BAA+B;oBAC/B,kBAAkB,CAAC,eAAe,CAAC,CAAA;oBACnC,OAAO,KAAwB,CAAA;gBACjC,CAAC;YACH,CAAC,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,WAAW,EAAE,CAAC;YACvB,+CAA+C;YAC/C,MAAM,aAAa,GAAwB,EAAE,CAAA;YAC7C,KAAK,MAAM,IAAI,IAAI,WAAW,EAAE,CAAC;gBAC/B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CACnD,IAAI,EACJ,eAAe,EACf,IAAI,CAAC,OAAO,CAAC,KAAK,CACnB,CAAA;gBACD,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC7B,CAAC;YAED,kDAAkD;YAClD,eAAe,GAAG,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;gBAC5C,IAAI,CAAC,OAAO,CAAC,eAAe,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;oBACtD,MAAM,IAAI,KAAK,CACb,SAAS,OAAO,CAAC,SAAS,8DAA8D,CACzF,CAAA;gBACH,CAAC;gBACD,kBAAkB,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;gBAC3C,OAAO,OAAO,CAAC,YAAY,CAAC,UAAU,CAAA;YACxC,CAAC,CAAC,CAAA;YACF,iBAAiB,GAAG,aAAa,CAAC,CAAC,CAAC,CAAA;QACtC,CAAC;aAAM,CAAC;YACN,oDAAoD;YACpD,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAA;QAClC,CAAC;QAED,IAAI,iBAAiB,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CACb,0GAA0G,CAC3G,CAAA;QACH,CAAC;QAED,MAAM,wBAAwB,GAAG,iBAAiB,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAA;QACxE,IAAI,wBAAwB,IAAI,IAAI,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAA;QAClC,CAAC;QAED,wDAAwD;QACxD,MAAM,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,cAAc,CAAC,CAAA;QAE5D,IAAI,YAAY,EAAE,CAAC;YACjB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAS,CAAC,WAAW,EAAE;gBAC3C,OAAO,EAAE,YAAY;gBACrB,cAAc;aACf,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,iBAAiB,EAAE,CAAC;YAC7B,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAS,CAAC,WAAW,EAAE;gBAC3C,KAAK,EAAE,iBAAiB;gBACxB,cAAc;aACf,CAAC,CAAA;QACJ,CAAC;QAED,wCAAwC;QACxC,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC;YACrD,MAAM,EAAE,eAAe;YACvB,cAAc;YACd,MAAM;YACN,eAAe,EAAE,wBAAwB;YACzC,SAAS;SACV,CAAC,CAAA;QAEF,iCAAiC;QACjC,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CACnC,eAAe,EACf,iBAAS,CAAC,WAAW,EACrB,cAAc,eAAe,CAAC,MAAM,WAAW,CAChD,CAAA;QAED,OAAO,eAAe,CAAA;IACxB,CAAC;IAED;;;;;;;;;OASG;IACK,KAAK,CAAC,mBAAmB,CAAC,EAChC,MAAM,EACN,cAAc,EACd,MAAM,EACN,eAAe,GAAG,wCAAgC,EAClD,SAAS,GAOV;QACC,MAAM,OAAO,GAAG,IAAA,0BAAkB,EAAC,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAEzE,MAAM,WAAW,GAAG,MAAM,OAAO;aAC9B,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,CAAC;aACvD,QAAQ,EAAE,CAAA;QAEb,OAAO,WAAW,CAAC,IAAI,CAAA;IACzB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,mBAAmB,CACvB,eAAuB,EACvB,SAAiB,EACjB,KAAY;QAEZ,MAAM,OAAO,GAAG,IAAA,kBAAU,EAAC,KAAK,CAAC,CAAA;QACjC,MAAM,IAAI,GAAG,SAAS,CAAA;QACtB,MAAM,OAAO,GAAG,IAAA,yBAAiB,EAAC,eAAe,CAAC,CAAA;QAElD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAA;QAClC,IAAI,CAAC,CAAC,QAAQ,IAAI,MAAM,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CACb,mEAAmE,CACpE,CAAA;QACH,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,aAAa,CAChC,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,EAC9D,EAAE,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,EACvD,EAAE,SAAS,EAAE,CACd,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,mBAAmB,CACvB,eAAuB,EACvB,SAAiB,EACjB,QAAe,IAAI,CAAC,OAAO,CAAC,KAAK,EACjC,gBAAyB,EACzB,iCAA2C;QAE3C,IAAI,iCAAiC,EAAE,CAAC;YACtC,gBAAgB,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAC/C,eAAe,EACf,SAAS,EACT,KAAK,CACN,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,CACzC,eAAe,EACf,SAAS,EACT,KAAK,EACL,gBAAgB,CACjB,CAAA;IACH,CAAC;CACF;AAjWD,kDAiWC"}
@@ -51,6 +51,24 @@ export declare class FulfillmentManager {
51
51
  includeOptionalCreatorFees?: boolean;
52
52
  overrides?: Record<string, unknown>;
53
53
  }): Promise<string>;
54
+ /**
55
+ * Throw an actionable error when the buyer cannot pay for an ERC20-priced
56
+ * listing, because they hold too little of the payment token or have not
57
+ * approved the address Seaport pulls it from.
58
+ *
59
+ * The check is skipped for native-priced listings, for offer fulfillments, and
60
+ * for any response shape or RPC read it cannot interpret, so it never blocks a
61
+ * purchase that would otherwise have succeeded.
62
+ */
63
+ private requireErc20PaymentIsSpendable;
64
+ /**
65
+ * Resolve the address that will pull the payment token: Seaport itself when the
66
+ * fulfiller conduit key is `bytes32(0)`, otherwise the conduit registered for
67
+ * that key. Returns null when the key cannot be resolved.
68
+ */
69
+ private resolveFulfillerSpender;
70
+ /** Read the buyer's payment-token balance and allowance for a spender. */
71
+ private readErc20SpendState;
54
72
  /**
55
73
  * Returns whether an order is fulfillable.
56
74
  * An order may not be fulfillable if a target item's transfer function
@@ -80,10 +98,35 @@ export declare class FulfillmentManager {
80
98
  approveOrder(order: OrderV2, domain?: string): Promise<string>;
81
99
  /**
82
100
  * Validates an order onchain using Seaport's validate() method.
101
+ *
102
+ * The order is left with an empty signature: Seaport takes the transaction
103
+ * sender as proof the offerer approved it. This does not post the order to
104
+ * OpenSea. It becomes discoverable only once OpenSea ingests the resulting
105
+ * `OrderValidated` event.
106
+ *
107
+ * @param orderComponents The order to validate
108
+ * @param accountAddress Address sending the validate transaction
109
+ * @param protocolAddress Seaport protocol address the components were built
110
+ * for. Defaults to {@link DEFAULT_SEAPORT_CONTRACT_ADDRESS}.
111
+ * @returns Transaction hash of the validate transaction
112
+ *
113
+ * @throws Error if the accountAddress is not available through wallet or provider.
114
+ * @throws Error if the protocol address is not supported by OpenSea. See {@link isValidProtocol}.
83
115
  */
84
- validateOrderOnchain(orderComponents: OrderComponents, accountAddress: string): Promise<string>;
116
+ validateOrderOnchain(orderComponents: OrderComponents, accountAddress: string, protocolAddress?: string): Promise<string>;
85
117
  /**
86
- * Create and validate a listing onchain.
118
+ * Create a listing and validate it onchain, instead of signing it offchain.
119
+ *
120
+ * Runs any token approvals the listing needs, then sends one `validate()`
121
+ * transaction. The wallet is never asked for an EIP-712 signature, so this
122
+ * works for contract accounts that cannot produce one.
123
+ *
124
+ * Unlike {@link OrdersManager.createListing}, this does not post the listing
125
+ * to OpenSea. It becomes discoverable only once OpenSea ingests the
126
+ * `OrderValidated` event, so the returned hash is a transaction hash, not an
127
+ * order hash.
128
+ *
129
+ * @returns Transaction hash of the validate transaction
87
130
  */
88
131
  createListingAndValidateOnchain({ asset, accountAddress, amount, quantity, domain, salt, listingTime, expirationTime, buyerAddress, includeOptionalCreatorFees, zone, }: {
89
132
  asset: AssetWithTokenId;
@@ -99,7 +142,18 @@ export declare class FulfillmentManager {
99
142
  zone?: string;
100
143
  }): Promise<string>;
101
144
  /**
102
- * Create and validate an offer onchain.
145
+ * Create an offer and validate it onchain, instead of signing it offchain.
146
+ *
147
+ * Runs any token approvals the offer needs, then sends one `validate()`
148
+ * transaction. The wallet is never asked for an EIP-712 signature, so this
149
+ * works for contract accounts that cannot produce one.
150
+ *
151
+ * Unlike {@link OrdersManager.createOffer}, this does not post the offer to
152
+ * OpenSea. It becomes discoverable only once OpenSea ingests the
153
+ * `OrderValidated` event, so the returned hash is a transaction hash, not an
154
+ * order hash.
155
+ *
156
+ * @returns Transaction hash of the validate transaction
103
157
  */
104
158
  createOfferAndValidateOnchain({ asset, accountAddress, amount, quantity, domain, salt, expirationTime, zone, }: {
105
159
  asset: AssetWithTokenId;