Skip to content

Commit 2b50dbe

Browse files
kumaryash90kumaryash90
committed
docs
1 parent 27d0e57 commit 2b50dbe

7 files changed

+29
-19
lines changed

‎docs/DirectListingsLogic.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,7 @@ Emitted when a currency is approved as a form of payment for the listing.
386386
### NewListing
387387

388388
```solidity
389-
event NewListing(address indexed listingCreator, uint256 indexed listingId, IDirectListings.Listing listing)
389+
event NewListing(address indexed listingCreator, uint256 indexed listingId, address indexed assetContract, IDirectListings.Listing listing)
390390
```
391391

392392
Emitted when a new listing is created.
@@ -399,12 +399,13 @@ Emitted when a new listing is created.
399399
|---|---|---|
400400
| listingCreator `indexed` | address | undefined |
401401
| listingId `indexed` | uint256 | undefined |
402+
| assetContract `indexed` | address | undefined |
402403
| listing | IDirectListings.Listing | undefined |
403404

404405
### NewSale
405406

406407
```solidity
407-
event NewSale(uint256 indexed listingId, address indexed assetContract, address indexed listingCreator, uint256 tokenId, address buyer, uint256 quantityBought, uint256 totalPricePaid)
408+
event NewSale(address indexed listingCreator, uint256 indexed listingId, address indexed assetContract, uint256 tokenId, address buyer, uint256 quantityBought, uint256 totalPricePaid)
408409
```
409410

410411
Emitted when NFTs are bought from a listing.
@@ -415,9 +416,9 @@ Emitted when NFTs are bought from a listing.
415416

416417
| Name | Type | Description |
417418
|---|---|---|
419+
| listingCreator `indexed` | address | undefined |
418420
| listingId `indexed` | uint256 | undefined |
419421
| assetContract `indexed` | address | undefined |
420-
| listingCreator `indexed` | address | undefined |
421422
| tokenId | uint256 | undefined |
422423
| buyer | address | undefined |
423424
| quantityBought | uint256 | undefined |
@@ -426,7 +427,7 @@ Emitted when NFTs are bought from a listing.
426427
### UpdatedListing
427428

428429
```solidity
429-
event UpdatedListing(address indexed listingCreator, uint256 indexed listingId, IDirectListings.Listing listing)
430+
event UpdatedListing(address indexed listingCreator, uint256 indexed listingId, address indexed assetContract, IDirectListings.Listing listing)
430431
```
431432

432433
Emitted when a listing is updated.
@@ -439,6 +440,7 @@ Emitted when a listing is updated.
439440
|---|---|---|
440441
| listingCreator `indexed` | address | undefined |
441442
| listingId `indexed` | uint256 | undefined |
443+
| assetContract `indexed` | address | undefined |
442444
| listing | IDirectListings.Listing | undefined |
443445

444446

‎docs/EnglishAuctionsLogic.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ Emitted when a auction is cancelled.
347347
### NewAuction
348348

349349
```solidity
350-
event NewAuction(address indexed auctionCreator, uint256 indexed auctionId, IEnglishAuctions.Auction auction)
350+
event NewAuction(address indexed auctionCreator, uint256 indexed auctionId, address indexed assetContract, IEnglishAuctions.Auction auction)
351351
```
352352

353353

@@ -360,12 +360,13 @@ event NewAuction(address indexed auctionCreator, uint256 indexed auctionId, IEng
360360
|---|---|---|
361361
| auctionCreator `indexed` | address | undefined |
362362
| auctionId `indexed` | uint256 | undefined |
363+
| assetContract `indexed` | address | undefined |
363364
| auction | IEnglishAuctions.Auction | undefined |
364365

365366
### NewBid
366367

367368
```solidity
368-
event NewBid(uint256 indexed auctionId, address indexed bidder, uint256 bidAmount, IEnglishAuctions.Auction auction)
369+
event NewBid(uint256 indexed auctionId, address indexed bidder, address indexed assetContract, uint256 bidAmount, IEnglishAuctions.Auction auction)
369370
```
370371

371372

@@ -378,6 +379,7 @@ event NewBid(uint256 indexed auctionId, address indexed bidder, uint256 bidAmoun
378379
|---|---|---|
379380
| auctionId `indexed` | uint256 | undefined |
380381
| bidder `indexed` | address | undefined |
382+
| assetContract `indexed` | address | undefined |
381383
| bidAmount | uint256 | undefined |
382384
| auction | IEnglishAuctions.Auction | undefined |
383385

‎docs/IDirectListings.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ Emitted when a currency is approved as a form of payment for the listing.
266266
### NewListing
267267

268268
```solidity
269-
event NewListing(address indexed listingCreator, uint256 indexed listingId, IDirectListings.Listing listing)
269+
event NewListing(address indexed listingCreator, uint256 indexed listingId, address indexed assetContract, IDirectListings.Listing listing)
270270
```
271271

272272
Emitted when a new listing is created.
@@ -279,12 +279,13 @@ Emitted when a new listing is created.
279279
|---|---|---|
280280
| listingCreator `indexed` | address | undefined |
281281
| listingId `indexed` | uint256 | undefined |
282+
| assetContract `indexed` | address | undefined |
282283
| listing | IDirectListings.Listing | undefined |
283284

284285
### NewSale
285286

286287
```solidity
287-
event NewSale(uint256 indexed listingId, address indexed assetContract, address indexed listingCreator, uint256 tokenId, address buyer, uint256 quantityBought, uint256 totalPricePaid)
288+
event NewSale(address indexed listingCreator, uint256 indexed listingId, address indexed assetContract, uint256 tokenId, address buyer, uint256 quantityBought, uint256 totalPricePaid)
288289
```
289290

290291
Emitted when NFTs are bought from a listing.
@@ -295,9 +296,9 @@ Emitted when NFTs are bought from a listing.
295296

296297
| Name | Type | Description |
297298
|---|---|---|
299+
| listingCreator `indexed` | address | undefined |
298300
| listingId `indexed` | uint256 | undefined |
299301
| assetContract `indexed` | address | undefined |
300-
| listingCreator `indexed` | address | undefined |
301302
| tokenId | uint256 | undefined |
302303
| buyer | address | undefined |
303304
| quantityBought | uint256 | undefined |
@@ -306,7 +307,7 @@ Emitted when NFTs are bought from a listing.
306307
### UpdatedListing
307308

308309
```solidity
309-
event UpdatedListing(address indexed listingCreator, uint256 indexed listingId, IDirectListings.Listing listing)
310+
event UpdatedListing(address indexed listingCreator, uint256 indexed listingId, address indexed assetContract, IDirectListings.Listing listing)
310311
```
311312

312313
Emitted when a listing is updated.
@@ -319,6 +320,7 @@ Emitted when a listing is updated.
319320
|---|---|---|
320321
| listingCreator `indexed` | address | undefined |
321322
| listingId `indexed` | uint256 | undefined |
323+
| assetContract `indexed` | address | undefined |
322324
| listing | IDirectListings.Listing | undefined |
323325

324326

‎docs/IEnglishAuctions.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ Emitted when a auction is cancelled.
279279
### NewAuction
280280

281281
```solidity
282-
event NewAuction(address indexed auctionCreator, uint256 indexed auctionId, IEnglishAuctions.Auction auction)
282+
event NewAuction(address indexed auctionCreator, uint256 indexed auctionId, address indexed assetContract, IEnglishAuctions.Auction auction)
283283
```
284284

285285

@@ -292,12 +292,13 @@ event NewAuction(address indexed auctionCreator, uint256 indexed auctionId, IEng
292292
|---|---|---|
293293
| auctionCreator `indexed` | address | undefined |
294294
| auctionId `indexed` | uint256 | undefined |
295+
| assetContract `indexed` | address | undefined |
295296
| auction | IEnglishAuctions.Auction | undefined |
296297

297298
### NewBid
298299

299300
```solidity
300-
event NewBid(uint256 indexed auctionId, address indexed bidder, uint256 bidAmount, IEnglishAuctions.Auction auction)
301+
event NewBid(uint256 indexed auctionId, address indexed bidder, address indexed assetContract, uint256 bidAmount, IEnglishAuctions.Auction auction)
301302
```
302303

303304

@@ -310,6 +311,7 @@ event NewBid(uint256 indexed auctionId, address indexed bidder, uint256 bidAmoun
310311
|---|---|---|
311312
| auctionId `indexed` | uint256 | undefined |
312313
| bidder `indexed` | address | undefined |
314+
| assetContract `indexed` | address | undefined |
313315
| bidAmount | uint256 | undefined |
314316
| auction | IEnglishAuctions.Auction | undefined |
315317

‎docs/IOffers.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ function makeOffer(IOffers.OfferParams _params) external nonpayable returns (uin
139139
### AcceptedOffer
140140

141141
```solidity
142-
event AcceptedOffer(uint256 indexed offerId, address indexed assetContract, address indexed offeror, uint256 tokenId, address seller, uint256 quantityBought, uint256 totalPricePaid)
142+
event AcceptedOffer(address indexed offeror, uint256 indexed offerId, address indexed assetContract, uint256 tokenId, address seller, uint256 quantityBought, uint256 totalPricePaid)
143143
```
144144

145145

@@ -150,9 +150,9 @@ event AcceptedOffer(uint256 indexed offerId, address indexed assetContract, addr
150150

151151
| Name | Type | Description |
152152
|---|---|---|
153+
| offeror `indexed` | address | undefined |
153154
| offerId `indexed` | uint256 | undefined |
154155
| assetContract `indexed` | address | undefined |
155-
| offeror `indexed` | address | undefined |
156156
| tokenId | uint256 | undefined |
157157
| seller | address | undefined |
158158
| quantityBought | uint256 | undefined |
@@ -178,7 +178,7 @@ event CancelledOffer(address indexed offeror, uint256 indexed offerId)
178178
### NewOffer
179179

180180
```solidity
181-
event NewOffer(address indexed offeror, uint256 indexed offerId, IOffers.Offer offer)
181+
event NewOffer(address indexed offeror, uint256 indexed offerId, address indexed assetContract, IOffers.Offer offer)
182182
```
183183

184184

@@ -191,6 +191,7 @@ event NewOffer(address indexed offeror, uint256 indexed offerId, IOffers.Offer o
191191
|---|---|---|
192192
| offeror `indexed` | address | undefined |
193193
| offerId `indexed` | uint256 | undefined |
194+
| assetContract `indexed` | address | undefined |
194195
| offer | IOffers.Offer | undefined |
195196

196197

‎docs/MarketplaceRouter.md renamed to ‎docs/MarketplaceV3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# MarketplaceRouter
1+
# MarketplaceV3
22

33

44

‎docs/OffersLogic.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ function totalOffers() external view returns (uint256)
207207
### AcceptedOffer
208208

209209
```solidity
210-
event AcceptedOffer(uint256 indexed offerId, address indexed assetContract, address indexed offeror, uint256 tokenId, address seller, uint256 quantityBought, uint256 totalPricePaid)
210+
event AcceptedOffer(address indexed offeror, uint256 indexed offerId, address indexed assetContract, uint256 tokenId, address seller, uint256 quantityBought, uint256 totalPricePaid)
211211
```
212212

213213

@@ -218,9 +218,9 @@ event AcceptedOffer(uint256 indexed offerId, address indexed assetContract, addr
218218

219219
| Name | Type | Description |
220220
|---|---|---|
221+
| offeror `indexed` | address | undefined |
221222
| offerId `indexed` | uint256 | undefined |
222223
| assetContract `indexed` | address | undefined |
223-
| offeror `indexed` | address | undefined |
224224
| tokenId | uint256 | undefined |
225225
| seller | address | undefined |
226226
| quantityBought | uint256 | undefined |
@@ -246,7 +246,7 @@ event CancelledOffer(address indexed offeror, uint256 indexed offerId)
246246
### NewOffer
247247

248248
```solidity
249-
event NewOffer(address indexed offeror, uint256 indexed offerId, IOffers.Offer offer)
249+
event NewOffer(address indexed offeror, uint256 indexed offerId, address indexed assetContract, IOffers.Offer offer)
250250
```
251251

252252

@@ -259,6 +259,7 @@ event NewOffer(address indexed offeror, uint256 indexed offerId, IOffers.Offer o
259259
|---|---|---|
260260
| offeror `indexed` | address | undefined |
261261
| offerId `indexed` | uint256 | undefined |
262+
| assetContract `indexed` | address | undefined |
262263
| offer | IOffers.Offer | undefined |
263264

264265

0 commit comments

Comments
 (0)