Documentation updates

Author: rynoV

index.d.ts

@@ -2,6 +2,11 @@ export function callMarketPlaceBuy(config: Config, args: BuyNftArgs):
     Promise<void>
 export function callMarketPlaceListNft(config: Config):
     Promise<Array<NftListing>>
+/**
+ * Fetch the info for a single NFT. Returns null if the given
+ * transaction input has been spent (for example if the NFT has been
+ * bought).
+ */
 export function callMarketPlaceFetchNft(config: Config, args: FetchNftArgs):
     Promise<NftListing?>
 export function connectWallet(): Promise<any>

index.js

@@ -27,11 +27,6 @@ exports.callMarketPlaceListNft = async (config) => {
   return sb.callMarketPlaceListNft(config)();
 };
 
-/**
- * Calls Seabug Contract 'marketPlaceFetchNft'.
- * Returns a promise holding the up to date data for the given utxo
- * reference.
- */
 exports.callMarketPlaceFetchNft = async (config, args) => {
   const sb = await seabug;
   return sb.callMarketPlaceFetchNft(config)(args)();

src/Seabug/Contract/Common.purs

@@ -1,4 +1,3 @@
--- |
 module Seabug.Contract.Common
   ( NftResult
   ) where

src/Seabug/Contract/MarketPlaceFetchNft.purs

@@ -5,7 +5,7 @@ module Seabug.Contract.MarketPlaceFetchNft
 
 import Contract.Prelude
 
-import Contract.Monad (Contract, liftContractM, liftedE, liftedM)
+import Contract.Monad (Contract, liftContractM, liftedE, liftedM, logWarn')
 import Contract.PlutusData (fromData, getDatumByHash)
 import Contract.Transaction (TransactionInput, TransactionOutput(..))
 import Contract.Utxos (getUtxo)
@@ -14,14 +14,17 @@ import Seabug.Contract.Common (NftResult)
 import Seabug.Metadata (getFullSeabugMetadataWithBackoff)
 import Seabug.Types (MarketplaceDatum(..))
 
+-- | Fetch the info for a single NFT identified by a utxo
+-- | (`TransactionInput`). Returns `Nothing` if the given transaction
+-- | input has been spent (for example if the NFT has been bought).
 marketPlaceFetchNft
   :: forall (r :: Row Type)
    . TransactionInput
   -> Contract (projectId :: String | r) (Maybe NftResult)
 marketPlaceFetchNft ref = do
   getUtxo ref >>= case _ of
     Nothing -> do
-      log "Could not find NFT utxo, it may have been spent"
+      logWarn' "Could not find NFT utxo, it may have been spent"
       pure Nothing
     Just output@(TransactionOutput nftTxOut) -> do
       datumHash <- liftContractM "Datum hash not available for NFT"