Check ERC2981 Royalty

To know the methods calling to Startrail API from Startrail-Sdk-Js

checkERC2981Royalty()

Retrieve royalty payment information for SRR that is in accordance with ERC-2981 for non-fungible tokens (NFTs).

Refer to ERC-2981: NFT Royalty Standard for more details.

Method parameters

Variable	Type	Description
contractAddress	string	The address of collection contract. Sets it when you want to associate collection contract address with the SRR.
tokenId	string	Startrail Registry Record Token ID. Sets it when SRR is already issued and you know the tokenId.
metadata	object	Sets it instead of tokenId if SRR has not been issued yet. Refer to the Startrail Registry (SRR) data schema for all possible data
issuerAddress	string	The ethereum address of the issuer of the artwork. Sets it instead of tokenId if SRR has not been issued yet.

Parameters Example

sdk.checkERC2981Royalty(
  {  
    tokenId: '212786904920'
  }
)

Returns

Promise will be returned which resolves with a Response object upon a successful confirmation. false will be returned when user flow is cancelled in such a case that a user closes the popup modal.

If the confirmation fails, the Promise will resolve with an {error} object that describes the failure.

Promise<Response | false>

Response

Variable	Type	Description
royaltyReceiver	string | null	The Etherem address of SRR Royalty receiver, null if its ERC2981 is not activated or ineligible
royaltyBasisPoints	string | null	SRR royalty basis points, null if its ERC2981 is not activated or ineligible. Divide it by 100 to see the actual nmber.

Error

Custom Error objects. Refer to the Error Catalogue for possible data.

Response Example

{
  "royaltyReceiver": "0xA6E6a9E20a541680a1D6E1412f5088AefBF58a22",
  "royaltyBasisPoints": "1570",
}