setDescription

setDescription is a method on the ANT class that updates the descriptive text for the ANT process.

setDescription requires authentication.

Parameters

← Swipe to see more →
ParameterTypeDescriptionOptional
descriptionstringThe descriptive text to set for the ANT processfalse
tagsarrayAn array of GQL tag objects to attach to the transfer AO message.true
← Swipe to see more →

Examples

setDescription

 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.setDescription(
         { description: 'A friendly description of this ANT' },
         // optional tags
         { tags: [{ name: 'App-Name', value: 'My-Awesome-App' }] },
     );
 }

 main();