docs(root): use embed for omni example OP_RETURN

BTC-1864

TICKET: BTC-0

Author: ericli-bitgo

examples/ts/btc/omni/config.ts

@@ -1,5 +1,6 @@
 import { BitGoAPI } from '@bitgo/sdk-api';
 import { Btc, Tbtc4 } from '@bitgo/sdk-coin-btc';
+import * as utxolib from '@bitgo/utxo-lib';
 
 const env = 'test' as 'test' | 'prod';
 
@@ -17,6 +18,7 @@ sdk.authenticateWithAccessToken({ accessToken });
 export const omniConfig = {
   env,
   coin: env === 'test' ? 'tbtc4' : 'btc',
+  network: env === 'test' ? utxolib.networks.bitcoinTestnet4 : utxolib.networks.bitcoin,
   sdk,
   walletPassphrase,
   walletId,

examples/ts/btc/omni/index.ts

@@ -6,48 +6,47 @@
 import { Wallet } from 'modules/bitgo/src';
 import { omniConfig } from './config';
 import * as superagent from 'superagent';
+import * as utxolib from '@bitgo/utxo-lib';
 
 const RECEIVE_ADDRESS = '';
 const SEND_ADDRESS = '';
-const NETWORK = omniConfig.coin === 'tbtc4/' ? 'testnet4' : '';
-const AMOUNT = 1234;
+const MEMPOOL_PREFIX = omniConfig.coin === 'tbtc4' ? 'testnet4/' : '';
+const AMOUNT = 729100000n;
 const ASSET_ID = 31;
+const OMNI_PREFIX = Buffer.from('6f6d6e69', 'hex');
 
 async function getWallet() {
   return await omniConfig.sdk.coin(omniConfig.coin).wallets().get({ id: omniConfig.walletId });
 }
 
-function strToHex(s: string) {
-  return (
-    s
-      .split('')
-      .map((c) => c.charCodeAt(0).toString(16))
-      .join('') + '0'
-  );
-}
-
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 async function mintOmniAsset(wallet: Wallet, address: string, feeRate = 20_000) {
-  const transactionVersion = '0000';
-  const trnasactionType = (50).toString(16).padStart(4, '0');
-  const ecoSystem = '02';
-  const propertyType = (2).toString(16).padStart(4, '0');
-  const previousPropertyID = '00000000';
-  const category = strToHex('Other\0');
-  const subCategory = strToHex('Other\0');
-  const propertyTitle = strToHex('Testcoin\0');
-  const propertyURL = strToHex('https://example.com\0');
-  const propertyData = strToHex('\0');
-  const amount = (100000 * 10**8).toString(16).padStart(16, '0');
+  const transactionVersion = Buffer.alloc(2);
+  const transactionType = Buffer.alloc(2);
+  transactionType.writeUint16BE(50);
+  const ecoSystem = Buffer.alloc(1);
+  ecoSystem.writeInt8(2);
+  const propertyType = Buffer.alloc(2);
+  propertyType.writeUint16BE(2);
+  const previousPropertyID = Buffer.alloc(4);
+
+  const category = Buffer.from('Other\0');
+  const subCategory = Buffer.from('Other\0');
+  const propertyTitle = Buffer.from('Testcoin\0');
+  const propertyURL = Buffer.from('https://example.com\0');
+  const propertyData = Buffer.from('\0');
+
+  const amount = Buffer.alloc(8);
+  amount.writeBigUint64BE(BigInt(100000 * 10 ** 8));
 
-  const res = await superagent.get(`https://mempool.space/${NETWORK}api/address/${address}/utxo`);
+  const res = await superagent.get(`https://mempool.space/${MEMPOOL_PREFIX}api/address/${address}/utxo`);
   const unspent = res.body[0];
   const unspent_id = unspent.txid + ':' + unspent.vout;
 
-  const omniScript = [
-    '6f6d6e69', // omni
+  const omniScript = Buffer.concat([
+    OMNI_PREFIX, // omni
     transactionVersion,
-    trnasactionType,
+    transactionType,
     ecoSystem,
     propertyType,
     previousPropertyID,
@@ -57,21 +56,18 @@ async function mintOmniAsset(wallet: Wallet, address: string, feeRate = 20_000)
     propertyURL,
     propertyData,
     amount,
-  ].join('');
+  ]);
 
-  // scriptPubkey: op_return omni simple_send tether amount
-  const script =
-    'scriptPubkey:' +
-    [
-      '6a', // op_return
-      (omniScript.length / 2).toString(16).padStart(2, '0'),
-      omniScript,
-    ].join('');
+  const output = utxolib.payments.embed({ data: [omniScript], network: utxolib.networks.bitcoin }).output;
+  if (!output) {
+    throw new Error('Invalid output');
+  }
+  const script = output.toString('hex');
   const tx = await wallet.sendMany({
     recipients: [
       {
         amount: '0',
-        address: script,
+        address: `scriptPubkey:${script}`,
       },
     ],
     isReplaceableByFee: true,
@@ -87,21 +83,26 @@ async function sendOmniAsset(
   wallet: Wallet,
   receiver: string,
   sender: string,
-  amountMicroCents: number,
+  amountMicroCents: bigint,
   assetId = 31,
   feeRate = 20_000
 ) {
-  // convert amountMicroCents to hex string of length 16
-  const amountHex = amountMicroCents.toString(16).padStart(16, '0');
-
-  const assetHex = assetId.toString(16).padStart(8, '0');
-
-  const res = await superagent.get(`https://mempool.space/${NETWORK}/api/address/${sender}/utxo`);
+  const res = await superagent.get(`https://mempool.space/${MEMPOOL_PREFIX}/api/address/${sender}/utxo`);
   const unspent = res.body[0];
   const unspent_id = unspent.txid + ':' + unspent.vout;
 
   // scriptPubkey: op_return omni simple_send tether amount
-  const script = ('scriptPubkey: 6a14 6f6d6e69 00000000' + assetHex + amountHex).split(' ').join('');
+  const transactionType = Buffer.alloc(4);
+  const assetHex = Buffer.alloc(4);
+  assetHex.writeUInt32BE(assetId);
+  const amountHex = Buffer.alloc(8);
+  amountHex.writeBigUInt64BE(amountMicroCents);
+  const omniScript = Buffer.concat([OMNI_PREFIX, transactionType, assetHex, amountHex]);
+  const output = utxolib.payments.embed({ data: [omniScript], network: omniConfig.network }).output;
+  if (!output) {
+    throw new Error('Invalid output');
+  }
+  const script = output.toString('hex');
   const tx = await wallet.sendMany({
     recipients: [
       {
@@ -110,7 +111,7 @@ async function sendOmniAsset(
       },
       {
         amount: '0',
-        address: script,
+        address: `scriptPubkey:${script}`,
       },
     ],
     isReplaceableByFee: true,
@@ -128,7 +129,7 @@ async function sendOmniAsset(
 async function main() {
   console.log('Starting...');
 
-  const feeRateRes = await superagent.get(`https://mempool.space/${NETWORK}api/v1/fees/recommended`);
+  const feeRateRes = await superagent.get(`https://mempool.space/${MEMPOOL_PREFIX}api/v1/fees/recommended`);
   const feeRate = feeRateRes.body.fastestFee;
 
   const wallet = await getWallet();