fix: migrate subdomains to wallet key address

Author: ahsan-javaid

packages/cli/src/argparse.ts

@@ -1380,6 +1380,33 @@ export const CLI_ARGS = {
         '\n',
       group: 'Key Management',
     },
+    migrate_subdomains: {
+      type: 'array',
+      items: [
+        {
+          name: 'backup_phrase',
+          type: 'string',
+          realtype: '24_words_or_ciphertext',
+        },
+      ],
+      minItems: 1,
+      maxItems: 1,
+      help:
+        'Enable users to transfer subdomains to wallet-key addresses that correspond to all data-key addresses \n' +
+        'This command performs these steps in sequence: \n' +
+        "1. Detects whether there are any subdomains registered with the user's key and owned by data-key-derived addresses\n" +
+        '2. Prompts the user to confirm whether they want to migrate these subdomains to the corresponding wallet-key-derived addresses for their key by position\n' +
+        "3. Alerts the user to any subdomains that can't be migrated to these wallet-key-derived addresses given collision with existing usernames owned by them\n" +
+        '4. Initiates request to subdomain registrar using new transfer endpoint upon confirmation\n' +
+        '5. Displays message indicating how long the user will have to wait until request is likely fulfilled\n' +
+        '6. Displays confirmation that no subdomains are pending migration if user tries to execute command again\n' +
+        '\n' +
+        'Example\n' +
+        '\n' +
+        '    $ stx migrate_subdomains "toast canal educate tissue express melody produce later gospel victory meadow outdoor hollow catch liberty annual gasp hat hello april equip thank neck cruise"\n' +
+        '\n',
+      group: 'Blockstack ID Management',
+    },
     get_zonefile: {
       type: 'array',
       items: [

packages/cli/src/cli.ts

@@ -42,6 +42,8 @@ import {
   pubKeyfromPrivKey,
   createStacksPrivateKey,
   AnchorMode,
+  signWithKey,
+  compressPublicKey,
 } from '@stacks/transactions';
 import { buildPreorderNameTx, buildRegisterNameTx } from '@stacks/bns';
 import { StacksMainnet, StacksTestnet } from '@stacks/network';
@@ -109,10 +111,17 @@ import {
   ClarityFunctionArg,
   generateExplorerTxPageUrl,
   isTestnetAddress,
+  subdomainOpToZFPieces,
+  SubdomainOp,
 } from './utils';
 
 import { handleAuth, handleSignIn } from './auth';
-import { generateNewAccount, generateWallet, getAppPrivateKey } from '@stacks/wallet-sdk';
+import {
+  generateNewAccount,
+  generateWallet,
+  getAppPrivateKey,
+  restoreWalletAccounts,
+} from '@stacks/wallet-sdk';
 import { getMaxIDSearchIndex, setMaxIDSearchIndex, getPrivateKeyAddress } from './common';
 // global CLI options
 let txOnly = false;
@@ -317,6 +326,163 @@ async function getStacksWalletKey(network: CLINetworkAdapter, args: string[]): P
   return JSONStringify(keyInfo);
 }
 
+/**
+ * Enable users to transfer subdomains to wallet-key addresses that correspond to all data-key addresses
+ * Reference: https://github.com/hirosystems/stacks.js/issues/1209
+ * args:
+ * @mnemonic (string) the 12-word phrase to retrieve the privateKey & address
+ */
+async function migrateSubdomains(network: CLINetworkAdapter, args: string[]): Promise<string> {
+  // Decrypt the mnemonic input given by user
+  const mnemonic: string = await getBackupPhrase(args[0]); // args[0] is the cli argument for mnemonic
+  // Get baseWallet from mnemonic given by user
+  const baseWallet = await generateWallet({ secretKey: mnemonic, password: '' });
+  // Find network type to find user accounts
+  const _network = network.isMainnet() ? new StacksMainnet() : new StacksTestnet();
+  // fetch list of accounts stored in a json file on Gaia
+  const wallet = await restoreWalletAccounts({
+    wallet: baseWallet,
+    gaiaHubUrl: 'https://hub.blockstack.org',
+    network: _network,
+  });
+  // Inform user about retrieved accounts
+  console.log(`Accounts found: ${wallet.accounts.length}`);
+  // Use this status instance and return at the end of command completion
+  const status = { found: 0, migrated: 0, collisions: 0, pending: 0 };
+  // Loop over accounts and check if there are any subdomain linked with data key address
+  for (let i = 0; i < wallet.accounts.length; i++) {
+    const account = wallet.accounts[i];
+    console.log('Index: ', i, 'Account: ', account);
+    // Get data key address from data private key
+    const dataKeyAddress = getAddressFromPrivateKey(
+      account.dataPrivateKey,
+      network.isMainnet() ? TransactionVersion.Mainnet : TransactionVersion.Testnet
+    );
+    // Get wallet key address from stx private key
+    const walletKeyAddress = getAddressFromPrivateKey(
+      account.stxPrivateKey,
+      network.isMainnet() ? TransactionVersion.Mainnet : TransactionVersion.Testnet
+    );
+    // Find subdomains at dataKeyAddress for the account in iteration
+    console.log('Finding subdomains at data key address: ', dataKeyAddress);
+    const namesResponse = await fetch(
+      `${_network.coreApiUrl}/v1/addresses/stacks/${dataKeyAddress}`
+    );
+    const namesJson = await namesResponse.json();
+
+    const regExp = /(\..*){2,}/; // regex to verify two dots in subdomain
+
+    if ((namesJson.names.length || 0) > 0) {
+      // Filter only subdomains
+      const subDomains = namesJson.names.filter((val: string) => regExp.test(val));
+
+      if (subDomains.length === 0) console.log('No subdomains found at: ', dataKeyAddress);
+
+      for (const subDomain of subDomains) {
+        status.found++;
+        // Alerts the user to any subdomains that can't be migrated to these wallet-key-derived addresses
+        // Given collision with existing usernames owned by them
+        const namesResponse = await fetch(
+          `${_network.coreApiUrl}/v1/addresses/stacks/${walletKeyAddress}`
+        );
+        const existingNames = await namesResponse.json();
+        if (existingNames.names.indexOf(subDomain) >= 0) {
+          status.collisions++;
+          console.log(`collision: ${subDomain} already exists in wallet key address.`);
+          continue;
+        }
+        // validate user owns the subdomain
+        const nameInfo = await fetch(`${_network.coreApiUrl}/v1/names/${subDomain}`);
+        const nameInfoJson = await nameInfo.json();
+        console.log('subdomain info: ', nameInfoJson);
+        if (nameInfoJson.address !== dataKeyAddress) {
+          console.log(`Error: Only owner of ${subDomain} can execute this migration`);
+          continue; // Skip and move to next subdomain in iteration
+        }
+        // Remove . char in prompt name to avoid nested prompt response
+        const promptName = subDomain.replaceAll('.', '_');
+        // Prompt user if he want the subdomain migration
+        const confirm: { [promptName: string]: string } = await prompt([
+          {
+            name: promptName,
+            message: `Do you want to migrate the domain: ${subDomain}`,
+            type: 'confirm',
+          },
+        ]);
+        // If no, then move to next account
+        if (!confirm[promptName]) continue;
+
+        // Generate Subdomain Operation payload starting with signature
+
+        const subDomainOp: SubdomainOp = {
+          subdomainName: subDomain, // Subdomain name
+          owner: walletKeyAddress, // New owner address / wallet key address
+          zonefile: nameInfoJson.zonefile, // Old copy of zonefile at data key address
+          sequenceNumber: 1,
+          // It should be (old sequence number + 1) but cannot find old sequence number so assuming 1. Api should calc it again.
+        };
+
+        const subdomainPieces = subdomainOpToZFPieces(subDomainOp);
+
+        const textToSign = subdomainPieces.txt.join(',');
+
+        // Generate signature: https://docs.stacks.co/build-apps/references/bns#subdomain-lifecycle
+        /**
+         * *********************** IMPORTANT **********************************************
+         * If the subdomain owner wants to change the address of their subdomain,         *
+         * they need to sign a subdomain-transfer operation and                           *
+         * give it to the on-chain name owner who created the subdomain.                  *
+         * They then package it into a zone file and broadcast it.                        *
+         * *********************** IMPORTANT **********************************************
+         * subdomain operation will only be accepted if it has a later "sequence=" number,*
+         * and a valid signature in "sig=" over the transaction body .The "sig=" field    *
+         * includes both the public key and signature, and the public key must hash to    *
+         * the previous subdomain operation's "addr=" field                               *
+         * ********************************************************************************
+         */
+
+        const hash = crypto.createHash('sha256').update(textToSign).digest('hex');
+        const sig = signWithKey(createStacksPrivateKey(account.dataPrivateKey), hash);
+        // https://docs.stacks.co/build-apps/references/bns#subdomain-lifecycle
+        subDomainOp.signature = [
+          sig.data,
+          compressPublicKey(
+            publicKeyToString(pubKeyfromPrivKey(account.dataPrivateKey))
+          ).data.toString('hex'),
+        ].join(',');
+        console.log('SubDomain Operation payload', subDomainOp);
+        // Todo: // This is a supposed migration api request
+        const options = {
+          method: 'POST',
+          headers: { 'Content-Type': 'application/json' },
+          body: JSON.stringify(subDomainOp),
+        };
+
+        const migrationURL = 'https://registrar.stacks.co/migrate-subdomain'; // Todo: // Required API call
+
+        const response = await fetch(migrationURL, options);
+
+        if (response.ok) {
+          const migrationStatus = await response.json();
+          status.migrated++;
+          console.log(migrationStatus);
+          console.log(
+            'Transaction will take some time to complete. Check transaction explorer url to verify the status of migration'
+          );
+          // Continue to next subDomain or address in loop
+        } else {
+          status.pending++;
+          console.log(response);
+          throw Error(`Failed to migrate: ${response.statusText}`);
+        }
+      }
+    } else {
+      console.log('No subdomains found at: ', dataKeyAddress);
+    }
+  }
+  return JSONStringify(status);
+}
+
 /*
  * Make a private key and output it
  * args:
@@ -1836,6 +2002,7 @@ const COMMANDS: Record<string, CommandFunction> = {
   tx_preorder: preorder,
   send_tokens: sendTokens,
   stack: stack,
+  migrate_subdomains: migrateSubdomains,
   stacking_status: stackingStatus,
   faucet: faucetCall,
 };
@@ -2013,5 +2180,6 @@ export const testables =
         getStacksWalletKey,
         register,
         preorder,
+        migrateSubdomains,
       }
     : undefined;

packages/cli/src/utils.ts

@@ -775,3 +775,56 @@ export function isTestnetAddress(address: string) {
   const addressInfo = bitcoinjs.address.fromBase58Check(address);
   return addressInfo.version === bitcoinjs.networks.testnet.pubKeyHash;
 }
+
+/**
+ * Reference: https://github.com/stacks-network/subdomain-registrar/blob/da2d144f4355bb1d67f67d1ae5f329b476d647d6/src/operations.js#L18
+ */
+export type SubdomainOp = {
+  owner: string;
+  sequenceNumber: number;
+  zonefile: string;
+  subdomainName: string;
+  signature?: string;
+};
+
+/**
+ * Reference: https://github.com/stacks-network/subdomain-registrar/blob/da2d144f4355bb1d67f67d1ae5f329b476d647d6/src/operations.js#L55
+ */
+function destructZonefile(zonefile: string) {
+  const encodedZonefile = Buffer.from(zonefile).toString('base64');
+  // we pack into 250 byte strings -- the entry "zf99=" eliminates 5 useful bytes,
+  // and the max is 255.
+  const pieces = 1 + Math.floor(encodedZonefile.length / 250);
+  const destructed = [];
+  for (let i = 0; i < pieces; i++) {
+    const startIndex = i * 250;
+    const currentPiece = encodedZonefile.slice(startIndex, startIndex + 250);
+    if (currentPiece.length > 0) {
+      destructed.push(currentPiece);
+    }
+  }
+  return destructed;
+}
+
+/**
+ * Reference: https://github.com/stacks-network/subdomain-registrar/blob/da2d144f4355bb1d67f67d1ae5f329b476d647d6/src/operations.js#L71
+ */
+export function subdomainOpToZFPieces(operation: SubdomainOp) {
+  const destructedZonefile = destructZonefile(operation.zonefile);
+  const txt = [
+    operation.subdomainName,
+    `owner=${operation.owner}`,
+    `seqn=${operation.sequenceNumber}`,
+    `parts=${destructedZonefile.length}`,
+  ];
+  destructedZonefile.forEach((zfPart, ix) => txt.push(`zf${ix}=${zfPart}`));
+
+  if (operation.signature) {
+    txt.push(`sig=${operation.signature}`);
+  }
+
+  return {
+    name: operation.subdomainName,
+    txt,
+  };
+}