@augustdigital/sdk 8.3.2 → 8.5.0

package/lib/abis/ERC20_Bytes32.d.ts

@@ -1,3 +1,7 @@
+/**
+ * [bytes32-flavored ERC-20](https://docs.makerdao.com/smart-contract-modules/mkr-module#4.-gotchas-potential-source-of-user-error)
+ * for tokens (ie. Maker) that use bytes32 instead of string.
+ */
 export declare const ABI_ERC20_BYTES32: readonly [{
     readonly type: "event";
     readonly name: "Approval";

package/lib/abis/ERC20_Bytes32.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ABI_ERC20_BYTES32 = void 0;
+/**
+ * [bytes32-flavored ERC-20](https://docs.makerdao.com/smart-contract-modules/mkr-module#4.-gotchas-potential-source-of-user-error)
+ * for tokens (ie. Maker) that use bytes32 instead of string.
+ */
 exports.ABI_ERC20_BYTES32 = [
     {
         type: 'event',

package/lib/abis/ERC4626.d.ts

@@ -1,3 +1,4 @@
+/** [ERC-4626 Tokenized Vaults Standard](https://ethereum.org/en/developers/docs/standards/tokens/erc-4626) */
 export declare const ABI_ERC4626: readonly [{
     readonly anonymous: false;
     readonly inputs: readonly [{

package/lib/abis/ERC4626.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ABI_ERC4626 = void 0;
+/** [ERC-4626 Tokenized Vaults Standard](https://ethereum.org/en/developers/docs/standards/tokens/erc-4626) */
 exports.ABI_ERC4626 = [
     {
         anonymous: false,

package/lib/abis/ERC721.d.ts

@@ -1,3 +1,4 @@
+/** [ERC-721 Non-Fungible Token Standard](https://ethereum.org/en/developers/docs/standards/tokens/erc-721) */
 export declare const ABI_ERC721: readonly [{
     readonly type: "event";
     readonly name: "Approval";

package/lib/abis/ERC721.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ABI_ERC721 = void 0;
+/** [ERC-721 Non-Fungible Token Standard](https://ethereum.org/en/developers/docs/standards/tokens/erc-721) */
 exports.ABI_ERC721 = [
     {
         type: 'event',

package/lib/abis/FeeOracle.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ABI_FEE_ORACLE = void 0;
+// export const ABI_FEE_ORACLE = [{"type":"constructor","inputs":[{"name":"ownerAddr","type":"address","internalType":"address"}],"stateMutability":"nonpayable"},{"type":"function","name":"FEES_DIVISOR","inputs":[],"outputs":[{"name":"","type":"uint256","internalType":"uint256"}],"stateMutability":"view"},{"type":"function","name":"getContextFeeAmount","inputs":[{"name":"amount","type":"uint256","internalType":"uint256"},{"name":"categoryId","type":"bytes32","internalType":"bytes32"},{"name":"specificAddr","type":"address","internalType":"address"}],"outputs":[{"name":"feePercent","type":"uint256","internalType":"uint256"},{"name":"feeAmount","type":"uint256","internalType":"uint256"}],"stateMutability":"view"},{"type":"function","name":"getContextFeeRate","inputs":[{"name":"categoryId","type":"bytes32","internalType":"bytes32"},{"name":"specificAddr","type":"address","internalType":"address"}],"outputs":[{"name":"","type":"uint256","internalType":"uint256"}],"stateMutability":"view"},{"type":"function","name":"owner","inputs":[],"outputs":[{"name":"","type":"address","internalType":"address"}],"stateMutability":"view"},{"type":"function","name":"setContextFeeRate","inputs":[{"name":"feePercent","type":"uint256","internalType":"uint256"},{"name":"categoryId","type":"bytes32","internalType":"bytes32"},{"name":"specificAddr","type":"address","internalType":"address"}],"outputs":[],"stateMutability":"nonpayable"},{"type":"function","name":"transferOwnership","inputs":[{"name":"newOwner","type":"address","internalType":"address"}],"outputs":[],"stateMutability":"nonpayable"},{"type":"event","name":"OwnershipTransferred","inputs":[{"name":"previousOwner","type":"address","indexed":true,"internalType":"address"},{"name":"newOwner","type":"address","indexed":true,"internalType":"address"}],"anonymous":false}] as const;
 exports.ABI_FEE_ORACLE = [
     {
         inputs: [

package/lib/abis/LendingPool.js

@@ -1155,6 +1155,7 @@ exports.ABI_LENDING_POOLS = [
         type: 'function',
     },
     {
+        // TokenizedVaults only
         inputs: [],
         name: 'operator',
         outputs: [

package/lib/abis/LendingPoolV2.js

@@ -1168,6 +1168,7 @@ exports.ABI_LENDING_POOL_V2 = [
         type: 'function',
     },
     {
+        // Tokenized Vaults only
         inputs: [],
         name: 'operator',
         outputs: [

package/lib/abis/Multicall3.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ABI_MULTICALL3 = void 0;
+/* [Multicall3](https://github.com/mds1/multicall) */
 exports.ABI_MULTICALL3 = [
     {
         inputs: [
@@ -44,6 +45,8 @@ exports.ABI_MULTICALL3 = [
         type: 'function',
     },
 ];
+// Universal resolver error definitions (reserved for future use)
+// @ts-expect-error - Reserved for future ENS integration
 const universalResolverErrors = [
     {
         inputs: [],

package/lib/abis/OFT.d.ts

@@ -1,3 +1,10 @@
+/**
+ * ABI fragments for OFT (Omnichain Fungible Token) and related contracts
+ * used in LayerZero cross-chain vault operations.
+ *
+ * @module ABIs/OFT
+ */
+/** ERC20 allowance + approve ABI for cross-chain approval checks */
 export declare const ABI_CROSS_CHAIN_ERC20: readonly [{
     readonly inputs: readonly [{
         readonly internalType: "address";
@@ -35,6 +42,11 @@ export declare const ABI_CROSS_CHAIN_ERC20: readonly [{
     readonly stateMutability: "nonpayable";
     readonly type: "function";
 }];
+/**
+ * Multi-asset vault previewDeposit ABI.
+ * Uses `previewDeposit(address, uint256)` instead of standard ERC4626's
+ * `previewDeposit(uint256)` to specify which asset is being deposited.
+ */
 export declare const ABI_MULTI_ASSET_PREVIEW_DEPOSIT: readonly [{
     readonly type: "function";
     readonly name: "previewDeposit";
@@ -58,6 +70,11 @@ export declare const ABI_MULTI_ASSET_PREVIEW_DEPOSIT: readonly [{
     }];
     readonly stateMutability: "view";
 }];
+/**
+ * Multi-asset vault previewRedemption ABI.
+ * Uses `previewRedemption(uint256, bool)` to preview redeem output
+ * with an `isInstant` flag.
+ */
 export declare const ABI_MULTI_ASSET_PREVIEW_REDEEM: readonly [{
     readonly type: "function";
     readonly name: "previewRedemption";
@@ -81,6 +98,9 @@ export declare const ABI_MULTI_ASSET_PREVIEW_REDEEM: readonly [{
     }];
     readonly stateMutability: "view";
 }];
+/**
+ * Standard ERC4626 previewRedeem ABI.
+ */
 export declare const ABI_STANDARD_PREVIEW_REDEEM: readonly [{
     readonly type: "function";
     readonly name: "previewRedeem";

package/lib/abis/OFT.js

@@ -1,6 +1,13 @@
 "use strict";
+/**
+ * ABI fragments for OFT (Omnichain Fungible Token) and related contracts
+ * used in LayerZero cross-chain vault operations.
+ *
+ * @module ABIs/OFT
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ABI_STANDARD_PREVIEW_REDEEM = exports.ABI_MULTI_ASSET_PREVIEW_REDEEM = exports.ABI_MULTI_ASSET_PREVIEW_DEPOSIT = exports.ABI_CROSS_CHAIN_ERC20 = void 0;
+/** ERC20 allowance + approve ABI for cross-chain approval checks */
 exports.ABI_CROSS_CHAIN_ERC20 = [
     {
         inputs: [
@@ -23,6 +30,11 @@ exports.ABI_CROSS_CHAIN_ERC20 = [
         type: 'function',
     },
 ];
+/**
+ * Multi-asset vault previewDeposit ABI.
+ * Uses `previewDeposit(address, uint256)` instead of standard ERC4626's
+ * `previewDeposit(uint256)` to specify which asset is being deposited.
+ */
 exports.ABI_MULTI_ASSET_PREVIEW_DEPOSIT = [
     {
         type: 'function',
@@ -38,6 +50,11 @@ exports.ABI_MULTI_ASSET_PREVIEW_DEPOSIT = [
         stateMutability: 'view',
     },
 ];
+/**
+ * Multi-asset vault previewRedemption ABI.
+ * Uses `previewRedemption(uint256, bool)` to preview redeem output
+ * with an `isInstant` flag.
+ */
 exports.ABI_MULTI_ASSET_PREVIEW_REDEEM = [
     {
         type: 'function',
@@ -53,6 +70,9 @@ exports.ABI_MULTI_ASSET_PREVIEW_REDEEM = [
         stateMutability: 'view',
     },
 ];
+/**
+ * Standard ERC4626 previewRedeem ABI.
+ */
 exports.ABI_STANDARD_PREVIEW_REDEEM = [
     {
         type: 'function',

package/lib/abis/SmartAccount.d.ts

@@ -1,3 +1,4 @@
+/** @internal */
 export declare const ABI_SMART_ACCOUNT: readonly [{
     readonly name: "isValidSignature";
     readonly type: "function";

package/lib/abis/SmartAccount.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ABI_SMART_ACCOUNT = void 0;
+// ERC-1271
+// isValidSignature(bytes32 hash, bytes signature) → bytes4 magicValue
+/** @internal */
 exports.ABI_SMART_ACCOUNT = [
     {
         name: 'isValidSignature',

package/lib/abis/SwapRouter.d.ts

@@ -1,3 +1,4 @@
+/** ABI for the August `SwapRouter` periphery contract. */
 export declare const ABI_SWAP_ROUTER: readonly [{
     readonly inputs: readonly [];
     readonly stateMutability: "nonpayable";

package/lib/abis/SwapRouter.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ABI_SWAP_ROUTER = void 0;
+/** ABI for the August `SwapRouter` periphery contract. */
 exports.ABI_SWAP_ROUTER = [
     { inputs: [], stateMutability: 'nonpayable', type: 'constructor' },
     { inputs: [], name: 'AlreadyConfigured', type: 'error' },

package/lib/abis/UniversalSignatureValidator.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ABI_UNIVERSAL_SIGNATURE_VALIDATOR = void 0;
+// ERC-6492 - universal deployless signature validator contract
+// constructor(address _signer, bytes32 _hash, bytes _signature) → bytes4 returnValue
+// returnValue is either 0x1 (valid) or 0x0 (invalid)
 exports.ABI_UNIVERSAL_SIGNATURE_VALIDATOR = [
     {
         inputs: [

package/lib/abis/index.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Contract ABI definitions for interacting with August/Upshift smart contracts.
+ *
+ * @module ABIs
+ */
 export * from './LendingPool';
 export * from './ERC20';
 export * from './Loan';

package/lib/abis/index.js

@@ -1,4 +1,9 @@
 "use strict";
+/**
+ * Contract ABI definitions for interacting with August/Upshift smart contracts.
+ *
+ * @module ABIs
+ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/lib/adapters/evm/getters.d.ts

@@ -1,4 +1,19 @@
-import { ITokenizedVault } from '../../types';
-import { IVaultBaseOptions } from '../../modules/vaults/types';
+import type { ITokenizedVault } from '../../types';
+import type { IVaultBaseOptions } from '../../modules/vaults/types';
+/**
+ * Fetch EVM vault data for v1 vault contracts (legacy format).
+ * Queries on-chain state and combines with backend metadata.
+ * @param tokenizedVault Vault metadata from backend
+ * @param options RPC configuration and chain details
+ * @returns Formatted vault object or null if closed/invisible
+ */
 export declare const getEvmVaultV1: (tokenizedVault: ITokenizedVault, options: IVaultBaseOptions) => Promise<import("../../types").IVault>;
+/**
+ * Fetch EVM vault data for v2 vault contracts (current format).
+ * V2 vaults use separate contracts for vault, receipt token, and whitelist.
+ * Queries all three contracts and combines results.
+ * @param tokenizedVault Vault metadata from backend
+ * @param options RPC configuration and chain details
+ * @returns Formatted vault object or null if closed/invisible
+ */
 export declare const getEvmVaultV2: (tokenizedVault: ITokenizedVault, options: IVaultBaseOptions) => Promise<import("../../types").IVault>;

package/lib/adapters/evm/getters.js

@@ -6,17 +6,29 @@ const core_1 = require("../../core");
 const utils_1 = require("../../modules/vaults/utils");
 const TokenizedVaultV2_1 = require("../../abis/TokenizedVaultV2");
 const TokenizedVaultV2Receipt_1 = require("../../abis/TokenizedVaultV2Receipt");
+/**
+ * Fetch EVM vault data for v1 vault contracts (legacy format).
+ * Queries on-chain state and combines with backend metadata.
+ * @param tokenizedVault Vault metadata from backend
+ * @param options RPC configuration and chain details
+ * @returns Formatted vault object or null if closed/invisible
+ */
 const getEvmVaultV1 = async (tokenizedVault, options) => {
     const vault = tokenizedVault.address;
     if (!vault) {
         throw new Error('Vault address is undefined');
     }
+    // Skip closed staging vaults that shouldn't be displayed — unless the caller
+    // explicitly opts in (portfolio mode), where a user's position in a closed,
+    // invisible vault must still resolve its metadata.
     if (tokenizedVault.status === 'closed' &&
-        tokenizedVault.is_visible === false) {
+        tokenizedVault.is_visible === false &&
+        !options?.includeClosed) {
         core_1.Logger.log.warn('getEvmVaultV1', `closed: ${tokenizedVault.vault_name}`);
         return null;
     }
     const provider = (0, core_1.createProvider)(options.rpcUrl);
+    // Batch fetch all vault contract data
     const vaultContract = (0, core_1.createContract)({
         address: vault,
         abi: abis_1.ABI_LENDING_POOL_V2,
@@ -45,6 +57,7 @@ const getEvmVaultV1 = async (tokenizedVault, options) => {
         }
         return vaultContract[f]();
     }));
+    // Normalize contract call results into typed object
     const formattedContractCalls = vaultContractCalls.reduce((acc, curr, i) => {
         let val;
         if (core_1.VAULT_FUNCTIONS_V1[i] === 'maxDepositAmount') {
@@ -69,6 +82,7 @@ const getEvmVaultV1 = async (tokenizedVault, options) => {
             val = Number(curr.toString());
         }
         else if (core_1.VAULT_FUNCTIONS_V1[i] === 'loansOperator') {
+            // TODO: hardcoded as we cannot pull the real strategist
             val = '0x4DCb388488622e47683EAd1a147947140a31e485';
         }
         else {
@@ -76,21 +90,35 @@ const getEvmVaultV1 = async (tokenizedVault, options) => {
         }
         return { ...acc, [core_1.VAULT_FUNCTIONS_V1[i]]: val };
     }, {});
+    // Combine on-chain and backend data into unified vault object
     const returnObj = await (0, utils_1.buildFormattedVault)(provider, tokenizedVault, formattedContractCalls);
     return returnObj;
 };
 exports.getEvmVaultV1 = getEvmVaultV1;
+/**
+ * Fetch EVM vault data for v2 vault contracts (current format).
+ * V2 vaults use separate contracts for vault, receipt token, and whitelist.
+ * Queries all three contracts and combines results.
+ * @param tokenizedVault Vault metadata from backend
+ * @param options RPC configuration and chain details
+ * @returns Formatted vault object or null if closed/invisible
+ */
 const getEvmVaultV2 = async (tokenizedVault, options) => {
     const provider = (0, core_1.createProvider)(options.rpcUrl);
     const vault = tokenizedVault.address;
     if (!vault) {
         throw new Error('Vault address is undefined');
     }
+    // Skip closed staging vaults that shouldn't be displayed — unless the caller
+    // explicitly opts in (portfolio mode), where a user's position in a closed,
+    // invisible vault must still resolve its metadata.
     if (tokenizedVault.status === 'closed' &&
-        tokenizedVault.is_visible === false) {
+        tokenizedVault.is_visible === false &&
+        !options?.includeClosed) {
         core_1.Logger.log.warn('getEvmVaultV2', `closed: ${tokenizedVault.vault_name}`);
         return null;
     }
+    // Fetch vault contract state
     const vaultContract = (0, core_1.createContract)({
         address: vault,
         abi: TokenizedVaultV2_1.ABI_TOKENIZED_VAULT_V2,
@@ -110,7 +138,7 @@ const getEvmVaultV2 = async (tokenizedVault, options) => {
     const receiptAddress = vaultContractCalls[core_1.VAULT_FUNCTIONS_V2.length - 1];
     const whitelistedAssetsAddress = vaultContractCalls[0];
     const reciptContract = (0, core_1.createContract)({
-        address: receiptAddress,
+        address: receiptAddress, // lpTokenAddress
         abi: TokenizedVaultV2Receipt_1.ABI_TOKENIZED_VAULT_V2_RECEIPT,
         provider,
     });
@@ -127,6 +155,7 @@ const getEvmVaultV2 = async (tokenizedVault, options) => {
         (0, core_1.getWhitelistedAssets)(provider, whitelistedAssetsAddress),
     ]);
     const whitelistedAssetsContractCalls = [whitelistedList];
+    // Merge all contract call results
     const combinedCalls = [
         ...vaultContractCalls,
         ...receiptContractCalls,
@@ -137,6 +166,7 @@ const getEvmVaultV2 = async (tokenizedVault, options) => {
         ...core_1.VAULT_FUNCTIONS_V2_RECEIPT,
         ...core_1.VAULT_FUNCTIONS_V2_WHITELISTED_ASSETS,
     ];
+    // Normalize all contract results with proper decimal handling
     const formattedContractCalls = combinedCalls.reduce((acc, curr, i) => {
         let val;
         if (combinedFunctions[i] === 'depositCap') {
@@ -163,6 +193,7 @@ const getEvmVaultV2 = async (tokenizedVault, options) => {
             val = Number(curr.toString());
         }
         else if (combinedFunctions[i] === 'loansOperator') {
+            // @hardcoded: we cannot pull the real strategist
             val = '0x4DCb388488622e47683EAd1a147947140a31e485';
         }
         else {
@@ -170,6 +201,7 @@ const getEvmVaultV2 = async (tokenizedVault, options) => {
         }
         return { ...acc, [combinedFunctions[i]]: val };
     }, {});
+    // Combine on-chain and backend data into unified vault object
     const returnObj = await (0, utils_1.buildFormattedVault)(provider, tokenizedVault, formattedContractCalls);
     return returnObj;
 };