Guides
Get API KeyStatusSupport
These docs are for v2.0. Click to read the latest docs for v3.0.

Update offer: (meta) TxApprove

How to to pass the transaction hash of the Approve transaction.

Suggest Edits

🚧

The Market API will be discontinued, in Q3 2024 we will be sunsetting this product

In order for the market to take an NFT into custody, the market requires the end user to execute a contract call, allowing the market to move the NFT. Since the market doesn't know the end-users of the client, it is up to the client to ask the user to perform the Approve transaction. Once the user has launched the Approve transaction the client sends the transaction hash of that transaction back to the market for validation.

Since there are multiple variants and standards of NFT contracts it can be difficult for a client to know for each NFT contract which function to call and which input parameter each function might need. To overcome that specific pain the market also provides an endpoint that returns that required information, allowing the client to easily query what they need to forward to their end-users.

Based on contract specifics, one of two approvals need to be done: Meta transaction approvals, or (traditional) transaction approvals. To know which approval needs to be done, look for the response in Get Preparation Transaction & Signable Messages.

Meta Transaction Approval

Request Endpoint: reference

PUT /offers/{id}/metaTxApprove
ParameterParam TypeDescriptionData TypeMandatory
{id}PathThe offer IDString✅
functionSignatureBodyFor a meta-transaction the signature parameter that you get as the response to the signing step, needs to be transmitted as the functionSignature parameterString✅
rBodyThe value you get as a response from the signature callString✅
sBodyThe value you get as a response from the signature callString✅
vBodyThe value you get as a response from the signature callString✅

Traditional Transaction Approval

Request Endpoint: reference

PATCH /offers/{id}/txapprove
ParameterParam TypeDescriptionData TypeMandatory
{id}PathThe offer IDString✅
txApproveBodyThis is the transaction hash after the required approval transactions are executed for the offerString✅

📘

Note that in order to move an offer from state NEW to state READY, the offer will need a second update, which is Update offer: Signature.

Which TxApprove needs to be done?

The Approve transaction that needs to be done can differ, depending on the specific contract that is being used, or the actions that have already been done.

Types of approvals:

  • Meta transaction approval:
    • Only a signature is needed for Venly to take the NFT into custody and put it on sale.
  • Traditional transaction approval:
    • A (blockchain) transaction needs to be executed on a contract.
  • No approval is needed (it is already done in the past):
    • The Approve transaction is not always required, when a wallet has approved the market for a specific NFT contract in the past the wallet will not be required to approve the market a second time. More concrete if a user has approved the market to take an NFT of a certain NFT contract into custody he will not have to approve the market next time he wants to sell a different NFT of the same NFT contract.

📘

In the case that no approval is needed the Update offer: TxApprove step can be skipped and moved directly to Update offer: Signature.

Retrieve the correct TxApprove type

To know which TxApprove step needs to be done, you can call the Get Preparation Transaction & Signable Messages endpoint. It contains all the necessary information to perform the approval step.

  • When the result set is empty it means the Approve step can be skipped.
  • If the result set contains data, then the Approve still needs to happen:
  • If signableMessages is present, you need to sign a specific message. See Sign a message.

Example Request:

PATCH https://api.arkane.market/offers/b91c6f5f-5ebd-4941-99c1-94e9d1cbd9d5/txapprove

{
    "txApprove": "0x7c7fe6ffa8100851e00676ebfea524dc6c666e017da67f07ac4f93e48d1329af"
}

Response Body:

{
    "success": true,
    "result": {
        "id": "b91c6f5f-5ebd-4941-99c1-94e9d1cbd9d5",
        "nft": {
            "tokenId": "2",
            "address": "0x492aef91afb79efaa508debbed7b3e21069d13e3",
            "chain": "ETHEREUM",
            "name": "Cauliflower Pizza",
            "description": "Awesome cauliflower crust pizza with cured pepperoni. Found on a BBS in the early 80s.",
            "imageUrl": "https://lh3.googleusercontent.com/0Dw7pMcyX_m7T_6q3zzrvjmYMg-Matgg8c42DTGvviRDI8M7fa3Ot9siVfhzE0gqolLshVp2O6T3QdccmVblMurg7A",
            "url": "",
            "imagePreviewUrl": "https://lh3.googleusercontent.com/0Dw7pMcyX_m7T_6q3zzrvjmYMg-Matgg8c42DTGvviRDI8M7fa3Ot9siVfhzE0gqolLshVp2O6T3QdccmVblMurg7A=s250",
            "imageThumbnailUrl": "https://lh3.googleusercontent.com/0Dw7pMcyX_m7T_6q3zzrvjmYMg-Matgg8c42DTGvviRDI8M7fa3Ot9siVfhzE0gqolLshVp2O6T3QdccmVblMurg7A=s128",
            "attributes": [
                {
                    "traitType": "topping",
                    "value": "cheese",
                    "traitCount": 4
                },
                {
                    "traitType": "crust",
                    "value": "cauliflower",
                    "traitCount": 2
                },
                {
                    "traitType": "topping",
                    "value": "pepperoni",
                    "traitCount": 2
                },
                {
                    "traitType": "level",
                    "value": "7",
                    "traitCount": 1
                },
                {
                    "traitType": "fuel",
                    "value": "3.4",
                    "traitCount": 1
                },
                {
                    "traitType": "cauliflower_power",
                    "value": "80",
                    "displayType": "boost_number",
                    "traitCount": 1
                },
                {
                    "traitType": "bellyfat_increase",
                    "value": "3",
                    "displayType": "boost_percentage",
                    "traitCount": 1
                }
            ],
            "contract": {
                "chain": "ETHEREUM",
                "address": "0x492aef91afb79efaa508debbed7b3e21069d13e3",
                "count": 0,
                "name": "CryptoPizza Shop",
                "description": "In honor of the dude who paid 10k BTC for two large pizzas in 2010, I'm proud to announce the first ever CryptoPizza Shop! Collect these slices - more to be added soon, but these OG CryptoPizza Slices will go down in history!",
                "symbol": "OSC",
                "imageUrl": "https://rinkeby-storage.opensea.io/0x492aef91afb79efaa508debbed7b3e21069d13e3-1561429292.png"
            }
        },
        "sellerId": "7cbc2bd3-b3d7-4d8e-bda8-173e56189f75",
        "sellerAddress": "0xdb7c22EA49EF93F753F2ed4c9E1A2589aC6E7690",
        "startDate": "2020-10-21T14:46:09.252659Z",
        "endDate": "2020-10-31T14:46:09.252674Z",
        "type": "SALE",
        "status": "NEW",
        "dataToSign": "b91c6f5f-5ebd-4941-99c1-94e9d1cbd9d5_0xdb7c22EA49EF93F753F2ed4c9E1A2589aC6E7690_0xb06b3f1e824BD7eFC0BCe584cF6B772dC0Ff7C75_2",
        "txApprove": "0xd5234cc910c382a4807d94b5af3be68f62ecac867bef9a61e984dfad08257a44",
        "createdOn": "2020-10-21T14:46:09.305261Z",
        "createdBy": "7cbc2bd3-b3d7-4d8e-bda8-173e56189f75",
        "price": 25
    }
}

Updated 6 months ago