Approve SRR By Commitment
To know the methods calling to Startrail API from Startrail-Sdk-Js
Last updated
To know the methods calling to Startrail API from Startrail-Sdk-Js
Last updated
ยฉ2023 Startbahn, Inc.
approveSRRByCommitment()
Approve transfer to those who knows the secret value set in approveSRRByCommitment() under a commit/reveal scheme.
The approveSRRByCommitment() function alone does not initiate the transfer of the SRR. You need to call Transfer SRR Ownership by RevealHash to finalize the transfer.
When you provide a preimage
for approveSRRByCommitment
, you must hash the preimage
using keccak256
later on and provide the resulting hash as the revealHash
parameter to the transferByReveal
endpoint in order to complete the transfer. This is particularly useful in cases where the sender only knows the recipient's email, while the Dapp system, functioning as an intermediary, can determine the Ethereum address associated with that email.
When you provide a revealHash
that has been hashed with keccak256 for approveSRRByCommitment
, you can directly use it as the revealHash parameter for the transferByReveal
endpoint to finalize the transfer.
Please take care to ensure that the preimage remains sufficiently obscure to individuals who are not authorized. If it becomes predictable, anyone possessing this information will have the capability to execute the transfer.
Variable | Type | Description |
---|---|---|
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>
The use of "txReceiptId" will soon be deprecated and removed.
Custom Error
objects. Refer to the Error Catalogue for possible data.
Example
Variable | Type | Description |
---|---|---|
Variable | Type | Description |
---|---|---|
Variable | Type | Description |
---|---|---|
startrailLUWContractAddress
string
The address of LicensedUserWallet(LUW) contract. Sets it when you want to execute transaction by the LUW contract address
contractAddress
string
The address of collection contract. Sets it when you want to associate collection contract address with the SRR.
preimage
string
A string value used to reserve the transfer. Anyone who knows the value is entitled to complete the transfer. If this value is provided along with an email, confirmation emails will be sent to the email address at the time of transfer reservation and completion. This value is exclusive to revealHash
.
revealHash
string
A keccak256 hash value used to reserve the transfer. Anyone who knows the value is entitled to complete the transfer. This value is exclusive to preimage
.
See the sample code for Generating the revealHash Value below.
metadata
TransferMetadata
SRR Transfer Metadata conforming to the Transfer Data schema
isHashPreimageEnabled
boolean
(Deprecated. It will be removed soon) Setting true hashes the preimage with keccak256
transferType
string
Select one of the followings "Primary sale", "Secondary sale", "Other transferโ
remarks
Lang
Write down whatever relevant to transfer ownership
customHistoryId
number
Custom History Id that is already registered in Startrail
ja
string
Japanse text
en
string
English text
txReceiptId
string
ID to identify transaction details in Startrail-API DB.