Marketplace Functions

In the ORB ecosystem, we extend the scope of possibilities of the ORB3 API with the introduction of the Marketplace functions. In this section, we will delve into the functionalities that empower you to seamlessly navigate the realm of buying, selling, and auctioning your unique Collectibles.

List, Offer, Auction, Bid

In the following sections, we will explain through a step by step process, how you can use the ORB3 API in order to:

  • List a Collectible for Sale

  • Make an Offer on a Collectible:

  • Auction Your Collectibles:

  • Bid on Auctions:

If you own a Collectible, you are able to list it for sale for a set price. Furthermore, you can also set more that one editions of a Collectible for an auction, where users will be able to actively bid to buy it. You can also make an Offer on a Collectible, regardless of whether it is listed for sale, thus showing your interest in wanting to buy it from an owner.

The way these Marketplace features work on the Blockchain can be best, and very simply, be described as following:

In order to make these marketplace functions fully decentralized, when you want to list a Collectible for sale, the Collectible is firstly sent to a contract address - the Marketplace contract address. It will stay there until someone buys it. When someone decides to buy the Collectible, then it will be released from the contract address and sent to the wallet address of the buyer. The previous owner of the Collectible will be sent the amount of money the Collectible was sold for.

In order to be able to list or add to an auction any of the Collectibled you have previously created, you will need to add the Marketplace contract as an operator to the token. Once it has been added, the token will be able to be automatically send to the Marketplace contract address.

Update Operator for Marketplace

Use the following Mutation to update the operators of the smart contract.

UpdateOperator
mutation UpdateOperator($input: UpdateOperatorInput!) {
  UpdateOperator(input: $input) {
    status,
    transactionHash
  }
}
Input Variables
"updateOperatorInput": {
    "contractAddress": "KT1SjwraTtii88ZaEs8ReU6wkUreTvM8qfaa",
    "operator": "KT1S7gpdycJ7EGQFDDebsUhVG52iZr4mvvG4",
    "owner": "tz1i7SnAcekYtyPv1RZ9YBbnd8ScNcREVaDK",
    "tokenId": "0",
    "type": "add_operator"
}

In terms of the input variables of the mutation, here are a few tips to help you understand the process:

  • contractAddress: This is the collectionId of the collectible on which this mutation will have an effect on. More specifically, this is the collectionId under which you have created your collectible.

  • operator: This is the contract address of the Marketplace.

  • owner: This is the developer wallet that has created the collectible - the owner of the collectible.

  • tokenId: The tokenId of the collectible the update operator function will be applied to.

  • type: This is set by default to "add_operator" in order to allow the Collectible to be send to the Marketplace contract address.

Sample Response
{
  "data": {
    "UpdateOperator": {
      "status": "applied",
      "transactionHash": "ooRADFbt8ftELT5Vd3qwH3vfmxy1WZz7Ma57ssdBTMmPWKpZi7"
    }
  }
}

Once the transaction has been signed from the developer, the Collectible will be able to be listed for sale, or added for an Auction in the ORB Marketplace.

Unlocking Marketplace Potential

The Marketplace functions seamlessly within the ORB ecosystem, extending the lifecycle of your Collectibles beyond creation. As a developer, this section equips you with the tools and insights needed to navigate the intricacies of selling, offering, auctioning, and bidding on Collectibles within the dynamic ORB Marketplace. Everything that happens in your game through the Marketplace functions will automatically be reflected in the ORB Marketplace & Platform.

In the following segments of the documentation, we will show you how you can integrate the Marketplace functions in your game.

Last updated