@augustdigital/sdk 8.5.0 → 8.6.1

package/lib/modules/vaults/read.actions.js

@@ -40,7 +40,7 @@ async function fetchInstantRedemptionFee(signer, options) {
         }
     }
     catch (e) {
-        core_1.Logger.log.error('failed to fetch instant redeem fee', e);
+        (0, core_1.logChainError)('failed to fetch instant redeem fee', e, (0, core_1.isExpectedRevertError)(e));
         throw new Error(`Failed to fetch instant redeem fee for ${target}: ${e instanceof Error ? e.message : 'Unknown error'}`);
     }
 }
@@ -83,7 +83,7 @@ async function vaultAllowance(signer, options) {
         return normalized;
     }
     catch (e) {
-        core_1.Logger.log.error('allowance', e);
+        (0, core_1.logChainError)('allowance', e, (0, core_1.isExpectedRevertError)(e));
         throw new Error(`Failed to fetch allowance: ${e instanceof Error ? e.message : 'Unknown error'}`);
     }
 }
@@ -109,7 +109,7 @@ async function sendersWhitelistAddress(signer, options) {
         return whitelistAddress;
     }
     catch (e) {
-        core_1.Logger.log.error('sendersWhitelistAddress', e);
+        (0, core_1.logChainError)('sendersWhitelistAddress', e, (0, core_1.isExpectedRevertError)(e));
         throw new Error(`Failed to fetch senders whitelist address: ${e instanceof Error ? e.message : 'Unknown error'}`);
     }
 }
@@ -138,7 +138,7 @@ async function isWhitelisted(signer, options) {
         return result;
     }
     catch (e) {
-        core_1.Logger.log.error('isWhitelisted', e);
+        (0, core_1.logChainError)('isWhitelisted', e, (0, core_1.isExpectedRevertError)(e));
         throw new Error(`Failed to check whitelist status: ${e instanceof Error ? e.message : 'Unknown error'}`);
     }
 }
@@ -183,7 +183,7 @@ async function getDeposited(signer, options) {
         return normalized;
     }
     catch (e) {
-        core_1.Logger.log.error('getDeposited', e);
+        (0, core_1.logChainError)('getDeposited', e, (0, core_1.isExpectedRevertError)(e));
         throw new Error(`Failed to fetch deposited amount: ${e instanceof Error ? e.message : 'Unknown error'}`);
     }
 }
@@ -232,7 +232,7 @@ async function getRemainingAllocations(signer, options) {
         return normalized;
     }
     catch (e) {
-        core_1.Logger.log.error('getRemainingAllocations', e);
+        (0, core_1.logChainError)('getRemainingAllocations', e, (0, core_1.isExpectedRevertError)(e));
         throw new Error(`Failed to fetch remaining allocations: ${e instanceof Error ? e.message : 'Unknown error'}`);
     }
 }
@@ -263,7 +263,11 @@ async function previewRwaRedemption(signer, options) {
         return normalized;
     }
     catch (e) {
-        core_1.Logger.log.error('previewRwaRedemption', e, { target, asset, amount });
+        (0, core_1.logChainError)('previewRwaRedemption', e, (0, core_1.isExpectedRevertError)(e), {
+            target,
+            asset,
+            amount,
+        });
         throw new Error(`Preview RWA redemption failed: ${e instanceof Error ? e.message : 'Unknown error'}`);
     }
 }
@@ -354,7 +358,10 @@ async function previewDeposit(signer, options) {
         if (e instanceof core_1.AugustValidationError || e instanceof core_1.AugustSDKError) {
             throw e;
         }
-        core_1.Logger.log.error('previewDeposit', e, { vault, amount: amount.toString() });
+        (0, core_1.logChainError)('previewDeposit', e, (0, core_1.isExpectedRevertError)(e), {
+            vault,
+            amount: amount.toString(),
+        });
         throw new core_1.AugustSDKError('UNKNOWN', `previewDeposit failed: ${e instanceof Error ? e.message : 'Unknown error'}`, { cause: e, context: { vault, amount: amount.toString() } });
     }
 }
@@ -410,7 +417,7 @@ async function previewRedeem(signer, options) {
         if (e instanceof core_1.AugustValidationError || e instanceof core_1.AugustSDKError) {
             throw e;
         }
-        core_1.Logger.log.error('previewRedeem', e, {
+        (0, core_1.logChainError)('previewRedeem', e, (0, core_1.isExpectedRevertError)(e), {
             vault,
             shares: shares.toString(),
         });
@@ -480,7 +487,11 @@ async function allowance(signer, options) {
         if (e instanceof core_1.AugustValidationError || e instanceof core_1.AugustSDKError) {
             throw e;
         }
-        core_1.Logger.log.error('allowance', e, { vault, owner, asset });
+        (0, core_1.logChainError)('allowance', e, (0, core_1.isExpectedRevertError)(e), {
+            vault,
+            owner,
+            asset,
+        });
         throw new core_1.AugustSDKError('UNKNOWN', `allowance failed: ${e instanceof Error ? e.message : 'Unknown error'}`, { cause: e, context: { vault, owner, asset } });
     }
 }
@@ -521,7 +532,7 @@ async function balanceOf(signer, options) {
         if (e instanceof core_1.AugustValidationError || e instanceof core_1.AugustSDKError) {
             throw e;
         }
-        core_1.Logger.log.error('balanceOf', e, { asset, owner });
+        (0, core_1.logChainError)('balanceOf', e, (0, core_1.isExpectedRevertError)(e), { asset, owner });
         throw new core_1.AugustSDKError('UNKNOWN', `balanceOf failed: ${e instanceof Error ? e.message : 'Unknown error'}`, { cause: e, context: { asset, owner } });
     }
 }
@@ -575,7 +586,10 @@ async function maxDeposit(signer, options) {
         if (e instanceof core_1.AugustValidationError || e instanceof core_1.AugustSDKError) {
             throw e;
         }
-        core_1.Logger.log.error('maxDeposit', e, { vault, receiver });
+        (0, core_1.logChainError)('maxDeposit', e, (0, core_1.isExpectedRevertError)(e), {
+            vault,
+            receiver,
+        });
         throw new core_1.AugustSDKError('UNKNOWN', `maxDeposit failed: ${e instanceof Error ? e.message : 'Unknown error'}`, { cause: e, context: { vault, receiver } });
     }
 }

package/lib/modules/vaults/utils/call-data-decoder.d.ts

@@ -4,7 +4,7 @@
  * Decodes transaction calldata to extract which (year, month, day) cluster
  * was processed when a WithdrawalProcessed event was emitted.
  */
-import { ContractTransactionReceipt, Interface } from 'ethers';
+import type { ContractTransactionReceipt, Interface } from 'ethers';
 export interface ProcessingCallData {
     functionName: 'processAllClaimsByDate' | 'claim' | 'unknown';
     year: number;

package/lib/modules/vaults/utils.d.ts

@@ -16,9 +16,18 @@ export declare function walletClientToSigner(walletClient: WalletClient): Promis
  */
 export declare const getRewardMultiplierByTimestamp: (foundPool: IVault, timestamp?: number) => number;
 /**
- * Get the rewards for the vault
- * @param tokenizedVault - The tokenized vault
- * @returns The rewards
+ * Get the rewards for the vault.
+ *
+ * Builds the display-facing rewards summary from the raw tokenized-vault
+ * rewards array. In addition to the legacy `additionalPoints` string list, it
+ * emits `additionalPointsDetailed`, which pairs each label with its
+ * backend-provided `img_url`. Consumers (e.g. the Upshift app) resolve a
+ * reward's logo from this `imgUrl` first, falling back to a bundled asset only
+ * when it is absent — so a newly-added reward with a backend logo (e.g.
+ * "Cores") renders its icon without any client-side keyword mapping.
+ *
+ * @param tokenizedVault - The tokenized vault.
+ * @returns The rewards summary, including `additionalPointsDetailed`.
  */
 export declare function getVaultRewards(tokenizedVault: ITokenizedVault): {
     points: string;
@@ -28,6 +37,13 @@ export declare function getVaultRewards(tokenizedVault: ITokenizedVault): {
         value: number;
     }[];
     additionalPoints: string[];
+    additionalPointsDetailed: {
+        id: string;
+        label: string;
+        text: string;
+        imgUrl: string;
+        multiplier: number;
+    }[];
 };
 /**
  * Get the idle assets for the vault

package/lib/modules/vaults/utils.js

@@ -72,9 +72,34 @@ const getRewardMultiplierByTimestamp = (foundPool, timestamp) => {
 };
 exports.getRewardMultiplierByTimestamp = getRewardMultiplierByTimestamp;
 /**
- * Get the rewards for the vault
- * @param tokenizedVault - The tokenized vault
- * @returns The rewards
+ * Build the human-readable display label for a single reward.
+ *
+ * The format is `"{multiplier}x {text}"`, with the multiplier prefix omitted
+ * when it equals 1 (e.g. `"2x Cores"`, `" Cores"` when multiplier is 1 — the
+ * leading space is preserved to keep `additionalPoints` and the
+ * `additionalPointsDetailed` label in lockstep). This is a display string only;
+ * consumers that need a stable key should join on the reward's `id`
+ * (see {@link IVaultRewardDetail}), not on this label.
+ *
+ * @param reward - The raw tokenized-vault reward.
+ * @returns The display label string.
+ */
+function getRewardLabel(reward) {
+    return `${reward.multiplier !== 1 ? `${reward.multiplier}x` : ''} ${reward.text}`;
+}
+/**
+ * Get the rewards for the vault.
+ *
+ * Builds the display-facing rewards summary from the raw tokenized-vault
+ * rewards array. In addition to the legacy `additionalPoints` string list, it
+ * emits `additionalPointsDetailed`, which pairs each label with its
+ * backend-provided `img_url`. Consumers (e.g. the Upshift app) resolve a
+ * reward's logo from this `imgUrl` first, falling back to a bundled asset only
+ * when it is absent — so a newly-added reward with a backend logo (e.g.
+ * "Cores") renders its icon without any client-side keyword mapping.
+ *
+ * @param tokenizedVault - The tokenized vault.
+ * @returns The rewards summary, including `additionalPointsDetailed`.
  */
 function getVaultRewards(tokenizedVault) {
     const upshiftPointRewards = tokenizedVault.rewards?.filter((r) => r.text === 'Upshift Points');
@@ -91,7 +116,14 @@ function getVaultRewards(tokenizedVault) {
             : '',
         multiplier: latestUpshiftPointMultiplier,
         multipliers: upshiftPointsMultipliers,
-        additionalPoints: tokenizedVault.rewards.map((r) => `${r.multiplier !== 1 ? `${r.multiplier}x` : ''} ${r.text}`),
+        additionalPoints: tokenizedVault.rewards.map(getRewardLabel),
+        additionalPointsDetailed: tokenizedVault.rewards.map((r) => ({
+            id: r.id,
+            label: getRewardLabel(r),
+            text: r.text,
+            imgUrl: r.img_url || null,
+            multiplier: r.multiplier,
+        })),
     };
     return rewards;
 }
@@ -289,6 +321,7 @@ function buildBackendVault(tokenizedVault, overrides) {
             multiplier: 0,
             multipliers: [],
             additionalPoints: [],
+            additionalPointsDetailed: [],
         };
     return {
         operator: '0x',
@@ -313,7 +346,7 @@ function buildBackendVault(tokenizedVault, overrides) {
         reserveTolerance: tokenizedVault.reserve_tolerance || 0,
         // Vault decimals are derived from the receipt token decimals for non-EVM vaults
         decimals: overrides.receipt.decimals,
-        maxSupply: (0, core_1.toNormalizedBn)(1000000000),
+        maxSupply: (0, core_1.toNormalizedBn)(1_000_000_000),
         depositCap: null,
         apy,
         rewards,
@@ -498,7 +531,7 @@ async function buildFormattedVault(provider, tokenizedVault, contractCalls) {
             depositAssets = [...depositAssets, ...extraAssets];
             totalSupply = contractCalls.totalSupply;
             (maxSupply =
-                (0, core_1.toNormalizedBn)(1000000000000)), // @hardcoded: no maxSupply on here
+                (0, core_1.toNormalizedBn)(1_000_000_000_000)), // @hardcoded: no maxSupply on here
                 (receipt = {
                     symbol: tokenizedVault.receipt_token_symbol,
                     address: contractCalls.lpTokenAddress,

package/lib/modules/vaults/write.actions.js

@@ -90,7 +90,7 @@ function validateAmountPrecision(amount) {
 }
 // Tries tx.wait() first (preserves replacement detection & revert checks), then falls back to
 // provider.waitForTransaction() for RPCs (e.g. Monad) that return malformed pending tx fields.
-const SAFE_WAIT_TIMEOUT_MS = 120000;
+const SAFE_WAIT_TIMEOUT_MS = 120_000;
 /** @internal */
 function isNonceParsing(error) {
     const code = error?.code;
@@ -297,7 +297,12 @@ async function approveCore(signer, options) {
     catch (e) {
         if (e instanceof core_1.AugustSDKError)
             throw e;
-        core_1.Logger.log.error('vaultApprove', e, { target, amount });
+        // A user declining the approval in their wallet is product behaviour, not
+        // an SDK fault — demote it to a breadcrumb so it doesn't bill as an issue.
+        (0, core_1.logChainError)('vaultApprove', e, (0, core_1.isUserRejectionError)(e), {
+            target,
+            amount,
+        });
         throw new core_1.AugustSDKError('UNKNOWN', `Approval failed: ${e instanceof Error ? e.message : 'Unknown error'}`, { cause: e, context: { target, amount } });
     }
 }
@@ -632,7 +637,12 @@ async function vaultDeposit(signer, options) {
         }
         if (e instanceof core_1.AugustSDKError)
             throw e;
-        core_1.Logger.log.error('deposit', e, { target, amount, depositAsset });
+        // User-cancelled deposits are normal; only genuine failures stay at error.
+        (0, core_1.logChainError)('deposit', e, (0, core_1.isUserRejectionError)(e), {
+            target,
+            amount,
+            depositAsset,
+        });
         throw new core_1.AugustSDKError('UNKNOWN', `Deposit failed: ${e instanceof Error ? e.message : 'Unknown error'}`, { cause: e, context: { target, amount, depositAsset } });
     }
 }
@@ -780,7 +790,11 @@ async function vaultRequestRedeem(signer, options) {
         }
         if (e instanceof core_1.AugustSDKError)
             throw e;
-        core_1.Logger.log.error('requestRedeem', e, { target, amount });
+        // User-cancelled redeem requests are normal; only genuine failures stay at error.
+        (0, core_1.logChainError)('requestRedeem', e, (0, core_1.isUserRejectionError)(e), {
+            target,
+            amount,
+        });
         throw new core_1.AugustSDKError('UNKNOWN', `Request redeem failed: ${e instanceof Error ? e.message : 'Unknown error'}`, { cause: e, context: { target, amount } });
     }
 }
@@ -823,7 +837,14 @@ async function vaultRedeem(signer, options) {
         }
         if (e instanceof core_1.AugustSDKError)
             throw e;
-        core_1.Logger.log.error('redeem', e, { target, year, month, day, receiverIndex });
+        // User-cancelled redeems are normal; only genuine failures stay at error.
+        (0, core_1.logChainError)('redeem', e, (0, core_1.isUserRejectionError)(e), {
+            target,
+            year,
+            month,
+            day,
+            receiverIndex,
+        });
         throw new core_1.AugustSDKError('UNKNOWN', `Redeem failed: ${e instanceof Error ? e.message : 'Unknown error'}`, { cause: e, context: { target, year, month, day, receiverIndex } });
     }
 }
@@ -914,7 +935,12 @@ async function depositNative(signer, options) {
         }
         if (e instanceof core_1.AugustSDKError)
             throw e;
-        core_1.Logger.log.error('depositNative', e, { wrapperAddress, receiver, amount });
+        // User-cancelled native deposits are normal; only genuine failures stay at error.
+        (0, core_1.logChainError)('depositNative', e, (0, core_1.isUserRejectionError)(e), {
+            wrapperAddress,
+            receiver,
+            amount,
+        });
         throw new core_1.AugustSDKError('UNKNOWN', `Deposit native failed: ${e instanceof Error ? e.message : 'Unknown error'}`, { cause: e, context: { wrapperAddress, receiver, amount } });
     }
 }
@@ -988,7 +1014,13 @@ async function rwaRedeemAsset(signer, options) {
         }
         if (e instanceof core_1.AugustSDKError)
             throw e;
-        core_1.Logger.log.error('rwaRedeemAsset', e, { target, asset, amount, minOut });
+        // User-cancelled RWA redeems are normal; only genuine failures stay at error.
+        (0, core_1.logChainError)('rwaRedeemAsset', e, (0, core_1.isUserRejectionError)(e), {
+            target,
+            asset,
+            amount,
+            minOut,
+        });
         throw new core_1.AugustSDKError('UNKNOWN', `RWA redeem failed: ${e instanceof Error ? e.message : 'Unknown error'}`, { cause: e, context: { target, asset, amount, minOut } });
     }
 }
@@ -1040,6 +1072,22 @@ async function dispatchViaSwapRouter(args) {
         abi: abis_1.ABI_ERC20,
     });
     const underlyingDecimals = Number(await underlyingErc20.decimals());
+    // The on-chain SwapRouter only authorizes a specific (router, selector) pair
+    // per chain (see SWAP_ROUTER_DEX_AGGREGATOR). Pin the aggregator to that
+    // router's single generic method so the calldata selector is deterministic,
+    // then reject any quote that would not match — otherwise the deposit reverts
+    // on-chain with InvalidRouter() / InvalidNotWhitelisted() after the user has
+    // already paid gas.
+    const aggregator = core_1.SWAP_ROUTER_DEX_AGGREGATOR[args.chainId];
+    if (!aggregator) {
+        throw new core_1.AugustValidationError('INVALID_CHAIN', `vaultDeposit (SwapRouter): no DEX aggregator is configured for chainId ${args.chainId}, but a swap is required because the deposit asset (${args.actualDepositAsset}) differs from the vault's reference asset (${args.underlyingAsset}). Deposit the reference asset directly, or add a SWAP_ROUTER_DEX_AGGREGATOR entry once the router is whitelisted on-chain.`, {
+            context: {
+                chainId: args.chainId,
+                depositAsset: args.actualDepositAsset,
+                underlyingAsset: args.underlyingAsset,
+            },
+        });
+    }
     const quote = await (0, swap_quotes_1.fetchSwapQuote)({
         chainId: args.chainId,
         srcToken: args.actualDepositAsset,
@@ -1049,7 +1097,25 @@ async function dispatchViaSwapRouter(args) {
         amount: amountRaw,
         receiver: args.routerAddress,
         slippageBps: args.slippageBps,
+        contractMethod: aggregator.contractMethod,
     });
+    // Fail closed on off-chain/on-chain config drift: if the aggregator's quote
+    // targets a router or selector the deployed SwapRouter has not whitelisted,
+    // the swapAndDeposit call would revert. Surfacing it here turns a wasted gas
+    // burn into an actionable SDK error.
+    const quotedSelector = quote.payload.slice(0, 10).toLowerCase();
+    if (quote.router.toLowerCase() !== aggregator.router.toLowerCase() ||
+        quotedSelector !== aggregator.selector.toLowerCase()) {
+        throw new core_1.AugustValidationError('INVALID_INPUT', `vaultDeposit (SwapRouter): the aggregator quote (router ${quote.router}, selector ${quotedSelector}) does not match the router whitelisted on chain ${args.chainId} (router ${aggregator.router}, selector ${aggregator.selector}); the on-chain SwapRouter would revert. This signals drift between the SDK's SWAP_ROUTER_DEX_AGGREGATOR and the deployed router's enableRouter config.`, {
+            context: {
+                chainId: args.chainId,
+                quotedRouter: quote.router,
+                quotedSelector,
+                expectedRouter: aggregator.router,
+                expectedSelector: aggregator.selector,
+            },
+        });
+    }
     return swapAndDeposit(args.signer, {
         chainId: args.chainId,
         vault: args.target,

package/lib/polyfills.js

@@ -5,8 +5,8 @@ const buffer_1 = require("buffer");
 if (typeof window !== 'undefined' && !window.Buffer) {
     window.Buffer = buffer_1.Buffer;
 }
-// @ts-ignore - Node.js global
-if (typeof global !== 'undefined' && !global.Buffer) {
-    global.Buffer = buffer_1.Buffer;
+const globalRef = globalThis;
+if (typeof globalRef !== 'undefined' && !globalRef.Buffer) {
+    globalRef.Buffer = buffer_1.Buffer;
 }
 //# sourceMappingURL=polyfills.js.map