docs: transaction optimization

.changeset/young-schools-push.md

@@ -0,0 +1,5 @@
+---
+"@internal/check-imports": patch
+---
+
+docs: transaction optimization

apps/docs/.vitepress/config.ts

@@ -346,6 +346,25 @@ export default defineConfig({
               },
             ],
           },
+          {
+            text: 'Optimizing Transactions',
+            link: '/guide/optimizing-transactions/',
+            collapsed: true,
+            items: [
+              {
+                text: 'Optimistic Transactions',
+                link: '/guide/optimizing-transactions/optimistic-transactions',
+              },
+              {
+                text: 'Optimistic Contract Calls',
+                link: '/guide/optimizing-transactions/optimistic-contract-calls',
+              },
+              {
+                text: 'Optimistic Predicates',
+                link: '/guide/optimizing-transactions/optimistic-predicates',
+              },
+            ],
+          },
           {
             text: 'Encoding',
             link: '/guide/encoding/',

apps/docs/src/guide/encoding/snippets/working-with-bytes.ts

@@ -38,14 +38,12 @@ const encodedU256 = u256Coder.encode(255);
 // #region working-with-bytes-2
 const booleanCoder = new BooleanCoder();
 const encodedTrue = booleanCoder.encode(true);
-
 const encodedFalse = booleanCoder.encode(false);
-
 // #endregion working-with-bytes-2
 
 // #region working-with-bytes-3
 const stringCoder = new StringCoder(5);
-const encoded = stringCoder.encode('hello');
+const encodedString = stringCoder.encode('hello');
 // #endregion working-with-bytes-3
 
 // #region working-with-bytes-4

apps/docs/src/guide/optimizing-transactions/index.md

@@ -0,0 +1,26 @@
+# Optimizing Transactions
+
+When submitting transactions using the SDK, the following actions are being performed:
+
+- Fetching chain information to compute transaction data
+- Retrieving the gas price for cost estimation
+- Simulating the transaction to obtain missing or estimating transaction data
+- Fetching funds for the transaction
+
+Depending on how you are performing the transaction, all of the above may have been abstracted away underneath a single function call that is performing multiple calls to the network to retrieve necessary information. Which gives the appearance of slowness for users interacting with your application.
+
+This process can be illustrated by the following diagram:
+
+![Pre-optimization Tx Process](../../public/tx-optimization-before.png)
+
+This can be mitigated by optimistically building the transaction before your user submits the transaction. Pre-preparation of the transaction can improve the perceived speed of transactions by **~2x**.
+
+The process now looks like the following:
+
+![Post-optimization Tx Process](../../public/tx-optimization-after.png)
+
+Check out the following guides on implementing optimistic transaction building:
+
+- [Optimistic Transactions](./optimistic-transactions)
+- [Optimistic Contract Calls](./optimistic-contract-calls)
+- [Optimistic Predicates](./optimistic-predicates)

apps/docs/src/guide/optimizing-transactions/optimistic-contract-calls.md

@@ -0,0 +1,22 @@
+# Optimistic Contract Calls
+
+Imagine we have an application that allows a user to interact with a counter contract.
+
+On the frontend, we'd have a button that would allow the user to submit a transaction that increments a counter.
+
+```tsx
+<Button onClick={onIncrementPressed}>Increment</Button>
+```
+
+This would likely have the following handler function:
+
+<<< @./snippets/optimistic-contract-calls-before.ts#main{ts:line-numbers}
+
+Under the hood, `call` is making multiple calls to the network to both simulate and fund the transaction, then submitting it. This may give the appearance of slowness for users interacting with your application.
+
+This process can be optimized by optimistically building the contract transaction on page load, like so:
+
+<<< @./snippets/optimistic-contract-calls-after.ts#main{ts:line-numbers}
+
+> [!NOTE]
+> Any change to the underlying transaction will require re-estimation and re-funding of the transaction. Otherwise the transaction could increase in size and therefore cost, causing the transaction to fail.

apps/docs/src/guide/optimizing-transactions/optimistic-predicates.md

@@ -0,0 +1,32 @@
+# Optimistic Predicates
+
+Imagine we have an application that allows a user to transfer funds to another user given a validated predicate condition, here we'll use a pin number.
+
+```tsx
+<Input
+  placeholder="Enter PIN number"
+  value={pin}
+  onChange={(e) => setPin(e.target.value)}
+/>
+<Input
+  placeholder="Enter recipient address"
+  value={recipientAddress}
+  onChange={(e) => setRecipientAddress(e.target.value)}
+/>
+<Button onClick={() => onTransferPressed(pin, recipientAddress)}>Transfer</Button>
+```
+
+This would likely have the following handler function:
+
+<<< @./snippets/optimistic-predicates-before.ts#main{ts:line-numbers}
+
+Under the hood, the `transfer` call is making multiple calls to the network to both simulate and fund the transaction, then submitting it. This may give the appearance of slowness for users interacting with your application.
+
+This process can be optimized by optimistically building the transaction on page load, like so:
+
+<<< @./snippets/optimistic-transactions-after.ts#main{ts:line-numbers}
+
+> [!NOTE]
+> Any change to the underlying transaction will require re-estimation and re-funding of the transaction. Otherwise the transaction could increase in size and therefore cost, causing the transaction to fail.
+>
+> For predicates, the data passed to validate it could potentially alter the amount of gas the predicate consumes. This may mean we need to re-estimate and re-fund the transaction.

apps/docs/src/guide/optimizing-transactions/optimistic-transactions.md

@@ -0,0 +1,27 @@
+# Optimistic Transactions
+
+Imagine we have an application that allows users to transfer funds between accounts.
+
+On the frontend, we'd have a button that would allow the user to submit a transfer to a specified address.
+
+```tsx
+<Input
+  placeholder="Enter recipient address"
+  value={recipientAddress}
+  onChange={(e) => setRecipientAddress(e.target.value)}
+/>
+<Button onClick={() => onTransferPressed(recipientAddress)}>Transfer</Button>
+```
+
+This would likely have the following handler function:
+
+<<< @./snippets/optimistic-transactions-before.ts#main{ts:line-numbers}
+
+Under the hood, the `transfer` call is making multiple calls to the network to both simulate and fund the transaction, then submitting it. This may give the appearance of slowness for users interacting with your application.
+
+This process can be optimized by optimistically building the transaction on page load, like so:
+
+<<< @./snippets/optimistic-transactions-after.ts#main{ts:line-numbers}
+
+> [!NOTE]
+> Any change to the underlying transaction will require re-estimation and re-funding of the transaction. Otherwise the transaction could increase in size and therefore cost, causing the transaction to fail.

apps/docs/src/guide/optimizing-transactions/snippets/optimistic-contract-calls-after.ts

@@ -0,0 +1,46 @@
+// #region main
+import type { Account, ScriptTransactionRequest } from 'fuels';
+import { Provider, Wallet } from 'fuels';
+
+import { LOCAL_NETWORK_URL, WALLET_PVT_KEY } from '../../../env';
+import { CounterFactory } from '../../../typegend/contracts';
+
+const { info } = console;
+
+let provider: Provider;
+let wallet: Account;
+let request: ScriptTransactionRequest;
+
+// This is a generic page load function which should be called
+// as soon as the user lands on the page
+async function onPageLoad() {
+  // Initialize the provider, sender and the contract
+  provider = await Provider.create(LOCAL_NETWORK_URL);
+  wallet = Wallet.fromPrivateKey(WALLET_PVT_KEY, provider);
+  const { waitForResult } = await CounterFactory.deploy(wallet);
+  const { contract } = await waitForResult();
+
+  // Get the transaction request for the increment_count function
+  request = await contract.functions.increment_count(1).getTransactionRequest();
+
+  // Estimate and fund the transaction
+  const txCost = await wallet.getTransactionCost(request);
+  request.gasLimit = txCost.gasUsed;
+  request.maxFee = txCost.maxFee;
+  await wallet.fund(request, txCost);
+}
+
+async function onIncrementPressed() {
+  // When the user presses the increment button, we submit the transaction
+  // ensuring that the dependencies are not re-estimated and making redundant calls to the network
+  const transaction = await wallet.sendTransaction(request, {
+    estimateTxDependencies: false,
+  });
+  info(`Transaction ID Submitted: ${transaction.id}`);
+  const result = await transaction.waitForResult();
+  info(`Transaction ID Successful: ${result.id}`);
+}
+// #endregion main
+
+await onPageLoad();
+await onIncrementPressed();

apps/docs/src/guide/optimizing-transactions/snippets/optimistic-contract-calls-before.ts

@@ -0,0 +1,26 @@
+// #region main
+import { Provider, Wallet } from 'fuels';
+
+import { LOCAL_NETWORK_URL, WALLET_PVT_KEY } from '../../../env';
+import { CounterFactory } from '../../../typegend/contracts';
+
+const { info } = console;
+
+async function onIncrementPressed() {
+  // Initialize the provider, sender and the contract
+  const provider = await Provider.create(LOCAL_NETWORK_URL);
+  const wallet = Wallet.fromPrivateKey(WALLET_PVT_KEY, provider);
+  const { waitForResult } = await CounterFactory.deploy(wallet);
+  const { contract } = await waitForResult();
+
+  // Calling the call function for a contract method will create a
+  // transaction request using the contract call, estimate and fund it
+  // and then submit it
+  const transaction = await contract.functions.increment_count(1).call();
+  info(`Transaction ID Submitted: ${transaction.transactionId}`);
+  const result = await transaction.waitForResult();
+  info(`Transaction ID Successful: ${result.transactionId}`);
+}
+// #endregion main
+
+await onIncrementPressed();

apps/docs/src/guide/optimizing-transactions/snippets/optimistic-predicates-after.ts

@@ -0,0 +1,70 @@
+// #region main
+import type { Account } from 'fuels';
+import { Provider, Wallet, ScriptTransactionRequest, Address } from 'fuels';
+
+import { LOCAL_NETWORK_URL, WALLET_PVT_KEY_2 } from '../../../env';
+import { ConfigurablePin } from '../../../typegend';
+
+const { info } = console;
+
+let provider: Provider;
+let sender: Account;
+let request: ScriptTransactionRequest;
+let predicate: ConfigurablePin;
+
+// This is a generic page load function which should be called
+// as soon as the user lands on the page
+async function onPageLoad() {
+  // Initialize the provider and wallet
+  provider = await Provider.create(LOCAL_NETWORK_URL);
+  sender = Wallet.fromPrivateKey(WALLET_PVT_KEY_2, provider);
+
+  // Instantiate the predicate and fund it
+  predicate = new ConfigurablePin({ provider });
+  const fundTx = await sender.transfer(
+    predicate.address,
+    500_000,
+    provider.getBaseAssetId()
+  );
+  await fundTx.waitForResult();
+
+  // Create a new transaction request and add the predicate resources
+  request = new ScriptTransactionRequest();
+  const resources = await predicate.getResourcesToSpend([
+    [100_000, provider.getBaseAssetId()],
+  ]);
+  request.addResources(resources);
+
+  // Estimate and fund the transaction, including the predicate gas used
+  const txCost = await predicate.getTransactionCost(request);
+  request.updatePredicateGasUsed(txCost.estimatedPredicates);
+  request.gasLimit = txCost.gasUsed;
+  request.maxFee = txCost.maxFee;
+  await predicate.fund(request, txCost);
+}
+
+async function onTransferPressed(pin: number, recipientAddress: string) {
+  // When the user presses the transfer button, we add the output
+  // to the transaction request
+  request.addCoinOutput(
+    Address.fromString(recipientAddress),
+    10_000,
+    provider.getBaseAssetId()
+  );
+  // Then we must alter any existing predicate data that may have changed
+  const predicateWithData = new ConfigurablePin({ provider, data: [pin] });
+  const requestWithData =
+    predicateWithData.populateTransactionPredicateData(request);
+  // And submit the transaction, ensuring that the dependencies are
+  // not re-estimated and making redundant calls to the network
+  const transaction = await sender.sendTransaction(requestWithData, {
+    estimateTxDependencies: false,
+  });
+  info(`Transaction ID Submitted: ${transaction.id}`);
+  const result = await transaction.waitForResult();
+  info(`Transaction ID Successful: ${result.id}`);
+}
+// #endregion main
+
+await onPageLoad();
+await onTransferPressed(1337, Wallet.generate().address.toString());

apps/docs/src/guide/optimizing-transactions/snippets/optimistic-predicates-before.ts

@@ -0,0 +1,32 @@
+// #region main
+import { Provider, Wallet } from 'fuels';
+
+import { LOCAL_NETWORK_URL, WALLET_PVT_KEY } from '../../../env';
+import { ConfigurablePin } from '../../../typegend';
+
+const { info } = console;
+
+async function onTransferPressed(pin: number, recipientAddress: string) {
+  // Initialize the provider and sender
+  const provider = await Provider.create(LOCAL_NETWORK_URL);
+  const sender = Wallet.fromPrivateKey(WALLET_PVT_KEY, provider);
+
+  // Instantiate the predicate and fund it
+  const predicate = new ConfigurablePin({ provider, data: [pin] });
+  const fundTx = await sender.transfer(
+    predicate.address,
+    500_000,
+    provider.getBaseAssetId()
+  );
+  await fundTx.waitForResult();
+
+  // Calling the transfer function will create the transaction,
+  // and then perform multiple network requests to fund, simulate and submit
+  const transaction = await predicate.transfer(recipientAddress, 10_000);
+  info(`Transaction ID Submitted: ${transaction.id}`);
+  const result = await transaction.waitForResult();
+  info(`Transaction ID Successful: ${result.id}`);
+}
+// #endregion main
+
+await onTransferPressed(1337, Wallet.generate().address.toString());

apps/docs/src/guide/optimizing-transactions/snippets/optimistic-transactions-after.ts

@@ -0,0 +1,59 @@
+// #region main
+import type { Account } from 'fuels';
+import { ScriptTransactionRequest, Address, Provider, Wallet, bn } from 'fuels';
+
+import { LOCAL_NETWORK_URL, WALLET_PVT_KEY } from '../../../env';
+
+const { info } = console;
+
+let provider: Provider;
+let sender: Account;
+let request: ScriptTransactionRequest;
+
+// This is a generic page load function which should be called
+// as soon as the user lands on the page
+async function onPageLoad() {
+  // Initialize the provider and sender
+  provider = await Provider.create(LOCAL_NETWORK_URL);
+  sender = Wallet.fromPrivateKey(WALLET_PVT_KEY, provider);
+
+  // Create and prepare the transaction request
+  request = new ScriptTransactionRequest();
+
+  // Estimate and fund the transaction with enough resources to cover
+  // both the transfer and the gas
+  const txCost = await sender.getTransactionCost(request, {
+    quantities: [
+      {
+        assetId: provider.getBaseAssetId(),
+        amount: bn(1_000_000),
+      },
+    ],
+  });
+  request.gasLimit = txCost.gasUsed;
+  request.maxFee = txCost.maxFee;
+  await sender.fund(request, txCost);
+}
+
+async function onTransferPressed(recipientAddress: string) {
+  // When the user presses the transfer button, we add the output
+  // to the transaction request
+  request.addCoinOutput(
+    Address.fromString(recipientAddress),
+    1_000_000,
+    provider.getBaseAssetId()
+  );
+
+  // And submit the transaction, ensuring that the dependencies are
+  // not re-estimated and making redundant calls to the network
+  const transaction = await sender.sendTransaction(request, {
+    estimateTxDependencies: false,
+  });
+  info(`Transaction ID Submitted: ${transaction.id}`);
+  const result = await transaction.waitForResult();
+  info(`Transaction ID Successful: ${result.id}`);
+}
+// #endregion main
+
+await onPageLoad();
+await onTransferPressed(Wallet.generate().address.toString());