Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sj-97 authored May 25, 2022
1 parent 1dbf9f8 commit b5a69ee
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
# aptos-nft-marketplace
Basic NFT Marketplace built using Move modules and deployed on the Aptos blockchain.

Please make changes to the paths commented in Cargo.toml and Move.toml after cloning this repo.
Run the code using
`npx ts-code auction_client.ts`
`npx ts-code fixed_price_client.ts`

## Supported functions:

initMarket: initializes the NFT marketplace
- listToken: lists your NFT for fixed price sale
- buyToken: buys you the said NFT for fixed price
- initAuction: initialized an auction for the desired NFT
- bid: bid on the desired NFT
- claimToken: highest bidder can claim the token from seller after the auction is over
- claimCoins: seller can claim the coins from the highest bidder after the auction is over

listTokenForSale: lists your NFT for sale

buyToken: buys you the said NFT

## Accounts:

Seller: account that is trying to sell their NFT

Buyer: account that is trying to buy an NFT

MarketOwner: account which holds all the NFT marketplace related data
- Seller: account that is selling their NFT
- Buyer: account that is buying an NFT
- Bidder: account that is bidding for auction

0 comments on commit b5a69ee

Please sign in to comment.