lightning/lnd_methods/peers/update_alias.js

Lightning Network client library

const asyncAuto = require('async/auto');
const {returnResult} = require('asyncjs-util');

const {isLnd} = require('./../../lnd_requests');

const errorUnimplemented = 'unknown service peersrpc.Peers';
const method = 'updateNodeAnnouncement';
const type = 'peers';

/** Update the node alias as advertised in the graph

  Note: this method is not supported in LND versions 0.14.5 and below

  Requires LND built with `peersrpc` build tag

  Requires `peers:write` permissions

  {
    alias: <Node Alias String>
    lnd: <Authenticated LND API Object>
  }

  @returns via cbk or Promise
*/
module.exports = ({alias, lnd}, cbk) => {
  return new Promise((resolve, reject) => {
    return asyncAuto({
      // Check arguments
      validate: cbk => {
        if (alias === undefined) {
          return cbk([400, 'ExpectedAliasToUpdateNodeAnnouncementAlias']);
        }

        if (!isLnd({lnd, method, type})) {
          return cbk([400, 'ExpectedLndToUpdateNodeAnnouncementAlias']);
        }

        return cbk();
      },

      // Update the node alias with the updated alias
      updateAlias: ['validate', ({}, cbk) => {
        return lnd[type][method]({alias}, (err, res) => {
          if (!!err && err.details === errorUnimplemented) {
            return cbk([400, 'ExpectedPeersRpcLndBuildTagToUpdateAlias']);
          }

          if (!!err) {
            return cbk([503, 'UnexpectedErrorUpdatingNodeAlias', {err}]);
          }

          return cbk();
        });
      }],
    },
    returnResult({reject, resolve}, cbk));
  });
};