psf-memo-client/test/unit/memo-set-name.test.js

/*
  Unit tests for the Memo set-name behavior slice (src/services/memo-set-name.js).

  These tests express the observable behavior described by specs/set-name.feature:
    - a valid name broadcasts an OP_RETURN transaction carrying the Memo set-name
      prefix (0x6d01) and the name text, and the profile store reflects the new
      name.
    - an empty name is rejected with a validation error and nothing is broadcast.
    - an over-long name is rejected with a length error and nothing is broadcast.
*/

'use strict'

const test = require('node:test')
const assert = require('node:assert/strict')

const MemoSetName = require('../../src/services/memo-set-name')
const { fakeWallet } = require('../helpers/fake-wallet')
const { fakeProfiles } = require('../helpers/fake-profiles')
const { registerMemoActionTests } = require('./memo-action-helpers')

registerMemoActionTests({
  Action: MemoSetName,
  method: 'setName',
  MAX: 77,
  lengthCode: 'name_length',
  validationCode: 'name_validation',
  label: 'setting a name',
  storeKey: 'profiles',
  storeFactory: fakeProfiles,
  assertStoreEmpty: (profiles, wallet) => assert.equal(profiles.getName(wallet.walletInfo.cashAddress), null),
  byteBased: true
})
test('MEMO_SET_NAME_PREFIX is the Memo set-name action 0x6d01', () => {
  assert.equal(MemoSetName.MEMO_SET_NAME_PREFIX, '6d01')
})

test('setting a valid name broadcasts an OP_RETURN with the Memo set-name prefix and name', async () => {
  const wallet = fakeWallet()
  const profiles = fakeProfiles()
  const memoSetName = new MemoSetName({ wallet, profiles })

  const txid = await memoSetName.setName('trout')

  assert.equal(txid, 'fake-txid')
  assert.equal(wallet.broadcasts.length, 1)
  const b = wallet.broadcasts[0]
  assert.equal(b.prefix, '6d01')
  assert.equal(b.msg, 'trout')

  // The profile store reflects the new name for this address.
  assert.equal(profiles.getName(wallet.walletInfo.cashAddress), 'trout')
})

test('setting an empty name throws a validation error and broadcasts nothing', async () => {
  const wallet = fakeWallet()
  const profiles = fakeProfiles()
  const memoSetName = new MemoSetName({ wallet, profiles })

  await assert.rejects(
    memoSetName.setName(''),
    (err) => err.code === 'name_validation'
  )
  assert.equal(wallet.broadcasts.length, 0)
  assert.equal(profiles.getName(wallet.walletInfo.cashAddress), null)
})

test('setting a name without a wallet reports a missing-wallet error', async () => {
  const memoSetName = new MemoSetName({})
  await assert.rejects(
    memoSetName.setName('trout'),
    (err) => /wallet/i.test(err.message)
  )
})

test('a failed broadcast does not update the profile store', async () => {
  const wallet = fakeWallet()
  wallet.sendOpReturn = async () => { throw new Error('broadcast failure') }
  const profiles = fakeProfiles()
  const memoSetName = new MemoSetName({ wallet, profiles })

  await assert.rejects(
    memoSetName.setName('trout'),
    (err) => /broadcast failure/i.test(err.message)
  )
  assert.equal(wallet.broadcasts.length, 0)
  assert.equal(profiles.getName(wallet.walletInfo.cashAddress), null)
})