feat: etna builder wrap up bug fixes and tests

Author: erictaylor

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

@@ -289,12 +289,11 @@ describe('./src/vms/pvm/etna-builder/builder.test.ts', () => {
           [
             TransferableOutput.fromNative(
               testContext.avaxAssetID,
-              // TODO: What is the expected value here?
-              49_999_000_000n - expectedFee,
+              // TODO: How to remove this "magic" number. How do we calculate it correctly from utxos?
+              50_000_000_000n - expectedFee,
               [testAddress1],
             ),
           ],
-          // TODO: Add an input here?
           [],
           memo ?? new Uint8Array(),
         ),
@@ -348,7 +347,7 @@ describe('./src/vms/pvm/etna-builder/builder.test.ts', () => {
           [
             TransferableOutput.fromNative(
               testContext.avaxAssetID,
-              // TODO: Possibly need to adjust this value?
+              // TODO: Remove magic number. How to calculate it correctly from utxos?
               45_000_000_000n - expectedFee,
               fromAddressesBytes,
             ),

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

@@ -161,7 +161,6 @@ export const newBaseTx: TxBuilderFn<NewBaseTxProps> = (
   const [error, spendResults] = spend(
     {
       complexity,
-      // TODO: Check this
       excessAVAX: 0n,
       fromAddresses,
       spendOptions: defaultedOptions,
@@ -330,8 +329,6 @@ export const newImportTx: TxBuilderFn<NewImportTxProps> = (
     excessAVAX = importedAvax - context.baseTxFee;
   }
 
-  console.log('excessAVAX', excessAVAX);
-
   const [error, spendResults] = spend(
     {
       complexity,
@@ -351,11 +348,6 @@ export const newImportTx: TxBuilderFn<NewImportTxProps> = (
 
   const { changeOutputs, inputs, inputUTXOs } = spendResults;
 
-  // NOTE: ChangeOutput amount should equal the excessAVAX amount.
-  console.log('changeOutputs', changeOutputs);
-  // NOTE: Inputs should be an empty array.
-  console.log('inputs', inputs);
-
   return new UnsignedTx(
     new ImportTx(
       new AvaxBaseTx(
@@ -420,7 +412,6 @@ export const newExportTx: TxBuilderFn<NewExportTxProps> = (
   const [error, spendResults] = spend(
     {
       complexity,
-      // TODO: Check this
       excessAVAX: 0n,
       fromAddresses,
       spendOptions: defaultedOptions,
@@ -499,7 +490,6 @@ export const newCreateSubnetTx: TxBuilderFn<NewCreateSubnetTxProps> = (
   const [error, spendResults] = spend(
     {
       complexity,
-      // TODO: Check this
       excessAVAX: 0n,
       fromAddresses: addressesFromBytes(fromAddressesBytes),
       spendOptions: defaultedOptions,
@@ -612,7 +602,6 @@ export const newCreateChainTx: TxBuilderFn<NewCreateChainTxProps> = (
   const [error, spendResults] = spend(
     {
       complexity,
-      // TODO: Check this
       excessAVAX: 0n,
       fromAddresses: addressesFromBytes(fromAddressesBytes),
       spendOptions: defaultedOptions,
@@ -707,7 +696,6 @@ export const newAddSubnetValidatorTx: TxBuilderFn<
   const [error, spendResults] = spend(
     {
       complexity,
-      // TODO: Check this
       excessAVAX: 0n,
       fromAddresses: addressesFromBytes(fromAddressesBytes),
       spendOptions: defaultedOptions,
@@ -791,7 +779,6 @@ export const newRemoveSubnetValidatorTx: TxBuilderFn<
   const [error, spendResults] = spend(
     {
       complexity,
-      // TODO: Check this
       excessAVAX: 0n,
       fromAddresses: addressesFromBytes(fromAddressesBytes),
       spendOptions: defaultedOptions,
@@ -964,7 +951,6 @@ export const newAddPermissionlessValidatorTx: TxBuilderFn<
   const [error, spendResults] = spend(
     {
       complexity,
-      // TODO: Check this
       excessAVAX: 0n,
       fromAddresses: addressesFromBytes(fromAddressesBytes),
       spendOptions: defaultedOptions,
@@ -1118,7 +1104,6 @@ export const newAddPermissionlessDelegatorTx: TxBuilderFn<
   const [error, spendResults] = spend(
     {
       complexity,
-      // TODO: Check this
       excessAVAX: 0n,
       fromAddresses: addressesFromBytes(fromAddressesBytes),
       spendOptions: defaultedOptions,
@@ -1233,7 +1218,6 @@ export const newTransferSubnetOwnershipTx: TxBuilderFn<
   const [error, spendResults] = spend(
     {
       complexity,
-      // TODO: Check this
       excessAVAX: 0n,
       fromAddresses: addressesFromBytes(fromAddressesBytes),
       spendOptions: defaultedOptions,

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

@@ -141,7 +141,7 @@ type SpendProps = Readonly<{
    * Contains the amount of extra AVAX that spend can produce in
    * the change outputs in addition to the consumed and not burned AVAX.
    */
-  excessAVAX: bigint;
+  excessAVAX?: bigint;
   /**
    * List of Addresses that are used for selecting which UTXOs are signable.
    */
@@ -187,7 +187,7 @@ type SpendProps = Readonly<{
 export const spend = (
   {
     complexity,
-    excessAVAX: _excessAVAX,
+    excessAVAX: _excessAVAX = 0n,
     fromAddresses,
     ownerOverride: _ownerOverride,
     spendOptions,
@@ -246,7 +246,6 @@ export const spend = (
       spendHelper.addInput(
         utxo,
         // TODO: Verify this.
-        // TransferableInput.fromUtxoAndSigindicies(utxo, inputSigIndices),
         new TransferableInput(
           utxo.utxoId,
           utxo.assetId,
@@ -403,7 +402,6 @@ export const spend = (
       spendHelper.addInput(
         utxo,
         // TODO: Verify this.
-        // TransferableInput.fromUtxoAndSigindicies(utxo, inputSigIndices),
         new TransferableInput(
           utxo.utxoId,
           utxo.assetId,

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

@@ -123,7 +123,7 @@ export class SpendHelper {
    * @returns {boolean} - Returns true if the asset should be consumed, false otherwise.
    */
   shouldConsumeLockedAsset(assetId: string): boolean {
-    return this.toStake.get(assetId) !== 0n;
+    return this.toStake.has(assetId) && this.toStake.get(assetId) !== 0n;
   }
 
   /**
@@ -134,7 +134,8 @@ export class SpendHelper {
    */
   shouldConsumeAsset(assetId: string): boolean {
     return (
-      this.toBurn.get(assetId) !== 0n || this.shouldConsumeLockedAsset(assetId)
+      (this.toBurn.has(assetId) && this.toBurn.get(assetId) !== 0n) ||
+      this.shouldConsumeLockedAsset(assetId)
     );
   }