@gauntlet-xyz/sdk 2.5.0 → 3.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +121 -7
- package/dist/api/activity.d.ts +4 -2
- package/dist/api/activity.d.ts.map +1 -1
- package/dist/api/activityRows.d.ts +11 -0
- package/dist/api/activityRows.d.ts.map +1 -0
- package/dist/api/caip.d.ts +1 -1
- package/dist/api/caip.d.ts.map +1 -1
- package/dist/api/client.d.ts +43 -5
- package/dist/api/client.d.ts.map +1 -1
- package/dist/api/decimal.d.ts.map +1 -1
- package/dist/api/errors.d.ts +1 -1
- package/dist/api/errors.d.ts.map +1 -1
- package/dist/api/generated.d.ts +570 -7
- package/dist/api/generated.d.ts.map +1 -1
- package/dist/api/http.d.ts.map +1 -1
- package/dist/api/index.d.ts +13 -13
- package/dist/api/index.d.ts.map +1 -1
- package/dist/api/index.js +47 -8
- package/dist/api/index.js.map +7 -1
- package/dist/api/positionHistory.d.ts +1 -1
- package/dist/api/positionHistory.d.ts.map +1 -1
- package/dist/attribution/index.d.ts +8 -5
- package/dist/attribution/index.d.ts.map +1 -1
- package/dist/chunk-JJOLVL5V.js +546 -0
- package/dist/chunk-JJOLVL5V.js.map +7 -0
- package/dist/chunk-JRSNLXFY.js +2009 -0
- package/dist/chunk-JRSNLXFY.js.map +7 -0
- package/dist/chunk-MEKISE2T.js +367 -0
- package/dist/chunk-MEKISE2T.js.map +7 -0
- package/dist/chunk-YQXTLIJA.js +4477 -0
- package/dist/chunk-YQXTLIJA.js.map +7 -0
- package/dist/cjs/api/activity.d.ts +72 -0
- package/dist/cjs/api/activity.d.ts.map +1 -0
- package/dist/cjs/api/activity.js +138 -0
- package/dist/cjs/api/activity.js.map +7 -0
- package/dist/cjs/api/activityRows.d.ts +11 -0
- package/dist/cjs/api/activityRows.d.ts.map +1 -0
- package/dist/cjs/api/activityRows.js +139 -0
- package/dist/cjs/api/activityRows.js.map +7 -0
- package/dist/cjs/api/caip.d.ts +29 -0
- package/dist/cjs/api/caip.d.ts.map +1 -0
- package/dist/cjs/api/caip.js +61 -0
- package/dist/cjs/api/caip.js.map +7 -0
- package/dist/cjs/api/client.d.ts +173 -0
- package/dist/cjs/api/client.d.ts.map +1 -0
- package/dist/cjs/api/client.js +199 -0
- package/dist/cjs/api/client.js.map +7 -0
- package/dist/cjs/api/decimal.d.ts +21 -0
- package/dist/cjs/api/decimal.d.ts.map +1 -0
- package/dist/cjs/api/decimal.js +61 -0
- package/dist/cjs/api/decimal.js.map +7 -0
- package/dist/cjs/api/errors.d.ts +32 -0
- package/dist/cjs/api/errors.d.ts.map +1 -0
- package/dist/cjs/api/errors.js +80 -0
- package/dist/cjs/api/errors.js.map +7 -0
- package/dist/cjs/api/generated.d.ts +2068 -0
- package/dist/cjs/api/generated.d.ts.map +1 -0
- package/dist/cjs/api/generated.js +17 -0
- package/dist/cjs/api/generated.js.map +7 -0
- package/dist/cjs/api/http.d.ts +16 -0
- package/dist/cjs/api/http.d.ts.map +1 -0
- package/dist/cjs/api/http.js +65 -0
- package/dist/cjs/api/http.js.map +7 -0
- package/dist/cjs/api/index.d.ts +14 -0
- package/dist/cjs/api/index.d.ts.map +1 -0
- package/dist/cjs/api/index.js +73 -0
- package/dist/cjs/api/index.js.map +7 -0
- package/dist/cjs/api/positionHistory.d.ts +44 -0
- package/dist/cjs/api/positionHistory.d.ts.map +1 -0
- package/dist/cjs/api/positionHistory.js +144 -0
- package/dist/cjs/api/positionHistory.js.map +7 -0
- package/dist/cjs/attribution/erc8021.d.ts +9 -0
- package/dist/cjs/attribution/erc8021.d.ts.map +1 -0
- package/dist/cjs/attribution/erc8021.js +37 -0
- package/dist/cjs/attribution/erc8021.js.map +7 -0
- package/dist/cjs/attribution/index.d.ts +28 -0
- package/dist/cjs/attribution/index.d.ts.map +1 -0
- package/dist/cjs/attribution/index.js +70 -0
- package/dist/cjs/attribution/index.js.map +7 -0
- package/dist/cjs/client.d.ts +72 -0
- package/dist/cjs/client.d.ts.map +1 -0
- package/dist/cjs/client.js +80 -0
- package/dist/cjs/client.js.map +7 -0
- package/dist/cjs/constants.d.ts +16 -0
- package/dist/cjs/constants.d.ts.map +1 -0
- package/dist/cjs/constants.js +83 -0
- package/dist/cjs/constants.js.map +7 -0
- package/dist/cjs/errors.d.ts +85 -0
- package/dist/cjs/errors.d.ts.map +1 -0
- package/dist/cjs/errors.js +210 -0
- package/dist/cjs/errors.js.map +7 -0
- package/dist/cjs/evm/abis/erc20.d.ts +41 -0
- package/dist/cjs/evm/abis/erc20.d.ts.map +1 -0
- package/dist/cjs/evm/abis/erc20.js +57 -0
- package/dist/cjs/evm/abis/erc20.js.map +7 -0
- package/dist/cjs/evm/abis/erc4626.d.ts +105 -0
- package/dist/cjs/evm/abis/erc4626.d.ts.map +1 -0
- package/dist/cjs/evm/abis/erc4626.js +97 -0
- package/dist/cjs/evm/abis/erc4626.js.map +7 -0
- package/dist/cjs/evm/abis/multiDepositorVault.d.ts +1048 -0
- package/dist/cjs/evm/abis/multiDepositorVault.d.ts.map +1 -0
- package/dist/cjs/evm/abis/multiDepositorVault.js +614 -0
- package/dist/cjs/evm/abis/multiDepositorVault.js.map +7 -0
- package/dist/cjs/evm/abis/priceAndFeeCalculator.d.ts +910 -0
- package/dist/cjs/evm/abis/priceAndFeeCalculator.d.ts.map +1 -0
- package/dist/cjs/evm/abis/priceAndFeeCalculator.js +517 -0
- package/dist/cjs/evm/abis/priceAndFeeCalculator.js.map +7 -0
- package/dist/cjs/evm/abis/priceAndFeeCalculatorV2.d.ts +277 -0
- package/dist/cjs/evm/abis/priceAndFeeCalculatorV2.d.ts.map +1 -0
- package/dist/cjs/evm/abis/priceAndFeeCalculatorV2.js +166 -0
- package/dist/cjs/evm/abis/priceAndFeeCalculatorV2.js.map +7 -0
- package/dist/cjs/evm/abis/provisioner.d.ts +4984 -0
- package/dist/cjs/evm/abis/provisioner.d.ts.map +1 -0
- package/dist/cjs/evm/abis/provisioner.js +2785 -0
- package/dist/cjs/evm/abis/provisioner.js.map +7 -0
- package/dist/cjs/evm/abis/provisionerV2.d.ts +740 -0
- package/dist/cjs/evm/abis/provisionerV2.d.ts.map +1 -0
- package/dist/cjs/evm/abis/provisionerV2.js +320 -0
- package/dist/cjs/evm/abis/provisionerV2.js.map +7 -0
- package/dist/cjs/evm/adapters/aera.d.ts +6 -0
- package/dist/cjs/evm/adapters/aera.d.ts.map +1 -0
- package/dist/cjs/evm/adapters/aera.js +500 -0
- package/dist/cjs/evm/adapters/aera.js.map +7 -0
- package/dist/cjs/evm/adapters/index.d.ts +3 -0
- package/dist/cjs/evm/adapters/index.d.ts.map +1 -0
- package/dist/cjs/evm/adapters/index.js +41 -0
- package/dist/cjs/evm/adapters/index.js.map +7 -0
- package/dist/cjs/evm/adapters/morpho.d.ts +3 -0
- package/dist/cjs/evm/adapters/morpho.d.ts.map +1 -0
- package/dist/cjs/evm/adapters/morpho.js +103 -0
- package/dist/cjs/evm/adapters/morpho.js.map +7 -0
- package/dist/cjs/evm/adapters/types.d.ts +85 -0
- package/dist/cjs/evm/adapters/types.d.ts.map +1 -0
- package/dist/cjs/evm/adapters/types.js +17 -0
- package/dist/cjs/evm/adapters/types.js.map +7 -0
- package/dist/cjs/evm/aeraContracts/priceAndFeeCalculator.d.ts +46 -0
- package/dist/cjs/evm/aeraContracts/priceAndFeeCalculator.d.ts.map +1 -0
- package/dist/cjs/evm/aeraContracts/priceAndFeeCalculator.js +223 -0
- package/dist/cjs/evm/aeraContracts/priceAndFeeCalculator.js.map +7 -0
- package/dist/cjs/evm/aeraContracts/readOptions.d.ts +8 -0
- package/dist/cjs/evm/aeraContracts/readOptions.d.ts.map +1 -0
- package/dist/cjs/evm/aeraContracts/readOptions.js +31 -0
- package/dist/cjs/evm/aeraContracts/readOptions.js.map +7 -0
- package/dist/cjs/evm/aeraContracts/v1.d.ts +2317 -0
- package/dist/cjs/evm/aeraContracts/v1.d.ts.map +1 -0
- package/dist/cjs/evm/aeraContracts/v1.js +120 -0
- package/dist/cjs/evm/aeraContracts/v1.js.map +7 -0
- package/dist/cjs/evm/aeraContracts/v2.d.ts +4538 -0
- package/dist/cjs/evm/aeraContracts/v2.d.ts.map +1 -0
- package/dist/cjs/evm/aeraContracts/v2.js +449 -0
- package/dist/cjs/evm/aeraContracts/v2.js.map +7 -0
- package/dist/cjs/evm/aeraContracts.d.ts +33 -0
- package/dist/cjs/evm/aeraContracts.d.ts.map +1 -0
- package/dist/cjs/evm/aeraContracts.js +234 -0
- package/dist/cjs/evm/aeraContracts.js.map +7 -0
- package/dist/cjs/evm/deposit.d.ts +51 -0
- package/dist/cjs/evm/deposit.d.ts.map +1 -0
- package/dist/cjs/evm/deposit.js +142 -0
- package/dist/cjs/evm/deposit.js.map +7 -0
- package/dist/cjs/evm/depositQuote.d.ts +32 -0
- package/dist/cjs/evm/depositQuote.d.ts.map +1 -0
- package/dist/cjs/evm/depositQuote.js +97 -0
- package/dist/cjs/evm/depositQuote.js.map +7 -0
- package/dist/cjs/evm/depositReceiverApproval.d.ts +17 -0
- package/dist/cjs/evm/depositReceiverApproval.d.ts.map +1 -0
- package/dist/cjs/evm/depositReceiverApproval.js +71 -0
- package/dist/cjs/evm/depositReceiverApproval.js.map +7 -0
- package/dist/cjs/evm/index.d.ts +28 -0
- package/dist/cjs/evm/index.d.ts.map +1 -0
- package/dist/cjs/evm/index.js +116 -0
- package/dist/cjs/evm/index.js.map +7 -0
- package/dist/cjs/evm/operationMode.d.ts +9 -0
- package/dist/cjs/evm/operationMode.d.ts.map +1 -0
- package/dist/cjs/evm/operationMode.js +65 -0
- package/dist/cjs/evm/operationMode.js.map +7 -0
- package/dist/cjs/evm/tokenModes.d.ts +22 -0
- package/dist/cjs/evm/tokenModes.d.ts.map +1 -0
- package/dist/cjs/evm/tokenModes.js +47 -0
- package/dist/cjs/evm/tokenModes.js.map +7 -0
- package/dist/cjs/evm/types.d.ts +34 -0
- package/dist/cjs/evm/types.d.ts.map +1 -0
- package/dist/cjs/evm/types.js +32 -0
- package/dist/cjs/evm/types.js.map +7 -0
- package/dist/cjs/evm/userCurrentBalance.d.ts +69 -0
- package/dist/cjs/evm/userCurrentBalance.d.ts.map +1 -0
- package/dist/cjs/evm/userCurrentBalance.js +268 -0
- package/dist/cjs/evm/userCurrentBalance.js.map +7 -0
- package/dist/cjs/evm/vaults.d.ts +44 -0
- package/dist/cjs/evm/vaults.d.ts.map +1 -0
- package/dist/cjs/evm/vaults.js +78 -0
- package/dist/cjs/evm/vaults.js.map +7 -0
- package/dist/cjs/evm/withdraw.d.ts +75 -0
- package/dist/cjs/evm/withdraw.d.ts.map +1 -0
- package/dist/cjs/evm/withdraw.js +174 -0
- package/dist/cjs/evm/withdraw.js.map +7 -0
- package/dist/cjs/evm/withdrawQuote.d.ts +135 -0
- package/dist/cjs/evm/withdrawQuote.d.ts.map +1 -0
- package/dist/cjs/evm/withdrawQuote.js +257 -0
- package/dist/cjs/evm/withdrawQuote.js.map +7 -0
- package/dist/cjs/index.d.ts +31 -0
- package/dist/cjs/index.d.ts.map +1 -0
- package/dist/cjs/index.js +128 -0
- package/dist/cjs/index.js.map +7 -0
- package/dist/cjs/package.json +1 -0
- package/dist/cjs/privy/index.d.ts +52 -0
- package/dist/cjs/privy/index.d.ts.map +1 -0
- package/dist/cjs/privy/index.js +57 -0
- package/dist/cjs/privy/index.js.map +7 -0
- package/dist/client.d.ts +4 -2
- package/dist/client.d.ts.map +1 -1
- package/dist/constants.d.ts.map +1 -1
- package/dist/errors.d.ts +4 -1
- package/dist/errors.d.ts.map +1 -1
- package/dist/evm/adapters/aera.d.ts +1 -1
- package/dist/evm/adapters/aera.d.ts.map +1 -1
- package/dist/evm/adapters/index.d.ts +1 -1
- package/dist/evm/adapters/index.d.ts.map +1 -1
- package/dist/evm/adapters/morpho.d.ts +1 -1
- package/dist/evm/adapters/morpho.d.ts.map +1 -1
- package/dist/evm/adapters/types.d.ts +6 -3
- package/dist/evm/adapters/types.d.ts.map +1 -1
- package/dist/evm/aeraContracts/priceAndFeeCalculator.d.ts +1 -1
- package/dist/evm/aeraContracts/priceAndFeeCalculator.d.ts.map +1 -1
- package/dist/evm/aeraContracts/v1.d.ts +2 -2
- package/dist/evm/aeraContracts/v1.d.ts.map +1 -1
- package/dist/evm/aeraContracts/v2.d.ts +25 -4
- package/dist/evm/aeraContracts/v2.d.ts.map +1 -1
- package/dist/evm/aeraContracts.d.ts +2 -2
- package/dist/evm/aeraContracts.d.ts.map +1 -1
- package/dist/evm/deposit.d.ts +7 -4
- package/dist/evm/deposit.d.ts.map +1 -1
- package/dist/evm/depositQuote.d.ts +32 -0
- package/dist/evm/depositQuote.d.ts.map +1 -0
- package/dist/evm/depositReceiverApproval.d.ts +2 -2
- package/dist/evm/depositReceiverApproval.d.ts.map +1 -1
- package/dist/evm/index.d.ts +27 -25
- package/dist/evm/index.d.ts.map +1 -1
- package/dist/evm/index.js +86 -12
- package/dist/evm/index.js.map +7 -1
- package/dist/evm/tokenModes.d.ts +2 -2
- package/dist/evm/tokenModes.d.ts.map +1 -1
- package/dist/evm/userCurrentBalance.d.ts +21 -3
- package/dist/evm/userCurrentBalance.d.ts.map +1 -1
- package/dist/evm/vaults.d.ts +2 -9
- package/dist/evm/vaults.d.ts.map +1 -1
- package/dist/evm/withdraw.d.ts +5 -3
- package/dist/evm/withdraw.d.ts.map +1 -1
- package/dist/evm/withdrawQuote.d.ts +14 -6
- package/dist/evm/withdrawQuote.d.ts.map +1 -1
- package/dist/index.d.ts +30 -28
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +137 -14
- package/dist/index.js.map +7 -1
- package/dist/manifest/vaults.json +1958 -0
- package/dist/privy/index.d.ts +1 -1
- package/dist/privy/index.d.ts.map +1 -1
- package/dist/privy/index.js +39 -48
- package/dist/privy/index.js.map +7 -1
- package/manifest/vaults.json +22 -395
- package/package.json +43 -9
- package/src/api/activity.ts +18 -15
- package/src/api/activityRows.ts +143 -0
- package/src/api/caip.ts +3 -1
- package/src/api/client.ts +105 -6
- package/src/api/decimal.ts +1 -0
- package/src/api/generated.ts +570 -7
- package/src/api/http.ts +1 -0
- package/src/api/index.ts +8 -0
- package/src/api/positionHistory.ts +20 -5
- package/src/attribution/index.ts +6 -2
- package/src/client.ts +4 -1
- package/src/constants.ts +2 -0
- package/src/errors.ts +7 -0
- package/src/evm/adapters/aera.ts +40 -19
- package/src/evm/adapters/types.ts +3 -0
- package/src/evm/aeraContracts/v2.ts +124 -16
- package/src/evm/aeraContracts.ts +29 -14
- package/src/evm/deposit.ts +61 -18
- package/src/evm/depositQuote.ts +138 -0
- package/src/evm/depositReceiverApproval.ts +14 -9
- package/src/evm/index.ts +10 -1
- package/src/evm/userCurrentBalance.ts +155 -60
- package/src/evm/vaults.ts +0 -7
- package/src/evm/withdraw.ts +20 -1
- package/src/evm/withdrawQuote.ts +126 -51
- package/src/index.ts +11 -2
- package/dist/api/activity.js +0 -154
- package/dist/api/activity.js.map +0 -1
- package/dist/api/caip.js +0 -38
- package/dist/api/caip.js.map +0 -1
- package/dist/api/client.js +0 -119
- package/dist/api/client.js.map +0 -1
- package/dist/api/decimal.js +0 -44
- package/dist/api/decimal.js.map +0 -1
- package/dist/api/errors.js +0 -41
- package/dist/api/errors.js.map +0 -1
- package/dist/api/generated.js +0 -6
- package/dist/api/generated.js.map +0 -1
- package/dist/api/http.js +0 -39
- package/dist/api/http.js.map +0 -1
- package/dist/api/positionHistory.js +0 -126
- package/dist/api/positionHistory.js.map +0 -1
- package/dist/attribution/erc8021.js +0 -17
- package/dist/attribution/erc8021.js.map +0 -1
- package/dist/attribution/index.js +0 -45
- package/dist/attribution/index.js.map +0 -1
- package/dist/client.js +0 -72
- package/dist/client.js.map +0 -1
- package/dist/constants.js +0 -28
- package/dist/constants.js.map +0 -1
- package/dist/errors.js +0 -134
- package/dist/errors.js.map +0 -1
- package/dist/evm/abis/erc20.js +0 -30
- package/dist/evm/abis/erc20.js.map +0 -1
- package/dist/evm/abis/erc4626.js +0 -70
- package/dist/evm/abis/erc4626.js.map +0 -1
- package/dist/evm/abis/multiDepositorVault.js +0 -587
- package/dist/evm/abis/multiDepositorVault.js.map +0 -1
- package/dist/evm/abis/priceAndFeeCalculator.js +0 -490
- package/dist/evm/abis/priceAndFeeCalculator.js.map +0 -1
- package/dist/evm/abis/priceAndFeeCalculatorV2.js +0 -141
- package/dist/evm/abis/priceAndFeeCalculatorV2.js.map +0 -1
- package/dist/evm/abis/provisioner.js +0 -2768
- package/dist/evm/abis/provisioner.js.map +0 -1
- package/dist/evm/abis/provisionerV2.js +0 -295
- package/dist/evm/abis/provisionerV2.js.map +0 -1
- package/dist/evm/adapters/aera.js +0 -280
- package/dist/evm/adapters/aera.js.map +0 -1
- package/dist/evm/adapters/index.js +0 -14
- package/dist/evm/adapters/index.js.map +0 -1
- package/dist/evm/adapters/morpho.js +0 -79
- package/dist/evm/adapters/morpho.js.map +0 -1
- package/dist/evm/adapters/types.js +0 -2
- package/dist/evm/adapters/types.js.map +0 -1
- package/dist/evm/aeraContracts/priceAndFeeCalculator.js +0 -174
- package/dist/evm/aeraContracts/priceAndFeeCalculator.js.map +0 -1
- package/dist/evm/aeraContracts/readOptions.js +0 -4
- package/dist/evm/aeraContracts/readOptions.js.map +0 -1
- package/dist/evm/aeraContracts/v1.js +0 -59
- package/dist/evm/aeraContracts/v1.js.map +0 -1
- package/dist/evm/aeraContracts/v2.js +0 -273
- package/dist/evm/aeraContracts/v2.js.map +0 -1
- package/dist/evm/aeraContracts.js +0 -195
- package/dist/evm/aeraContracts.js.map +0 -1
- package/dist/evm/deposit.js +0 -109
- package/dist/evm/deposit.js.map +0 -1
- package/dist/evm/depositReceiverApproval.js +0 -32
- package/dist/evm/depositReceiverApproval.js.map +0 -1
- package/dist/evm/operationMode.js +0 -41
- package/dist/evm/operationMode.js.map +0 -1
- package/dist/evm/tokenModes.js +0 -34
- package/dist/evm/tokenModes.js.map +0 -1
- package/dist/evm/types.js +0 -5
- package/dist/evm/types.js.map +0 -1
- package/dist/evm/userCurrentBalance.js +0 -211
- package/dist/evm/userCurrentBalance.js.map +0 -1
- package/dist/evm/vaults.js +0 -75
- package/dist/evm/vaults.js.map +0 -1
- package/dist/evm/withdraw.js +0 -177
- package/dist/evm/withdraw.js.map +0 -1
- package/dist/evm/withdrawQuote.js +0 -164
- package/dist/evm/withdrawQuote.js.map +0 -1
package/README.md
CHANGED
|
@@ -16,6 +16,19 @@ yarn add @gauntlet-xyz/sdk viem
|
|
|
16
16
|
|
|
17
17
|
> `viem` is a required peer dependency.
|
|
18
18
|
|
|
19
|
+
## Node.js
|
|
20
|
+
|
|
21
|
+
The package supports ESM `import` and CommonJS `require` in Node.js.
|
|
22
|
+
Both entry points use the same SDK exports.
|
|
23
|
+
|
|
24
|
+
```js
|
|
25
|
+
import { GauntletClient } from '@gauntlet-xyz/sdk';
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
```js
|
|
29
|
+
const { GauntletClient } = require('@gauntlet-xyz/sdk');
|
|
30
|
+
```
|
|
31
|
+
|
|
19
32
|
## Quick start
|
|
20
33
|
|
|
21
34
|
```ts
|
|
@@ -54,6 +67,56 @@ const client = await createGauntletClientFromPrivy({
|
|
|
54
67
|
});
|
|
55
68
|
```
|
|
56
69
|
|
|
70
|
+
## Aera instant deposits
|
|
71
|
+
|
|
72
|
+
Quote an Aera V2 instant deposit, then pass its minimum output to the transaction builder.
|
|
73
|
+
|
|
74
|
+
```ts
|
|
75
|
+
import { getDepositTx, getSyncDepositQuote, VaultId } from '@gauntlet-xyz/sdk';
|
|
76
|
+
|
|
77
|
+
const request = {
|
|
78
|
+
vaultId: VaultId.AeraUsdAlpha,
|
|
79
|
+
amount: 1_000_000n,
|
|
80
|
+
slippageBps: 100,
|
|
81
|
+
};
|
|
82
|
+
let quote = await getSyncDepositQuote(client, request);
|
|
83
|
+
let steps = await getDepositTx(client, {
|
|
84
|
+
...request,
|
|
85
|
+
depositMode: 'sync',
|
|
86
|
+
minUnitsOut: quote.minUnitsOut,
|
|
87
|
+
});
|
|
88
|
+
|
|
89
|
+
while (steps[0]?.tx.type === 'approve') {
|
|
90
|
+
await sendAndConfirm(steps[0]);
|
|
91
|
+
quote = await getSyncDepositQuote(client, request);
|
|
92
|
+
steps = await getDepositTx(client, {
|
|
93
|
+
...request,
|
|
94
|
+
depositMode: 'sync',
|
|
95
|
+
minUnitsOut: quote.minUnitsOut,
|
|
96
|
+
});
|
|
97
|
+
}
|
|
98
|
+
if (steps[0]?.tx.type !== 'deposit') {
|
|
99
|
+
throw new Error('The transaction builder returned no deposit step.');
|
|
100
|
+
}
|
|
101
|
+
await sendAndConfirm(steps[0]);
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
`SyncDepositQuote` has five required fields: `unitsOut`, `minUnitsOut`, `numeraireOut`, `feeBps`, and
|
|
105
|
+
`slippageBps`. `slippageBps` is the basis-point tolerance used to derive `minUnitsOut`; `feeBps` is
|
|
106
|
+
the Instant Supply fee applied to the deposited token amount; `numeraireOut` is the post-fee deposit
|
|
107
|
+
amount converted to the vault's numeraire, for display. The contract enforces `minUnitsOut`. Requote
|
|
108
|
+
after each approval so the deposit signature uses the latest reviewed minimum. Some tokens require
|
|
109
|
+
an approval of zero before the final approval.
|
|
110
|
+
|
|
111
|
+
Use `getSyncDepositRate` to read the live Instant Supply fee without an amount, e.g. to show a fee
|
|
112
|
+
caption before the user has typed a deposit amount:
|
|
113
|
+
|
|
114
|
+
```ts
|
|
115
|
+
import { getSyncDepositRate, VaultId } from '@gauntlet-xyz/sdk';
|
|
116
|
+
|
|
117
|
+
const { feeBps } = await getSyncDepositRate(client, { vaultId: VaultId.AeraUsdAlpha });
|
|
118
|
+
```
|
|
119
|
+
|
|
57
120
|
## Aera instant withdrawals
|
|
58
121
|
|
|
59
122
|
Use the live capability result to decide whether to offer an instant withdrawal, then pass the
|
|
@@ -65,30 +128,45 @@ import {
|
|
|
65
128
|
getSyncWithdrawQuote,
|
|
66
129
|
getWithdrawTx,
|
|
67
130
|
VaultId,
|
|
68
|
-
} from '@gauntlet-xyz/sdk'
|
|
131
|
+
} from '@gauntlet-xyz/sdk';
|
|
69
132
|
|
|
70
|
-
const vaultId = VaultId.AeraUsdAlpha
|
|
71
|
-
const support = await getAeraTokenModeSupport(client, { vaultId })
|
|
133
|
+
const vaultId = VaultId.AeraUsdAlpha;
|
|
134
|
+
const support = await getAeraTokenModeSupport(client, { vaultId });
|
|
72
135
|
|
|
73
136
|
if (support.syncRedeem) {
|
|
74
137
|
const quote = await getSyncWithdrawQuote(client, {
|
|
75
138
|
vaultId,
|
|
76
139
|
amount: 1_000_000n,
|
|
77
140
|
slippageBps: 100,
|
|
78
|
-
})
|
|
141
|
+
});
|
|
79
142
|
const steps = await getWithdrawTx(client, {
|
|
80
143
|
vaultId,
|
|
81
144
|
amount: 1_000_000n,
|
|
82
145
|
syncWithdrawQuote: quote,
|
|
83
|
-
})
|
|
146
|
+
});
|
|
84
147
|
}
|
|
85
148
|
```
|
|
86
149
|
|
|
150
|
+
Use `quote.rate` for the block-consistent rate associated with the quote. To fetch only the live
|
|
151
|
+
rate:
|
|
152
|
+
|
|
153
|
+
```ts
|
|
154
|
+
import { getSyncWithdrawRate } from '@gauntlet-xyz/sdk';
|
|
155
|
+
|
|
156
|
+
const rate = await getSyncWithdrawRate(client, { vaultId });
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
`getSyncWithdrawRate` accepts the exported `SyncWithdrawRateParams` and returns the live base,
|
|
160
|
+
dynamic-premium, and effective multipliers without requiring an amount or account.
|
|
161
|
+
|
|
87
162
|
An `amount` quote uses exact token output and returns a `maxUnitsIn` bound. A `shares` quote uses
|
|
88
163
|
exact shares and returns a `minTokensOut` bound. Full-position quotes require
|
|
89
164
|
`{ entireAmount: true, account }`; the matching transaction uses the configured wallet account,
|
|
90
165
|
and an optional `account` must match that wallet. The returned `SyncWithdrawQuote` is directly
|
|
91
|
-
assignable to the exported `SyncWithdrawQuoteBounds` accepted by `getWithdrawTx`.
|
|
166
|
+
assignable to the exported `SyncWithdrawQuoteBounds` accepted by `getWithdrawTx`. Redeem quotes
|
|
167
|
+
also include `shareSafeTokensOut`, the largest exact-token withdrawal that preserves slippage
|
|
168
|
+
headroom within the quoted shares. `capacity.knownLiquidityTokens` reports the vault's token
|
|
169
|
+
balance only when no pull-funds calldata can source more liquidity; otherwise it is undefined.
|
|
92
170
|
|
|
93
171
|
Supplying `syncWithdrawQuote` implies sync mode and validates its vault, chain, token, account,
|
|
94
172
|
slippage, and sizing request. When transaction slippage is omitted, the builder uses the quote's
|
|
@@ -112,10 +190,39 @@ const client = new GauntletClient({ apiKey: process.env.GAUNTLET_API_KEY });
|
|
|
112
190
|
const { data: vaults } = await client.api.vaults(); // live TVL / APY / unit price
|
|
113
191
|
const { data: positions } = await client.api.positions(wallet); // value, cost basis, PnL, ROI
|
|
114
192
|
const { data: history } = await client.api.positionTimeseries(wallet, vaultId);
|
|
193
|
+
const { data: vaultHistory } = await client.api.vaultTimeseriesBySlug('gtusda'); // aggregate TVL + primary metrics
|
|
194
|
+
const { data: primary } = await client.api.primaryVaultTimeseriesBySlug('gtusda'); // primary only
|
|
115
195
|
```
|
|
116
196
|
|
|
197
|
+
For logical-vault history, use `vaultTimeseriesBySlug`: each point contains
|
|
198
|
+
aggregate `tvl.usd` and `total_supply` alongside primary-deployment `apy_7d`,
|
|
199
|
+
`apy_30d`, `apy_90d`, and `unit_price`. `meta.resolved_vault_id` identifies that primary.
|
|
200
|
+
Null values mark missing data and should render as gaps. Use
|
|
201
|
+
`primaryVaultTimeseriesBySlug` when all metrics, including TVL, should describe
|
|
202
|
+
only the primary deployment; that response also includes its native-token TVL.
|
|
203
|
+
|
|
117
204
|
Vault ids on the API are CAIP-10 (`"{chainId}:{address}"`); convert to and from manifest vault ids with `apiVaultIdFromVaultId` / `vaultIdFromApiVaultId`. Monetary values are human-unit decimal strings; convert exactly with `decimalToBigInt` / `sharesToBigInt` (throws instead of rounding).
|
|
118
205
|
|
|
206
|
+
### Transaction and balance safety
|
|
207
|
+
|
|
208
|
+
Prepared transactions include `chainId` in both `payload` and `tx`.
|
|
209
|
+
Check the account and chain before signing each step.
|
|
210
|
+
Rebuild the steps after a wallet account or chain change.
|
|
211
|
+
|
|
212
|
+
For exact-token withdrawals derived from `shareSafeTokensOut`, pass `maxShares: quote.shares` to `getWithdrawTx`.
|
|
213
|
+
This cap remains effective after a rate change.
|
|
214
|
+
The contract rejects a withdrawal that needs more shares.
|
|
215
|
+
|
|
216
|
+
`getUserCurrentBalance` reads balances, conversions, and request state at one block.
|
|
217
|
+
It filters pending requests by the selected token.
|
|
218
|
+
A multi-asset deployment requires `assetSymbol`, as `getDepositTx` does.
|
|
219
|
+
The default scan covers the configured request lifetime, with a minimum of three days.
|
|
220
|
+
Use `fromBlock` to include older requests, including expired requests that still hold escrow.
|
|
221
|
+
A vault with several deployments also requires `chainId` with `fromBlock`.
|
|
222
|
+
Each result includes `blockNumber` and `fromBlock` to identify its scope.
|
|
223
|
+
`pendingWithdraw` reports the gross current token value of escrowed shares.
|
|
224
|
+
It does not promise the settlement payout after multipliers or solver tips.
|
|
225
|
+
|
|
119
226
|
### Activity flows
|
|
120
227
|
|
|
121
228
|
`getActivityFlows` stitches the raw activity log into lifecycle-aware flows — Aera async requests are paired with their settlement or refund via `request_hash`, replacing client-side event-log scanning:
|
|
@@ -127,9 +234,16 @@ const flows = await getActivityFlows(client.api, wallet);
|
|
|
127
234
|
// [{ kind: 'deposit', status: 'pending', requestedAt, settledAt, assets, shares, txHashes, ... }]
|
|
128
235
|
|
|
129
236
|
// After submitting a requestDeposit / requestRedeem transaction:
|
|
130
|
-
const settled = await waitForRequestSettlement(client.api, wallet, requestHash);
|
|
237
|
+
const settled = await waitForRequestSettlement(client.api, wallet, requestHash, { requestTxHash });
|
|
131
238
|
```
|
|
132
239
|
|
|
240
|
+
Settlement polling requires `requestTxHash`, the transaction hash of the submitted request.
|
|
241
|
+
This separates a new request from an earlier request with the same correlation hash.
|
|
242
|
+
Activity helpers reject incomplete pages, rows out of timestamp order, repeated cursors, and invalid lifecycle deltas.
|
|
243
|
+
Rows carry no event index, so identical rows in one transaction stay separate rows.
|
|
244
|
+
Position history rejects mixed asset denominations and unmatched escrow.
|
|
245
|
+
The API client rejects redirects to prevent credential forwarding.
|
|
246
|
+
|
|
133
247
|
### Position history
|
|
134
248
|
|
|
135
249
|
`getPositionHistory` replays a wallet's indexed events into a chronological position timeline — running share balance, escrowed pending amounts, and net asset flows:
|
package/dist/api/activity.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { ActivityOptions, GauntletApi, TokenRef, UserActivity } from
|
|
1
|
+
import type { ActivityOptions, GauntletApi, TokenRef, UserActivity } from "./client.js";
|
|
2
2
|
export type ActivityFlowKind = 'deposit' | 'withdraw' | 'transfer_in' | 'transfer_out';
|
|
3
3
|
export type ActivityFlowStatus = 'settled' | 'pending' | 'refunded';
|
|
4
4
|
/** A signed token amount as reported by the API, with base-unit conversion when possible. */
|
|
@@ -54,6 +54,8 @@ export interface ActivityFlowsOptions extends Pick<ActivityOptions, 'vaultId' |
|
|
|
54
54
|
*/
|
|
55
55
|
export declare function getActivityFlows(api: GauntletApi, walletAddress: string, options?: ActivityFlowsOptions): Promise<ActivityFlow[]>;
|
|
56
56
|
export interface WaitForSettlementOptions {
|
|
57
|
+
/** Transaction hash of the submitted request. Prevents reuse of an earlier settlement. */
|
|
58
|
+
requestTxHash: string;
|
|
57
59
|
/** CAIP-10 vault id — narrows polling to one vault's activity. */
|
|
58
60
|
vaultId?: string;
|
|
59
61
|
/** Polling interval. Defaults to 5s. */
|
|
@@ -66,5 +68,5 @@ export interface WaitForSettlementOptions {
|
|
|
66
68
|
* `requestHash` reaches a terminal state, and returns the settled or refunded
|
|
67
69
|
* flow. Use after submitting a `requestDeposit` / `requestRedeem` transaction.
|
|
68
70
|
*/
|
|
69
|
-
export declare function waitForRequestSettlement(api: GauntletApi, walletAddress: string, requestHash: string, options
|
|
71
|
+
export declare function waitForRequestSettlement(api: GauntletApi, walletAddress: string, requestHash: string, options: WaitForSettlementOptions): Promise<ActivityFlow>;
|
|
70
72
|
//# sourceMappingURL=activity.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"activity.d.ts","sourceRoot":"","sources":["../../src/api/activity.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"activity.d.ts","sourceRoot":"","sources":["../../src/api/activity.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,WAAW,EAAE,QAAQ,EAAE,YAAY,EAAE,oBAAiB;AAIrF,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,UAAU,GAAG,aAAa,GAAG,cAAc,CAAC;AACvF,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;AAEpE,6FAA6F;AAC7F,MAAM,WAAW,WAAW;IAC1B,8EAA8E;IAC9E,OAAO,EAAE,MAAM,CAAC;IAChB,qGAAqG;IACrG,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,gBAAgB,CAAC;IACvB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAC;IAChB,sEAAsE;IACtE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,mGAAmG;IACnG,WAAW,EAAE,IAAI,GAAG,IAAI,CAAC;IACzB,wEAAwE;IACxE,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;IACvB,oFAAoF;IACpF,MAAM,EAAE,WAAW,CAAC;IACpB,uEAAuE;IACvE,MAAM,EAAE,MAAM,CAAC;IACf,6FAA6F;IAC7F,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AA4CD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,YAAY,EAAE,GAAG,YAAY,EAAE,CA2CxE;AAED,MAAM,WAAW,oBAAqB,SAAQ,IAAI,CAAC,eAAe,EAAE,SAAS,GAAG,OAAO,CAAC;IACtF,+EAA+E;IAC/E,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;GAQG;AACH,wBAAsB,gBAAgB,CACpC,GAAG,EAAE,WAAW,EAChB,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,YAAY,EAAE,CAAC,CAqBzB;AAED,MAAM,WAAW,wBAAwB;IACvC,0FAA0F;IAC1F,aAAa,EAAE,MAAM,CAAC;IACtB,kEAAkE;IAClE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wCAAwC;IACxC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,2FAA2F;IAC3F,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,wBAAsB,wBAAwB,CAC5C,GAAG,EAAE,WAAW,EAChB,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,YAAY,CAAC,CAwBvB"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { UserActivity } from "./client.js";
|
|
2
|
+
export declare function isPending(row: UserActivity): boolean;
|
|
3
|
+
export declare function requireSameToken(leftRow: UserActivity, rightRow: UserActivity): void;
|
|
4
|
+
export declare function validateActivityRow(row: UserActivity): void;
|
|
5
|
+
export declare function orderActivityRows(rows: UserActivity[]): UserActivity[];
|
|
6
|
+
/**
|
|
7
|
+
* Split request hashes by vault and by each request occurrence.
|
|
8
|
+
* Takes the output of `orderActivityRows`.
|
|
9
|
+
*/
|
|
10
|
+
export declare function activityLifecycles(ordered: UserActivity[]): UserActivity[][];
|
|
11
|
+
//# sourceMappingURL=activityRows.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"activityRows.d.ts","sourceRoot":"","sources":["../../src/api/activityRows.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,oBAAiB;AAG7C,wBAAgB,SAAS,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAEpD;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,YAAY,GAAG,IAAI,CAepF;AAED,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,YAAY,GAAG,IAAI,CAsD3D;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,YAAY,EAAE,GAAG,YAAY,EAAE,CAQtE;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,YAAY,EAAE,EAAE,CA+C5E"}
|
package/dist/api/caip.d.ts
CHANGED
package/dist/api/caip.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"caip.d.ts","sourceRoot":"","sources":["../../src/api/caip.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,
|
|
1
|
+
{"version":3,"file":"caip.d.ts","sourceRoot":"","sources":["../../src/api/caip.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,qBAAkB;AAKhD;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,wBAAgB,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,CAMtD;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAEzE;AAED;;;;;;;;GAQG;AACH,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,cAAc,EACtB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,MAAM,CAAC,CAIjB;AAED;;;;GAIG;AACH,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,cAAc,EACtB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAQ7B"}
|
package/dist/api/client.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { components } from
|
|
2
|
-
import { type GauntletApiConfig } from
|
|
1
|
+
import type { components } from "./generated.js";
|
|
2
|
+
import { type GauntletApiConfig } from "./http.js";
|
|
3
3
|
type Schemas = components['schemas'];
|
|
4
4
|
export type UserActivity = Schemas['UserActivity'];
|
|
5
5
|
export type UserActivityResponse = Schemas['UserActivityResponse'];
|
|
@@ -10,7 +10,12 @@ export type UserPositionsTimeseriesResponse = Schemas['UserPositionsTimeseriesRe
|
|
|
10
10
|
export type PositionTimeseriesPoint = Schemas['PositionTimeseriesPoint'];
|
|
11
11
|
export type VaultDetail = Schemas['VaultDetail'];
|
|
12
12
|
export type VaultDetailResponse = Schemas['VaultDetailResponse'];
|
|
13
|
+
export type VaultListResponse = Schemas['VaultListResponse'];
|
|
14
|
+
export type VaultAllocations = Schemas['VaultAllocations'];
|
|
15
|
+
export type VaultAllocationsResponse = Schemas['VaultAllocationsResponse'];
|
|
13
16
|
export type VaultTimeseriesResponse = Schemas['VaultTimeseriesResponse'];
|
|
17
|
+
export type VaultGroupTimeseriesResponse = Schemas['VaultGroupTimeseriesResponse'];
|
|
18
|
+
export type VaultGroupTimeseriesPoint = Schemas['VaultGroupTimeseriesPoint'];
|
|
14
19
|
export type VaultTimeseriesPoint = Schemas['VaultTimeseriesPoint'];
|
|
15
20
|
export type VaultMetrics = Schemas['VaultMetrics'];
|
|
16
21
|
export type FeaturedVault = Schemas['FeaturedVault'];
|
|
@@ -18,6 +23,9 @@ export type FeaturedVaultsResponse = Schemas['FeaturedVaultsResponse'];
|
|
|
18
23
|
export type StrategyCard = Schemas['StrategyCard'];
|
|
19
24
|
export type StrategyListResponse = Schemas['StrategyListResponse'];
|
|
20
25
|
export type TvlResponse = Schemas['TvlResponse'];
|
|
26
|
+
export type TvlBreakdownMode = Schemas['TvlBreakdownMode'];
|
|
27
|
+
export type TvlTimeseriesResponse = Schemas['TvlTimeseriesResponse'];
|
|
28
|
+
export type TvlTimeseriesPoint = Schemas['TvlTimeseriesPoint'];
|
|
21
29
|
export type LatestPriceResponse = Schemas['LatestPriceResponse'];
|
|
22
30
|
export type PriceTimeseriesResponse = Schemas['TimeseriesResponse'];
|
|
23
31
|
export type TokenRef = Schemas['TokenRef'];
|
|
@@ -55,6 +63,13 @@ export interface PositionsOptions extends PageOptions {
|
|
|
55
63
|
*/
|
|
56
64
|
includeHidden?: boolean;
|
|
57
65
|
}
|
|
66
|
+
export interface VaultsOptions extends PageOptions {
|
|
67
|
+
/**
|
|
68
|
+
* Include hidden (enabled but unlisted) vaults alongside visible ones.
|
|
69
|
+
* Disabled vaults are never listed.
|
|
70
|
+
*/
|
|
71
|
+
includeHidden?: boolean;
|
|
72
|
+
}
|
|
58
73
|
export interface LatestPriceOptions {
|
|
59
74
|
address: string;
|
|
60
75
|
chainId: number;
|
|
@@ -95,10 +110,18 @@ export declare class GauntletApi {
|
|
|
95
110
|
/** GET /health/chains — per-chain indexer sync freshness. */
|
|
96
111
|
chainSyncStatus(): Promise<ChainSyncStatus[]>;
|
|
97
112
|
/** GET /v1/vaults — all indexed vaults with live metrics (TVL, APY, unit price). */
|
|
98
|
-
vaults(options?:
|
|
113
|
+
vaults(options?: VaultsOptions): Promise<{
|
|
99
114
|
data: VaultDetail[];
|
|
100
115
|
meta: TimeseriesMeta;
|
|
101
116
|
}>;
|
|
117
|
+
/** GET /v1/vaults/slug/{slug} — all enabled deployments for one exact vault slug. */
|
|
118
|
+
vaultsBySlug(slug: string): Promise<VaultListResponse>;
|
|
119
|
+
/** GET /v1/vaults/slug/{slug}/timeseries — aggregate USD TVL and supply, plus primary-deployment metrics.
|
|
120
|
+
* APY and unit price come from meta.resolved_vault_id; null marks missing data.
|
|
121
|
+
*/
|
|
122
|
+
vaultTimeseriesBySlug(slug: string, options?: TimeWindowOptions): Promise<VaultGroupTimeseriesResponse>;
|
|
123
|
+
/** GET /v1/vaults/slug/{slug}/primary/timeseries — primary deployment history. */
|
|
124
|
+
primaryVaultTimeseriesBySlug(slug: string, options?: TimeWindowOptions): Promise<VaultTimeseriesResponse>;
|
|
102
125
|
/** GET /v1/vaults/featured — admin-curated featured vault cards. */
|
|
103
126
|
featuredVaults(): Promise<FeaturedVaultsResponse>;
|
|
104
127
|
/** GET /v1/strategies — admin-curated strategy cards. */
|
|
@@ -107,6 +130,8 @@ export declare class GauntletApi {
|
|
|
107
130
|
vault(vaultId: string): Promise<VaultDetailResponse>;
|
|
108
131
|
/** GET /v1/vaults/{vault_id}/definition — raw indexed vault definition. */
|
|
109
132
|
vaultDefinition(vaultId: string): Promise<unknown>;
|
|
133
|
+
/** GET /v1/vaults/{vault_id}/allocations — current Aera allocations with source lineage. */
|
|
134
|
+
vaultAllocations(vaultId: string): Promise<VaultAllocationsResponse>;
|
|
110
135
|
/** GET /v1/vaults/{vault_id}/timeseries — TVL / unit-price / APY history. */
|
|
111
136
|
vaultTimeseries(vaultId: string, options?: TimeWindowOptions): Promise<VaultTimeseriesResponse>;
|
|
112
137
|
/** GET /v1/users/{wallet}/positions — all of a wallet's indexed positions with PnL. */
|
|
@@ -122,10 +147,23 @@ export declare class GauntletApi {
|
|
|
122
147
|
* across pages so callers never handle cursors.
|
|
123
148
|
*/
|
|
124
149
|
activityRows(walletAddress: string, options?: Omit<ActivityOptions, 'next'>): AsyncGenerator<UserActivity>;
|
|
125
|
-
/**
|
|
150
|
+
/**
|
|
151
|
+
* GET /v1/tvl — aggregate Gauntlet TVL. Pass `mode` for a `breakdown`:
|
|
152
|
+
* `chain` for one row per chain, `strategy` for one row per curated
|
|
153
|
+
* strategy. Omit it for the headline totals only.
|
|
154
|
+
*/
|
|
126
155
|
tvl(options?: {
|
|
127
|
-
|
|
156
|
+
mode?: TvlBreakdownMode;
|
|
128
157
|
}): Promise<TvlResponse>;
|
|
158
|
+
/**
|
|
159
|
+
* GET /v1/tvl/timeseries — daily aggregate Gauntlet TVL over a fixed
|
|
160
|
+
* 3-month trailing window. `mode` partitions each point's `sources` the
|
|
161
|
+
* same way `tvl()` partitions its `breakdown`; a point's total never
|
|
162
|
+
* depends on it.
|
|
163
|
+
*/
|
|
164
|
+
tvlTimeseries(options?: {
|
|
165
|
+
mode?: TvlBreakdownMode;
|
|
166
|
+
}): Promise<TvlTimeseriesResponse>;
|
|
129
167
|
/** GET /v1/prices — latest USD price for a token. */
|
|
130
168
|
latestPrice(options: LatestPriceOptions): Promise<LatestPriceResponse>;
|
|
131
169
|
/** GET /v1/prices/timeseries — USD price history for a token. */
|
package/dist/api/client.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,uBAAoB;AAC9C,OAAO,EAAU,KAAK,iBAAiB,EAAoB,kBAAe;AAE1E,KAAK,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;AAMrC,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;AACnD,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;AACnE,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;AACnD,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;AAC3E,MAAM,MAAM,0BAA0B,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;AAC/E,MAAM,MAAM,+BAA+B,GAAG,OAAO,CAAC,iCAAiC,CAAC,CAAC;AACzF,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;AACzE,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;AACjD,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;AACjE,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAC7D,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAC3D,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;AAC3E,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;AACzE,MAAM,MAAM,4BAA4B,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAAC;AACnF,MAAM,MAAM,yBAAyB,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAAC;AAC7E,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;AACnE,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;AACnD,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;AACrD,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;AACvE,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;AACnD,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;AACnE,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;AACjD,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAC3D,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;AACrE,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAC/D,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;AACjE,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;AACpE,MAAM,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAC3C,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;AACnE,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AAC/C,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AACvD,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AACvD,MAAM,MAAM,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAEzD,MAAM,WAAW,WAAW;IAC1B,mEAAmE;IACnE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,0DAA0D;IAC1D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC;CACjD;AAED,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAClD,iFAAiF;IACjF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,6DAA6D;IAC7D,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC;IACxD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAoB;gBAE/B,MAAM,GAAE,iBAAsB;IAI1C,OAAO,CAAC,GAAG;IAIX,yDAAyD;IACzD,MAAM,IAAI,OAAO,CAAC,cAAc,CAAC;IAIjC,6DAA6D;IAC7D,eAAe,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;IAI7C,oFAAoF;IACpF,MAAM,CAAC,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,WAAW,EAAE,CAAC;QAAC,IAAI,EAAE,cAAc,CAAA;KAAE,CAAC;IAQ3F,qFAAqF;IACrF,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAItD;;OAEG;IACH,qBAAqB,CACnB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,4BAA4B,CAAC;IAIxC,kFAAkF;IAClF,4BAA4B,CAC1B,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,uBAAuB,CAAC;IAMnC,oEAAoE;IACpE,cAAc,IAAI,OAAO,CAAC,sBAAsB,CAAC;IAIjD,yDAAyD;IACzD,UAAU,IAAI,OAAO,CAAC,oBAAoB,CAAC;IAI3C,qFAAqF;IACrF,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAIpD,2EAA2E;IAC3E,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlD,4FAA4F;IAC5F,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAIpE,6EAA6E;IAC7E,eAAe,CACb,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,uBAAuB,CAAC;IAInC,uFAAuF;IACvF,SAAS,CACP,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,wBAAwB,CAAC;IAQpC,qFAAqF;IACrF,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAMrF,uGAAuG;IACvG,kBAAkB,CAChB,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,+BAA+B,CAAC;IAO3C,sFAAsF;IACtF,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,GAAE,eAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAS7F;;;OAGG;IACI,YAAY,CACjB,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE,IAAI,CAAC,eAAe,EAAE,MAAM,CAAM,GAC1C,cAAc,CAAC,YAAY,CAAC;IAsC/B;;;;OAIG;IACH,GAAG,CAAC,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,gBAAgB,CAAA;KAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IAIpE;;;;;OAKG;IACH,aAAa,CAAC,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,gBAAgB,CAAA;KAAO,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAIxF,qDAAqD;IACrD,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAQtE,iEAAiE;IACjE,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAUnF"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"decimal.d.ts","sourceRoot":"","sources":["../../src/api/decimal.ts"],"names":[],"mappings":"AAKA;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,
|
|
1
|
+
{"version":3,"file":"decimal.d.ts","sourceRoot":"","sources":["../../src/api/decimal.ts"],"names":[],"mappings":"AAKA;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAevE;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAKvE;AAED,4EAA4E;AAC5E,eAAO,MAAM,cAAc,KAAK,CAAC;AAEjC,gFAAgF;AAChF,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEpD"}
|
package/dist/api/errors.d.ts
CHANGED
package/dist/api/errors.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/api/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,
|
|
1
|
+
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/api/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,qBAAkB;AAE7C,qBAAa,gBAAiB,SAAQ,gBAAgB;IACpD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,0FAA0F;IAC1F,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;gBAEX,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE;CASrF;AAED,qBAAa,mBAAoB,SAAQ,gBAAgB;IACvD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;gBAEX,KAAK,EAAE,MAAM;CAK1B;AAED,qBAAa,qBAAsB,SAAQ,gBAAgB;IACzD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;gBAEd,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;CAQ5C;AAED,qBAAa,kBAAmB,SAAQ,gBAAgB;IACtD,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;gBAER,EAAE,EAAE,MAAM;CAKvB;AAED,qBAAa,sBAAuB,SAAQ,gBAAgB;IAC1D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;gBAEf,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;CAMnD"}
|