releaseName

releaseName is a method on the ANT class that releases an ArNS name from the ANT, making it available for auction on the ARIO contract. The name must be permanently owned by the releasing wallet. Upon successful auction, 50% of the winning bid will be distributed to the ANT owner at the time of release. If there are no bids, the name becomes available for anyone to register.

releaseName requires authentication.

Parameters

ParameterTypeDescriptionOptional
namestringThe ArNS name to be releasedfalse
ioProcessIdstringThe Process ID of the ARIO contractfalse
tagsarrayAn array of GQL tag objects to attach to the transfer AO messagetrue

Examples

releaseName

 const fs = require("fs");
 const { ANT, ArweaveSigner } = require("@ar.io/sdk");

 async function main() {
 const jwk = JSON.parse(fs.readFileSync("KeyFile.json"));
 const ant = ANT.init({
     signer: new ArweaveSigner(jwk),
     processId: "bh9l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM"
 });

 const { id: txId } = await ant.releaseName({
         name: 'permalink',
         ioProcessId: ARIO_PROCESS_ID, // releases the name owned by the ANT and sends it to auction on the ARIO contract
     });
 }

 main();