feat: add changeAddressesBytes to etna builder

src/vms/pvm/etna-builder/spend-reducers/fixtures/reducers.ts

@@ -1,8 +1,6 @@
 import { testContext } from '../../../../../fixtures/context';
 import { feeState as testFeeState } from '../../../../../fixtures/pvm';
 import { Address, OutputOwners } from '../../../../../serializable';
-import type { SpendOptions } from '../../../../common';
-import { defaultSpendOptions } from '../../../../common/defaultSpendOptions';
 import { createDimensions } from '../../../../common/fees/dimensions';
 import type { FeeState } from '../../../models';
 import type { SpendHelperProps } from '../../spendHelper';
@@ -17,11 +15,12 @@ export const CHANGE_OWNERS: OutputOwners = OutputOwners.fromNative([
 ]);
 
 export const getInitialReducerState = ({
-  spendOptions,
   ...state
-}: Partial<Omit<SpendReducerState, 'spendOptions'>> & {
-  spendOptions?: SpendOptions;
-} = {}): SpendReducerState => ({
+}: Partial<SpendReducerState> = {}): SpendReducerState => ({
+  changeAddressesBytes: state?.fromAddresses?.map((address) =>
+    address.toBytes(),
+  ) ?? [CHANGE_ADDRESS.toBytes()],
+  changeOwnerOverride: null,
   excessAVAX: 0n,
   initialComplexity: createDimensions({
     bandwidth: 1,
@@ -31,13 +30,6 @@ export const getInitialReducerState = ({
   }),
   fromAddresses: [CHANGE_ADDRESS],
   minIssuanceTime: BigInt(Math.floor(new Date().getTime() / 1000)),
-  ownerOverride: null,
-  spendOptions: defaultSpendOptions(
-    state?.fromAddresses?.map((address) => address.toBytes()) ?? [
-      CHANGE_ADDRESS.toBytes(),
-    ],
-    spendOptions,
-  ),
   toBurn: new Map(),
   toStake: new Map(),
   utxos: [],

src/vms/pvm/etna-builder/spend-reducers/handleFeeAndChange.ts

@@ -45,8 +45,8 @@ export const handleFeeAndChange: SpendReducerFunction = (
   // Use the change owner override if it exists, otherwise use the default change owner.
   // This is used on "import" transactions.
   const changeOwners =
-    state.ownerOverride ??
-    OutputOwners.fromNative(state.spendOptions.changeAddresses);
+    state.changeOwnerOverride ??
+    OutputOwners.fromNative(state.changeAddressesBytes);
 
   const requiredFee = spendHelper.calculateFee();
 

src/vms/pvm/etna-builder/spend-reducers/types.ts

@@ -3,7 +3,14 @@ import type { SpendProps } from '../spend';
 import type { SpendHelper } from '../spendHelper';
 
 export type SpendReducerState = Readonly<
-  Required<Omit<SpendProps, 'feeState' | 'shouldConsolidateOutputs'>>
+  Required<
+    Omit<
+      SpendProps,
+      'changeAddressesBytes' | 'feeState' | 'shouldConsolidateOutputs'
+    >
+  > & {
+    changeAddressesBytes: readonly Uint8Array[];
+  }
 >;
 
 export type SpendReducerFunction = (

src/vms/pvm/etna-builder/spend-reducers/useUnlockedUTXOs.test.ts

@@ -115,7 +115,7 @@ describe('useUnlockedUTXOs', () => {
     const { inputs } = spendHelper.getInputsOutputs();
 
     expect(state.excessAVAX).toEqual(10_000n - 4_900n - 4_900n);
-    expect(state.ownerOverride).toBe(null);
+    expect(state.changeOwnerOverride).toBe(null);
     expect(inputs).toHaveLength(1);
     expect(inputs[0].getAssetId()).toEqual(testContext.avaxAssetID);
   });

src/vms/pvm/etna-builder/spend-reducers/useUnlockedUTXOs.ts

@@ -90,7 +90,7 @@ export const useUnlockedUTXOs: SpendReducerFunction = (
     );
 
   const changeOwner = OutputOwners.fromNative(
-    state.spendOptions.changeAddresses,
+    state.changeAddressesBytes,
     0n,
     1,
   );
@@ -147,7 +147,7 @@ export const useUnlockedUTXOs: SpendReducerFunction = (
 
   // 5. Handle AVAX asset UTXOs last to account for fees.
   let excessAVAX = state.excessAVAX;
-  let clearOwnerOverride = false;
+  let clearChangeOwnerOverride = false;
   for (const { sigData, data: utxo } of avaxVerifiedUsableUTXOs) {
     const requiredFee = spendHelper.calculateFee();
 
@@ -189,12 +189,14 @@ export const useUnlockedUTXOs: SpendReducerFunction = (
     excessAVAX += remainingAmount;
 
     // The ownerOverride is no longer needed. Clear it.
-    clearOwnerOverride = true;
+    clearChangeOwnerOverride = true;
   }
 
   return {
     ...state,
+    changeOwnerOverride: clearChangeOwnerOverride
+      ? null
+      : state.changeOwnerOverride,
     excessAVAX,
-    ownerOverride: clearOwnerOverride ? null : state.ownerOverride,
   };
 };

src/vms/pvm/etna-builder/spend.test.ts

@@ -2,7 +2,6 @@ import { jest } from '@jest/globals';
 
 import { testContext } from '../../../fixtures/context';
 import { Address, OutputOwners } from '../../../serializable';
-import { defaultSpendOptions } from '../../common/defaultSpendOptions';
 import { createDimensions } from '../../common/fees/dimensions';
 import {
   verifyAssetsConsumed,
@@ -13,6 +12,7 @@ import {
 import type { SpendProps } from './spend';
 import { spend } from './spend';
 import { feeState as testFeeState } from '../../../fixtures/pvm';
+import { bech32ToBytes } from '../../../utils';
 
 jest.mock('./spend-reducers', () => ({
   verifyAssetsConsumed: jest.fn<SpendReducerFunction>((state) => state),
@@ -27,6 +27,7 @@ const CHANGE_OWNERS: OutputOwners = OutputOwners.fromNative([
 ]);
 
 const getSpendProps = (state: Partial<SpendReducerState> = {}): SpendProps => ({
+  changeOwnerOverride: null,
   excessAVAX: 0n,
   initialComplexity: createDimensions({
     bandwidth: 1,
@@ -37,12 +38,6 @@ const getSpendProps = (state: Partial<SpendReducerState> = {}): SpendProps => ({
   feeState: testFeeState(),
   fromAddresses: [CHANGE_ADDRESS],
   minIssuanceTime: BigInt(Math.floor(new Date().getTime() / 1000)),
-  ownerOverride: null,
-  spendOptions: defaultSpendOptions(
-    state?.fromAddresses?.map((address) => address.toBytes()) ?? [
-      CHANGE_ADDRESS.toBytes(),
-    ],
-  ),
   toBurn: new Map(),
   toStake: new Map(),
   utxos: [],
@@ -82,13 +77,36 @@ describe('./src/vms/pvm/etna-builder/spend.test.ts', () => {
     ).toThrow('An unexpected error occurred during spend calculation');
   });
 
-  test('change owners in state should default to change addresses', () => {
+  test('change owners in state should default to from addresses', () => {
     expect.assertions(1);
 
     const initialState = getSpendProps({ excessAVAX: 1_000n });
     const testReducer = jest.fn<SpendReducerFunction>((state) => {
-      expect(state.ownerOverride).toEqual(
-        OutputOwners.fromNative(initialState.spendOptions.changeAddresses),
+      expect(state.changeOwnerOverride).toEqual(
+        OutputOwners.fromNative(
+          initialState.fromAddresses.map((address) => address.toBytes()),
+        ),
+      );
+      return state;
+    });
+
+    spend(initialState, [testReducer], testContext);
+  });
+
+  test('change owners in state should be change addresses', () => {
+    expect.assertions(1);
+
+    const changeAddressesBytes = [
+      bech32ToBytes('P-fuji1t43hr35eu9enk7tfyqq4ukpww4stpzf74kxjfk'),
+    ];
+
+    const initialState = getSpendProps({
+      changeAddressesBytes,
+      excessAVAX: 1_000n,
+    });
+    const testReducer = jest.fn<SpendReducerFunction>((state) => {
+      expect(state.changeOwnerOverride).toEqual(
+        OutputOwners.fromNative(changeAddressesBytes),
       );
       return state;
     });
@@ -99,12 +117,17 @@ describe('./src/vms/pvm/etna-builder/spend.test.ts', () => {
   test('change owners in state should be ownerOverride if provided', () => {
     expect.assertions(1);
 
+    const changeAddressesBytes = [
+      bech32ToBytes('P-fuji1t43hr35eu9enk7tfyqq4ukpww4stpzf74kxjfk'),
+    ];
+
     const initialState = getSpendProps({
+      changeAddressesBytes,
+      changeOwnerOverride: CHANGE_OWNERS,
       excessAVAX: 1_000n,
-      ownerOverride: CHANGE_OWNERS,
     });
     const testReducer = jest.fn<SpendReducerFunction>((state) => {
-      expect(state.ownerOverride).toBe(CHANGE_OWNERS);
+      expect(state.changeOwnerOverride).toBe(CHANGE_OWNERS);
       return state;
     });
 

src/vms/pvm/etna-builder/spend.ts

@@ -11,7 +11,17 @@ import type { FeeState } from '../models';
 import type { SpendReducerFunction, SpendReducerState } from './spend-reducers';
 import { handleFeeAndChange, verifyAssetsConsumed } from './spend-reducers';
 import { SpendHelper } from './spendHelper';
-import type { BuilderSpendOptions } from './types';
+
+const getChangeAddressesBytes = (
+  changeAddressesBytes: readonly Uint8Array[] | undefined,
+  fromAddresses: readonly Uint8Array[],
+): readonly Uint8Array[] => {
+  if (changeAddressesBytes && changeAddressesBytes.length > 0) {
+    return changeAddressesBytes;
+  }
+
+  return [...fromAddresses];
+};
 
 type SpendResult = Readonly<{
   /**
@@ -37,6 +47,20 @@ type SpendResult = Readonly<{
 }>;
 
 export type SpendProps = Readonly<{
+  /**
+   * List of addresses that are used for change outputs.
+   *
+   * Defaults to the addresses provided in `fromAddressesBytes`.
+   */
+  changeAddressesBytes?: readonly Uint8Array[];
+  /**
+   * Optionally specifies the output owners to use for the unlocked
+   * AVAX change output if no additional AVAX was needed to be burned.
+   * If this value is `undefined` or `null`, the default change owner is used.
+   *
+   * Used in ImportTx.
+   */
+  changeOwnerOverride?: OutputOwners | null;
   /**
    * The extra AVAX that spend can produce in
    * the change outputs in addition to the consumed and not burned AVAX.
@@ -52,21 +76,12 @@ export type SpendProps = Readonly<{
    */
   initialComplexity: Dimensions;
   minIssuanceTime: bigint;
-  /**
-   * Optionally specifies the output owners to use for the unlocked
-   * AVAX change output if no additional AVAX was needed to be burned.
-   * If this value is `undefined` or `null`, the default change owner is used.
-   *
-   * Used in ImportTx.
-   */
-  ownerOverride?: OutputOwners | null;
   /**
    * Whether to consolidate change and stake outputs.
    *
    * @default false
    */
   shouldConsolidateOutputs?: boolean;
-  spendOptions: Required<BuilderSpendOptions>;
   /**
    * Maps `assetID` to the amount of the asset to spend without
    * producing an output. This is typically used for fees.
@@ -103,14 +118,14 @@ export type SpendProps = Readonly<{
  */
 export const spend = (
   {
+    changeAddressesBytes: _changeAddressesBytes,
+    changeOwnerOverride,
     excessAVAX = 0n,
     feeState,
     fromAddresses,
     initialComplexity,
     minIssuanceTime,
-    ownerOverride,
     shouldConsolidateOutputs = false,
-    spendOptions,
     toBurn = new Map(),
     toStake = new Map(),
     utxos,
@@ -119,8 +134,13 @@ export const spend = (
   context: Context,
 ): SpendResult => {
   try {
+    const changeAddressesBytes = getChangeAddressesBytes(
+      _changeAddressesBytes,
+      fromAddresses.map((address) => address.toBytes()),
+    );
+
     const changeOwners =
-      ownerOverride || OutputOwners.fromNative(spendOptions.changeAddresses);
+      changeOwnerOverride || OutputOwners.fromNative(changeAddressesBytes);
 
     const gasPrice: bigint = feeState.price;
 
@@ -137,12 +157,12 @@ export const spend = (
     });
 
     const initialState: SpendReducerState = {
+      changeAddressesBytes,
+      changeOwnerOverride: changeOwners,
       excessAVAX,
       initialComplexity,
       fromAddresses,
       minIssuanceTime,
-      ownerOverride: changeOwners,
-      spendOptions,
       toBurn,
       toStake,
       utxos,