Jw/fix marketplace doc issues (#435)

Author: jarrodwatts

docs/sdk.marketplace.getlisting.md

@@ -26,13 +26,13 @@ either a direct or auction listing
 
 ## Remarks
 
-Create and manage auctions in your marketplace.
+Get a listing by its listing id
 
 ## Example
 
 
 ```javascript
-const listingId = "1";
+const listingId = 0;
 const listing = await contract.getListing(listingId);
 ```
 

docs/sdk.marketplace.setbidbufferbps.md

@@ -31,7 +31,7 @@ A percentage (e.g. 5%) in basis points (5% = 500, 100% = 10000). A new bid is co
 
 ```javascript
 // the bid buffer in basis points
-const bufferBps = 500; // 5%
+const bufferBps = 5_00; // 5%
 await contract.setBidBufferBps(bufferBps);
 ```
 

docs/sdk.marketplacedirect.makeoffer.md

@@ -34,6 +34,8 @@ Make an offer on a direct listing
 
 
 ```javascript
+import { ChainId, NATIVE_TOKENS } from "@thirdweb-dev/sdk";
+
 // The listing ID of the asset you want to offer on
 const listingId = 0;
 // The price you are willing to offer per token
@@ -47,7 +49,7 @@ await contract.direct.makeOffer(
   listingId,
   quantity,
   currencyContractAddress,
-  bidAmount
+  pricePerToken
 );
 ```
 

docs/snippets.json

@@ -370,9 +370,9 @@
       {
         "name": "getListing",
         "summary": "Convenience function to get either a direct or auction listing\n\n",
-        "remarks": "\n\nCreate and manage auctions in your marketplace.\n\n",
+        "remarks": "\n\nGet a listing by its listing id\n\n",
         "examples": {
-          "javascript": "const listingId = \"1\";\nconst listing = await contract.getListing(listingId);"
+          "javascript": "const listingId = 0;\nconst listing = await contract.getListing(listingId);"
         },
         "reference": "https://docs.thirdweb.com/typescript/sdk.Marketplace.getListing"
       },
@@ -381,7 +381,7 @@
         "summary": "Set the Auction bid buffer\n\n",
         "remarks": "\n\nA percentage (e.g. 5%) in basis points (5% = 500, 100% = 10000). A new bid is considered to be a winning bid only if its bid amount is at least the bid buffer (e.g. 5%) greater than the previous winning bid. This prevents buyers from making very slightly higher bids to win the auctioned items.\n\n",
         "examples": {
-          "javascript": "// the bid buffer in basis points\nconst bufferBps = 500; // 5%\nawait contract.setBidBufferBps(bufferBps);"
+          "javascript": "// the bid buffer in basis points\nconst bufferBps = 5_00; // 5%\nawait contract.setBidBufferBps(bufferBps);"
         },
         "reference": "https://docs.thirdweb.com/typescript/sdk.Marketplace.setBidBufferBps"
       },
@@ -537,7 +537,7 @@
         "summary": "Make an offer for a Direct Listing\n\n",
         "remarks": "\n\nMake an offer on a direct listing\n\n",
         "examples": {
-          "javascript": "// The listing ID of the asset you want to offer on\nconst listingId = 0;\n// The price you are willing to offer per token\nconst pricePerToken = 1;\n// The quantity of tokens you want to receive for this offer\nconst quantity = 1;\n// The address of the currency you are making the offer in (must be ERC-20)\nconst currencyContractAddress = NATIVE_TOKENS[ChainId.Rinkeby].wrapped.address\n\nawait contract.direct.makeOffer(\n  listingId,\n  quantity,\n  currencyContractAddress,\n  bidAmount\n);"
+          "javascript": "import { ChainId, NATIVE_TOKENS } from \"@thirdweb-dev/sdk\";\n\n// The listing ID of the asset you want to offer on\nconst listingId = 0;\n// The price you are willing to offer per token\nconst pricePerToken = 1;\n// The quantity of tokens you want to receive for this offer\nconst quantity = 1;\n// The address of the currency you are making the offer in (must be ERC-20)\nconst currencyContractAddress = NATIVE_TOKENS[ChainId.Rinkeby].wrapped.address\n\nawait contract.direct.makeOffer(\n  listingId,\n  quantity,\n  currencyContractAddress,\n  pricePerToken\n);"
         },
         "reference": "https://docs.thirdweb.com/typescript/sdk.MarketplaceDirect.makeOffer"
       }

src/contracts/marketplace.ts

@@ -197,10 +197,10 @@ export class Marketplace implements UpdateableNetwork {
    * @param listingId - the listing id
    * @returns either a direct or auction listing
    *
-   * @remarks Create and manage auctions in your marketplace.
+   * @remarks Get a listing by its listing id
    * @example
    * ```javascript
-   * const listingId = "1";
+   * const listingId = 0;
    * const listing = await contract.getListing(listingId);
    * ```
    */
@@ -364,7 +364,7 @@ export class Marketplace implements UpdateableNetwork {
    * @example
    * ```javascript
    * // the bid buffer in basis points
-   * const bufferBps = 500; // 5%
+   * const bufferBps = 5_00; // 5%
    * await contract.setBidBufferBps(bufferBps);
    * ```
    * @param bufferBps - the bps value

src/core/classes/marketplace-direct.ts

@@ -219,6 +219,8 @@ export class MarketplaceDirect {
    *
    * @example
    * ```javascript
+   * import { ChainId, NATIVE_TOKENS } from "@thirdweb-dev/sdk";
+   *
    * // The listing ID of the asset you want to offer on
    * const listingId = 0;
    * // The price you are willing to offer per token
@@ -232,7 +234,7 @@ export class MarketplaceDirect {
    *   listingId,
    *   quantity,
    *   currencyContractAddress,
-   *   bidAmount
+   *   pricePerToken
    * );
    * ```
    */