feat: refactor broadcast helper functions, upgrade deps

Author: friedger

package.json

@@ -17,9 +17,9 @@
     "@scure/bip32": "^1.1.1",
     "@scure/bip39": "^1.1.0",
     "@stacks/common": "^6.0.0",
-    "@stacks/network": "^6.0.0",
-    "@stacks/stacking": "^6.0.0",
-    "@stacks/transactions": "^6.0.0",
+    "@stacks/network": "^6.3.0",
+    "@stacks/stacking": "^6.0.2",
+    "@stacks/transactions": "^6.5.0",
     "@types/node": "^16.7.13",
     "micro-btc-signer": "^0.2.0",
     "node-fetch": "^2.6.7",

tests/integration/clarity/natives/get-burn-block-info.spec.ts

@@ -11,14 +11,15 @@ import {
 import { StacksNetwork, StacksTestnet } from "@stacks/network";
 import { Accounts, Constants } from "../../constants";
 import { DevnetNetworkOrchestrator } from "@hirosystems/stacks-devnet-js";
-import { broadcastStackSTX, waitForNextRewardPhase } from "../../pox/helpers";
+import { waitForNextRewardPhase } from "../../pox/helpers";
 import {
   buildDevnetNetworkOrchestrator,
   getBitcoinBlockHeight,
   waitForStacksTransaction,
   getNetworkIdFromEnv,
   getChainInfo,
 } from "../../helpers";
+import { broadcastStackSTX } from "../../pox/helpers-direct-stacking";
 
 describe("get-burn-block-info?", () => {
   let orchestrator: DevnetNetworkOrchestrator;
@@ -171,14 +172,14 @@ describe("get-burn-block-info?", () => {
 
     // Broadcast some STX stacking orders
     let response = await broadcastStackSTX(
-      2,
-      network,
-      90_000_000_000_000,
-      Accounts.WALLET_1,
-      blockHeight,
-      12,
-      1000,
-      1
+      {
+        poxVersion: 2,
+        network,
+        account: Accounts.WALLET_1,
+        fee: 1000,
+        nonce: 1,
+      },
+      { amount: 90_000_000_000_000, blockHeight, cycles: 12 }
     );
     expect(response.error).toBeUndefined();
 

tests/integration/clarity/natives/stx-account.spec.ts

@@ -11,7 +11,6 @@ import { StacksNetwork, StacksTestnet } from "@stacks/network";
 import { Accounts, Constants } from "../../constants";
 import { DevnetNetworkOrchestrator } from "@hirosystems/stacks-devnet-js";
 import {
-  broadcastStackSTX,
   getPoxInfo,
   waitForNextPreparePhase,
   waitForNextRewardPhase,
@@ -24,6 +23,7 @@ import {
   getChainInfo,
 } from "../../helpers";
 import { principalCV } from "@stacks/transactions/dist/clarity/types/principalCV";
+import { broadcastStackSTX } from "../../pox/helpers-direct-stacking";
 
 describe("stx-account", () => {
   let orchestrator: DevnetNetworkOrchestrator;
@@ -337,14 +337,14 @@ describe("stx-account", () => {
       // Broadcast some STX stacking orders
       let cycles = 12;
       let response = await broadcastStackSTX(
-        2,
-        network,
-        25_000_000_000_000,
-        Accounts.WALLET_1,
-        blockHeight,
-        cycles,
-        1000,
-        5
+        {
+          poxVersion: 2,
+          network,
+          account: Accounts.WALLET_1,
+          fee: 1000,
+          nonce: 1,
+        },
+        { amount: 25_000_000_000_000, blockHeight, cycles: 5 }
       );
       expect(response.error).toBeUndefined();
 

tests/integration/consensus/transaction-fee.spec.ts

@@ -1,27 +1,24 @@
+import { DevnetNetworkOrchestrator } from "@hirosystems/stacks-devnet-js";
+import { StacksNetwork, StacksTestnet } from "@stacks/network";
 import {
-  makeContractDeploy,
-  broadcastTransaction,
   AnchorMode,
+  ClarityValue,
+  ClarityVersion,
   PostConditionMode,
   TxBroadcastResultOk,
-  makeContractCall,
-  SignedContractCallOptions,
-  ClarityVersion,
-  ClarityValue,
-  createLPString,
+  broadcastTransaction,
   contractPrincipalCV,
+  makeContractCall,
+  makeContractDeploy,
 } from "@stacks/transactions";
-import { StacksNetwork, StacksTestnet } from "@stacks/network";
+import { afterAll, beforeAll, describe, expect, it } from "vitest";
 import { Accounts, Constants } from "../constants";
-import { getAccount, expectAccountToBe } from "../pox/helpers";
-import { principalCV } from "@stacks/transactions/dist/clarity/types/principalCV";
 import {
   buildDevnetNetworkOrchestrator,
-  getNetworkIdFromCtx,
+  getNetworkIdFromEnv,
   waitForStacksTransaction,
 } from "../helpers";
-import { DevnetNetworkOrchestrator } from "@hirosystems/stacks-devnet-js";
-import { describe, expect, it, test, beforeAll, afterAll } from "vitest";
+import { expectAccountToBe, getAccount } from "../pox/helpers";
 
 const CONTRACT_TRAIT = `
 (define-trait foo
@@ -52,7 +49,7 @@ describe("transaction-fee", () => {
   let orchestrator: DevnetNetworkOrchestrator;
 
   beforeAll(async (ctx) => {
-    orchestrator = buildDevnetNetworkOrchestrator(getNetworkIdFromCtx(ctx.id));
+    orchestrator = buildDevnetNetworkOrchestrator(getNetworkIdFromEnv());
     orchestrator.start();
   });
 

tests/integration/pox/helpers-direct-stacking.ts

@@ -13,7 +13,7 @@ import { Contracts } from "../constants";
 
 import { toBytes } from "@stacks/common";
 import { decodeBtcAddress } from "@stacks/stacking";
-import { Account, BroadcastOptions } from "./helpers";
+import { Account, BroadcastOptions, BroadcastOptionsPox2 } from "./helpers";
 const fetch = require("node-fetch");
 
 export const broadcastStackSTX = async (
@@ -54,11 +54,8 @@ export const broadcastStackSTX = async (
 };
 
 export const broadcastStackIncrease = async (
-  network: StacksNetwork,
-  amount: number,
-  account: Account,
-  fee: number,
-  nonce: number
+  { network, account, fee, nonce }: BroadcastOptionsPox2,
+  { amount }: { amount: number }
 ): Promise<TxBroadcastResult> => {
   const txOptions = {
     contractAddress: Contracts.POX_2.address,
@@ -79,11 +76,8 @@ export const broadcastStackIncrease = async (
 };
 
 export const broadcastStackExtend = async (
-  network: StacksNetwork,
-  account: Account,
-  cycles: number,
-  fee: number,
-  nonce: number
+  { network, account, fee, nonce }: BroadcastOptionsPox2,
+  { cycles }: { cycles: number }
 ): Promise<TxBroadcastResult> => {
   const { version, data } = decodeBtcAddress(account.btcAddress);
   const address = {

tests/integration/pox/helpers-pooled-stacking.ts

@@ -1,4 +1,3 @@
-import { StacksNetwork } from "@stacks/network";
 import {
   AnchorMode,
   PostConditionMode,
@@ -16,19 +15,22 @@ import { Contracts } from "../constants";
 
 import { toBytes } from "@stacks/common";
 import { decodeBtcAddress } from "@stacks/stacking";
-import { Account } from "./helpers";
+import { Account, BroadcastOptions, BroadcastOptionsPox2 } from "./helpers";
 const fetch = require("node-fetch");
 
 export const broadcastDelegateSTX = async (
-  poxVersion: number,
-  network: StacksNetwork,
-  account: Account,
-  fee: number,
-  nonce: number,
-  amount: number,
-  poolAddress: Account,
-  poolRewardAccount?: Account,
-  untilBurnHeight?: number
+  { poxVersion, network, account, fee, nonce }: BroadcastOptions,
+  {
+    amount,
+    poolAddress,
+    poolRewardAccount,
+    untilBurnHeight,
+  }: {
+    amount: number;
+    poolAddress: Account;
+    poolRewardAccount?: Account;
+    untilBurnHeight?: number;
+  }
 ): Promise<TxBroadcastResult> => {
   let poxAddressCV;
   if (poolRewardAccount) {
@@ -69,13 +71,13 @@ export const broadcastDelegateSTX = async (
   return result;
 };
 
-export const broadcastRevokeDelegateStx = async (
-  poxVersion: number,
-  network: StacksNetwork,
-  account: Account,
-  fee: number,
-  nonce: number
-): Promise<TxBroadcastResult> => {
+export const broadcastRevokeDelegateStx = async ({
+  poxVersion,
+  network,
+  account,
+  fee,
+  nonce,
+}: BroadcastOptions): Promise<TxBroadcastResult> => {
   const txOptions = {
     contractAddress: Contracts.POX_1.address,
     contractName: poxVersion == 1 ? Contracts.POX_1.name : Contracts.POX_2.name,
@@ -95,16 +97,20 @@ export const broadcastRevokeDelegateStx = async (
 };
 
 export const broadcastDelegateStackSTX = async (
-  poxVersion: number,
-  network: StacksNetwork,
-  account: Account,
-  fee: number,
-  nonce: number,
-  stacker: Account,
-  amount: number,
-  poolRewardAccount: Account,
-  startBurnHeight: number,
-  lockPeriodCycles: number
+  { poxVersion, network, account, fee, nonce }: BroadcastOptions,
+  {
+    stacker,
+    amount,
+    poolRewardAccount,
+    startBurnHeight,
+    lockPeriodCycles,
+  }: {
+    stacker: Account;
+    amount: number;
+    poolRewardAccount: Account;
+    startBurnHeight: number;
+    lockPeriodCycles: number;
+  }
 ): Promise<TxBroadcastResult> => {
   const { version, data } = decodeBtcAddress(poolRewardAccount.btcAddress);
   const poxAddress = {
@@ -137,14 +143,12 @@ export const broadcastDelegateStackSTX = async (
 };
 
 export const broadcastDelegateStackExtend = async (
-  poxVersion: number,
-  network: StacksNetwork,
-  account: Account,
-  fee: number,
-  nonce: number,
-  stacker: Account,
-  poolRewardAccount: Account,
-  extendByCount: number
+  { poxVersion, network, account, fee, nonce }: BroadcastOptions,
+  {
+    stacker,
+    poolRewardAccount,
+    extendByCount,
+  }: { stacker: Account; poolRewardAccount: Account; extendByCount: number }
 ): Promise<TxBroadcastResult> => {
   const { version, data } = decodeBtcAddress(poolRewardAccount.btcAddress);
   const poxAddress = {
@@ -175,14 +179,16 @@ export const broadcastDelegateStackExtend = async (
 };
 
 export const broadcastDelegateStackIncrease = async (
-  poxVersion: number,
-  network: StacksNetwork,
-  account: Account,
-  fee: number,
-  nonce: number,
-  stacker: Account,
-  poolRewardAccount: Account,
-  increaseByAmountUstx: number
+  { poxVersion, network, account, fee, nonce }: BroadcastOptions,
+  {
+    stacker,
+    poolRewardAccount,
+    increaseByAmountUstx,
+  }: {
+    stacker: Account;
+    poolRewardAccount: Account;
+    increaseByAmountUstx: number;
+  }
 ): Promise<TxBroadcastResult> => {
   const { version, data } = decodeBtcAddress(poolRewardAccount.btcAddress);
   const poxAddress = {
@@ -225,13 +231,11 @@ export const broadcastDelegateStackIncrease = async (
  * @returns
  */
 export const broadcastStackAggregationCommitIndexed = async (
-  poxVersion: number,
-  network: StacksNetwork,
-  account: Account,
-  fee: number,
-  nonce: number,
-  poolRewardAccount: Account,
-  cycleId: number
+  { poxVersion, network, account, fee, nonce }: BroadcastOptions,
+  {
+    poolRewardAccount,
+    cycleId,
+  }: { poolRewardAccount: Account; cycleId: number }
 ): Promise<TxBroadcastResult> => {
   const { version, data } = decodeBtcAddress(poolRewardAccount.btcAddress);
   const poxAddress = {
@@ -261,13 +265,12 @@ export const broadcastStackAggregationCommitIndexed = async (
 };
 
 export const broadcastStackAggregationIncrease = async (
-  network: StacksNetwork,
-  account: Account,
-  fee: number,
-  nonce: number,
-  poolRewardAccount: Account,
-  cycleId: number,
-  rewardIndex: number
+  { network, account, fee, nonce }: BroadcastOptionsPox2,
+  {
+    poolRewardAccount,
+    cycleId,
+    rewardIndex,
+  }: { poolRewardAccount: Account; cycleId: number; rewardIndex: number }
 ): Promise<TxBroadcastResult> => {
   const { version, data } = decodeBtcAddress(poolRewardAccount.btcAddress);
   const poxAddress = {

tests/integration/pox/helpers.ts

@@ -33,13 +33,15 @@ export interface Account {
   secretKey: string;
 }
 
-export interface BroadcastOptions {
-  poxVersion: number;
+export interface BroadcastOptionsPox2 {
   network: StacksNetwork;
   account: Account;
   fee: number;
   nonce: number;
 }
+export interface BroadcastOptions extends BroadcastOptionsPox2 {
+  poxVersion: number;
+}
 
 const delay = () => new Promise((resolve) => setTimeout(resolve, 3000));