Use appropriate payers in derived identity (#351)

* chore: use appropriate payers in derived identity

* fix: subtract tx fee when withdrawing everything

* feat: expose getCandyMachineSize helper

Author: lorisleiva

packages/js/src/plugins/candyMachineModule/models/CandyMachine.ts

@@ -430,3 +430,33 @@ export const toCandyMachineData = (
         : null,
   };
 };
+
+export const getCandyMachineSize = (data: CandyMachineData): number => {
+  if (data.hiddenSettings) {
+    return CANDY_MACHINE_HIDDEN_SECTION;
+  }
+
+  // This should not happen as the candy machine input type
+  // ensures exactly on of them is provided.
+  assert(
+    !!data.configLineSettings,
+    'No config line settings nor hidden settings were provided. ' +
+      'Please provide one of them.'
+  );
+
+  const itemsAvailable = toBigNumber(data.itemsAvailable).toNumber();
+  const configLineSize =
+    data.configLineSettings.nameLength + data.configLineSettings.uriLength;
+
+  return Math.ceil(
+    CANDY_MACHINE_HIDDEN_SECTION +
+      // Number of currently items inserted.
+      4 +
+      // Config line data.
+      itemsAvailable * configLineSize +
+      // Bit mask to keep track of which ConfigLines have been added.
+      (4 + Math.floor(itemsAvailable / 8) + 1) +
+      // Mint indices.
+      (4 + itemsAvailable * 4)
+  );
+};

packages/js/src/plugins/candyMachineModule/models/CandyMachineHiddenSection.ts

@@ -1,9 +1,7 @@
 import * as beet from '@metaplex-foundation/beet';
-import { CandyMachineData } from '@metaplex-foundation/mpl-candy-machine-core';
 import { CandyMachineConfigLineSettings, CandyMachineItem } from '..';
-import { CANDY_MACHINE_HIDDEN_SECTION } from '../constants';
-import { assert, removeEmptyChars } from '@/utils';
-import { deserializeFeatureFlags, toBigNumber } from '@/types';
+import { deserializeFeatureFlags } from '@/types';
+import { removeEmptyChars } from '@/utils';
 
 /** @internal */
 export type CandyMachineHiddenSection = {
@@ -95,37 +93,6 @@ export const deserializeCandyMachineHiddenSection = (
   };
 };
 
-/** @internal */
-export const getCandyMachineSize = (data: CandyMachineData): number => {
-  if (data.hiddenSettings) {
-    return CANDY_MACHINE_HIDDEN_SECTION;
-  }
-
-  // This should not happen as the candy machine input type
-  // ensures exactly on of them is provided.
-  assert(
-    !!data.configLineSettings,
-    'No config line settings nor hidden settings were provided. ' +
-      'Please provide one of them.'
-  );
-
-  const itemsAvailable = toBigNumber(data.itemsAvailable).toNumber();
-  const configLineSize =
-    data.configLineSettings.nameLength + data.configLineSettings.uriLength;
-
-  return Math.ceil(
-    CANDY_MACHINE_HIDDEN_SECTION +
-      // Number of currently items inserted.
-      4 +
-      // Config line data.
-      itemsAvailable * configLineSize +
-      // Bit mask to keep track of which ConfigLines have been added.
-      (4 + Math.floor(itemsAvailable / 8) + 1) +
-      // Mint indices.
-      (4 + itemsAvailable * 4)
-  );
-};
-
 /** @internal */
 export const replaceCandyMachineItemPattern = (
   value: string,

packages/js/src/plugins/candyMachineModule/operations/createCandyMachine.ts

@@ -7,8 +7,8 @@ import {
   CandyMachineConfigLineSettings,
   CandyMachineHiddenSettings,
   toCandyMachineData,
+  getCandyMachineSize,
 } from '../models';
-import { getCandyMachineSize } from '../models/CandyMachineHiddenSection';
 import { TransactionBuilder, TransactionBuilderOptions } from '@/utils';
 import {
   BigNumber,

packages/js/src/plugins/derivedIdentity/DerivedIdentityClient.ts

@@ -9,6 +9,7 @@ import {
   KeypairSigner,
   Signer,
   SolAmount,
+  subtractAmounts,
 } from '@/types';
 import type { Metaplex } from '@/Metaplex';
 
@@ -59,28 +60,35 @@ export class DerivedIdentityClient implements IdentitySigner, KeypairSigner {
 
   fund(amount: SolAmount) {
     this.assertInitialized();
-    return this.metaplex.system().transferSol({
-      from: this.originalSigner,
-      to: this.derivedKeypair.publicKey,
-      amount,
-    });
+    return this.metaplex.system().transferSol(
+      {
+        from: this.originalSigner,
+        to: this.derivedKeypair.publicKey,
+        amount,
+      },
+      { payer: this.originalSigner }
+    );
   }
 
   withdraw(amount: SolAmount) {
     this.assertInitialized();
-    return this.metaplex.system().transferSol({
-      from: this.derivedKeypair,
-      to: this.originalSigner.publicKey,
-      amount,
-    });
+    return this.metaplex.system().transferSol(
+      {
+        from: this.derivedKeypair,
+        to: this.originalSigner.publicKey,
+        amount,
+      },
+      { payer: this.derivedKeypair }
+    );
   }
 
   async withdrawAll() {
     this.assertInitialized();
     const balance = await this.metaplex
       .rpc()
       .getBalance(this.derivedKeypair.publicKey);
-    return this.withdraw(balance);
+    const transactionFee = this.metaplex.utils().estimateTransactionFee();
+    return this.withdraw(subtractAmounts(balance, transactionFee));
   }
 
   close(): void {

packages/js/src/plugins/utilsModule/UtilsClient.ts

@@ -44,6 +44,8 @@ export class UtilsClient {
       this.cachedRentPerByte === null
     ) {
       const rentFor0Bytes = await this.metaplex.rpc().getRent(0);
+
+      // TODO(loris): Infer from header size in bytes.
       const rentFor1Byte = await this.metaplex.rpc().getRent(1);
       this.cachedRentPerEmptyAccount = rentFor0Bytes;
       this.cachedRentPerByte = subtractAmounts(rentFor1Byte, rentFor0Bytes);

packages/js/test/plugins/derivedIdentity/DerivedIdentityClient.test.ts

@@ -8,8 +8,6 @@ import {
   KeypairIdentityDriver,
   sol,
   isEqualToAmount,
-  isLessThanAmount,
-  isGreaterThanAmount,
 } from '@/index';
 
 killStuckProcess();
@@ -162,12 +160,8 @@ test('[derivedIdentity] it can fund the derived identity', async (t: Test) => {
   // It's a little less due to the transaction fee.
   const { identityBalance, derivedBalance } = await getBalances(mx);
   t.ok(
-    isLessThanAmount(identityBalance, sol(4)),
-    'identity balance is less than 4'
-  );
-  t.ok(
-    isGreaterThanAmount(identityBalance, sol(3.9)),
-    'identity balance is greater than 3.9'
+    isEqualToAmount(identityBalance, sol(4), sol(0.01)),
+    'identity balance is around 4'
   );
   t.ok(isEqualToAmount(derivedBalance, sol(1)), 'derived balance is 1');
 });
@@ -188,15 +182,11 @@ test('[derivedIdentity] it can withdraw from the derived identity', async (t: Te
   // Then we can see that 1 SOL was transferred from the derived identity to the identity.
   // It's a little less due to the transaction fee.
   const { identityBalance, derivedBalance } = await getBalances(mx);
+  t.ok(isEqualToAmount(identityBalance, sol(6)), 'identity balance is 6');
   t.ok(
-    isLessThanAmount(identityBalance, sol(6)),
-    'identity balance is less than 6'
-  );
-  t.ok(
-    isGreaterThanAmount(identityBalance, sol(5.9)),
-    'identity balance is greater than 5.9'
+    isEqualToAmount(derivedBalance, sol(1), sol(0.01)),
+    'derived balance is around 1'
   );
-  t.ok(isEqualToAmount(derivedBalance, sol(1)), 'derived balance is 1');
 });
 
 test('[derivedIdentity] it can withdraw everything from the derived identity', async (t: Test) => {
@@ -216,12 +206,8 @@ test('[derivedIdentity] it can withdraw everything from the derived identity', a
   // It's a little less due to the transaction fee.
   const { identityBalance, derivedBalance } = await getBalances(mx);
   t.ok(
-    isLessThanAmount(identityBalance, sol(7)),
-    'identity balance is less than 7'
-  );
-  t.ok(
-    isGreaterThanAmount(identityBalance, sol(6.9)),
-    'identity balance is greater than 6.9'
+    isEqualToAmount(identityBalance, sol(7), sol(0.01)),
+    'derived balance is around 7'
   );
   t.ok(isEqualToAmount(derivedBalance, sol(0)), 'derived balance is 0');
 });