@augustdigital/sdk 4.26.0-alpha.1 → 4.27.0

package/README.md

@@ -35,7 +35,7 @@ const sdk = new AugustSDK({
     -1: 'https://api.mainnet-beta.solana.com', // Solana
   },
   keys: {
-    august: 'YOUR_API_KEY', // Optional
+    august: 'YOUR_API_KEY', // Optional: required for allocations, health factors, and subaccount operations
   },
   monitoring: {
     env: 'DEV', // Optional: 'DEV' enables console logging (defaults to 'PROD')

package/lib/abis/{SendersAllocationWhitelist.d.ts → OFT.d.ts}

@@ -1,40 +1,49 @@
-export declare const ABI_SENDERS_ALLOCATION_WHITELIST: readonly [{
-    readonly type: "function";
-    readonly name: "getAllocationBps";
+export declare const ABI_CROSS_CHAIN_ERC20: readonly [{
     readonly inputs: readonly [{
-        readonly name: "addr";
+        readonly internalType: "address";
+        readonly name: "owner";
         readonly type: "address";
+    }, {
         readonly internalType: "address";
+        readonly name: "spender";
+        readonly type: "address";
     }];
+    readonly name: "allowance";
     readonly outputs: readonly [{
+        readonly internalType: "uint256";
         readonly name: "";
         readonly type: "uint256";
-        readonly internalType: "uint256";
     }];
     readonly stateMutability: "view";
-}, {
     readonly type: "function";
-    readonly name: "getDeposited";
+}, {
     readonly inputs: readonly [{
-        readonly name: "addr";
-        readonly type: "address";
         readonly internalType: "address";
+        readonly name: "spender";
+        readonly type: "address";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "amount";
+        readonly type: "uint256";
     }];
+    readonly name: "approve";
     readonly outputs: readonly [{
+        readonly internalType: "bool";
         readonly name: "";
-        readonly type: "uint256";
-        readonly internalType: "uint256";
+        readonly type: "bool";
     }];
-    readonly stateMutability: "view";
-}, {
+    readonly stateMutability: "nonpayable";
     readonly type: "function";
-    readonly name: "getRemainingAllocation";
+}];
+export declare const ABI_MULTI_ASSET_PREVIEW_DEPOSIT: readonly [{
+    readonly type: "function";
+    readonly name: "previewDeposit";
     readonly inputs: readonly [{
-        readonly name: "addr";
+        readonly name: "assetIn";
         readonly type: "address";
         readonly internalType: "address";
     }, {
-        readonly name: "depositCapAmount";
+        readonly name: "amountIn";
         readonly type: "uint256";
         readonly internalType: "uint256";
     }];
@@ -42,72 +51,46 @@ export declare const ABI_SENDERS_ALLOCATION_WHITELIST: readonly [{
         readonly name: "";
         readonly type: "uint256";
         readonly internalType: "uint256";
+    }, {
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
     readonly stateMutability: "view";
-}, {
+}];
+export declare const ABI_MULTI_ASSET_PREVIEW_REDEEM: readonly [{
     readonly type: "function";
-    readonly name: "isWhitelisted";
+    readonly name: "previewRedemption";
     readonly inputs: readonly [{
-        readonly name: "addr";
-        readonly type: "address";
-        readonly internalType: "address";
-    }];
-    readonly outputs: readonly [{
-        readonly name: "";
+        readonly name: "shares";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "isInstant";
         readonly type: "bool";
         readonly internalType: "bool";
     }];
-    readonly stateMutability: "view";
-}, {
-    readonly type: "function";
-    readonly name: "allocationBps";
-    readonly inputs: readonly [{
-        readonly name: "";
-        readonly type: "address";
-        readonly internalType: "address";
-    }];
     readonly outputs: readonly [{
-        readonly name: "";
+        readonly name: "assetsAmount";
         readonly type: "uint256";
         readonly internalType: "uint256";
-    }];
-    readonly stateMutability: "view";
-}, {
-    readonly type: "function";
-    readonly name: "deposited";
-    readonly inputs: readonly [{
-        readonly name: "";
-        readonly type: "address";
-        readonly internalType: "address";
-    }];
-    readonly outputs: readonly [{
-        readonly name: "";
+    }, {
+        readonly name: "assetsAfterFee";
         readonly type: "uint256";
         readonly internalType: "uint256";
     }];
     readonly stateMutability: "view";
-}, {
+}];
+export declare const ABI_STANDARD_PREVIEW_REDEEM: readonly [{
     readonly type: "function";
-    readonly name: "authorizedRecorders";
+    readonly name: "previewRedeem";
     readonly inputs: readonly [{
-        readonly name: "";
-        readonly type: "address";
-        readonly internalType: "address";
-    }];
-    readonly outputs: readonly [{
-        readonly name: "";
-        readonly type: "bool";
-        readonly internalType: "bool";
+        readonly name: "shares";
+        readonly type: "uint256";
     }];
-    readonly stateMutability: "view";
-}, {
-    readonly type: "function";
-    readonly name: "owner";
-    readonly inputs: readonly [];
     readonly outputs: readonly [{
         readonly name: "";
-        readonly type: "address";
-        readonly internalType: "address";
+        readonly type: "uint256";
     }];
     readonly stateMutability: "view";
 }];

package/lib/abis/OFT.js

@@ -0,0 +1,65 @@
+"use strict";
+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;
+exports.ABI_CROSS_CHAIN_ERC20 = [
+    {
+        inputs: [
+            { internalType: 'address', name: 'owner', type: 'address' },
+            { internalType: 'address', name: 'spender', type: 'address' },
+        ],
+        name: 'allowance',
+        outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+        stateMutability: 'view',
+        type: 'function',
+    },
+    {
+        inputs: [
+            { internalType: 'address', name: 'spender', type: 'address' },
+            { internalType: 'uint256', name: 'amount', type: 'uint256' },
+        ],
+        name: 'approve',
+        outputs: [{ internalType: 'bool', name: '', type: 'bool' }],
+        stateMutability: 'nonpayable',
+        type: 'function',
+    },
+];
+exports.ABI_MULTI_ASSET_PREVIEW_DEPOSIT = [
+    {
+        type: 'function',
+        name: 'previewDeposit',
+        inputs: [
+            { name: 'assetIn', type: 'address', internalType: 'address' },
+            { name: 'amountIn', type: 'uint256', internalType: 'uint256' },
+        ],
+        outputs: [
+            { name: '', type: 'uint256', internalType: 'uint256' },
+            { name: '', type: 'uint256', internalType: 'uint256' },
+        ],
+        stateMutability: 'view',
+    },
+];
+exports.ABI_MULTI_ASSET_PREVIEW_REDEEM = [
+    {
+        type: 'function',
+        name: 'previewRedemption',
+        inputs: [
+            { name: 'shares', type: 'uint256', internalType: 'uint256' },
+            { name: 'isInstant', type: 'bool', internalType: 'bool' },
+        ],
+        outputs: [
+            { name: 'assetsAmount', type: 'uint256', internalType: 'uint256' },
+            { name: 'assetsAfterFee', type: 'uint256', internalType: 'uint256' },
+        ],
+        stateMutability: 'view',
+    },
+];
+exports.ABI_STANDARD_PREVIEW_REDEEM = [
+    {
+        type: 'function',
+        name: 'previewRedeem',
+        inputs: [{ name: 'shares', type: 'uint256' }],
+        outputs: [{ name: '', type: 'uint256' }],
+        stateMutability: 'view',
+    },
+];
+//# sourceMappingURL=OFT.js.map

package/lib/abis/OFT.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OFT.js","sourceRoot":"","sources":["../../src.ts/abis/OFT.ts"],"names":[],"mappings":";;;AAQa,QAAA,qBAAqB,GAAG;IACnC;QACE,MAAM,EAAE;YACN,EAAE,YAAY,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;YAC3D,EAAE,YAAY,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;SAC9D;QACD,IAAI,EAAE,WAAW;QACjB,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QACjE,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,MAAM,EAAE;YACN,EAAE,YAAY,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;YAC7D,EAAE,YAAY,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE;SAC7D;QACD,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QAC3D,eAAe,EAAE,YAAY;QAC7B,IAAI,EAAE,UAAU;KACjB;CACO,CAAC;AAOE,QAAA,+BAA+B,GAAG;IAC7C;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,gBAAgB;QACtB,MAAM,EAAE;YACN,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE;YAC7D,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE;SAC/D;QACD,OAAO,EAAE;YACP,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE;YACtD,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE;SACvD;QACD,eAAe,EAAE,MAAM;KACxB;CACO,CAAC;AAOE,QAAA,8BAA8B,GAAG;IAC5C;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,mBAAmB;QACzB,MAAM,EAAE;YACN,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE;YAC5D,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE;SAC1D;QACD,OAAO,EAAE;YACP,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE;YAClE,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE;SACrE;QACD,eAAe,EAAE,MAAM;KACxB;CACO,CAAC;AAKE,QAAA,2BAA2B,GAAG;IACzC;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,eAAe;QACrB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QAC7C,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QACxC,eAAe,EAAE,MAAM;KACxB;CACO,CAAC"}

package/lib/abis/index.d.ts

@@ -25,3 +25,4 @@ export * from './TokenizedVaultV2WhitelistedAllocation';
 export * from './MultiAssetNativeDepositWrapper';
 export * from './TokenizedVaultV2SenderAllocationWhitelist';
 export * from './RwaRedeemSubaccount';
+export * from './OFT';

package/lib/abis/index.js

@@ -41,4 +41,5 @@ __exportStar(require("./TokenizedVaultV2WhitelistedAllocation"), exports);
 __exportStar(require("./MultiAssetNativeDepositWrapper"), exports);
 __exportStar(require("./TokenizedVaultV2SenderAllocationWhitelist"), exports);
 __exportStar(require("./RwaRedeemSubaccount"), exports);
+__exportStar(require("./OFT"), exports);
 //# sourceMappingURL=index.js.map

package/lib/abis/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src.ts/abis/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAMA,gDAA8B;AAC9B,0CAAwB;AACxB,yCAAuB;AACvB,8CAA4B;AAC5B,oDAAkC;AAClC,kDAAgC;AAChC,4CAA0B;AAC1B,2CAAyB;AACzB,kDAAgC;AAChC,+CAA6B;AAC7B,iDAA+B;AAC/B,iDAA+B;AAC/B,6DAA2C;AAC3C,gEAA8C;AAC9C,gDAA8B;AAC9B,sDAAoC;AACpC,mDAAiC;AACjC,gDAA8B;AAC9B,kDAAgC;AAChC,sEAAoD;AACpD,qDAAmC;AACnC,4DAA0C;AAC1C,sEAAoD;AACpD,0EAAwD;AACxD,mEAAiD;AACjD,8EAA4D;AAC5D,wDAAsC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src.ts/abis/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAMA,gDAA8B;AAC9B,0CAAwB;AACxB,yCAAuB;AACvB,8CAA4B;AAC5B,oDAAkC;AAClC,kDAAgC;AAChC,4CAA0B;AAC1B,2CAAyB;AACzB,kDAAgC;AAChC,+CAA6B;AAC7B,iDAA+B;AAC/B,iDAA+B;AAC/B,6DAA2C;AAC3C,gEAA8C;AAC9C,gDAA8B;AAC9B,sDAAoC;AACpC,mDAAiC;AACjC,gDAA8B;AAC9B,kDAAgC;AAChC,sEAAoD;AACpD,qDAAmC;AACnC,4DAA0C;AAC1C,sEAAoD;AACpD,0EAAwD;AACxD,mEAAiD;AACjD,8EAA4D;AAC5D,wDAAsC;AACtC,wCAAsB"}

package/lib/evm/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types';
+export * from './methods';

package/lib/evm/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);
+__exportStar(require("./methods"), exports);
+//# sourceMappingURL=index.js.map

package/lib/evm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src.ts/evm/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,4CAA0B"}

package/lib/evm/methods/crossChainVault.d.ts

@@ -0,0 +1,38 @@
+import type { IAddress } from '../../types';
+import type { ICrossChainVaultConfig, ICrossChainBuildRequest, ICrossChainBuildResult, ICrossChainDepositRequest, ICrossChainDepositResult, ICrossChainRedeemRequest, ICrossChainRedeemResult, IQuoteCrossChainDepositRequest, IQuoteCrossChainRedeemRequest, IQuoteCrossChainResult, CrossChainErrorType } from '../types/crossChain';
+export declare function buildCrossChainVaultTx(props: ICrossChainBuildRequest): Promise<ICrossChainBuildResult>;
+export declare function quoteCrossChainDeposit(props: IQuoteCrossChainDepositRequest): Promise<IQuoteCrossChainResult | null>;
+export declare function quoteCrossChainRedeem(props: IQuoteCrossChainRedeemRequest): Promise<IQuoteCrossChainResult | null>;
+export declare function needsCrossChainApproval(tokenAddress: IAddress, spenderAddress: IAddress, walletAddress: IAddress, amount: bigint, publicClient: {
+    readContract: (args: unknown) => Promise<unknown>;
+}): Promise<boolean>;
+export declare function approveCrossChain(tokenAddress: IAddress, spenderAddress: IAddress, amount: bigint, walletClient: {
+    account: {
+        address: string;
+    } | undefined;
+    writeContract: (args: unknown) => Promise<string>;
+}, publicClient: {
+    waitForTransactionReceipt: (args: {
+        hash: string;
+    }) => Promise<{
+        status: string;
+    }>;
+}): Promise<string>;
+export declare function crossChainVaultDeposit(props: ICrossChainDepositRequest): Promise<ICrossChainDepositResult>;
+export declare function crossChainVaultRedeem(props: ICrossChainRedeemRequest): Promise<ICrossChainRedeemResult>;
+export declare function isNoPeerError(errStr: string): boolean;
+export declare function classifyCrossChainError(error: unknown): CrossChainErrorType;
+export declare function canDepositFromChain(config: ICrossChainVaultConfig, userChainId: number): boolean;
+export declare function canRedeemFromChain(config: ICrossChainVaultConfig, userChainId: number): boolean;
+export declare function isCrossChainOperation(config: ICrossChainVaultConfig, userChainId: number, destinationChainId?: number): boolean;
+export declare function getAvailableChains(config: ICrossChainVaultConfig): number[];
+export declare function formatCrossChainError(errMsg: string): string;
+export declare function getLayerZeroScanUrl(txHash: string, testnet?: boolean): string;
+export declare const LAYERZERO_ENDPOINT_IDS: {
+    readonly ETHEREUM: 30101;
+    readonly ARBITRUM: 30110;
+    readonly AVALANCHE: 30106;
+    readonly BASE: 30184;
+    readonly SONIC: 30332;
+    readonly MONAD: 30390;
+};