setName

setName is a method on the ANT class that updates the display name of the ANT process.

setName requires authentication.

Parameters

ParameterTypeDescriptionOptional
namestringThe display name to set for the ANT processfalse
tagsarrayAn array of GQL tag objects to attach to the transfer AO message.true

Examples

setName

 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.setName(
         { name: 'My ANT' },
         // optional additional tags
         { tags: [{ name: 'App-Name', value: 'My-Awesome-App' }] },
     );
 }

 main();