Boost

Generate a claim signature that can be used to submit a claim

Changed on

Given a tx hash, id, and valid claim data hash, generate a valid signature that can be used to claim a reward on chain.

get/signatures

Request

  • Base URL
    https://api-v2.boost.xyz
  • Auth
    none declared

Query parameters

txHashstring required

Transaction hash of transaction that satisfies a reward's action that unlocks claim rewards.

Hex in format 0x[0-9a-fA-F]{64}

boostIdstring required

System reward ID in the format chainId:boostCoreAddress:identifier

Example:8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1

BoostID in format chainId:boostCoreAddress:identifier

claimDataunknown

Response

Successfully generated a claim signature

signaturestring required

Claim signature that can be used with the Boost Protocol V2's claim/claimIncentiveFor methods

claimantstring required

The address for the user making the claim

referrerstring required

The address of the referrer

incentiveIdnumber required

The index of the incentive being claimed, typically 0

Example response

[
  {
    "claimant": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
    "referrer": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
  }
]

Changes

    • info

      added the required property / to the response with the status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from integer to number for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      api operation id getSignatures was added

    • info

      api tag Boost added

    • info

      api tag boosts removed

    • info

      api tag claiming removed

    • info

      removed the pattern ^0x[a-fA-F0-9]{64}$ from the query request parameter txHash

    • info

      removed the pattern ^[0-9]+:[0-9]+$ from the query request parameter boostId

    • info

      for the query request parameter claimData, the type was generalized from string to no type

    • info

      added the non-success response with the status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      the / response's property pattern ^0x[a-fA-F0-9]{40}$ was added for the status