docs(fund with ar): add examples for topUpWithTokens PE-5849

README.md

@@ -333,7 +333,9 @@ Types are exported from `./lib/types/[node/web]/index.d.ts` and should be automa
   });
   ```
 
-  - `topUpWithTokens({ tokenAmount, feeMultiplier })` - Tops up the connected wallet with Credits by submitting a payment transaction for the token amount to the Turbo wallet and then submitting that transaction id to the Turbo for processing.s The `tokenAmount` is the amount of tokens in the token type's smallest unit value (e.g: Winston for arweave token type) to fund the wallet with. The `feeMultiplier` is the multiplier to apply to the reward for the transaction to modify its chances of being mined. Credits will be added to the wallet balance after the transaction is confirmed on the given blockchains.
+  - `topUpWithTokens({ tokenAmount, feeMultiplier })` - Tops up the connected wallet with Credits by submitting a payment transaction for the token amount to the Turbo wallet and then submitting that transaction id to Turbo Payment Service for processing.
+    - The `tokenAmount` is the amount of tokens in the token type's smallest unit value (e.g: Winston for arweave token type) to fund the wallet with.
+    - The `feeMultiplier` is the multiplier to apply to the reward for the transaction to modify its chances of being mined. Credits will be added to the wallet balance after the transaction is confirmed on the given blockchain.
 
   ```typescript
   const turbo = TurboFactory.authenticated({ signer, token: 'arweave' });

examples/cjs/index.cjs

@@ -81,4 +81,13 @@ const {
     signal: AbortSignal.timeout(10_000), // cancel the upload after 10 seconds
   });
   console.log(JSON.stringify(uploadResult, null, 2));
+
+  /**
+   * Tops up a wallet with Credits using tokens.
+   * Default token is AR, using Winston as the unit.
+   */
+  const topUpResult = await turboAuthClient.topUpWithTokens({
+    tokenAmount: 1, /// 0.000_000_000_000_001 AR
+  });
+  console.log(JSON.stringify(topUpResult, null, 2));
 })();

examples/esm/index.mjs

@@ -78,4 +78,13 @@ import fs from 'fs';
     signal: AbortSignal.timeout(10_000), // cancel the upload after 10 seconds
   });
   console.log(JSON.stringify(uploadResult, null, 2));
+
+  /**
+   * Tops up a wallet with Credits using tokens.
+   * Default token is AR, using Winston as the unit.
+   */
+  const topUpResult = await turboAuthClient.topUpWithTokens({
+    tokenAmount: 1, /// 0.000_000_000_000_001 AR
+  });
+  console.log(JSON.stringify(topUpResult, null, 2));
 })();

examples/typescript/cjs/index.ts

@@ -47,4 +47,13 @@ import path from 'path';
     signal: AbortSignal.timeout(10_000), // cancel the upload after 10 seconds
   });
   console.log(JSON.stringify(uploadResult, null, 2));
+
+  /**
+   * Tops up a wallet with Credits using tokens.
+   * Default token is AR, using Winston as the unit.
+   */
+  const topUpResult = await turboAuthClient.topUpWithTokens({
+    tokenAmount: 1, /// 0.000_000_000_000_001 AR
+  });
+  console.log(JSON.stringify(topUpResult, null, 2));
 })();

examples/typescript/esm/index.ts

@@ -47,4 +47,13 @@ import fs from 'fs';
     signal: AbortSignal.timeout(10_000), // cancel the upload after 10 seconds
   });
   console.log(JSON.stringify(uploadResult, null, 2));
+
+  /**
+   * Tops up a wallet with Credits using tokens.
+   * Default token is AR, using Winston as the unit.
+   */
+  const topUpResult = await turboAuthClient.topUpWithTokens({
+    tokenAmount: 1, /// 0.000_000_000_000_001 AR
+  });
+  console.log(JSON.stringify(topUpResult, null, 2));
 })();

package.json

@@ -60,7 +60,7 @@
     "test:node": "c8 mocha --config .mocharc --exclude tests/**/*.web.test.ts --exit",
     "test:docker": "docker compose up --exit-code-from test-runner --build",
     "prepare": "husky install",
-    "examples": "yarn example:mjs & yarn example:cjs & yarn example:ts:esm & yarn example:ts:cjs",
+    "examples": "yarn example:esm & yarn example:cjs & yarn example:ts:esm & yarn example:ts:cjs",
     "example:esm": "cd examples/esm && yarn && node index.mjs",
     "example:cjs": "cd examples/cjs && yarn && node index.cjs",
     "example:web": "http-server --port 8080 --host -o examples/web",

src/common/payment.ts

@@ -315,7 +315,7 @@ export class TurboAuthenticatedPaymentService
         reward: signedTx.reward,
       };
     } catch (e) {
-      this.logger.error('Failed to submit fund transaction...', { e });
+      this.logger.error('Failed to submit fund transaction...', e);
 
       throw Error(
         `Failed to submit fund transaction! Save this Transaction ID and try again with 'turbo.submitFundTransaction(id)': ${txId}`,

src/common/token.ts

@@ -39,9 +39,9 @@ export class ArweaveToken implements BaseToken<Transaction.default> {
     logger = new TurboWinstonLogger(),
     mintU = true,
     pollingOptions = {
-      maxAttempts: 30,
-      pollingIntervalMs: 1_000,
-      initialBackoffMs: 5_000,
+      maxAttempts: 10,
+      pollingIntervalMs: 3_000,
+      initialBackoffMs: 7_000,
     },
   }: {
     arweave: Arweave;