@opendatalabs/vana-sdk 0.1.0-alpha.eebb656 → 0.1.0-alpha.ef15099
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 +67 -351
- package/dist/browser.cjs.map +1 -1
- package/dist/browser.d.ts +33 -1
- package/dist/browser.js.map +1 -1
- package/dist/chains/definitions.cjs +9 -6
- package/dist/chains/definitions.cjs.map +1 -1
- package/dist/chains/definitions.d.ts +2 -0
- package/dist/chains/definitions.js +9 -6
- package/dist/chains/definitions.js.map +1 -1
- package/dist/chains/index.cjs.map +1 -1
- package/dist/chains/index.d.ts +30 -1
- package/dist/chains/index.js.map +1 -1
- package/dist/client/enhancedResponse.cjs +164 -0
- package/dist/client/enhancedResponse.cjs.map +1 -0
- package/dist/client/enhancedResponse.d.ts +120 -0
- package/dist/client/enhancedResponse.js +138 -0
- package/dist/client/enhancedResponse.js.map +1 -0
- package/dist/config/chains.cjs.map +1 -1
- package/dist/config/chains.d.ts +99 -0
- package/dist/config/chains.js.map +1 -1
- package/dist/config/contracts.config.cjs +400 -0
- package/dist/config/contracts.config.cjs.map +1 -0
- package/dist/config/contracts.config.d.ts +84 -0
- package/dist/config/contracts.config.js +375 -0
- package/dist/config/contracts.config.js.map +1 -0
- package/dist/config/default-services.cjs +60 -0
- package/dist/config/default-services.cjs.map +1 -0
- package/dist/config/default-services.d.ts +46 -0
- package/dist/config/default-services.js +33 -0
- package/dist/config/default-services.js.map +1 -0
- package/dist/config/default-services.test.d.ts +1 -0
- package/dist/contracts/contractController.cjs +1 -1
- package/dist/contracts/contractController.cjs.map +1 -1
- package/dist/contracts/contractController.d.ts +66 -10
- package/dist/contracts/contractController.js +1 -1
- package/dist/contracts/contractController.js.map +1 -1
- package/dist/controllers/__tests__/data-consistency-integration.test.d.ts +7 -0
- package/dist/controllers/__tests__/operations.processQueue.test.d.ts +1 -0
- package/dist/controllers/accessSettlement.cjs +289 -0
- package/dist/controllers/accessSettlement.cjs.map +1 -0
- package/dist/controllers/accessSettlement.d.ts +157 -0
- package/dist/controllers/accessSettlement.js +265 -0
- package/dist/controllers/accessSettlement.js.map +1 -0
- package/dist/controllers/accessSettlement.test.d.ts +1 -0
- package/dist/controllers/base.cjs +116 -0
- package/dist/controllers/base.cjs.map +1 -0
- package/dist/controllers/base.d.ts +94 -0
- package/dist/controllers/base.js +92 -0
- package/dist/controllers/base.js.map +1 -0
- package/dist/controllers/data.cjs +634 -352
- package/dist/controllers/data.cjs.map +1 -1
- package/dist/controllers/data.d.ts +348 -213
- package/dist/controllers/data.js +647 -355
- package/dist/controllers/data.js.map +1 -1
- package/dist/controllers/operations.cjs +430 -0
- package/dist/controllers/operations.cjs.map +1 -0
- package/dist/controllers/operations.d.ts +229 -0
- package/dist/controllers/operations.js +406 -0
- package/dist/controllers/operations.js.map +1 -0
- package/dist/controllers/permissions.cjs +943 -443
- package/dist/controllers/permissions.cjs.map +1 -1
- package/dist/controllers/permissions.d.ts +201 -120
- package/dist/controllers/permissions.js +943 -443
- package/dist/controllers/permissions.js.map +1 -1
- package/dist/controllers/protocol.cjs +14 -10
- package/dist/controllers/protocol.cjs.map +1 -1
- package/dist/controllers/protocol.d.ts +30 -31
- package/dist/controllers/protocol.js +14 -10
- package/dist/controllers/protocol.js.map +1 -1
- package/dist/controllers/runtimePermissions.cjs +272 -0
- package/dist/controllers/runtimePermissions.cjs.map +1 -0
- package/dist/controllers/runtimePermissions.d.ts +152 -0
- package/dist/controllers/runtimePermissions.js +251 -0
- package/dist/controllers/runtimePermissions.js.map +1 -0
- package/dist/controllers/runtimePermissions.test.d.ts +1 -0
- package/dist/controllers/schemas.cjs +113 -43
- package/dist/controllers/schemas.cjs.map +1 -1
- package/dist/controllers/schemas.d.ts +90 -43
- package/dist/controllers/schemas.js +113 -43
- package/dist/controllers/schemas.js.map +1 -1
- package/dist/controllers/server.cjs +276 -60
- package/dist/controllers/server.cjs.map +1 -1
- package/dist/controllers/server.d.ts +159 -54
- package/dist/controllers/server.js +276 -60
- package/dist/controllers/server.js.map +1 -1
- package/dist/core/__tests__/health.test.d.ts +1 -0
- package/dist/core/__tests__/inMemoryNonceManager.test.d.ts +1 -0
- package/dist/core/__tests__/nonceManager.test.d.ts +1 -0
- package/dist/core/__tests__/pollingManager.test.d.ts +4 -0
- package/dist/core/apiClient.cjs +53 -3
- package/dist/core/apiClient.cjs.map +1 -1
- package/dist/core/apiClient.d.ts +132 -7
- package/dist/core/apiClient.js +53 -3
- package/dist/core/apiClient.js.map +1 -1
- package/dist/core/generics.cjs +30 -3
- package/dist/core/generics.cjs.map +1 -1
- package/dist/core/generics.d.ts +95 -6
- package/dist/core/generics.js +30 -3
- package/dist/core/generics.js.map +1 -1
- package/dist/core/health.cjs +289 -0
- package/dist/core/health.cjs.map +1 -0
- package/dist/core/health.d.ts +143 -0
- package/dist/core/health.js +265 -0
- package/dist/core/health.js.map +1 -0
- package/dist/core/inMemoryNonceManager.cjs +138 -0
- package/dist/core/inMemoryNonceManager.cjs.map +1 -0
- package/dist/core/inMemoryNonceManager.d.ts +69 -0
- package/dist/core/inMemoryNonceManager.js +114 -0
- package/dist/core/inMemoryNonceManager.js.map +1 -0
- package/dist/core/nonceManager.cjs +304 -0
- package/dist/core/nonceManager.cjs.map +1 -0
- package/dist/core/nonceManager.d.ts +116 -0
- package/dist/core/nonceManager.js +280 -0
- package/dist/core/nonceManager.js.map +1 -0
- package/dist/core/pollingManager.cjs +292 -0
- package/dist/core/pollingManager.cjs.map +1 -0
- package/dist/core/pollingManager.d.ts +120 -0
- package/dist/core/pollingManager.js +268 -0
- package/dist/core/pollingManager.js.map +1 -0
- package/dist/core.cjs +164 -36
- package/dist/core.cjs.map +1 -1
- package/dist/core.d.ts +69 -10
- package/dist/core.js +167 -37
- package/dist/core.js.map +1 -1
- package/dist/crypto/ecies/__tests__/constants.test.d.ts +1 -1
- package/dist/crypto/ecies/__tests__/interface.test.d.ts +1 -0
- package/dist/crypto/ecies/__tests__/serialization.test.d.ts +8 -0
- package/dist/crypto/ecies/__tests__/utils.test.d.ts +1 -0
- package/dist/crypto/ecies/base.cjs +59 -23
- package/dist/crypto/ecies/base.cjs.map +1 -1
- package/dist/crypto/ecies/base.js +59 -23
- package/dist/crypto/ecies/base.js.map +1 -1
- package/dist/crypto/ecies/constants.cjs +2 -10
- package/dist/crypto/ecies/constants.cjs.map +1 -1
- package/dist/crypto/ecies/constants.d.ts +0 -9
- package/dist/crypto/ecies/constants.js +1 -8
- package/dist/crypto/ecies/constants.js.map +1 -1
- package/dist/crypto/ecies/interface.cjs +19 -2
- package/dist/crypto/ecies/interface.cjs.map +1 -1
- package/dist/crypto/ecies/interface.js +19 -2
- package/dist/crypto/ecies/interface.js.map +1 -1
- package/dist/errors.cjs +45 -0
- package/dist/errors.cjs.map +1 -1
- package/dist/errors.d.ts +104 -0
- package/dist/errors.js +43 -0
- package/dist/errors.js.map +1 -1
- package/dist/generated/abi/AccessSettlementImplementation.cjs +635 -0
- package/dist/generated/abi/AccessSettlementImplementation.cjs.map +1 -0
- package/dist/generated/abi/AccessSettlementImplementation.d.ts +468 -0
- package/dist/generated/abi/AccessSettlementImplementation.js +611 -0
- package/dist/generated/abi/AccessSettlementImplementation.js.map +1 -0
- package/dist/generated/abi/AttestationPolicyImplementation.cjs +614 -0
- package/dist/generated/abi/AttestationPolicyImplementation.cjs.map +1 -0
- package/dist/generated/abi/AttestationPolicyImplementation.d.ts +449 -0
- package/dist/generated/abi/AttestationPolicyImplementation.js +590 -0
- package/dist/generated/abi/AttestationPolicyImplementation.js.map +1 -0
- package/dist/generated/abi/ComputeEngineImplementation.cjs.map +1 -1
- package/dist/generated/abi/ComputeEngineImplementation.js.map +1 -1
- package/dist/generated/abi/{DLPTreasuryImplementation.cjs → ComputeEngineTreasuryImplementation.cjs} +16 -92
- package/dist/generated/abi/ComputeEngineTreasuryImplementation.cjs.map +1 -0
- package/dist/generated/abi/{DLPTreasuryImplementation.d.ts → ComputeEngineTreasuryImplementation.d.ts} +9 -67
- package/dist/generated/abi/{DLPTreasuryImplementation.js → ComputeEngineTreasuryImplementation.js} +12 -88
- package/dist/generated/abi/ComputeEngineTreasuryImplementation.js.map +1 -0
- package/dist/generated/abi/ComputeInstructionRegistryImplementation.cjs.map +1 -1
- package/dist/generated/abi/ComputeInstructionRegistryImplementation.js.map +1 -1
- package/dist/generated/abi/DATFactoryImplementation.cjs.map +1 -1
- package/dist/generated/abi/DATFactoryImplementation.js.map +1 -1
- package/dist/generated/abi/DATImplementation.cjs.map +1 -1
- package/dist/generated/abi/DATImplementation.js.map +1 -1
- package/dist/generated/abi/DATPausableImplementation.cjs.map +1 -1
- package/dist/generated/abi/DATPausableImplementation.js.map +1 -1
- package/dist/generated/abi/DATVotesImplementation.cjs.map +1 -1
- package/dist/generated/abi/DATVotesImplementation.js.map +1 -1
- package/dist/generated/abi/DLPPerformanceImplementation.cjs +42 -0
- package/dist/generated/abi/DLPPerformanceImplementation.cjs.map +1 -1
- package/dist/generated/abi/DLPPerformanceImplementation.d.ts +32 -0
- package/dist/generated/abi/DLPPerformanceImplementation.js +42 -0
- package/dist/generated/abi/DLPPerformanceImplementation.js.map +1 -1
- package/dist/generated/abi/DLPRegistryImplementation.cjs +5 -5
- package/dist/generated/abi/DLPRegistryImplementation.cjs.map +1 -1
- package/dist/generated/abi/DLPRegistryImplementation.d.ts +4 -4
- package/dist/generated/abi/DLPRegistryImplementation.js +5 -5
- package/dist/generated/abi/DLPRegistryImplementation.js.map +1 -1
- package/dist/generated/abi/DLPRegistryTreasuryImplementation.cjs.map +1 -1
- package/dist/generated/abi/DLPRegistryTreasuryImplementation.js.map +1 -1
- package/dist/generated/abi/DLPRewardDeployerImplementation.cjs +166 -2
- package/dist/generated/abi/DLPRewardDeployerImplementation.cjs.map +1 -1
- package/dist/generated/abi/DLPRewardDeployerImplementation.d.ts +129 -2
- package/dist/generated/abi/DLPRewardDeployerImplementation.js +166 -2
- package/dist/generated/abi/DLPRewardDeployerImplementation.js.map +1 -1
- package/dist/generated/abi/DLPRewardSwapImplementation.cjs.map +1 -1
- package/dist/generated/abi/DLPRewardSwapImplementation.js.map +1 -1
- package/dist/generated/abi/DataLiquidityPoolImplementation.cjs +282 -100
- package/dist/generated/abi/DataLiquidityPoolImplementation.cjs.map +1 -1
- package/dist/generated/abi/DataLiquidityPoolImplementation.d.ts +218 -79
- package/dist/generated/abi/DataLiquidityPoolImplementation.js +281 -99
- package/dist/generated/abi/DataLiquidityPoolImplementation.js.map +1 -1
- package/dist/generated/abi/DataPortabilityGranteesImplementation.cjs +167 -19
- package/dist/generated/abi/DataPortabilityGranteesImplementation.cjs.map +1 -1
- package/dist/generated/abi/DataPortabilityGranteesImplementation.d.ts +127 -14
- package/dist/generated/abi/DataPortabilityGranteesImplementation.js +167 -19
- package/dist/generated/abi/DataPortabilityGranteesImplementation.js.map +1 -1
- package/dist/generated/abi/DataPortabilityPermissionsImplementation.cjs +0 -19
- package/dist/generated/abi/DataPortabilityPermissionsImplementation.cjs.map +1 -1
- package/dist/generated/abi/DataPortabilityPermissionsImplementation.d.ts +0 -14
- package/dist/generated/abi/DataPortabilityPermissionsImplementation.js +0 -19
- package/dist/generated/abi/DataPortabilityPermissionsImplementation.js.map +1 -1
- package/dist/generated/abi/DataPortabilityServersImplementation.cjs +0 -19
- package/dist/generated/abi/DataPortabilityServersImplementation.cjs.map +1 -1
- package/dist/generated/abi/DataPortabilityServersImplementation.d.ts +0 -14
- package/dist/generated/abi/DataPortabilityServersImplementation.js +0 -19
- package/dist/generated/abi/DataPortabilityServersImplementation.js.map +1 -1
- package/dist/generated/abi/DataRefinerRegistryImplementation.cjs.map +1 -1
- package/dist/generated/abi/DataRefinerRegistryImplementation.js.map +1 -1
- package/dist/generated/abi/DataRegistryImplementation.cjs +0 -13
- package/dist/generated/abi/DataRegistryImplementation.cjs.map +1 -1
- package/dist/generated/abi/DataRegistryImplementation.d.ts +0 -10
- package/dist/generated/abi/DataRegistryImplementation.js +0 -13
- package/dist/generated/abi/DataRegistryImplementation.js.map +1 -1
- package/dist/generated/abi/DatasetRegistryImplementation.cjs +751 -0
- package/dist/generated/abi/DatasetRegistryImplementation.cjs.map +1 -0
- package/dist/generated/abi/DatasetRegistryImplementation.d.ts +557 -0
- package/dist/generated/abi/DatasetRegistryImplementation.js +727 -0
- package/dist/generated/abi/DatasetRegistryImplementation.js.map +1 -0
- package/dist/generated/abi/ProtocolConfigImplementation.cjs +578 -0
- package/dist/generated/abi/ProtocolConfigImplementation.cjs.map +1 -0
- package/dist/generated/abi/ProtocolConfigImplementation.d.ts +423 -0
- package/dist/generated/abi/ProtocolConfigImplementation.js +554 -0
- package/dist/generated/abi/ProtocolConfigImplementation.js.map +1 -0
- package/dist/generated/abi/QueryEngineImplementation.cjs.map +1 -1
- package/dist/generated/abi/QueryEngineImplementation.js.map +1 -1
- package/dist/generated/abi/SwapHelperImplementation.cjs +0 -43
- package/dist/generated/abi/SwapHelperImplementation.cjs.map +1 -1
- package/dist/generated/abi/SwapHelperImplementation.d.ts +0 -35
- package/dist/generated/abi/SwapHelperImplementation.js +0 -43
- package/dist/generated/abi/SwapHelperImplementation.js.map +1 -1
- package/dist/generated/abi/TeePoolDedicatedGpuImplementation.cjs.map +1 -1
- package/dist/generated/abi/TeePoolDedicatedGpuImplementation.js.map +1 -1
- package/dist/generated/abi/TeePoolDedicatedStandardImplementation.cjs.map +1 -1
- package/dist/generated/abi/TeePoolDedicatedStandardImplementation.js.map +1 -1
- package/dist/generated/abi/TeePoolEphemeralStandardImplementation.cjs.map +1 -1
- package/dist/generated/abi/TeePoolEphemeralStandardImplementation.js.map +1 -1
- package/dist/generated/abi/TeePoolPersistentGpuImplementation.cjs.map +1 -1
- package/dist/generated/abi/TeePoolPersistentGpuImplementation.js.map +1 -1
- package/dist/generated/abi/TeePoolPersistentStandardImplementation.cjs.map +1 -1
- package/dist/generated/abi/TeePoolPersistentStandardImplementation.js.map +1 -1
- package/dist/generated/abi/TeePoolPhalaImplementation.cjs.map +1 -1
- package/dist/generated/abi/TeePoolPhalaImplementation.js.map +1 -1
- package/dist/generated/abi/UniswapV3NonfungiblePositionManagerImplementation.cjs +1251 -0
- package/dist/generated/abi/UniswapV3NonfungiblePositionManagerImplementation.cjs.map +1 -0
- package/dist/generated/abi/UniswapV3NonfungiblePositionManagerImplementation.d.ts +948 -0
- package/dist/generated/abi/UniswapV3NonfungiblePositionManagerImplementation.js +1227 -0
- package/dist/generated/abi/UniswapV3NonfungiblePositionManagerImplementation.js.map +1 -0
- package/dist/generated/abi/UniswapV3QuoterV2Implementation.cjs +297 -0
- package/dist/generated/abi/UniswapV3QuoterV2Implementation.cjs.map +1 -0
- package/dist/generated/abi/UniswapV3QuoterV2Implementation.d.ts +206 -0
- package/dist/generated/abi/UniswapV3QuoterV2Implementation.js +273 -0
- package/dist/generated/abi/UniswapV3QuoterV2Implementation.js.map +1 -0
- package/dist/generated/abi/VanaEpochImplementation.cjs +195 -0
- package/dist/generated/abi/VanaEpochImplementation.cjs.map +1 -1
- package/dist/generated/abi/VanaEpochImplementation.d.ts +151 -0
- package/dist/generated/abi/VanaEpochImplementation.js +195 -0
- package/dist/generated/abi/VanaEpochImplementation.js.map +1 -1
- package/dist/generated/abi/VanaPoolEntityImplementation.cjs +22 -65
- package/dist/generated/abi/VanaPoolEntityImplementation.cjs.map +1 -1
- package/dist/generated/abi/VanaPoolEntityImplementation.d.ts +17 -51
- package/dist/generated/abi/VanaPoolEntityImplementation.js +22 -65
- package/dist/generated/abi/VanaPoolEntityImplementation.js.map +1 -1
- package/dist/generated/abi/VanaPoolStakingImplementation.cjs +113 -1
- package/dist/generated/abi/VanaPoolStakingImplementation.cjs.map +1 -1
- package/dist/generated/abi/VanaPoolStakingImplementation.d.ts +85 -1
- package/dist/generated/abi/VanaPoolStakingImplementation.js +113 -1
- package/dist/generated/abi/VanaPoolStakingImplementation.js.map +1 -1
- package/dist/generated/abi/VanaPoolTreasuryImplementation.cjs.map +1 -1
- package/dist/generated/abi/VanaPoolTreasuryImplementation.js.map +1 -1
- package/dist/generated/abi/VanaRuntimePermissionsImplementation.cjs +759 -0
- package/dist/generated/abi/VanaRuntimePermissionsImplementation.cjs.map +1 -0
- package/dist/generated/abi/VanaRuntimePermissionsImplementation.d.ts +563 -0
- package/dist/generated/abi/VanaRuntimePermissionsImplementation.js +735 -0
- package/dist/generated/abi/VanaRuntimePermissionsImplementation.js.map +1 -0
- package/dist/generated/abi/VanaRuntimeServersImplementation.cjs +820 -0
- package/dist/generated/abi/VanaRuntimeServersImplementation.cjs.map +1 -0
- package/dist/generated/abi/VanaRuntimeServersImplementation.d.ts +609 -0
- package/dist/generated/abi/VanaRuntimeServersImplementation.js +796 -0
- package/dist/generated/abi/VanaRuntimeServersImplementation.js.map +1 -0
- package/dist/generated/abi/VanaTreasuryImplementation.cjs +536 -0
- package/dist/generated/abi/VanaTreasuryImplementation.cjs.map +1 -0
- package/dist/generated/abi/VanaTreasuryImplementation.d.ts +393 -0
- package/dist/generated/abi/VanaTreasuryImplementation.js +512 -0
- package/dist/generated/abi/VanaTreasuryImplementation.js.map +1 -0
- package/dist/generated/abi/WVANAImplementation.cjs +339 -0
- package/dist/generated/abi/WVANAImplementation.cjs.map +1 -0
- package/dist/generated/abi/WVANAImplementation.d.ts +244 -0
- package/dist/generated/abi/WVANAImplementation.js +315 -0
- package/dist/generated/abi/WVANAImplementation.js.map +1 -0
- package/dist/generated/abi/index.cjs +79 -47
- package/dist/generated/abi/index.cjs.map +1 -1
- package/dist/generated/abi/index.d.ts +15783 -10449
- package/dist/generated/abi/index.js +65 -43
- package/dist/generated/abi/index.js.map +1 -1
- package/dist/{config → generated}/addresses.cjs +174 -75
- package/dist/generated/addresses.cjs.map +1 -0
- package/dist/{config → generated}/addresses.d.ts +174 -165
- package/dist/{config → generated}/addresses.js +174 -75
- package/dist/generated/addresses.js.map +1 -0
- package/dist/generated/event-types.cjs.map +1 -1
- package/dist/generated/event-types.d.ts +482 -399
- package/dist/generated/eventRegistry.cjs +2601 -724
- package/dist/generated/eventRegistry.cjs.map +1 -1
- package/dist/generated/eventRegistry.d.ts +2 -2
- package/dist/generated/eventRegistry.js +2601 -724
- package/dist/generated/eventRegistry.js.map +1 -1
- package/dist/generated/server/server-exports.cjs +22 -0
- package/dist/generated/server/server-exports.cjs.map +1 -1
- package/dist/generated/server/server-exports.d.ts +31 -11
- package/dist/generated/server/server-exports.js +17 -0
- package/dist/generated/server/server-exports.js.map +1 -1
- package/dist/generated/server/server.cjs.map +1 -1
- package/dist/generated/server/server.d.ts +771 -402
- package/dist/generated/subgraph.cjs +797 -32
- package/dist/generated/subgraph.cjs.map +1 -1
- package/dist/generated/subgraph.d.ts +135 -0
- package/dist/generated/subgraph.js +792 -32
- package/dist/generated/subgraph.js.map +1 -1
- package/dist/index.browser.d.ts +6 -1
- package/dist/index.browser.js +26 -1
- package/dist/index.browser.js.map +1 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.node.cjs +47 -4
- package/dist/index.node.cjs.map +1 -1
- package/dist/index.node.d.ts +60 -14
- package/dist/index.node.js +42 -3
- package/dist/index.node.js.map +1 -1
- package/dist/lib/__tests__/redisAtomicStore.test.d.ts +1 -0
- package/dist/lib/redisAtomicStore.cjs +201 -0
- package/dist/lib/redisAtomicStore.cjs.map +1 -0
- package/dist/lib/redisAtomicStore.d.ts +120 -0
- package/dist/lib/redisAtomicStore.js +177 -0
- package/dist/lib/redisAtomicStore.js.map +1 -0
- package/dist/node.cjs.map +1 -1
- package/dist/node.d.ts +39 -1
- package/dist/node.js.map +1 -1
- package/dist/platform/browser.cjs +160 -2
- package/dist/platform/browser.cjs.map +1 -1
- package/dist/platform/browser.d.ts +232 -12
- package/dist/platform/browser.js +160 -2
- package/dist/platform/browser.js.map +1 -1
- package/dist/platform/interface.cjs.map +1 -1
- package/dist/platform/interface.d.ts +283 -90
- package/dist/platform/node.cjs +163 -2
- package/dist/platform/node.cjs.map +1 -1
- package/dist/platform/node.d.ts +69 -6
- package/dist/platform/node.js +163 -2
- package/dist/platform/node.js.map +1 -1
- package/dist/server/relayerHandler.cjs +452 -0
- package/dist/server/relayerHandler.cjs.map +1 -0
- package/dist/server/relayerHandler.d.ts +69 -0
- package/dist/server/relayerHandler.js +428 -0
- package/dist/server/relayerHandler.js.map +1 -0
- package/dist/storage/index.cjs +3 -0
- package/dist/storage/index.cjs.map +1 -1
- package/dist/storage/index.d.ts +1 -0
- package/dist/storage/index.js +2 -0
- package/dist/storage/index.js.map +1 -1
- package/dist/storage/manager.cjs +108 -25
- package/dist/storage/manager.cjs.map +1 -1
- package/dist/storage/manager.d.ts +119 -25
- package/dist/storage/manager.js +108 -25
- package/dist/storage/manager.js.map +1 -1
- package/dist/storage/providers/callback-storage.cjs +86 -15
- package/dist/storage/providers/callback-storage.cjs.map +1 -1
- package/dist/storage/providers/callback-storage.d.ts +109 -20
- package/dist/storage/providers/callback-storage.js +86 -15
- package/dist/storage/providers/callback-storage.js.map +1 -1
- package/dist/storage/providers/dropbox.cjs +237 -0
- package/dist/storage/providers/dropbox.cjs.map +1 -0
- package/dist/storage/providers/dropbox.d.ts +39 -0
- package/dist/storage/providers/dropbox.js +215 -0
- package/dist/storage/providers/dropbox.js.map +1 -0
- package/dist/storage/providers/dropbox.test.d.ts +1 -0
- package/dist/storage/providers/pinata.cjs.map +1 -1
- package/dist/storage/providers/pinata.d.ts +12 -14
- package/dist/storage/providers/pinata.js.map +1 -1
- package/dist/tests/data-upload-owner-validation.test.d.ts +1 -0
- package/dist/tests/factories/mockFactory.d.ts +6 -6
- package/dist/tests/fakes/FakeWaitForTransactionEvents.d.ts +2 -2
- package/dist/tests/permissions-revoke-relayer.test.d.ts +1 -0
- package/dist/tests/permissions-transaction-options.test.d.ts +1 -0
- package/dist/tests/read-only-mode.test.d.ts +1 -0
- package/dist/tests/relayer-integration.test.d.ts +1 -0
- package/dist/tests/relayer-unified.test.d.ts +1 -0
- package/dist/tests/server-relayer-handler.test.d.ts +1 -0
- package/dist/types/accessSettlement.cjs +17 -0
- package/dist/types/accessSettlement.cjs.map +1 -0
- package/dist/types/accessSettlement.d.ts +66 -0
- package/dist/types/accessSettlement.js +1 -0
- package/dist/types/accessSettlement.js.map +1 -0
- package/dist/types/atomicStore.cjs +31 -0
- package/dist/types/atomicStore.cjs.map +1 -0
- package/dist/types/atomicStore.d.ts +236 -0
- package/dist/types/atomicStore.js +7 -0
- package/dist/types/atomicStore.js.map +1 -0
- package/dist/types/blockchain.cjs.map +1 -1
- package/dist/types/blockchain.d.ts +39 -11
- package/dist/types/chains.cjs.map +1 -1
- package/dist/types/chains.d.ts +74 -7
- package/dist/types/chains.js.map +1 -1
- package/dist/types/config.cjs +10 -0
- package/dist/types/config.cjs.map +1 -1
- package/dist/types/config.d.ts +217 -220
- package/dist/types/config.js +8 -0
- package/dist/types/config.js.map +1 -1
- package/dist/types/contracts.cjs.map +1 -1
- package/dist/types/contracts.d.ts +71 -7
- package/dist/types/controller-context.cjs.map +1 -1
- package/dist/types/controller-context.d.ts +12 -6
- package/dist/types/data.cjs.map +1 -1
- package/dist/types/data.d.ts +82 -10
- package/dist/types/generics.cjs.map +1 -1
- package/dist/types/generics.d.ts +81 -10
- package/dist/types/index.cjs +4 -0
- package/dist/types/index.cjs.map +1 -1
- package/dist/types/index.d.ts +36 -6
- package/dist/types/index.js +9 -1
- package/dist/types/index.js.map +1 -1
- package/dist/types/operationStore.cjs +17 -0
- package/dist/types/operationStore.cjs.map +1 -0
- package/dist/types/operationStore.d.ts +171 -0
- package/dist/types/operationStore.js +1 -0
- package/dist/types/operationStore.js.map +1 -0
- package/dist/types/operations.cjs +3 -15
- package/dist/types/operations.cjs.map +1 -1
- package/dist/types/operations.d.ts +131 -39
- package/dist/types/operations.js +2 -13
- package/dist/types/operations.js.map +1 -1
- package/dist/types/options.cjs +17 -0
- package/dist/types/options.cjs.map +1 -0
- package/dist/types/options.d.ts +308 -0
- package/dist/types/options.js +1 -0
- package/dist/types/options.js.map +1 -0
- package/dist/types/permissions.cjs.map +1 -1
- package/dist/types/permissions.d.ts +19 -20
- package/dist/types/personal.cjs.map +1 -1
- package/dist/types/personal.d.ts +150 -14
- package/dist/types/relayer.cjs.map +1 -1
- package/dist/types/relayer.d.ts +307 -35
- package/dist/types/runtimePermissions.cjs +17 -0
- package/dist/types/runtimePermissions.cjs.map +1 -0
- package/dist/types/runtimePermissions.d.ts +122 -0
- package/dist/types/runtimePermissions.js +1 -0
- package/dist/types/runtimePermissions.js.map +1 -0
- package/dist/types/storage.cjs.map +1 -1
- package/dist/types/storage.d.ts +9 -21
- package/dist/types/storage.js.map +1 -1
- package/dist/types/utils.cjs.map +1 -1
- package/dist/types/utils.d.ts +0 -45
- package/dist/utils/__tests__/chainQuery.test.d.ts +1 -0
- package/dist/utils/__tests__/subgraphConsistency.test.d.ts +4 -0
- package/dist/utils/__tests__/subgraphPagination.test.d.ts +4 -0
- package/dist/utils/blockchain/registry.cjs +3 -3
- package/dist/utils/blockchain/registry.cjs.map +1 -1
- package/dist/utils/blockchain/registry.d.ts +1 -1
- package/dist/utils/blockchain/registry.js +3 -3
- package/dist/utils/blockchain/registry.js.map +1 -1
- package/dist/utils/chainQuery.cjs +107 -0
- package/dist/utils/chainQuery.cjs.map +1 -0
- package/dist/utils/chainQuery.d.ts +31 -0
- package/dist/utils/chainQuery.js +82 -0
- package/dist/utils/chainQuery.js.map +1 -0
- package/dist/utils/grantFiles.cjs +4 -1
- package/dist/utils/grantFiles.cjs.map +1 -1
- package/dist/utils/grantFiles.d.ts +10 -20
- package/dist/utils/grantFiles.js +4 -1
- package/dist/utils/grantFiles.js.map +1 -1
- package/dist/utils/grantValidation.cjs.map +1 -1
- package/dist/utils/grantValidation.d.ts +95 -16
- package/dist/utils/grantValidation.js.map +1 -1
- package/dist/utils/grants.cjs.map +1 -1
- package/dist/utils/grants.d.ts +93 -12
- package/dist/utils/grants.js.map +1 -1
- package/dist/utils/ipfs.cjs +2 -4
- package/dist/utils/ipfs.cjs.map +1 -1
- package/dist/utils/ipfs.d.ts +1 -1
- package/dist/utils/ipfs.js +2 -4
- package/dist/utils/ipfs.js.map +1 -1
- package/dist/utils/lazy-import.cjs.map +1 -1
- package/dist/utils/lazy-import.d.ts +32 -7
- package/dist/utils/lazy-import.js.map +1 -1
- package/dist/utils/multicall.cjs +1 -1
- package/dist/utils/multicall.cjs.map +1 -1
- package/dist/utils/multicall.js +1 -1
- package/dist/utils/multicall.js.map +1 -1
- package/dist/utils/runtimeGrantFiles.cjs +84 -0
- package/dist/utils/runtimeGrantFiles.cjs.map +1 -0
- package/dist/utils/runtimeGrantFiles.d.ts +66 -0
- package/dist/utils/runtimeGrantFiles.js +58 -0
- package/dist/utils/runtimeGrantFiles.js.map +1 -0
- package/dist/utils/signatureCache.cjs +8 -2
- package/dist/utils/signatureCache.cjs.map +1 -1
- package/dist/utils/signatureCache.d.ts +49 -8
- package/dist/utils/signatureCache.js +8 -2
- package/dist/utils/signatureCache.js.map +1 -1
- package/dist/utils/subgraphConsistency.cjs +184 -0
- package/dist/utils/subgraphConsistency.cjs.map +1 -0
- package/dist/utils/subgraphConsistency.d.ts +65 -0
- package/dist/utils/subgraphConsistency.js +155 -0
- package/dist/utils/subgraphConsistency.js.map +1 -0
- package/dist/utils/subgraphMetaCache.cjs +101 -0
- package/dist/utils/subgraphMetaCache.cjs.map +1 -0
- package/dist/utils/subgraphMetaCache.d.ts +56 -0
- package/dist/utils/subgraphMetaCache.js +76 -0
- package/dist/utils/subgraphMetaCache.js.map +1 -0
- package/dist/utils/subgraphPagination.cjs +104 -0
- package/dist/utils/subgraphPagination.cjs.map +1 -0
- package/dist/utils/subgraphPagination.d.ts +78 -0
- package/dist/utils/subgraphPagination.js +78 -0
- package/dist/utils/subgraphPagination.js.map +1 -0
- package/dist/utils/transactionHelpers.cjs.map +1 -1
- package/dist/utils/transactionHelpers.d.ts +12 -12
- package/dist/utils/transactionHelpers.js.map +1 -1
- package/dist/utils/typedDataConverter.cjs.map +1 -1
- package/dist/utils/typedDataConverter.d.ts +39 -3
- package/dist/utils/typedDataConverter.js.map +1 -1
- package/dist/utils/urlResolver.cjs +7 -0
- package/dist/utils/urlResolver.cjs.map +1 -1
- package/dist/utils/urlResolver.d.ts +22 -4
- package/dist/utils/urlResolver.js +7 -0
- package/dist/utils/urlResolver.js.map +1 -1
- package/dist/utils/wallet.cjs +63 -0
- package/dist/utils/wallet.cjs.map +1 -0
- package/dist/utils/wallet.d.ts +94 -0
- package/dist/utils/wallet.js +37 -0
- package/dist/utils/wallet.js.map +1 -0
- package/package.json +7 -2
- package/dist/config/addresses.cjs.map +0 -1
- package/dist/config/addresses.js.map +0 -1
- package/dist/generated/abi/DLPTreasuryImplementation.cjs.map +0 -1
- package/dist/generated/abi/DLPTreasuryImplementation.js.map +0 -1
- package/dist/server/handler.cjs +0 -101
- package/dist/server/handler.cjs.map +0 -1
- package/dist/server/handler.d.ts +0 -87
- package/dist/server/handler.js +0 -77
- package/dist/server/handler.js.map +0 -1
- /package/dist/{tests/server-handler.test.d.ts → client/__tests__/enhancedResponse.test.d.ts} +0 -0
|
@@ -1,18 +1,43 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* Provides lazy module loading to avoid Temporal Dead Zone issues.
|
|
3
3
|
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
4
|
+
* @remarks
|
|
5
|
+
* This module implements a caching lazy import pattern to work around Turbopack's
|
|
6
|
+
* strict module initialization. Dependencies that access globals during initialization
|
|
7
|
+
* must be dynamically imported to prevent TDZ errors in Next.js environments.
|
|
8
|
+
*
|
|
9
|
+
* @see {@link https://github.com/vercel/next.js/issues/82632 | Turbopack TDZ Issue}
|
|
10
|
+
*
|
|
11
|
+
* @category Utilities
|
|
12
|
+
* @module utils/lazy-import
|
|
6
13
|
*/
|
|
7
14
|
/**
|
|
8
|
-
* Creates a lazy import function
|
|
9
|
-
*
|
|
15
|
+
* Creates a cached lazy import function for deferred module loading.
|
|
16
|
+
*
|
|
17
|
+
* @remarks
|
|
18
|
+
* Caches the import promise (not the module) to prevent race conditions
|
|
19
|
+
* during concurrent first calls. On import failure, clears the cache to
|
|
20
|
+
* allow retry on next attempt.
|
|
21
|
+
*
|
|
22
|
+
* @typeParam T - The type of the module being imported
|
|
10
23
|
*
|
|
11
|
-
* @param importFn - Function that returns a dynamic import promise
|
|
12
|
-
*
|
|
24
|
+
* @param importFn - Function that returns a dynamic import promise.
|
|
25
|
+
* Should be a dynamic import expression like `() => import('module')`.
|
|
26
|
+
* @returns A function that returns the cached import promise
|
|
13
27
|
*
|
|
14
28
|
* @example
|
|
29
|
+
* ```typescript
|
|
30
|
+
* // Create lazy loader for heavy crypto library
|
|
15
31
|
* const getOpenPGP = lazyImport(() => import('openpgp'));
|
|
32
|
+
*
|
|
33
|
+
* // Use when needed (first call triggers import)
|
|
16
34
|
* const openpgp = await getOpenPGP();
|
|
35
|
+
* const encrypted = await openpgp.encrypt(data);
|
|
36
|
+
*
|
|
37
|
+
* // Subsequent calls return cached promise
|
|
38
|
+
* const openpgp2 = await getOpenPGP(); // Same instance
|
|
39
|
+
* ```
|
|
40
|
+
*
|
|
41
|
+
* @category Utilities
|
|
17
42
|
*/
|
|
18
43
|
export declare function lazyImport<T>(importFn: () => Promise<T>): () => Promise<T>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/utils/lazy-import.ts"],"sourcesContent":["/**\n *
|
|
1
|
+
{"version":3,"sources":["../../src/utils/lazy-import.ts"],"sourcesContent":["/**\n * Provides lazy module loading to avoid Temporal Dead Zone issues.\n *\n * @remarks\n * This module implements a caching lazy import pattern to work around Turbopack's\n * strict module initialization. Dependencies that access globals during initialization\n * must be dynamically imported to prevent TDZ errors in Next.js environments.\n *\n * @see {@link https://github.com/vercel/next.js/issues/82632 | Turbopack TDZ Issue}\n *\n * @category Utilities\n * @module utils/lazy-import\n */\n\n/**\n * Creates a cached lazy import function for deferred module loading.\n *\n * @remarks\n * Caches the import promise (not the module) to prevent race conditions\n * during concurrent first calls. On import failure, clears the cache to\n * allow retry on next attempt.\n *\n * @typeParam T - The type of the module being imported\n *\n * @param importFn - Function that returns a dynamic import promise.\n * Should be a dynamic import expression like `() => import('module')`.\n * @returns A function that returns the cached import promise\n *\n * @example\n * ```typescript\n * // Create lazy loader for heavy crypto library\n * const getOpenPGP = lazyImport(() => import('openpgp'));\n *\n * // Use when needed (first call triggers import)\n * const openpgp = await getOpenPGP();\n * const encrypted = await openpgp.encrypt(data);\n *\n * // Subsequent calls return cached promise\n * const openpgp2 = await getOpenPGP(); // Same instance\n * ```\n *\n * @category Utilities\n */\nexport function lazyImport<T>(importFn: () => Promise<T>): () => Promise<T> {\n let cached: Promise<T> | null = null;\n\n return () => {\n cached ??= importFn().catch((err) => {\n // Clear cache on error so next attempt can retry\n cached = null;\n throw new Error(\"Failed to load module\", { cause: err });\n });\n return cached;\n };\n}\n"],"mappings":"AA2CO,SAAS,WAAc,UAA8C;AAC1E,MAAI,SAA4B;AAEhC,SAAO,MAAM;AACX,eAAW,SAAS,EAAE,MAAM,CAAC,QAAQ;AAEnC,eAAS;AACT,YAAM,IAAI,MAAM,yBAAyB,EAAE,OAAO,IAAI,CAAC;AAAA,IACzD,CAAC;AACD,WAAO;AAAA,EACT;AACF;","names":[]}
|
package/dist/utils/multicall.cjs
CHANGED
|
@@ -23,7 +23,7 @@ __export(multicall_exports, {
|
|
|
23
23
|
});
|
|
24
24
|
module.exports = __toCommonJS(multicall_exports);
|
|
25
25
|
var import_viem = require("viem");
|
|
26
|
-
var import_addresses = require("../
|
|
26
|
+
var import_addresses = require("../generated/addresses");
|
|
27
27
|
const DEFAULT_OPTIONS = {
|
|
28
28
|
maxGasPerBatch: 10000000n,
|
|
29
29
|
// 10M gas - conservative default
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/utils/multicall.ts"],"sourcesContent":["import type {\n Address,\n PublicClient,\n MulticallParameters,\n MulticallReturnType,\n EncodeFunctionDataParameters,\n Hex,\n Abi,\n} from \"viem\";\nimport { encodeFunctionData, size } from \"viem\";\nimport { getUtilityAddress } from \"../config/addresses\";\nimport type { VanaChainId } from \"../types\";\n\n/**\n * Type for a contract function configuration used in multicall\n */\nexport interface ContractFunctionConfig {\n address: Address;\n abi: Abi;\n functionName: string;\n args?: readonly unknown[];\n}\n\n/**\n * Configuration options for gas-aware multicall batching.\n *\n * @remarks\n * These options control how the multicall utility splits large batches\n * to stay within gas and calldata limits. The defaults are conservative\n * to ensure compatibility across different chains and RPC providers.\n */\nexport interface GasAwareMulticallOptions {\n /**\n * Maximum gas per batch. Defaults to 10M (conservative for most chains).\n *\n * @remarks\n * This should be set below the block gas limit of your target chain.\n * Common values:\n * - Vana mainnet: 30M (use 25M for safety)\n * - Vana moksha: 30M (use 25M for safety)\n * - Ethereum mainnet: 30M (use 25M for safety)\n * - Arbitrum: 32M (use 25M for safety)\n */\n maxGasPerBatch?: bigint;\n\n /**\n * Maximum calldata size per batch in bytes. Defaults to 100KB.\n *\n * @remarks\n * This is particularly important for L2 chains where calldata is expensive.\n * Some RPC providers also have limits on request size.\n */\n maxCalldataBytes?: number;\n\n /**\n * How often to checkpoint gas estimates. Defaults to every 32 calls or 8KB.\n *\n * @remarks\n * More frequent checkpoints give more accurate batching but require more\n * RPC calls for gas estimation. The default balances accuracy vs performance.\n */\n checkpointFrequency?: {\n /** Checkpoint after this many calls */\n calls: number;\n /** Checkpoint after this many bytes of calldata */\n bytes: number;\n };\n\n /**\n * Whether to allow partial batch failures. Defaults to false.\n *\n * @remarks\n * When true, individual call failures won't fail the entire batch.\n * This matches viem's multicall behavior with allowFailure option.\n */\n allowFailure?: boolean;\n\n /**\n * Optional multicall3 contract address override.\n *\n * @remarks\n * By default, uses the standard multicall3 address deployed on most chains:\n * 0xcA11bde05977b3631167028862bE2a173976CA11\n */\n multicallAddress?: Address;\n\n /**\n * Optional callback for tracking batching progress.\n *\n * @remarks\n * Useful for showing progress in UI or debugging batch performance.\n */\n onProgress?: (completed: number, total: number) => void;\n}\n\n/**\n * Internal configuration with defaults applied\n */\ninterface NormalizedOptions {\n maxGasPerBatch: bigint;\n maxCalldataBytes: number;\n checkpointFrequency: {\n calls: number;\n bytes: number;\n };\n allowFailure: boolean;\n multicallAddress: Address;\n onProgress?: (completed: number, total: number) => void;\n}\n\n/**\n * Default configuration values\n */\nconst DEFAULT_OPTIONS: Omit<NormalizedOptions, \"multicallAddress\"> = {\n maxGasPerBatch: 10_000_000n, // 10M gas - conservative default\n maxCalldataBytes: 100_000, // 100KB - works with most RPC providers\n checkpointFrequency: {\n calls: 32,\n bytes: 8192, // 8KB\n },\n allowFailure: false,\n};\n\n/**\n * A gas-aware multicall function that automatically batches calls to stay within limits.\n *\n * @remarks\n * This function extends viem's multicall with intelligent batching based on:\n * - Actual gas costs (via periodic estimateGas calls)\n * - Calldata size limits\n * - Chain-specific constraints\n *\n * It uses a greedy algorithm with periodic checkpoints to efficiently determine\n * optimal batch sizes without making excessive RPC calls.\n *\n * @param client - The viem public client to use for RPC calls\n * @param parameters - The multicall parameters (same as viem's multicall)\n * @param options - Optional configuration for gas-aware batching\n * @returns The aggregated results from all batches\n *\n * @example\n * ```typescript\n * // Basic usage - drop-in replacement for viem's multicall\n * const results = await gasAwareMulticall(publicClient, {\n * contracts: [\n * { address: '0x...', abi: erc20Abi, functionName: 'balanceOf', args: [address1] },\n * { address: '0x...', abi: erc20Abi, functionName: 'balanceOf', args: [address2] },\n * // ... hundreds more calls\n * ]\n * });\n *\n * // With custom limits for a specific chain\n * const results = await gasAwareMulticall(publicClient, {\n * contracts: calls,\n * }, {\n * maxGasPerBatch: 25_000_000n, // 25M for mainnet\n * maxCalldataBytes: 128_000, // 128KB\n * onProgress: (done, total) => console.log(`Progress: ${done}/${total}`)\n * });\n * ```\n */\nexport async function gasAwareMulticall<\n TContracts extends readonly ContractFunctionConfig[],\n TAllowFailure extends boolean = false,\n>(\n client: PublicClient,\n parameters: MulticallParameters<TContracts, TAllowFailure>,\n options: GasAwareMulticallOptions = {},\n): Promise<MulticallReturnType<TContracts, TAllowFailure>> {\n // Get the chain-specific Multicall3 address\n const chainId = await client.getChainId();\n const multicall3Address =\n options.multicallAddress ??\n getUtilityAddress(chainId as VanaChainId, \"Multicall3\");\n\n // Normalize options with defaults\n const opts: NormalizedOptions = {\n ...DEFAULT_OPTIONS,\n ...options,\n multicallAddress: multicall3Address,\n checkpointFrequency: {\n ...DEFAULT_OPTIONS.checkpointFrequency,\n ...options.checkpointFrequency,\n },\n };\n\n // Override allowFailure if specified in parameters\n if (parameters.allowFailure !== undefined) {\n opts.allowFailure = parameters.allowFailure;\n }\n\n const { contracts } = parameters;\n if (!contracts || contracts.length === 0) {\n // TODO(TYPES): Empty array needs to match complex generic return type.\n // Future improvement: Use conditional types to properly type empty results\n // based on TAllowFailure parameter. Consider creating utility type helper.\n return [] as unknown as MulticallReturnType<TContracts, TAllowFailure>;\n }\n\n // Execute batching algorithm\n const batches = await createBatches(\n client,\n contracts as readonly ContractFunctionConfig[],\n opts,\n );\n\n // Execute all batches in parallel\n const batchResults = await Promise.all(\n batches.map((batch, index) => {\n // Report progress if callback provided\n if (opts.onProgress && index > 0) {\n const completed = batches\n .slice(0, index)\n .reduce((sum, b) => sum + b.length, 0);\n opts.onProgress(completed, contracts.length);\n }\n\n // Execute batch using viem's multicall\n return client.multicall({\n ...parameters,\n contracts: batch as typeof contracts,\n multicallAddress: opts.multicallAddress,\n allowFailure: opts.allowFailure,\n });\n }),\n );\n\n // Report final progress\n if (opts.onProgress) {\n opts.onProgress(contracts.length, contracts.length);\n }\n\n // Flatten results\n return batchResults.flat() as MulticallReturnType<TContracts, TAllowFailure>;\n}\n\n/**\n * Creates optimally-sized batches using greedy algorithm with checkpoints.\n *\n * @param client - The viem public client for making RPC calls\n * @param contracts - Array of contract function configurations to batch\n * @param options - Normalized batching options with limits and settings\n * @returns Array of optimally-sized contract function configuration batches\n */\nasync function createBatches(\n client: PublicClient,\n contracts: readonly ContractFunctionConfig[],\n options: NormalizedOptions,\n): Promise<ContractFunctionConfig[][]> {\n const batches: ContractFunctionConfig[][] = [];\n let currentBatch: ContractFunctionConfig[] = [];\n let currentBytes = 0;\n let lastCheckpointIndex = 0;\n let lastCheckpointBytes = 0;\n let lastEstimatedGas = 0n;\n\n for (let i = 0; i < contracts.length; i++) {\n const contract = contracts[i];\n\n // Calculate encoded size for this call\n const encoded = encodeContractCall(contract);\n const callBytes = size(encoded);\n\n // Check if we need a gas checkpoint\n const callsSinceCheckpoint = i - lastCheckpointIndex;\n const bytesSinceCheckpoint = currentBytes - lastCheckpointBytes;\n\n const needsCheckpoint =\n callsSinceCheckpoint >= options.checkpointFrequency.calls ||\n bytesSinceCheckpoint >= options.checkpointFrequency.bytes;\n\n // Perform checkpoint if needed\n if (needsCheckpoint && currentBatch.length > 0) {\n try {\n lastEstimatedGas = await estimateBatchGas(\n client,\n currentBatch,\n options.multicallAddress,\n );\n lastCheckpointIndex = i;\n lastCheckpointBytes = currentBytes;\n } catch (error) {\n // If estimation fails, finalize current batch to be safe\n if (currentBatch.length > 1) {\n // Try with half the batch\n const halfBatch = currentBatch.slice(\n 0,\n Math.floor(currentBatch.length / 2),\n );\n batches.push(halfBatch);\n currentBatch = currentBatch.slice(halfBatch.length);\n currentBytes = calculateBatchSize(currentBatch);\n lastCheckpointIndex = i;\n lastCheckpointBytes = currentBytes;\n lastEstimatedGas = 0n;\n } else {\n // Single call failed, skip it or throw based on allowFailure\n if (!options.allowFailure) {\n throw new Error(\n `Gas estimation failed for call ${i}: ${String(error)}`,\n );\n }\n currentBatch = [];\n currentBytes = 0;\n continue;\n }\n }\n }\n\n // Check if adding this call would exceed limits\n const wouldExceedCalldata =\n currentBytes + callBytes > options.maxCalldataBytes;\n const wouldExceedGas =\n lastEstimatedGas > 0n &&\n estimateNextGas(lastEstimatedGas, callsSinceCheckpoint + 1) >\n options.maxGasPerBatch;\n\n // If we would exceed limits, finalize current batch\n if ((wouldExceedCalldata || wouldExceedGas) && currentBatch.length > 0) {\n batches.push(currentBatch);\n currentBatch = [];\n currentBytes = 0;\n lastCheckpointIndex = i;\n lastCheckpointBytes = 0;\n lastEstimatedGas = 0n;\n }\n\n // Add call to current batch\n currentBatch.push(contract);\n currentBytes += callBytes;\n }\n\n // Add final batch if not empty\n if (currentBatch.length > 0) {\n batches.push(currentBatch);\n }\n\n return batches;\n}\n\n/**\n * Encodes a contract call to measure its calldata size.\n *\n * @param contract - The contract function configuration to encode\n * @returns Hex-encoded function data\n */\nfunction encodeContractCall(contract: ContractFunctionConfig): Hex {\n const { abi, functionName, args } = contract;\n\n return encodeFunctionData({\n abi,\n functionName,\n args,\n } as EncodeFunctionDataParameters);\n}\n\n/**\n * Calculates total encoded size of a batch.\n *\n * @param batch - Array of contract function configurations to measure\n * @returns Total size in bytes of all encoded calls in the batch\n */\nfunction calculateBatchSize(batch: ContractFunctionConfig[]): number {\n return batch.reduce((total, contract) => {\n const encoded = encodeContractCall(contract);\n return total + size(encoded);\n }, 0);\n}\n\n/**\n * Estimates gas for a batch of calls via multicall3.\n *\n * @param client - The viem public client for gas estimation\n * @param batch - Array of contract calls to estimate gas for\n * @param multicallAddress - The multicall3 contract address to use\n * @returns Estimated gas cost for executing the batch\n */\nasync function estimateBatchGas(\n client: PublicClient,\n batch: ContractFunctionConfig[],\n multicallAddress: Address,\n): Promise<bigint> {\n // Encode batch as multicall3 aggregate3 call\n const calls = batch.map((contract) => ({\n target: contract.address,\n allowFailure: false,\n callData: encodeContractCall(contract),\n }));\n\n // Estimate gas for the multicall\n const gas = await client.estimateGas({\n to: multicallAddress,\n data: encodeFunctionData({\n abi: multicall3Abi,\n functionName: \"aggregate3\",\n args: [calls],\n }),\n });\n\n return gas;\n}\n\n/**\n * Extrapolates gas usage for calls added since last checkpoint.\n *\n * @remarks\n * Uses a conservative 1.1x multiplier for safety to account for gas usage variations.\n *\n * @param lastGas - The gas estimate from the last checkpoint\n * @param callsSinceCheckpoint - Number of calls added since the checkpoint\n * @returns Extrapolated gas estimate with safety margin\n */\nfunction estimateNextGas(\n lastGas: bigint,\n callsSinceCheckpoint: number,\n): bigint {\n if (callsSinceCheckpoint === 0) return lastGas;\n\n // Assume linear scaling with safety factor\n const avgGasPerCall = lastGas / BigInt(Math.max(1, callsSinceCheckpoint - 1));\n const estimatedGas = lastGas + avgGasPerCall;\n\n // Apply 10% safety margin\n return (estimatedGas * 110n) / 100n;\n}\n\n/**\n * Minimal multicall3 ABI for gas estimation\n */\nconst multicall3Abi = [\n {\n name: \"aggregate3\",\n type: \"function\",\n stateMutability: \"payable\",\n inputs: [\n {\n name: \"calls\",\n type: \"tuple[]\",\n components: [\n { name: \"target\", type: \"address\" },\n { name: \"allowFailure\", type: \"bool\" },\n { name: \"callData\", type: \"bytes\" },\n ],\n },\n ],\n outputs: [\n {\n name: \"returnData\",\n type: \"tuple[]\",\n components: [\n { name: \"success\", type: \"bool\" },\n { name: \"returnData\", type: \"bytes\" },\n ],\n },\n ],\n },\n] as const;\n\n/**\n * Utility function to analyze calls and predict optimal batch configuration\n *\n * @remarks\n * This function helps determine the best configuration for a specific set of calls\n * by analyzing their characteristics. Useful for optimizing repeated operations.\n *\n * @param contracts - The calls to analyze\n * @returns Suggested configuration based on call analysis\n */\nexport function analyzeCallsForOptimalConfig(\n contracts: readonly ContractFunctionConfig[],\n): Pick<GasAwareMulticallOptions, \"checkpointFrequency\" | \"maxCalldataBytes\"> {\n // Calculate average call size\n const totalBytes = contracts.reduce((sum, contract) => {\n const encoded = encodeContractCall(contract);\n return sum + size(encoded);\n }, 0);\n\n const avgBytesPerCall = totalBytes / contracts.length;\n\n // Suggest checkpoint frequency based on call density\n const checkpointFrequency = {\n calls: avgBytesPerCall > 500 ? 16 : 32, // More frequent for large calls\n bytes: avgBytesPerCall > 500 ? 4096 : 8192,\n };\n\n // Suggest calldata limit based on total size\n // For 1000 calls with small arrays, totalBytes will be much less than 500KB,\n // so use number of contracts as additional signal\n const maxCalldataBytes =\n totalBytes > 50_000 || contracts.length > 500 ? 128_000 : 100_000;\n\n return {\n checkpointFrequency,\n maxCalldataBytes,\n };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AASA,kBAAyC;AACzC,uBAAkC;AAuGlC,MAAM,kBAA+D;AAAA,EACnE,gBAAgB;AAAA;AAAA,EAChB,kBAAkB;AAAA;AAAA,EAClB,qBAAqB;AAAA,IACnB,OAAO;AAAA,IACP,OAAO;AAAA;AAAA,EACT;AAAA,EACA,cAAc;AAChB;AAwCA,eAAsB,kBAIpB,QACA,YACA,UAAoC,CAAC,GACoB;AAEzD,QAAM,UAAU,MAAM,OAAO,WAAW;AACxC,QAAM,oBACJ,QAAQ,wBACR,oCAAkB,SAAwB,YAAY;AAGxD,QAAM,OAA0B;AAAA,IAC9B,GAAG;AAAA,IACH,GAAG;AAAA,IACH,kBAAkB;AAAA,IAClB,qBAAqB;AAAA,MACnB,GAAG,gBAAgB;AAAA,MACnB,GAAG,QAAQ;AAAA,IACb;AAAA,EACF;AAGA,MAAI,WAAW,iBAAiB,QAAW;AACzC,SAAK,eAAe,WAAW;AAAA,EACjC;AAEA,QAAM,EAAE,UAAU,IAAI;AACtB,MAAI,CAAC,aAAa,UAAU,WAAW,GAAG;AAIxC,WAAO,CAAC;AAAA,EACV;AAGA,QAAM,UAAU,MAAM;AAAA,IACpB;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAGA,QAAM,eAAe,MAAM,QAAQ;AAAA,IACjC,QAAQ,IAAI,CAAC,OAAO,UAAU;AAE5B,UAAI,KAAK,cAAc,QAAQ,GAAG;AAChC,cAAM,YAAY,QACf,MAAM,GAAG,KAAK,EACd,OAAO,CAAC,KAAK,MAAM,MAAM,EAAE,QAAQ,CAAC;AACvC,aAAK,WAAW,WAAW,UAAU,MAAM;AAAA,MAC7C;AAGA,aAAO,OAAO,UAAU;AAAA,QACtB,GAAG;AAAA,QACH,WAAW;AAAA,QACX,kBAAkB,KAAK;AAAA,QACvB,cAAc,KAAK;AAAA,MACrB,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAGA,MAAI,KAAK,YAAY;AACnB,SAAK,WAAW,UAAU,QAAQ,UAAU,MAAM;AAAA,EACpD;AAGA,SAAO,aAAa,KAAK;AAC3B;AAUA,eAAe,cACb,QACA,WACA,SACqC;AACrC,QAAM,UAAsC,CAAC;AAC7C,MAAI,eAAyC,CAAC;AAC9C,MAAI,eAAe;AACnB,MAAI,sBAAsB;AAC1B,MAAI,sBAAsB;AAC1B,MAAI,mBAAmB;AAEvB,WAAS,IAAI,GAAG,IAAI,UAAU,QAAQ,KAAK;AACzC,UAAM,WAAW,UAAU,CAAC;AAG5B,UAAM,UAAU,mBAAmB,QAAQ;AAC3C,UAAM,gBAAY,kBAAK,OAAO;AAG9B,UAAM,uBAAuB,IAAI;AACjC,UAAM,uBAAuB,eAAe;AAE5C,UAAM,kBACJ,wBAAwB,QAAQ,oBAAoB,SACpD,wBAAwB,QAAQ,oBAAoB;AAGtD,QAAI,mBAAmB,aAAa,SAAS,GAAG;AAC9C,UAAI;AACF,2BAAmB,MAAM;AAAA,UACvB;AAAA,UACA;AAAA,UACA,QAAQ;AAAA,QACV;AACA,8BAAsB;AACtB,8BAAsB;AAAA,MACxB,SAAS,OAAO;AAEd,YAAI,aAAa,SAAS,GAAG;AAE3B,gBAAM,YAAY,aAAa;AAAA,YAC7B;AAAA,YACA,KAAK,MAAM,aAAa,SAAS,CAAC;AAAA,UACpC;AACA,kBAAQ,KAAK,SAAS;AACtB,yBAAe,aAAa,MAAM,UAAU,MAAM;AAClD,yBAAe,mBAAmB,YAAY;AAC9C,gCAAsB;AACtB,gCAAsB;AACtB,6BAAmB;AAAA,QACrB,OAAO;AAEL,cAAI,CAAC,QAAQ,cAAc;AACzB,kBAAM,IAAI;AAAA,cACR,kCAAkC,CAAC,KAAK,OAAO,KAAK,CAAC;AAAA,YACvD;AAAA,UACF;AACA,yBAAe,CAAC;AAChB,yBAAe;AACf;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAGA,UAAM,sBACJ,eAAe,YAAY,QAAQ;AACrC,UAAM,iBACJ,mBAAmB,MACnB,gBAAgB,kBAAkB,uBAAuB,CAAC,IACxD,QAAQ;AAGZ,SAAK,uBAAuB,mBAAmB,aAAa,SAAS,GAAG;AACtE,cAAQ,KAAK,YAAY;AACzB,qBAAe,CAAC;AAChB,qBAAe;AACf,4BAAsB;AACtB,4BAAsB;AACtB,yBAAmB;AAAA,IACrB;AAGA,iBAAa,KAAK,QAAQ;AAC1B,oBAAgB;AAAA,EAClB;AAGA,MAAI,aAAa,SAAS,GAAG;AAC3B,YAAQ,KAAK,YAAY;AAAA,EAC3B;AAEA,SAAO;AACT;AAQA,SAAS,mBAAmB,UAAuC;AACjE,QAAM,EAAE,KAAK,cAAc,KAAK,IAAI;AAEpC,aAAO,gCAAmB;AAAA,IACxB;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAiC;AACnC;AAQA,SAAS,mBAAmB,OAAyC;AACnE,SAAO,MAAM,OAAO,CAAC,OAAO,aAAa;AACvC,UAAM,UAAU,mBAAmB,QAAQ;AAC3C,WAAO,YAAQ,kBAAK,OAAO;AAAA,EAC7B,GAAG,CAAC;AACN;AAUA,eAAe,iBACb,QACA,OACA,kBACiB;AAEjB,QAAM,QAAQ,MAAM,IAAI,CAAC,cAAc;AAAA,IACrC,QAAQ,SAAS;AAAA,IACjB,cAAc;AAAA,IACd,UAAU,mBAAmB,QAAQ;AAAA,EACvC,EAAE;AAGF,QAAM,MAAM,MAAM,OAAO,YAAY;AAAA,IACnC,IAAI;AAAA,IACJ,UAAM,gCAAmB;AAAA,MACvB,KAAK;AAAA,MACL,cAAc;AAAA,MACd,MAAM,CAAC,KAAK;AAAA,IACd,CAAC;AAAA,EACH,CAAC;AAED,SAAO;AACT;AAYA,SAAS,gBACP,SACA,sBACQ;AACR,MAAI,yBAAyB,EAAG,QAAO;AAGvC,QAAM,gBAAgB,UAAU,OAAO,KAAK,IAAI,GAAG,uBAAuB,CAAC,CAAC;AAC5E,QAAM,eAAe,UAAU;AAG/B,SAAQ,eAAe,OAAQ;AACjC;AAKA,MAAM,gBAAgB;AAAA,EACpB;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,iBAAiB;AAAA,IACjB,QAAQ;AAAA,MACN;AAAA,QACE,MAAM;AAAA,QACN,MAAM;AAAA,QACN,YAAY;AAAA,UACV,EAAE,MAAM,UAAU,MAAM,UAAU;AAAA,UAClC,EAAE,MAAM,gBAAgB,MAAM,OAAO;AAAA,UACrC,EAAE,MAAM,YAAY,MAAM,QAAQ;AAAA,QACpC;AAAA,MACF;AAAA,IACF;AAAA,IACA,SAAS;AAAA,MACP;AAAA,QACE,MAAM;AAAA,QACN,MAAM;AAAA,QACN,YAAY;AAAA,UACV,EAAE,MAAM,WAAW,MAAM,OAAO;AAAA,UAChC,EAAE,MAAM,cAAc,MAAM,QAAQ;AAAA,QACtC;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAYO,SAAS,6BACd,WAC4E;AAE5E,QAAM,aAAa,UAAU,OAAO,CAAC,KAAK,aAAa;AACrD,UAAM,UAAU,mBAAmB,QAAQ;AAC3C,WAAO,UAAM,kBAAK,OAAO;AAAA,EAC3B,GAAG,CAAC;AAEJ,QAAM,kBAAkB,aAAa,UAAU;AAG/C,QAAM,sBAAsB;AAAA,IAC1B,OAAO,kBAAkB,MAAM,KAAK;AAAA;AAAA,IACpC,OAAO,kBAAkB,MAAM,OAAO;AAAA,EACxC;AAKA,QAAM,mBACJ,aAAa,OAAU,UAAU,SAAS,MAAM,QAAU;AAE5D,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../../src/utils/multicall.ts"],"sourcesContent":["import type {\n Address,\n PublicClient,\n MulticallParameters,\n MulticallReturnType,\n EncodeFunctionDataParameters,\n Hex,\n Abi,\n} from \"viem\";\nimport { encodeFunctionData, size } from \"viem\";\nimport { getUtilityAddress } from \"../generated/addresses\";\nimport type { VanaChainId } from \"../types\";\n\n/**\n * Type for a contract function configuration used in multicall\n */\nexport interface ContractFunctionConfig {\n address: Address;\n abi: Abi;\n functionName: string;\n args?: readonly unknown[];\n}\n\n/**\n * Configuration options for gas-aware multicall batching.\n *\n * @remarks\n * These options control how the multicall utility splits large batches\n * to stay within gas and calldata limits. The defaults are conservative\n * to ensure compatibility across different chains and RPC providers.\n */\nexport interface GasAwareMulticallOptions {\n /**\n * Maximum gas per batch. Defaults to 10M (conservative for most chains).\n *\n * @remarks\n * This should be set below the block gas limit of your target chain.\n * Common values:\n * - Vana mainnet: 30M (use 25M for safety)\n * - Vana moksha: 30M (use 25M for safety)\n * - Ethereum mainnet: 30M (use 25M for safety)\n * - Arbitrum: 32M (use 25M for safety)\n */\n maxGasPerBatch?: bigint;\n\n /**\n * Maximum calldata size per batch in bytes. Defaults to 100KB.\n *\n * @remarks\n * This is particularly important for L2 chains where calldata is expensive.\n * Some RPC providers also have limits on request size.\n */\n maxCalldataBytes?: number;\n\n /**\n * How often to checkpoint gas estimates. Defaults to every 32 calls or 8KB.\n *\n * @remarks\n * More frequent checkpoints give more accurate batching but require more\n * RPC calls for gas estimation. The default balances accuracy vs performance.\n */\n checkpointFrequency?: {\n /** Checkpoint after this many calls */\n calls: number;\n /** Checkpoint after this many bytes of calldata */\n bytes: number;\n };\n\n /**\n * Whether to allow partial batch failures. Defaults to false.\n *\n * @remarks\n * When true, individual call failures won't fail the entire batch.\n * This matches viem's multicall behavior with allowFailure option.\n */\n allowFailure?: boolean;\n\n /**\n * Optional multicall3 contract address override.\n *\n * @remarks\n * By default, uses the standard multicall3 address deployed on most chains:\n * 0xcA11bde05977b3631167028862bE2a173976CA11\n */\n multicallAddress?: Address;\n\n /**\n * Optional callback for tracking batching progress.\n *\n * @remarks\n * Useful for showing progress in UI or debugging batch performance.\n */\n onProgress?: (completed: number, total: number) => void;\n}\n\n/**\n * Internal configuration with defaults applied\n */\ninterface NormalizedOptions {\n maxGasPerBatch: bigint;\n maxCalldataBytes: number;\n checkpointFrequency: {\n calls: number;\n bytes: number;\n };\n allowFailure: boolean;\n multicallAddress: Address;\n onProgress?: (completed: number, total: number) => void;\n}\n\n/**\n * Default configuration values\n */\nconst DEFAULT_OPTIONS: Omit<NormalizedOptions, \"multicallAddress\"> = {\n maxGasPerBatch: 10_000_000n, // 10M gas - conservative default\n maxCalldataBytes: 100_000, // 100KB - works with most RPC providers\n checkpointFrequency: {\n calls: 32,\n bytes: 8192, // 8KB\n },\n allowFailure: false,\n};\n\n/**\n * A gas-aware multicall function that automatically batches calls to stay within limits.\n *\n * @remarks\n * This function extends viem's multicall with intelligent batching based on:\n * - Actual gas costs (via periodic estimateGas calls)\n * - Calldata size limits\n * - Chain-specific constraints\n *\n * It uses a greedy algorithm with periodic checkpoints to efficiently determine\n * optimal batch sizes without making excessive RPC calls.\n *\n * @param client - The viem public client to use for RPC calls\n * @param parameters - The multicall parameters (same as viem's multicall)\n * @param options - Optional configuration for gas-aware batching\n * @returns The aggregated results from all batches\n *\n * @example\n * ```typescript\n * // Basic usage - drop-in replacement for viem's multicall\n * const results = await gasAwareMulticall(publicClient, {\n * contracts: [\n * { address: '0x...', abi: erc20Abi, functionName: 'balanceOf', args: [address1] },\n * { address: '0x...', abi: erc20Abi, functionName: 'balanceOf', args: [address2] },\n * // ... hundreds more calls\n * ]\n * });\n *\n * // With custom limits for a specific chain\n * const results = await gasAwareMulticall(publicClient, {\n * contracts: calls,\n * }, {\n * maxGasPerBatch: 25_000_000n, // 25M for mainnet\n * maxCalldataBytes: 128_000, // 128KB\n * onProgress: (done, total) => console.log(`Progress: ${done}/${total}`)\n * });\n * ```\n */\nexport async function gasAwareMulticall<\n TContracts extends readonly ContractFunctionConfig[],\n TAllowFailure extends boolean = false,\n>(\n client: PublicClient,\n parameters: MulticallParameters<TContracts, TAllowFailure>,\n options: GasAwareMulticallOptions = {},\n): Promise<MulticallReturnType<TContracts, TAllowFailure>> {\n // Get the chain-specific Multicall3 address\n const chainId = await client.getChainId();\n const multicall3Address =\n options.multicallAddress ??\n getUtilityAddress(chainId as VanaChainId, \"Multicall3\");\n\n // Normalize options with defaults\n const opts: NormalizedOptions = {\n ...DEFAULT_OPTIONS,\n ...options,\n multicallAddress: multicall3Address,\n checkpointFrequency: {\n ...DEFAULT_OPTIONS.checkpointFrequency,\n ...options.checkpointFrequency,\n },\n };\n\n // Override allowFailure if specified in parameters\n if (parameters.allowFailure !== undefined) {\n opts.allowFailure = parameters.allowFailure;\n }\n\n const { contracts } = parameters;\n if (!contracts || contracts.length === 0) {\n // TODO(TYPES): Empty array needs to match complex generic return type.\n // Future improvement: Use conditional types to properly type empty results\n // based on TAllowFailure parameter. Consider creating utility type helper.\n return [] as unknown as MulticallReturnType<TContracts, TAllowFailure>;\n }\n\n // Execute batching algorithm\n const batches = await createBatches(\n client,\n contracts as readonly ContractFunctionConfig[],\n opts,\n );\n\n // Execute all batches in parallel\n const batchResults = await Promise.all(\n batches.map((batch, index) => {\n // Report progress if callback provided\n if (opts.onProgress && index > 0) {\n const completed = batches\n .slice(0, index)\n .reduce((sum, b) => sum + b.length, 0);\n opts.onProgress(completed, contracts.length);\n }\n\n // Execute batch using viem's multicall\n return client.multicall({\n ...parameters,\n contracts: batch as typeof contracts,\n multicallAddress: opts.multicallAddress,\n allowFailure: opts.allowFailure,\n });\n }),\n );\n\n // Report final progress\n if (opts.onProgress) {\n opts.onProgress(contracts.length, contracts.length);\n }\n\n // Flatten results\n return batchResults.flat() as MulticallReturnType<TContracts, TAllowFailure>;\n}\n\n/**\n * Creates optimally-sized batches using greedy algorithm with checkpoints.\n *\n * @param client - The viem public client for making RPC calls\n * @param contracts - Array of contract function configurations to batch\n * @param options - Normalized batching options with limits and settings\n * @returns Array of optimally-sized contract function configuration batches\n */\nasync function createBatches(\n client: PublicClient,\n contracts: readonly ContractFunctionConfig[],\n options: NormalizedOptions,\n): Promise<ContractFunctionConfig[][]> {\n const batches: ContractFunctionConfig[][] = [];\n let currentBatch: ContractFunctionConfig[] = [];\n let currentBytes = 0;\n let lastCheckpointIndex = 0;\n let lastCheckpointBytes = 0;\n let lastEstimatedGas = 0n;\n\n for (let i = 0; i < contracts.length; i++) {\n const contract = contracts[i];\n\n // Calculate encoded size for this call\n const encoded = encodeContractCall(contract);\n const callBytes = size(encoded);\n\n // Check if we need a gas checkpoint\n const callsSinceCheckpoint = i - lastCheckpointIndex;\n const bytesSinceCheckpoint = currentBytes - lastCheckpointBytes;\n\n const needsCheckpoint =\n callsSinceCheckpoint >= options.checkpointFrequency.calls ||\n bytesSinceCheckpoint >= options.checkpointFrequency.bytes;\n\n // Perform checkpoint if needed\n if (needsCheckpoint && currentBatch.length > 0) {\n try {\n lastEstimatedGas = await estimateBatchGas(\n client,\n currentBatch,\n options.multicallAddress,\n );\n lastCheckpointIndex = i;\n lastCheckpointBytes = currentBytes;\n } catch (error) {\n // If estimation fails, finalize current batch to be safe\n if (currentBatch.length > 1) {\n // Try with half the batch\n const halfBatch = currentBatch.slice(\n 0,\n Math.floor(currentBatch.length / 2),\n );\n batches.push(halfBatch);\n currentBatch = currentBatch.slice(halfBatch.length);\n currentBytes = calculateBatchSize(currentBatch);\n lastCheckpointIndex = i;\n lastCheckpointBytes = currentBytes;\n lastEstimatedGas = 0n;\n } else {\n // Single call failed, skip it or throw based on allowFailure\n if (!options.allowFailure) {\n throw new Error(\n `Gas estimation failed for call ${i}: ${String(error)}`,\n );\n }\n currentBatch = [];\n currentBytes = 0;\n continue;\n }\n }\n }\n\n // Check if adding this call would exceed limits\n const wouldExceedCalldata =\n currentBytes + callBytes > options.maxCalldataBytes;\n const wouldExceedGas =\n lastEstimatedGas > 0n &&\n estimateNextGas(lastEstimatedGas, callsSinceCheckpoint + 1) >\n options.maxGasPerBatch;\n\n // If we would exceed limits, finalize current batch\n if ((wouldExceedCalldata || wouldExceedGas) && currentBatch.length > 0) {\n batches.push(currentBatch);\n currentBatch = [];\n currentBytes = 0;\n lastCheckpointIndex = i;\n lastCheckpointBytes = 0;\n lastEstimatedGas = 0n;\n }\n\n // Add call to current batch\n currentBatch.push(contract);\n currentBytes += callBytes;\n }\n\n // Add final batch if not empty\n if (currentBatch.length > 0) {\n batches.push(currentBatch);\n }\n\n return batches;\n}\n\n/**\n * Encodes a contract call to measure its calldata size.\n *\n * @param contract - The contract function configuration to encode\n * @returns Hex-encoded function data\n */\nfunction encodeContractCall(contract: ContractFunctionConfig): Hex {\n const { abi, functionName, args } = contract;\n\n return encodeFunctionData({\n abi,\n functionName,\n args,\n } as EncodeFunctionDataParameters);\n}\n\n/**\n * Calculates total encoded size of a batch.\n *\n * @param batch - Array of contract function configurations to measure\n * @returns Total size in bytes of all encoded calls in the batch\n */\nfunction calculateBatchSize(batch: ContractFunctionConfig[]): number {\n return batch.reduce((total, contract) => {\n const encoded = encodeContractCall(contract);\n return total + size(encoded);\n }, 0);\n}\n\n/**\n * Estimates gas for a batch of calls via multicall3.\n *\n * @param client - The viem public client for gas estimation\n * @param batch - Array of contract calls to estimate gas for\n * @param multicallAddress - The multicall3 contract address to use\n * @returns Estimated gas cost for executing the batch\n */\nasync function estimateBatchGas(\n client: PublicClient,\n batch: ContractFunctionConfig[],\n multicallAddress: Address,\n): Promise<bigint> {\n // Encode batch as multicall3 aggregate3 call\n const calls = batch.map((contract) => ({\n target: contract.address,\n allowFailure: false,\n callData: encodeContractCall(contract),\n }));\n\n // Estimate gas for the multicall\n const gas = await client.estimateGas({\n to: multicallAddress,\n data: encodeFunctionData({\n abi: multicall3Abi,\n functionName: \"aggregate3\",\n args: [calls],\n }),\n });\n\n return gas;\n}\n\n/**\n * Extrapolates gas usage for calls added since last checkpoint.\n *\n * @remarks\n * Uses a conservative 1.1x multiplier for safety to account for gas usage variations.\n *\n * @param lastGas - The gas estimate from the last checkpoint\n * @param callsSinceCheckpoint - Number of calls added since the checkpoint\n * @returns Extrapolated gas estimate with safety margin\n */\nfunction estimateNextGas(\n lastGas: bigint,\n callsSinceCheckpoint: number,\n): bigint {\n if (callsSinceCheckpoint === 0) return lastGas;\n\n // Assume linear scaling with safety factor\n const avgGasPerCall = lastGas / BigInt(Math.max(1, callsSinceCheckpoint - 1));\n const estimatedGas = lastGas + avgGasPerCall;\n\n // Apply 10% safety margin\n return (estimatedGas * 110n) / 100n;\n}\n\n/**\n * Minimal multicall3 ABI for gas estimation\n */\nconst multicall3Abi = [\n {\n name: \"aggregate3\",\n type: \"function\",\n stateMutability: \"payable\",\n inputs: [\n {\n name: \"calls\",\n type: \"tuple[]\",\n components: [\n { name: \"target\", type: \"address\" },\n { name: \"allowFailure\", type: \"bool\" },\n { name: \"callData\", type: \"bytes\" },\n ],\n },\n ],\n outputs: [\n {\n name: \"returnData\",\n type: \"tuple[]\",\n components: [\n { name: \"success\", type: \"bool\" },\n { name: \"returnData\", type: \"bytes\" },\n ],\n },\n ],\n },\n] as const;\n\n/**\n * Utility function to analyze calls and predict optimal batch configuration\n *\n * @remarks\n * This function helps determine the best configuration for a specific set of calls\n * by analyzing their characteristics. Useful for optimizing repeated operations.\n *\n * @param contracts - The calls to analyze\n * @returns Suggested configuration based on call analysis\n */\nexport function analyzeCallsForOptimalConfig(\n contracts: readonly ContractFunctionConfig[],\n): Pick<GasAwareMulticallOptions, \"checkpointFrequency\" | \"maxCalldataBytes\"> {\n // Calculate average call size\n const totalBytes = contracts.reduce((sum, contract) => {\n const encoded = encodeContractCall(contract);\n return sum + size(encoded);\n }, 0);\n\n const avgBytesPerCall = totalBytes / contracts.length;\n\n // Suggest checkpoint frequency based on call density\n const checkpointFrequency = {\n calls: avgBytesPerCall > 500 ? 16 : 32, // More frequent for large calls\n bytes: avgBytesPerCall > 500 ? 4096 : 8192,\n };\n\n // Suggest calldata limit based on total size\n // For 1000 calls with small arrays, totalBytes will be much less than 500KB,\n // so use number of contracts as additional signal\n const maxCalldataBytes =\n totalBytes > 50_000 || contracts.length > 500 ? 128_000 : 100_000;\n\n return {\n checkpointFrequency,\n maxCalldataBytes,\n };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AASA,kBAAyC;AACzC,uBAAkC;AAuGlC,MAAM,kBAA+D;AAAA,EACnE,gBAAgB;AAAA;AAAA,EAChB,kBAAkB;AAAA;AAAA,EAClB,qBAAqB;AAAA,IACnB,OAAO;AAAA,IACP,OAAO;AAAA;AAAA,EACT;AAAA,EACA,cAAc;AAChB;AAwCA,eAAsB,kBAIpB,QACA,YACA,UAAoC,CAAC,GACoB;AAEzD,QAAM,UAAU,MAAM,OAAO,WAAW;AACxC,QAAM,oBACJ,QAAQ,wBACR,oCAAkB,SAAwB,YAAY;AAGxD,QAAM,OAA0B;AAAA,IAC9B,GAAG;AAAA,IACH,GAAG;AAAA,IACH,kBAAkB;AAAA,IAClB,qBAAqB;AAAA,MACnB,GAAG,gBAAgB;AAAA,MACnB,GAAG,QAAQ;AAAA,IACb;AAAA,EACF;AAGA,MAAI,WAAW,iBAAiB,QAAW;AACzC,SAAK,eAAe,WAAW;AAAA,EACjC;AAEA,QAAM,EAAE,UAAU,IAAI;AACtB,MAAI,CAAC,aAAa,UAAU,WAAW,GAAG;AAIxC,WAAO,CAAC;AAAA,EACV;AAGA,QAAM,UAAU,MAAM;AAAA,IACpB;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAGA,QAAM,eAAe,MAAM,QAAQ;AAAA,IACjC,QAAQ,IAAI,CAAC,OAAO,UAAU;AAE5B,UAAI,KAAK,cAAc,QAAQ,GAAG;AAChC,cAAM,YAAY,QACf,MAAM,GAAG,KAAK,EACd,OAAO,CAAC,KAAK,MAAM,MAAM,EAAE,QAAQ,CAAC;AACvC,aAAK,WAAW,WAAW,UAAU,MAAM;AAAA,MAC7C;AAGA,aAAO,OAAO,UAAU;AAAA,QACtB,GAAG;AAAA,QACH,WAAW;AAAA,QACX,kBAAkB,KAAK;AAAA,QACvB,cAAc,KAAK;AAAA,MACrB,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAGA,MAAI,KAAK,YAAY;AACnB,SAAK,WAAW,UAAU,QAAQ,UAAU,MAAM;AAAA,EACpD;AAGA,SAAO,aAAa,KAAK;AAC3B;AAUA,eAAe,cACb,QACA,WACA,SACqC;AACrC,QAAM,UAAsC,CAAC;AAC7C,MAAI,eAAyC,CAAC;AAC9C,MAAI,eAAe;AACnB,MAAI,sBAAsB;AAC1B,MAAI,sBAAsB;AAC1B,MAAI,mBAAmB;AAEvB,WAAS,IAAI,GAAG,IAAI,UAAU,QAAQ,KAAK;AACzC,UAAM,WAAW,UAAU,CAAC;AAG5B,UAAM,UAAU,mBAAmB,QAAQ;AAC3C,UAAM,gBAAY,kBAAK,OAAO;AAG9B,UAAM,uBAAuB,IAAI;AACjC,UAAM,uBAAuB,eAAe;AAE5C,UAAM,kBACJ,wBAAwB,QAAQ,oBAAoB,SACpD,wBAAwB,QAAQ,oBAAoB;AAGtD,QAAI,mBAAmB,aAAa,SAAS,GAAG;AAC9C,UAAI;AACF,2BAAmB,MAAM;AAAA,UACvB;AAAA,UACA;AAAA,UACA,QAAQ;AAAA,QACV;AACA,8BAAsB;AACtB,8BAAsB;AAAA,MACxB,SAAS,OAAO;AAEd,YAAI,aAAa,SAAS,GAAG;AAE3B,gBAAM,YAAY,aAAa;AAAA,YAC7B;AAAA,YACA,KAAK,MAAM,aAAa,SAAS,CAAC;AAAA,UACpC;AACA,kBAAQ,KAAK,SAAS;AACtB,yBAAe,aAAa,MAAM,UAAU,MAAM;AAClD,yBAAe,mBAAmB,YAAY;AAC9C,gCAAsB;AACtB,gCAAsB;AACtB,6BAAmB;AAAA,QACrB,OAAO;AAEL,cAAI,CAAC,QAAQ,cAAc;AACzB,kBAAM,IAAI;AAAA,cACR,kCAAkC,CAAC,KAAK,OAAO,KAAK,CAAC;AAAA,YACvD;AAAA,UACF;AACA,yBAAe,CAAC;AAChB,yBAAe;AACf;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAGA,UAAM,sBACJ,eAAe,YAAY,QAAQ;AACrC,UAAM,iBACJ,mBAAmB,MACnB,gBAAgB,kBAAkB,uBAAuB,CAAC,IACxD,QAAQ;AAGZ,SAAK,uBAAuB,mBAAmB,aAAa,SAAS,GAAG;AACtE,cAAQ,KAAK,YAAY;AACzB,qBAAe,CAAC;AAChB,qBAAe;AACf,4BAAsB;AACtB,4BAAsB;AACtB,yBAAmB;AAAA,IACrB;AAGA,iBAAa,KAAK,QAAQ;AAC1B,oBAAgB;AAAA,EAClB;AAGA,MAAI,aAAa,SAAS,GAAG;AAC3B,YAAQ,KAAK,YAAY;AAAA,EAC3B;AAEA,SAAO;AACT;AAQA,SAAS,mBAAmB,UAAuC;AACjE,QAAM,EAAE,KAAK,cAAc,KAAK,IAAI;AAEpC,aAAO,gCAAmB;AAAA,IACxB;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAiC;AACnC;AAQA,SAAS,mBAAmB,OAAyC;AACnE,SAAO,MAAM,OAAO,CAAC,OAAO,aAAa;AACvC,UAAM,UAAU,mBAAmB,QAAQ;AAC3C,WAAO,YAAQ,kBAAK,OAAO;AAAA,EAC7B,GAAG,CAAC;AACN;AAUA,eAAe,iBACb,QACA,OACA,kBACiB;AAEjB,QAAM,QAAQ,MAAM,IAAI,CAAC,cAAc;AAAA,IACrC,QAAQ,SAAS;AAAA,IACjB,cAAc;AAAA,IACd,UAAU,mBAAmB,QAAQ;AAAA,EACvC,EAAE;AAGF,QAAM,MAAM,MAAM,OAAO,YAAY;AAAA,IACnC,IAAI;AAAA,IACJ,UAAM,gCAAmB;AAAA,MACvB,KAAK;AAAA,MACL,cAAc;AAAA,MACd,MAAM,CAAC,KAAK;AAAA,IACd,CAAC;AAAA,EACH,CAAC;AAED,SAAO;AACT;AAYA,SAAS,gBACP,SACA,sBACQ;AACR,MAAI,yBAAyB,EAAG,QAAO;AAGvC,QAAM,gBAAgB,UAAU,OAAO,KAAK,IAAI,GAAG,uBAAuB,CAAC,CAAC;AAC5E,QAAM,eAAe,UAAU;AAG/B,SAAQ,eAAe,OAAQ;AACjC;AAKA,MAAM,gBAAgB;AAAA,EACpB;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,iBAAiB;AAAA,IACjB,QAAQ;AAAA,MACN;AAAA,QACE,MAAM;AAAA,QACN,MAAM;AAAA,QACN,YAAY;AAAA,UACV,EAAE,MAAM,UAAU,MAAM,UAAU;AAAA,UAClC,EAAE,MAAM,gBAAgB,MAAM,OAAO;AAAA,UACrC,EAAE,MAAM,YAAY,MAAM,QAAQ;AAAA,QACpC;AAAA,MACF;AAAA,IACF;AAAA,IACA,SAAS;AAAA,MACP;AAAA,QACE,MAAM;AAAA,QACN,MAAM;AAAA,QACN,YAAY;AAAA,UACV,EAAE,MAAM,WAAW,MAAM,OAAO;AAAA,UAChC,EAAE,MAAM,cAAc,MAAM,QAAQ;AAAA,QACtC;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAYO,SAAS,6BACd,WAC4E;AAE5E,QAAM,aAAa,UAAU,OAAO,CAAC,KAAK,aAAa;AACrD,UAAM,UAAU,mBAAmB,QAAQ;AAC3C,WAAO,UAAM,kBAAK,OAAO;AAAA,EAC3B,GAAG,CAAC;AAEJ,QAAM,kBAAkB,aAAa,UAAU;AAG/C,QAAM,sBAAsB;AAAA,IAC1B,OAAO,kBAAkB,MAAM,KAAK;AAAA;AAAA,IACpC,OAAO,kBAAkB,MAAM,OAAO;AAAA,EACxC;AAKA,QAAM,mBACJ,aAAa,OAAU,UAAU,SAAS,MAAM,QAAU;AAE5D,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;","names":[]}
|
package/dist/utils/multicall.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/utils/multicall.ts"],"sourcesContent":["import type {\n Address,\n PublicClient,\n MulticallParameters,\n MulticallReturnType,\n EncodeFunctionDataParameters,\n Hex,\n Abi,\n} from \"viem\";\nimport { encodeFunctionData, size } from \"viem\";\nimport { getUtilityAddress } from \"../config/addresses\";\nimport type { VanaChainId } from \"../types\";\n\n/**\n * Type for a contract function configuration used in multicall\n */\nexport interface ContractFunctionConfig {\n address: Address;\n abi: Abi;\n functionName: string;\n args?: readonly unknown[];\n}\n\n/**\n * Configuration options for gas-aware multicall batching.\n *\n * @remarks\n * These options control how the multicall utility splits large batches\n * to stay within gas and calldata limits. The defaults are conservative\n * to ensure compatibility across different chains and RPC providers.\n */\nexport interface GasAwareMulticallOptions {\n /**\n * Maximum gas per batch. Defaults to 10M (conservative for most chains).\n *\n * @remarks\n * This should be set below the block gas limit of your target chain.\n * Common values:\n * - Vana mainnet: 30M (use 25M for safety)\n * - Vana moksha: 30M (use 25M for safety)\n * - Ethereum mainnet: 30M (use 25M for safety)\n * - Arbitrum: 32M (use 25M for safety)\n */\n maxGasPerBatch?: bigint;\n\n /**\n * Maximum calldata size per batch in bytes. Defaults to 100KB.\n *\n * @remarks\n * This is particularly important for L2 chains where calldata is expensive.\n * Some RPC providers also have limits on request size.\n */\n maxCalldataBytes?: number;\n\n /**\n * How often to checkpoint gas estimates. Defaults to every 32 calls or 8KB.\n *\n * @remarks\n * More frequent checkpoints give more accurate batching but require more\n * RPC calls for gas estimation. The default balances accuracy vs performance.\n */\n checkpointFrequency?: {\n /** Checkpoint after this many calls */\n calls: number;\n /** Checkpoint after this many bytes of calldata */\n bytes: number;\n };\n\n /**\n * Whether to allow partial batch failures. Defaults to false.\n *\n * @remarks\n * When true, individual call failures won't fail the entire batch.\n * This matches viem's multicall behavior with allowFailure option.\n */\n allowFailure?: boolean;\n\n /**\n * Optional multicall3 contract address override.\n *\n * @remarks\n * By default, uses the standard multicall3 address deployed on most chains:\n * 0xcA11bde05977b3631167028862bE2a173976CA11\n */\n multicallAddress?: Address;\n\n /**\n * Optional callback for tracking batching progress.\n *\n * @remarks\n * Useful for showing progress in UI or debugging batch performance.\n */\n onProgress?: (completed: number, total: number) => void;\n}\n\n/**\n * Internal configuration with defaults applied\n */\ninterface NormalizedOptions {\n maxGasPerBatch: bigint;\n maxCalldataBytes: number;\n checkpointFrequency: {\n calls: number;\n bytes: number;\n };\n allowFailure: boolean;\n multicallAddress: Address;\n onProgress?: (completed: number, total: number) => void;\n}\n\n/**\n * Default configuration values\n */\nconst DEFAULT_OPTIONS: Omit<NormalizedOptions, \"multicallAddress\"> = {\n maxGasPerBatch: 10_000_000n, // 10M gas - conservative default\n maxCalldataBytes: 100_000, // 100KB - works with most RPC providers\n checkpointFrequency: {\n calls: 32,\n bytes: 8192, // 8KB\n },\n allowFailure: false,\n};\n\n/**\n * A gas-aware multicall function that automatically batches calls to stay within limits.\n *\n * @remarks\n * This function extends viem's multicall with intelligent batching based on:\n * - Actual gas costs (via periodic estimateGas calls)\n * - Calldata size limits\n * - Chain-specific constraints\n *\n * It uses a greedy algorithm with periodic checkpoints to efficiently determine\n * optimal batch sizes without making excessive RPC calls.\n *\n * @param client - The viem public client to use for RPC calls\n * @param parameters - The multicall parameters (same as viem's multicall)\n * @param options - Optional configuration for gas-aware batching\n * @returns The aggregated results from all batches\n *\n * @example\n * ```typescript\n * // Basic usage - drop-in replacement for viem's multicall\n * const results = await gasAwareMulticall(publicClient, {\n * contracts: [\n * { address: '0x...', abi: erc20Abi, functionName: 'balanceOf', args: [address1] },\n * { address: '0x...', abi: erc20Abi, functionName: 'balanceOf', args: [address2] },\n * // ... hundreds more calls\n * ]\n * });\n *\n * // With custom limits for a specific chain\n * const results = await gasAwareMulticall(publicClient, {\n * contracts: calls,\n * }, {\n * maxGasPerBatch: 25_000_000n, // 25M for mainnet\n * maxCalldataBytes: 128_000, // 128KB\n * onProgress: (done, total) => console.log(`Progress: ${done}/${total}`)\n * });\n * ```\n */\nexport async function gasAwareMulticall<\n TContracts extends readonly ContractFunctionConfig[],\n TAllowFailure extends boolean = false,\n>(\n client: PublicClient,\n parameters: MulticallParameters<TContracts, TAllowFailure>,\n options: GasAwareMulticallOptions = {},\n): Promise<MulticallReturnType<TContracts, TAllowFailure>> {\n // Get the chain-specific Multicall3 address\n const chainId = await client.getChainId();\n const multicall3Address =\n options.multicallAddress ??\n getUtilityAddress(chainId as VanaChainId, \"Multicall3\");\n\n // Normalize options with defaults\n const opts: NormalizedOptions = {\n ...DEFAULT_OPTIONS,\n ...options,\n multicallAddress: multicall3Address,\n checkpointFrequency: {\n ...DEFAULT_OPTIONS.checkpointFrequency,\n ...options.checkpointFrequency,\n },\n };\n\n // Override allowFailure if specified in parameters\n if (parameters.allowFailure !== undefined) {\n opts.allowFailure = parameters.allowFailure;\n }\n\n const { contracts } = parameters;\n if (!contracts || contracts.length === 0) {\n // TODO(TYPES): Empty array needs to match complex generic return type.\n // Future improvement: Use conditional types to properly type empty results\n // based on TAllowFailure parameter. Consider creating utility type helper.\n return [] as unknown as MulticallReturnType<TContracts, TAllowFailure>;\n }\n\n // Execute batching algorithm\n const batches = await createBatches(\n client,\n contracts as readonly ContractFunctionConfig[],\n opts,\n );\n\n // Execute all batches in parallel\n const batchResults = await Promise.all(\n batches.map((batch, index) => {\n // Report progress if callback provided\n if (opts.onProgress && index > 0) {\n const completed = batches\n .slice(0, index)\n .reduce((sum, b) => sum + b.length, 0);\n opts.onProgress(completed, contracts.length);\n }\n\n // Execute batch using viem's multicall\n return client.multicall({\n ...parameters,\n contracts: batch as typeof contracts,\n multicallAddress: opts.multicallAddress,\n allowFailure: opts.allowFailure,\n });\n }),\n );\n\n // Report final progress\n if (opts.onProgress) {\n opts.onProgress(contracts.length, contracts.length);\n }\n\n // Flatten results\n return batchResults.flat() as MulticallReturnType<TContracts, TAllowFailure>;\n}\n\n/**\n * Creates optimally-sized batches using greedy algorithm with checkpoints.\n *\n * @param client - The viem public client for making RPC calls\n * @param contracts - Array of contract function configurations to batch\n * @param options - Normalized batching options with limits and settings\n * @returns Array of optimally-sized contract function configuration batches\n */\nasync function createBatches(\n client: PublicClient,\n contracts: readonly ContractFunctionConfig[],\n options: NormalizedOptions,\n): Promise<ContractFunctionConfig[][]> {\n const batches: ContractFunctionConfig[][] = [];\n let currentBatch: ContractFunctionConfig[] = [];\n let currentBytes = 0;\n let lastCheckpointIndex = 0;\n let lastCheckpointBytes = 0;\n let lastEstimatedGas = 0n;\n\n for (let i = 0; i < contracts.length; i++) {\n const contract = contracts[i];\n\n // Calculate encoded size for this call\n const encoded = encodeContractCall(contract);\n const callBytes = size(encoded);\n\n // Check if we need a gas checkpoint\n const callsSinceCheckpoint = i - lastCheckpointIndex;\n const bytesSinceCheckpoint = currentBytes - lastCheckpointBytes;\n\n const needsCheckpoint =\n callsSinceCheckpoint >= options.checkpointFrequency.calls ||\n bytesSinceCheckpoint >= options.checkpointFrequency.bytes;\n\n // Perform checkpoint if needed\n if (needsCheckpoint && currentBatch.length > 0) {\n try {\n lastEstimatedGas = await estimateBatchGas(\n client,\n currentBatch,\n options.multicallAddress,\n );\n lastCheckpointIndex = i;\n lastCheckpointBytes = currentBytes;\n } catch (error) {\n // If estimation fails, finalize current batch to be safe\n if (currentBatch.length > 1) {\n // Try with half the batch\n const halfBatch = currentBatch.slice(\n 0,\n Math.floor(currentBatch.length / 2),\n );\n batches.push(halfBatch);\n currentBatch = currentBatch.slice(halfBatch.length);\n currentBytes = calculateBatchSize(currentBatch);\n lastCheckpointIndex = i;\n lastCheckpointBytes = currentBytes;\n lastEstimatedGas = 0n;\n } else {\n // Single call failed, skip it or throw based on allowFailure\n if (!options.allowFailure) {\n throw new Error(\n `Gas estimation failed for call ${i}: ${String(error)}`,\n );\n }\n currentBatch = [];\n currentBytes = 0;\n continue;\n }\n }\n }\n\n // Check if adding this call would exceed limits\n const wouldExceedCalldata =\n currentBytes + callBytes > options.maxCalldataBytes;\n const wouldExceedGas =\n lastEstimatedGas > 0n &&\n estimateNextGas(lastEstimatedGas, callsSinceCheckpoint + 1) >\n options.maxGasPerBatch;\n\n // If we would exceed limits, finalize current batch\n if ((wouldExceedCalldata || wouldExceedGas) && currentBatch.length > 0) {\n batches.push(currentBatch);\n currentBatch = [];\n currentBytes = 0;\n lastCheckpointIndex = i;\n lastCheckpointBytes = 0;\n lastEstimatedGas = 0n;\n }\n\n // Add call to current batch\n currentBatch.push(contract);\n currentBytes += callBytes;\n }\n\n // Add final batch if not empty\n if (currentBatch.length > 0) {\n batches.push(currentBatch);\n }\n\n return batches;\n}\n\n/**\n * Encodes a contract call to measure its calldata size.\n *\n * @param contract - The contract function configuration to encode\n * @returns Hex-encoded function data\n */\nfunction encodeContractCall(contract: ContractFunctionConfig): Hex {\n const { abi, functionName, args } = contract;\n\n return encodeFunctionData({\n abi,\n functionName,\n args,\n } as EncodeFunctionDataParameters);\n}\n\n/**\n * Calculates total encoded size of a batch.\n *\n * @param batch - Array of contract function configurations to measure\n * @returns Total size in bytes of all encoded calls in the batch\n */\nfunction calculateBatchSize(batch: ContractFunctionConfig[]): number {\n return batch.reduce((total, contract) => {\n const encoded = encodeContractCall(contract);\n return total + size(encoded);\n }, 0);\n}\n\n/**\n * Estimates gas for a batch of calls via multicall3.\n *\n * @param client - The viem public client for gas estimation\n * @param batch - Array of contract calls to estimate gas for\n * @param multicallAddress - The multicall3 contract address to use\n * @returns Estimated gas cost for executing the batch\n */\nasync function estimateBatchGas(\n client: PublicClient,\n batch: ContractFunctionConfig[],\n multicallAddress: Address,\n): Promise<bigint> {\n // Encode batch as multicall3 aggregate3 call\n const calls = batch.map((contract) => ({\n target: contract.address,\n allowFailure: false,\n callData: encodeContractCall(contract),\n }));\n\n // Estimate gas for the multicall\n const gas = await client.estimateGas({\n to: multicallAddress,\n data: encodeFunctionData({\n abi: multicall3Abi,\n functionName: \"aggregate3\",\n args: [calls],\n }),\n });\n\n return gas;\n}\n\n/**\n * Extrapolates gas usage for calls added since last checkpoint.\n *\n * @remarks\n * Uses a conservative 1.1x multiplier for safety to account for gas usage variations.\n *\n * @param lastGas - The gas estimate from the last checkpoint\n * @param callsSinceCheckpoint - Number of calls added since the checkpoint\n * @returns Extrapolated gas estimate with safety margin\n */\nfunction estimateNextGas(\n lastGas: bigint,\n callsSinceCheckpoint: number,\n): bigint {\n if (callsSinceCheckpoint === 0) return lastGas;\n\n // Assume linear scaling with safety factor\n const avgGasPerCall = lastGas / BigInt(Math.max(1, callsSinceCheckpoint - 1));\n const estimatedGas = lastGas + avgGasPerCall;\n\n // Apply 10% safety margin\n return (estimatedGas * 110n) / 100n;\n}\n\n/**\n * Minimal multicall3 ABI for gas estimation\n */\nconst multicall3Abi = [\n {\n name: \"aggregate3\",\n type: \"function\",\n stateMutability: \"payable\",\n inputs: [\n {\n name: \"calls\",\n type: \"tuple[]\",\n components: [\n { name: \"target\", type: \"address\" },\n { name: \"allowFailure\", type: \"bool\" },\n { name: \"callData\", type: \"bytes\" },\n ],\n },\n ],\n outputs: [\n {\n name: \"returnData\",\n type: \"tuple[]\",\n components: [\n { name: \"success\", type: \"bool\" },\n { name: \"returnData\", type: \"bytes\" },\n ],\n },\n ],\n },\n] as const;\n\n/**\n * Utility function to analyze calls and predict optimal batch configuration\n *\n * @remarks\n * This function helps determine the best configuration for a specific set of calls\n * by analyzing their characteristics. Useful for optimizing repeated operations.\n *\n * @param contracts - The calls to analyze\n * @returns Suggested configuration based on call analysis\n */\nexport function analyzeCallsForOptimalConfig(\n contracts: readonly ContractFunctionConfig[],\n): Pick<GasAwareMulticallOptions, \"checkpointFrequency\" | \"maxCalldataBytes\"> {\n // Calculate average call size\n const totalBytes = contracts.reduce((sum, contract) => {\n const encoded = encodeContractCall(contract);\n return sum + size(encoded);\n }, 0);\n\n const avgBytesPerCall = totalBytes / contracts.length;\n\n // Suggest checkpoint frequency based on call density\n const checkpointFrequency = {\n calls: avgBytesPerCall > 500 ? 16 : 32, // More frequent for large calls\n bytes: avgBytesPerCall > 500 ? 4096 : 8192,\n };\n\n // Suggest calldata limit based on total size\n // For 1000 calls with small arrays, totalBytes will be much less than 500KB,\n // so use number of contracts as additional signal\n const maxCalldataBytes =\n totalBytes > 50_000 || contracts.length > 500 ? 128_000 : 100_000;\n\n return {\n checkpointFrequency,\n maxCalldataBytes,\n };\n}\n"],"mappings":"AASA,SAAS,oBAAoB,YAAY;AACzC,SAAS,yBAAyB;AAuGlC,MAAM,kBAA+D;AAAA,EACnE,gBAAgB;AAAA;AAAA,EAChB,kBAAkB;AAAA;AAAA,EAClB,qBAAqB;AAAA,IACnB,OAAO;AAAA,IACP,OAAO;AAAA;AAAA,EACT;AAAA,EACA,cAAc;AAChB;AAwCA,eAAsB,kBAIpB,QACA,YACA,UAAoC,CAAC,GACoB;AAEzD,QAAM,UAAU,MAAM,OAAO,WAAW;AACxC,QAAM,oBACJ,QAAQ,oBACR,kBAAkB,SAAwB,YAAY;AAGxD,QAAM,OAA0B;AAAA,IAC9B,GAAG;AAAA,IACH,GAAG;AAAA,IACH,kBAAkB;AAAA,IAClB,qBAAqB;AAAA,MACnB,GAAG,gBAAgB;AAAA,MACnB,GAAG,QAAQ;AAAA,IACb;AAAA,EACF;AAGA,MAAI,WAAW,iBAAiB,QAAW;AACzC,SAAK,eAAe,WAAW;AAAA,EACjC;AAEA,QAAM,EAAE,UAAU,IAAI;AACtB,MAAI,CAAC,aAAa,UAAU,WAAW,GAAG;AAIxC,WAAO,CAAC;AAAA,EACV;AAGA,QAAM,UAAU,MAAM;AAAA,IACpB;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAGA,QAAM,eAAe,MAAM,QAAQ;AAAA,IACjC,QAAQ,IAAI,CAAC,OAAO,UAAU;AAE5B,UAAI,KAAK,cAAc,QAAQ,GAAG;AAChC,cAAM,YAAY,QACf,MAAM,GAAG,KAAK,EACd,OAAO,CAAC,KAAK,MAAM,MAAM,EAAE,QAAQ,CAAC;AACvC,aAAK,WAAW,WAAW,UAAU,MAAM;AAAA,MAC7C;AAGA,aAAO,OAAO,UAAU;AAAA,QACtB,GAAG;AAAA,QACH,WAAW;AAAA,QACX,kBAAkB,KAAK;AAAA,QACvB,cAAc,KAAK;AAAA,MACrB,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAGA,MAAI,KAAK,YAAY;AACnB,SAAK,WAAW,UAAU,QAAQ,UAAU,MAAM;AAAA,EACpD;AAGA,SAAO,aAAa,KAAK;AAC3B;AAUA,eAAe,cACb,QACA,WACA,SACqC;AACrC,QAAM,UAAsC,CAAC;AAC7C,MAAI,eAAyC,CAAC;AAC9C,MAAI,eAAe;AACnB,MAAI,sBAAsB;AAC1B,MAAI,sBAAsB;AAC1B,MAAI,mBAAmB;AAEvB,WAAS,IAAI,GAAG,IAAI,UAAU,QAAQ,KAAK;AACzC,UAAM,WAAW,UAAU,CAAC;AAG5B,UAAM,UAAU,mBAAmB,QAAQ;AAC3C,UAAM,YAAY,KAAK,OAAO;AAG9B,UAAM,uBAAuB,IAAI;AACjC,UAAM,uBAAuB,eAAe;AAE5C,UAAM,kBACJ,wBAAwB,QAAQ,oBAAoB,SACpD,wBAAwB,QAAQ,oBAAoB;AAGtD,QAAI,mBAAmB,aAAa,SAAS,GAAG;AAC9C,UAAI;AACF,2BAAmB,MAAM;AAAA,UACvB;AAAA,UACA;AAAA,UACA,QAAQ;AAAA,QACV;AACA,8BAAsB;AACtB,8BAAsB;AAAA,MACxB,SAAS,OAAO;AAEd,YAAI,aAAa,SAAS,GAAG;AAE3B,gBAAM,YAAY,aAAa;AAAA,YAC7B;AAAA,YACA,KAAK,MAAM,aAAa,SAAS,CAAC;AAAA,UACpC;AACA,kBAAQ,KAAK,SAAS;AACtB,yBAAe,aAAa,MAAM,UAAU,MAAM;AAClD,yBAAe,mBAAmB,YAAY;AAC9C,gCAAsB;AACtB,gCAAsB;AACtB,6BAAmB;AAAA,QACrB,OAAO;AAEL,cAAI,CAAC,QAAQ,cAAc;AACzB,kBAAM,IAAI;AAAA,cACR,kCAAkC,CAAC,KAAK,OAAO,KAAK,CAAC;AAAA,YACvD;AAAA,UACF;AACA,yBAAe,CAAC;AAChB,yBAAe;AACf;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAGA,UAAM,sBACJ,eAAe,YAAY,QAAQ;AACrC,UAAM,iBACJ,mBAAmB,MACnB,gBAAgB,kBAAkB,uBAAuB,CAAC,IACxD,QAAQ;AAGZ,SAAK,uBAAuB,mBAAmB,aAAa,SAAS,GAAG;AACtE,cAAQ,KAAK,YAAY;AACzB,qBAAe,CAAC;AAChB,qBAAe;AACf,4BAAsB;AACtB,4BAAsB;AACtB,yBAAmB;AAAA,IACrB;AAGA,iBAAa,KAAK,QAAQ;AAC1B,oBAAgB;AAAA,EAClB;AAGA,MAAI,aAAa,SAAS,GAAG;AAC3B,YAAQ,KAAK,YAAY;AAAA,EAC3B;AAEA,SAAO;AACT;AAQA,SAAS,mBAAmB,UAAuC;AACjE,QAAM,EAAE,KAAK,cAAc,KAAK,IAAI;AAEpC,SAAO,mBAAmB;AAAA,IACxB;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAiC;AACnC;AAQA,SAAS,mBAAmB,OAAyC;AACnE,SAAO,MAAM,OAAO,CAAC,OAAO,aAAa;AACvC,UAAM,UAAU,mBAAmB,QAAQ;AAC3C,WAAO,QAAQ,KAAK,OAAO;AAAA,EAC7B,GAAG,CAAC;AACN;AAUA,eAAe,iBACb,QACA,OACA,kBACiB;AAEjB,QAAM,QAAQ,MAAM,IAAI,CAAC,cAAc;AAAA,IACrC,QAAQ,SAAS;AAAA,IACjB,cAAc;AAAA,IACd,UAAU,mBAAmB,QAAQ;AAAA,EACvC,EAAE;AAGF,QAAM,MAAM,MAAM,OAAO,YAAY;AAAA,IACnC,IAAI;AAAA,IACJ,MAAM,mBAAmB;AAAA,MACvB,KAAK;AAAA,MACL,cAAc;AAAA,MACd,MAAM,CAAC,KAAK;AAAA,IACd,CAAC;AAAA,EACH,CAAC;AAED,SAAO;AACT;AAYA,SAAS,gBACP,SACA,sBACQ;AACR,MAAI,yBAAyB,EAAG,QAAO;AAGvC,QAAM,gBAAgB,UAAU,OAAO,KAAK,IAAI,GAAG,uBAAuB,CAAC,CAAC;AAC5E,QAAM,eAAe,UAAU;AAG/B,SAAQ,eAAe,OAAQ;AACjC;AAKA,MAAM,gBAAgB;AAAA,EACpB;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,iBAAiB;AAAA,IACjB,QAAQ;AAAA,MACN;AAAA,QACE,MAAM;AAAA,QACN,MAAM;AAAA,QACN,YAAY;AAAA,UACV,EAAE,MAAM,UAAU,MAAM,UAAU;AAAA,UAClC,EAAE,MAAM,gBAAgB,MAAM,OAAO;AAAA,UACrC,EAAE,MAAM,YAAY,MAAM,QAAQ;AAAA,QACpC;AAAA,MACF;AAAA,IACF;AAAA,IACA,SAAS;AAAA,MACP;AAAA,QACE,MAAM;AAAA,QACN,MAAM;AAAA,QACN,YAAY;AAAA,UACV,EAAE,MAAM,WAAW,MAAM,OAAO;AAAA,UAChC,EAAE,MAAM,cAAc,MAAM,QAAQ;AAAA,QACtC;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAYO,SAAS,6BACd,WAC4E;AAE5E,QAAM,aAAa,UAAU,OAAO,CAAC,KAAK,aAAa;AACrD,UAAM,UAAU,mBAAmB,QAAQ;AAC3C,WAAO,MAAM,KAAK,OAAO;AAAA,EAC3B,GAAG,CAAC;AAEJ,QAAM,kBAAkB,aAAa,UAAU;AAG/C,QAAM,sBAAsB;AAAA,IAC1B,OAAO,kBAAkB,MAAM,KAAK;AAAA;AAAA,IACpC,OAAO,kBAAkB,MAAM,OAAO;AAAA,EACxC;AAKA,QAAM,mBACJ,aAAa,OAAU,UAAU,SAAS,MAAM,QAAU;AAE5D,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../../src/utils/multicall.ts"],"sourcesContent":["import type {\n Address,\n PublicClient,\n MulticallParameters,\n MulticallReturnType,\n EncodeFunctionDataParameters,\n Hex,\n Abi,\n} from \"viem\";\nimport { encodeFunctionData, size } from \"viem\";\nimport { getUtilityAddress } from \"../generated/addresses\";\nimport type { VanaChainId } from \"../types\";\n\n/**\n * Type for a contract function configuration used in multicall\n */\nexport interface ContractFunctionConfig {\n address: Address;\n abi: Abi;\n functionName: string;\n args?: readonly unknown[];\n}\n\n/**\n * Configuration options for gas-aware multicall batching.\n *\n * @remarks\n * These options control how the multicall utility splits large batches\n * to stay within gas and calldata limits. The defaults are conservative\n * to ensure compatibility across different chains and RPC providers.\n */\nexport interface GasAwareMulticallOptions {\n /**\n * Maximum gas per batch. Defaults to 10M (conservative for most chains).\n *\n * @remarks\n * This should be set below the block gas limit of your target chain.\n * Common values:\n * - Vana mainnet: 30M (use 25M for safety)\n * - Vana moksha: 30M (use 25M for safety)\n * - Ethereum mainnet: 30M (use 25M for safety)\n * - Arbitrum: 32M (use 25M for safety)\n */\n maxGasPerBatch?: bigint;\n\n /**\n * Maximum calldata size per batch in bytes. Defaults to 100KB.\n *\n * @remarks\n * This is particularly important for L2 chains where calldata is expensive.\n * Some RPC providers also have limits on request size.\n */\n maxCalldataBytes?: number;\n\n /**\n * How often to checkpoint gas estimates. Defaults to every 32 calls or 8KB.\n *\n * @remarks\n * More frequent checkpoints give more accurate batching but require more\n * RPC calls for gas estimation. The default balances accuracy vs performance.\n */\n checkpointFrequency?: {\n /** Checkpoint after this many calls */\n calls: number;\n /** Checkpoint after this many bytes of calldata */\n bytes: number;\n };\n\n /**\n * Whether to allow partial batch failures. Defaults to false.\n *\n * @remarks\n * When true, individual call failures won't fail the entire batch.\n * This matches viem's multicall behavior with allowFailure option.\n */\n allowFailure?: boolean;\n\n /**\n * Optional multicall3 contract address override.\n *\n * @remarks\n * By default, uses the standard multicall3 address deployed on most chains:\n * 0xcA11bde05977b3631167028862bE2a173976CA11\n */\n multicallAddress?: Address;\n\n /**\n * Optional callback for tracking batching progress.\n *\n * @remarks\n * Useful for showing progress in UI or debugging batch performance.\n */\n onProgress?: (completed: number, total: number) => void;\n}\n\n/**\n * Internal configuration with defaults applied\n */\ninterface NormalizedOptions {\n maxGasPerBatch: bigint;\n maxCalldataBytes: number;\n checkpointFrequency: {\n calls: number;\n bytes: number;\n };\n allowFailure: boolean;\n multicallAddress: Address;\n onProgress?: (completed: number, total: number) => void;\n}\n\n/**\n * Default configuration values\n */\nconst DEFAULT_OPTIONS: Omit<NormalizedOptions, \"multicallAddress\"> = {\n maxGasPerBatch: 10_000_000n, // 10M gas - conservative default\n maxCalldataBytes: 100_000, // 100KB - works with most RPC providers\n checkpointFrequency: {\n calls: 32,\n bytes: 8192, // 8KB\n },\n allowFailure: false,\n};\n\n/**\n * A gas-aware multicall function that automatically batches calls to stay within limits.\n *\n * @remarks\n * This function extends viem's multicall with intelligent batching based on:\n * - Actual gas costs (via periodic estimateGas calls)\n * - Calldata size limits\n * - Chain-specific constraints\n *\n * It uses a greedy algorithm with periodic checkpoints to efficiently determine\n * optimal batch sizes without making excessive RPC calls.\n *\n * @param client - The viem public client to use for RPC calls\n * @param parameters - The multicall parameters (same as viem's multicall)\n * @param options - Optional configuration for gas-aware batching\n * @returns The aggregated results from all batches\n *\n * @example\n * ```typescript\n * // Basic usage - drop-in replacement for viem's multicall\n * const results = await gasAwareMulticall(publicClient, {\n * contracts: [\n * { address: '0x...', abi: erc20Abi, functionName: 'balanceOf', args: [address1] },\n * { address: '0x...', abi: erc20Abi, functionName: 'balanceOf', args: [address2] },\n * // ... hundreds more calls\n * ]\n * });\n *\n * // With custom limits for a specific chain\n * const results = await gasAwareMulticall(publicClient, {\n * contracts: calls,\n * }, {\n * maxGasPerBatch: 25_000_000n, // 25M for mainnet\n * maxCalldataBytes: 128_000, // 128KB\n * onProgress: (done, total) => console.log(`Progress: ${done}/${total}`)\n * });\n * ```\n */\nexport async function gasAwareMulticall<\n TContracts extends readonly ContractFunctionConfig[],\n TAllowFailure extends boolean = false,\n>(\n client: PublicClient,\n parameters: MulticallParameters<TContracts, TAllowFailure>,\n options: GasAwareMulticallOptions = {},\n): Promise<MulticallReturnType<TContracts, TAllowFailure>> {\n // Get the chain-specific Multicall3 address\n const chainId = await client.getChainId();\n const multicall3Address =\n options.multicallAddress ??\n getUtilityAddress(chainId as VanaChainId, \"Multicall3\");\n\n // Normalize options with defaults\n const opts: NormalizedOptions = {\n ...DEFAULT_OPTIONS,\n ...options,\n multicallAddress: multicall3Address,\n checkpointFrequency: {\n ...DEFAULT_OPTIONS.checkpointFrequency,\n ...options.checkpointFrequency,\n },\n };\n\n // Override allowFailure if specified in parameters\n if (parameters.allowFailure !== undefined) {\n opts.allowFailure = parameters.allowFailure;\n }\n\n const { contracts } = parameters;\n if (!contracts || contracts.length === 0) {\n // TODO(TYPES): Empty array needs to match complex generic return type.\n // Future improvement: Use conditional types to properly type empty results\n // based on TAllowFailure parameter. Consider creating utility type helper.\n return [] as unknown as MulticallReturnType<TContracts, TAllowFailure>;\n }\n\n // Execute batching algorithm\n const batches = await createBatches(\n client,\n contracts as readonly ContractFunctionConfig[],\n opts,\n );\n\n // Execute all batches in parallel\n const batchResults = await Promise.all(\n batches.map((batch, index) => {\n // Report progress if callback provided\n if (opts.onProgress && index > 0) {\n const completed = batches\n .slice(0, index)\n .reduce((sum, b) => sum + b.length, 0);\n opts.onProgress(completed, contracts.length);\n }\n\n // Execute batch using viem's multicall\n return client.multicall({\n ...parameters,\n contracts: batch as typeof contracts,\n multicallAddress: opts.multicallAddress,\n allowFailure: opts.allowFailure,\n });\n }),\n );\n\n // Report final progress\n if (opts.onProgress) {\n opts.onProgress(contracts.length, contracts.length);\n }\n\n // Flatten results\n return batchResults.flat() as MulticallReturnType<TContracts, TAllowFailure>;\n}\n\n/**\n * Creates optimally-sized batches using greedy algorithm with checkpoints.\n *\n * @param client - The viem public client for making RPC calls\n * @param contracts - Array of contract function configurations to batch\n * @param options - Normalized batching options with limits and settings\n * @returns Array of optimally-sized contract function configuration batches\n */\nasync function createBatches(\n client: PublicClient,\n contracts: readonly ContractFunctionConfig[],\n options: NormalizedOptions,\n): Promise<ContractFunctionConfig[][]> {\n const batches: ContractFunctionConfig[][] = [];\n let currentBatch: ContractFunctionConfig[] = [];\n let currentBytes = 0;\n let lastCheckpointIndex = 0;\n let lastCheckpointBytes = 0;\n let lastEstimatedGas = 0n;\n\n for (let i = 0; i < contracts.length; i++) {\n const contract = contracts[i];\n\n // Calculate encoded size for this call\n const encoded = encodeContractCall(contract);\n const callBytes = size(encoded);\n\n // Check if we need a gas checkpoint\n const callsSinceCheckpoint = i - lastCheckpointIndex;\n const bytesSinceCheckpoint = currentBytes - lastCheckpointBytes;\n\n const needsCheckpoint =\n callsSinceCheckpoint >= options.checkpointFrequency.calls ||\n bytesSinceCheckpoint >= options.checkpointFrequency.bytes;\n\n // Perform checkpoint if needed\n if (needsCheckpoint && currentBatch.length > 0) {\n try {\n lastEstimatedGas = await estimateBatchGas(\n client,\n currentBatch,\n options.multicallAddress,\n );\n lastCheckpointIndex = i;\n lastCheckpointBytes = currentBytes;\n } catch (error) {\n // If estimation fails, finalize current batch to be safe\n if (currentBatch.length > 1) {\n // Try with half the batch\n const halfBatch = currentBatch.slice(\n 0,\n Math.floor(currentBatch.length / 2),\n );\n batches.push(halfBatch);\n currentBatch = currentBatch.slice(halfBatch.length);\n currentBytes = calculateBatchSize(currentBatch);\n lastCheckpointIndex = i;\n lastCheckpointBytes = currentBytes;\n lastEstimatedGas = 0n;\n } else {\n // Single call failed, skip it or throw based on allowFailure\n if (!options.allowFailure) {\n throw new Error(\n `Gas estimation failed for call ${i}: ${String(error)}`,\n );\n }\n currentBatch = [];\n currentBytes = 0;\n continue;\n }\n }\n }\n\n // Check if adding this call would exceed limits\n const wouldExceedCalldata =\n currentBytes + callBytes > options.maxCalldataBytes;\n const wouldExceedGas =\n lastEstimatedGas > 0n &&\n estimateNextGas(lastEstimatedGas, callsSinceCheckpoint + 1) >\n options.maxGasPerBatch;\n\n // If we would exceed limits, finalize current batch\n if ((wouldExceedCalldata || wouldExceedGas) && currentBatch.length > 0) {\n batches.push(currentBatch);\n currentBatch = [];\n currentBytes = 0;\n lastCheckpointIndex = i;\n lastCheckpointBytes = 0;\n lastEstimatedGas = 0n;\n }\n\n // Add call to current batch\n currentBatch.push(contract);\n currentBytes += callBytes;\n }\n\n // Add final batch if not empty\n if (currentBatch.length > 0) {\n batches.push(currentBatch);\n }\n\n return batches;\n}\n\n/**\n * Encodes a contract call to measure its calldata size.\n *\n * @param contract - The contract function configuration to encode\n * @returns Hex-encoded function data\n */\nfunction encodeContractCall(contract: ContractFunctionConfig): Hex {\n const { abi, functionName, args } = contract;\n\n return encodeFunctionData({\n abi,\n functionName,\n args,\n } as EncodeFunctionDataParameters);\n}\n\n/**\n * Calculates total encoded size of a batch.\n *\n * @param batch - Array of contract function configurations to measure\n * @returns Total size in bytes of all encoded calls in the batch\n */\nfunction calculateBatchSize(batch: ContractFunctionConfig[]): number {\n return batch.reduce((total, contract) => {\n const encoded = encodeContractCall(contract);\n return total + size(encoded);\n }, 0);\n}\n\n/**\n * Estimates gas for a batch of calls via multicall3.\n *\n * @param client - The viem public client for gas estimation\n * @param batch - Array of contract calls to estimate gas for\n * @param multicallAddress - The multicall3 contract address to use\n * @returns Estimated gas cost for executing the batch\n */\nasync function estimateBatchGas(\n client: PublicClient,\n batch: ContractFunctionConfig[],\n multicallAddress: Address,\n): Promise<bigint> {\n // Encode batch as multicall3 aggregate3 call\n const calls = batch.map((contract) => ({\n target: contract.address,\n allowFailure: false,\n callData: encodeContractCall(contract),\n }));\n\n // Estimate gas for the multicall\n const gas = await client.estimateGas({\n to: multicallAddress,\n data: encodeFunctionData({\n abi: multicall3Abi,\n functionName: \"aggregate3\",\n args: [calls],\n }),\n });\n\n return gas;\n}\n\n/**\n * Extrapolates gas usage for calls added since last checkpoint.\n *\n * @remarks\n * Uses a conservative 1.1x multiplier for safety to account for gas usage variations.\n *\n * @param lastGas - The gas estimate from the last checkpoint\n * @param callsSinceCheckpoint - Number of calls added since the checkpoint\n * @returns Extrapolated gas estimate with safety margin\n */\nfunction estimateNextGas(\n lastGas: bigint,\n callsSinceCheckpoint: number,\n): bigint {\n if (callsSinceCheckpoint === 0) return lastGas;\n\n // Assume linear scaling with safety factor\n const avgGasPerCall = lastGas / BigInt(Math.max(1, callsSinceCheckpoint - 1));\n const estimatedGas = lastGas + avgGasPerCall;\n\n // Apply 10% safety margin\n return (estimatedGas * 110n) / 100n;\n}\n\n/**\n * Minimal multicall3 ABI for gas estimation\n */\nconst multicall3Abi = [\n {\n name: \"aggregate3\",\n type: \"function\",\n stateMutability: \"payable\",\n inputs: [\n {\n name: \"calls\",\n type: \"tuple[]\",\n components: [\n { name: \"target\", type: \"address\" },\n { name: \"allowFailure\", type: \"bool\" },\n { name: \"callData\", type: \"bytes\" },\n ],\n },\n ],\n outputs: [\n {\n name: \"returnData\",\n type: \"tuple[]\",\n components: [\n { name: \"success\", type: \"bool\" },\n { name: \"returnData\", type: \"bytes\" },\n ],\n },\n ],\n },\n] as const;\n\n/**\n * Utility function to analyze calls and predict optimal batch configuration\n *\n * @remarks\n * This function helps determine the best configuration for a specific set of calls\n * by analyzing their characteristics. Useful for optimizing repeated operations.\n *\n * @param contracts - The calls to analyze\n * @returns Suggested configuration based on call analysis\n */\nexport function analyzeCallsForOptimalConfig(\n contracts: readonly ContractFunctionConfig[],\n): Pick<GasAwareMulticallOptions, \"checkpointFrequency\" | \"maxCalldataBytes\"> {\n // Calculate average call size\n const totalBytes = contracts.reduce((sum, contract) => {\n const encoded = encodeContractCall(contract);\n return sum + size(encoded);\n }, 0);\n\n const avgBytesPerCall = totalBytes / contracts.length;\n\n // Suggest checkpoint frequency based on call density\n const checkpointFrequency = {\n calls: avgBytesPerCall > 500 ? 16 : 32, // More frequent for large calls\n bytes: avgBytesPerCall > 500 ? 4096 : 8192,\n };\n\n // Suggest calldata limit based on total size\n // For 1000 calls with small arrays, totalBytes will be much less than 500KB,\n // so use number of contracts as additional signal\n const maxCalldataBytes =\n totalBytes > 50_000 || contracts.length > 500 ? 128_000 : 100_000;\n\n return {\n checkpointFrequency,\n maxCalldataBytes,\n };\n}\n"],"mappings":"AASA,SAAS,oBAAoB,YAAY;AACzC,SAAS,yBAAyB;AAuGlC,MAAM,kBAA+D;AAAA,EACnE,gBAAgB;AAAA;AAAA,EAChB,kBAAkB;AAAA;AAAA,EAClB,qBAAqB;AAAA,IACnB,OAAO;AAAA,IACP,OAAO;AAAA;AAAA,EACT;AAAA,EACA,cAAc;AAChB;AAwCA,eAAsB,kBAIpB,QACA,YACA,UAAoC,CAAC,GACoB;AAEzD,QAAM,UAAU,MAAM,OAAO,WAAW;AACxC,QAAM,oBACJ,QAAQ,oBACR,kBAAkB,SAAwB,YAAY;AAGxD,QAAM,OAA0B;AAAA,IAC9B,GAAG;AAAA,IACH,GAAG;AAAA,IACH,kBAAkB;AAAA,IAClB,qBAAqB;AAAA,MACnB,GAAG,gBAAgB;AAAA,MACnB,GAAG,QAAQ;AAAA,IACb;AAAA,EACF;AAGA,MAAI,WAAW,iBAAiB,QAAW;AACzC,SAAK,eAAe,WAAW;AAAA,EACjC;AAEA,QAAM,EAAE,UAAU,IAAI;AACtB,MAAI,CAAC,aAAa,UAAU,WAAW,GAAG;AAIxC,WAAO,CAAC;AAAA,EACV;AAGA,QAAM,UAAU,MAAM;AAAA,IACpB;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAGA,QAAM,eAAe,MAAM,QAAQ;AAAA,IACjC,QAAQ,IAAI,CAAC,OAAO,UAAU;AAE5B,UAAI,KAAK,cAAc,QAAQ,GAAG;AAChC,cAAM,YAAY,QACf,MAAM,GAAG,KAAK,EACd,OAAO,CAAC,KAAK,MAAM,MAAM,EAAE,QAAQ,CAAC;AACvC,aAAK,WAAW,WAAW,UAAU,MAAM;AAAA,MAC7C;AAGA,aAAO,OAAO,UAAU;AAAA,QACtB,GAAG;AAAA,QACH,WAAW;AAAA,QACX,kBAAkB,KAAK;AAAA,QACvB,cAAc,KAAK;AAAA,MACrB,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAGA,MAAI,KAAK,YAAY;AACnB,SAAK,WAAW,UAAU,QAAQ,UAAU,MAAM;AAAA,EACpD;AAGA,SAAO,aAAa,KAAK;AAC3B;AAUA,eAAe,cACb,QACA,WACA,SACqC;AACrC,QAAM,UAAsC,CAAC;AAC7C,MAAI,eAAyC,CAAC;AAC9C,MAAI,eAAe;AACnB,MAAI,sBAAsB;AAC1B,MAAI,sBAAsB;AAC1B,MAAI,mBAAmB;AAEvB,WAAS,IAAI,GAAG,IAAI,UAAU,QAAQ,KAAK;AACzC,UAAM,WAAW,UAAU,CAAC;AAG5B,UAAM,UAAU,mBAAmB,QAAQ;AAC3C,UAAM,YAAY,KAAK,OAAO;AAG9B,UAAM,uBAAuB,IAAI;AACjC,UAAM,uBAAuB,eAAe;AAE5C,UAAM,kBACJ,wBAAwB,QAAQ,oBAAoB,SACpD,wBAAwB,QAAQ,oBAAoB;AAGtD,QAAI,mBAAmB,aAAa,SAAS,GAAG;AAC9C,UAAI;AACF,2BAAmB,MAAM;AAAA,UACvB;AAAA,UACA;AAAA,UACA,QAAQ;AAAA,QACV;AACA,8BAAsB;AACtB,8BAAsB;AAAA,MACxB,SAAS,OAAO;AAEd,YAAI,aAAa,SAAS,GAAG;AAE3B,gBAAM,YAAY,aAAa;AAAA,YAC7B;AAAA,YACA,KAAK,MAAM,aAAa,SAAS,CAAC;AAAA,UACpC;AACA,kBAAQ,KAAK,SAAS;AACtB,yBAAe,aAAa,MAAM,UAAU,MAAM;AAClD,yBAAe,mBAAmB,YAAY;AAC9C,gCAAsB;AACtB,gCAAsB;AACtB,6BAAmB;AAAA,QACrB,OAAO;AAEL,cAAI,CAAC,QAAQ,cAAc;AACzB,kBAAM,IAAI;AAAA,cACR,kCAAkC,CAAC,KAAK,OAAO,KAAK,CAAC;AAAA,YACvD;AAAA,UACF;AACA,yBAAe,CAAC;AAChB,yBAAe;AACf;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAGA,UAAM,sBACJ,eAAe,YAAY,QAAQ;AACrC,UAAM,iBACJ,mBAAmB,MACnB,gBAAgB,kBAAkB,uBAAuB,CAAC,IACxD,QAAQ;AAGZ,SAAK,uBAAuB,mBAAmB,aAAa,SAAS,GAAG;AACtE,cAAQ,KAAK,YAAY;AACzB,qBAAe,CAAC;AAChB,qBAAe;AACf,4BAAsB;AACtB,4BAAsB;AACtB,yBAAmB;AAAA,IACrB;AAGA,iBAAa,KAAK,QAAQ;AAC1B,oBAAgB;AAAA,EAClB;AAGA,MAAI,aAAa,SAAS,GAAG;AAC3B,YAAQ,KAAK,YAAY;AAAA,EAC3B;AAEA,SAAO;AACT;AAQA,SAAS,mBAAmB,UAAuC;AACjE,QAAM,EAAE,KAAK,cAAc,KAAK,IAAI;AAEpC,SAAO,mBAAmB;AAAA,IACxB;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAiC;AACnC;AAQA,SAAS,mBAAmB,OAAyC;AACnE,SAAO,MAAM,OAAO,CAAC,OAAO,aAAa;AACvC,UAAM,UAAU,mBAAmB,QAAQ;AAC3C,WAAO,QAAQ,KAAK,OAAO;AAAA,EAC7B,GAAG,CAAC;AACN;AAUA,eAAe,iBACb,QACA,OACA,kBACiB;AAEjB,QAAM,QAAQ,MAAM,IAAI,CAAC,cAAc;AAAA,IACrC,QAAQ,SAAS;AAAA,IACjB,cAAc;AAAA,IACd,UAAU,mBAAmB,QAAQ;AAAA,EACvC,EAAE;AAGF,QAAM,MAAM,MAAM,OAAO,YAAY;AAAA,IACnC,IAAI;AAAA,IACJ,MAAM,mBAAmB;AAAA,MACvB,KAAK;AAAA,MACL,cAAc;AAAA,MACd,MAAM,CAAC,KAAK;AAAA,IACd,CAAC;AAAA,EACH,CAAC;AAED,SAAO;AACT;AAYA,SAAS,gBACP,SACA,sBACQ;AACR,MAAI,yBAAyB,EAAG,QAAO;AAGvC,QAAM,gBAAgB,UAAU,OAAO,KAAK,IAAI,GAAG,uBAAuB,CAAC,CAAC;AAC5E,QAAM,eAAe,UAAU;AAG/B,SAAQ,eAAe,OAAQ;AACjC;AAKA,MAAM,gBAAgB;AAAA,EACpB;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,iBAAiB;AAAA,IACjB,QAAQ;AAAA,MACN;AAAA,QACE,MAAM;AAAA,QACN,MAAM;AAAA,QACN,YAAY;AAAA,UACV,EAAE,MAAM,UAAU,MAAM,UAAU;AAAA,UAClC,EAAE,MAAM,gBAAgB,MAAM,OAAO;AAAA,UACrC,EAAE,MAAM,YAAY,MAAM,QAAQ;AAAA,QACpC;AAAA,MACF;AAAA,IACF;AAAA,IACA,SAAS;AAAA,MACP;AAAA,QACE,MAAM;AAAA,QACN,MAAM;AAAA,QACN,YAAY;AAAA,UACV,EAAE,MAAM,WAAW,MAAM,OAAO;AAAA,UAChC,EAAE,MAAM,cAAc,MAAM,QAAQ;AAAA,QACtC;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAYO,SAAS,6BACd,WAC4E;AAE5E,QAAM,aAAa,UAAU,OAAO,CAAC,KAAK,aAAa;AACrD,UAAM,UAAU,mBAAmB,QAAQ;AAC3C,WAAO,MAAM,KAAK,OAAO;AAAA,EAC3B,GAAG,CAAC;AAEJ,QAAM,kBAAkB,aAAa,UAAU;AAG/C,QAAM,sBAAsB;AAAA,IAC1B,OAAO,kBAAkB,MAAM,KAAK;AAAA;AAAA,IACpC,OAAO,kBAAkB,MAAM,OAAO;AAAA,EACxC;AAKA,QAAM,mBACJ,aAAa,OAAU,UAAU,SAAS,MAAM,QAAU;AAE5D,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;","names":[]}
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
var runtimeGrantFiles_exports = {};
|
|
20
|
+
__export(runtimeGrantFiles_exports, {
|
|
21
|
+
createRuntimeGrantFile: () => createRuntimeGrantFile,
|
|
22
|
+
retrieveRuntimeGrantFile: () => retrieveRuntimeGrantFile,
|
|
23
|
+
storeRuntimeGrantFile: () => storeRuntimeGrantFile
|
|
24
|
+
});
|
|
25
|
+
module.exports = __toCommonJS(runtimeGrantFiles_exports);
|
|
26
|
+
var import_errors = require("../errors");
|
|
27
|
+
function createRuntimeGrantFile(params) {
|
|
28
|
+
return {
|
|
29
|
+
grantee: params.grantee,
|
|
30
|
+
task: params.task,
|
|
31
|
+
operation: params.operation,
|
|
32
|
+
pricing: {
|
|
33
|
+
price_per_file_vana: params.pricing.price_per_file_vana,
|
|
34
|
+
...params.pricing.minimum_price_vana && {
|
|
35
|
+
minimum_price_vana: params.pricing.minimum_price_vana
|
|
36
|
+
},
|
|
37
|
+
...params.pricing.maximum_price_vana && {
|
|
38
|
+
maximum_price_vana: params.pricing.maximum_price_vana
|
|
39
|
+
}
|
|
40
|
+
},
|
|
41
|
+
parameters: params.parameters ?? {}
|
|
42
|
+
};
|
|
43
|
+
}
|
|
44
|
+
async function storeRuntimeGrantFile(grantFile, relayerUrl) {
|
|
45
|
+
if (relayerUrl) {
|
|
46
|
+
const response = await fetch(`${relayerUrl}/upload`, {
|
|
47
|
+
method: "POST",
|
|
48
|
+
headers: { "Content-Type": "application/json" },
|
|
49
|
+
body: JSON.stringify(grantFile)
|
|
50
|
+
});
|
|
51
|
+
if (!response.ok) {
|
|
52
|
+
const errorText = await response.text();
|
|
53
|
+
throw new import_errors.NetworkError(
|
|
54
|
+
`Failed to upload grant file via relayer: ${errorText}`
|
|
55
|
+
);
|
|
56
|
+
}
|
|
57
|
+
const data = await response.json();
|
|
58
|
+
if (!data.url) {
|
|
59
|
+
throw new import_errors.NetworkError("Relayer did not return a URL");
|
|
60
|
+
}
|
|
61
|
+
return data.url;
|
|
62
|
+
} else {
|
|
63
|
+
throw new Error(
|
|
64
|
+
"Direct IPFS upload not yet implemented. Use relayer or provide grantUrl."
|
|
65
|
+
);
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
async function retrieveRuntimeGrantFile(ipfsHash) {
|
|
69
|
+
const url = ipfsHash.startsWith("ipfs://") ? `https://gateway.pinata.cloud/ipfs/${ipfsHash.slice(7)}` : ipfsHash.startsWith("http") ? ipfsHash : `https://gateway.pinata.cloud/ipfs/${ipfsHash}`;
|
|
70
|
+
const response = await fetch(url);
|
|
71
|
+
if (!response.ok) {
|
|
72
|
+
throw new import_errors.NetworkError(
|
|
73
|
+
`Failed to fetch grant file from ${url}: ${response.statusText}`
|
|
74
|
+
);
|
|
75
|
+
}
|
|
76
|
+
return await response.json();
|
|
77
|
+
}
|
|
78
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
79
|
+
0 && (module.exports = {
|
|
80
|
+
createRuntimeGrantFile,
|
|
81
|
+
retrieveRuntimeGrantFile,
|
|
82
|
+
storeRuntimeGrantFile
|
|
83
|
+
});
|
|
84
|
+
//# sourceMappingURL=runtimeGrantFiles.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/utils/runtimeGrantFiles.ts"],"sourcesContent":["import type {\n RuntimePermissionParams,\n RuntimeGrantFile,\n} from \"../types/runtimePermissions\";\nimport { NetworkError } from \"../errors\";\n\n/**\n * Creates runtime grant file structure for permission storage\n *\n * @remarks\n * Similar to createGrantFile() but for runtime permissions.\n * Constructs the JSON structure that will be stored on IPFS.\n *\n * @param params - Permission parameters to create the grant file from\n * @returns Grant file object for IPFS storage\n *\n * @category Runtime Permissions\n * @example\n * ```typescript\n * const grantFile = createRuntimeGrantFile({\n * datasetId: 123n,\n * grantee: \"0x...\",\n * task: \"thinker/task:v1\",\n * operation: \"aggregate_keywords\",\n * pricing: { price_per_file_vana: 0.1 },\n * endBlock: 2000000n\n * });\n * ```\n */\nexport function createRuntimeGrantFile(\n params: RuntimePermissionParams,\n): RuntimeGrantFile {\n return {\n grantee: params.grantee,\n task: params.task,\n operation: params.operation,\n pricing: {\n price_per_file_vana: params.pricing.price_per_file_vana,\n ...(params.pricing.minimum_price_vana && {\n minimum_price_vana: params.pricing.minimum_price_vana,\n }),\n ...(params.pricing.maximum_price_vana && {\n maximum_price_vana: params.pricing.maximum_price_vana,\n }),\n },\n parameters: params.parameters ?? {},\n };\n}\n\n/**\n * Stores grant file via relayer or direct IPFS\n *\n * @remarks\n * Reuses the same upload pattern as data portability grants.\n * If relayerUrl is provided, uploads via relayer. Otherwise, requires storageManager.\n *\n * @param grantFile - The grant file to store\n * @param relayerUrl - Optional URL of the relayer service\n * @returns Promise resolving to the IPFS URL\n * @throws {NetworkError} When the upload fails\n *\n * @category Runtime Permissions\n * @example\n * ```typescript\n * const grantFile = createRuntimeGrantFile(params);\n * const ipfsUrl = await storeRuntimeGrantFile(grantFile, relayerUrl);\n * console.log(`Grant stored at: ${ipfsUrl}`);\n * ```\n */\nexport async function storeRuntimeGrantFile(\n grantFile: RuntimeGrantFile,\n relayerUrl?: string,\n): Promise<string> {\n if (relayerUrl) {\n // Use relayer if available\n const response = await fetch(`${relayerUrl}/upload`, {\n method: \"POST\",\n headers: { \"Content-Type\": \"application/json\" },\n body: JSON.stringify(grantFile),\n });\n\n if (!response.ok) {\n const errorText = await response.text();\n throw new NetworkError(\n `Failed to upload grant file via relayer: ${errorText}`,\n );\n }\n\n const data = await response.json();\n if (!data.url) {\n throw new NetworkError(\"Relayer did not return a URL\");\n }\n\n return data.url;\n } else {\n // Direct IPFS upload would require storageManager\n // For now, throw error - can be implemented if needed\n throw new Error(\n \"Direct IPFS upload not yet implemented. Use relayer or provide grantUrl.\",\n );\n }\n}\n\n/**\n * Retrieves grant file from IPFS\n *\n * @remarks\n * Converts ipfs:// URLs to gateway URLs and fetches the grant file.\n * Uses Pinata gateway by default.\n *\n * @param ipfsHash - IPFS hash or full IPFS URL\n * @returns Promise resolving to the parsed grant file\n * @throws {NetworkError} When the fetch fails\n *\n * @category Runtime Permissions\n * @example\n * ```typescript\n * const permission = await sdk.runtimePermissions.getPermission(1024n);\n * const grantFile = await retrieveRuntimeGrantFile(permission.grant);\n * console.log(`Price: ${grantFile.pricing.price_per_file_vana} VANA`);\n * ```\n */\nexport async function retrieveRuntimeGrantFile(\n ipfsHash: string,\n): Promise<RuntimeGrantFile> {\n // Convert ipfs:// to gateway URL if needed\n const url = ipfsHash.startsWith(\"ipfs://\")\n ? `https://gateway.pinata.cloud/ipfs/${ipfsHash.slice(7)}`\n : ipfsHash.startsWith(\"http\")\n ? ipfsHash\n : `https://gateway.pinata.cloud/ipfs/${ipfsHash}`;\n\n const response = await fetch(url);\n if (!response.ok) {\n throw new NetworkError(\n `Failed to fetch grant file from ${url}: ${response.statusText}`,\n );\n }\n\n return await response.json();\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAIA,oBAA6B;AAyBtB,SAAS,uBACd,QACkB;AAClB,SAAO;AAAA,IACL,SAAS,OAAO;AAAA,IAChB,MAAM,OAAO;AAAA,IACb,WAAW,OAAO;AAAA,IAClB,SAAS;AAAA,MACP,qBAAqB,OAAO,QAAQ;AAAA,MACpC,GAAI,OAAO,QAAQ,sBAAsB;AAAA,QACvC,oBAAoB,OAAO,QAAQ;AAAA,MACrC;AAAA,MACA,GAAI,OAAO,QAAQ,sBAAsB;AAAA,QACvC,oBAAoB,OAAO,QAAQ;AAAA,MACrC;AAAA,IACF;AAAA,IACA,YAAY,OAAO,cAAc,CAAC;AAAA,EACpC;AACF;AAsBA,eAAsB,sBACpB,WACA,YACiB;AACjB,MAAI,YAAY;AAEd,UAAM,WAAW,MAAM,MAAM,GAAG,UAAU,WAAW;AAAA,MACnD,QAAQ;AAAA,MACR,SAAS,EAAE,gBAAgB,mBAAmB;AAAA,MAC9C,MAAM,KAAK,UAAU,SAAS;AAAA,IAChC,CAAC;AAED,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,YAAY,MAAM,SAAS,KAAK;AACtC,YAAM,IAAI;AAAA,QACR,4CAA4C,SAAS;AAAA,MACvD;AAAA,IACF;AAEA,UAAM,OAAO,MAAM,SAAS,KAAK;AACjC,QAAI,CAAC,KAAK,KAAK;AACb,YAAM,IAAI,2BAAa,8BAA8B;AAAA,IACvD;AAEA,WAAO,KAAK;AAAA,EACd,OAAO;AAGL,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACF;AAqBA,eAAsB,yBACpB,UAC2B;AAE3B,QAAM,MAAM,SAAS,WAAW,SAAS,IACrC,qCAAqC,SAAS,MAAM,CAAC,CAAC,KACtD,SAAS,WAAW,MAAM,IACxB,WACA,qCAAqC,QAAQ;AAEnD,QAAM,WAAW,MAAM,MAAM,GAAG;AAChC,MAAI,CAAC,SAAS,IAAI;AAChB,UAAM,IAAI;AAAA,MACR,mCAAmC,GAAG,KAAK,SAAS,UAAU;AAAA,IAChE;AAAA,EACF;AAEA,SAAO,MAAM,SAAS,KAAK;AAC7B;","names":[]}
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import type { RuntimePermissionParams, RuntimeGrantFile } from "../types/runtimePermissions";
|
|
2
|
+
/**
|
|
3
|
+
* Creates runtime grant file structure for permission storage
|
|
4
|
+
*
|
|
5
|
+
* @remarks
|
|
6
|
+
* Similar to createGrantFile() but for runtime permissions.
|
|
7
|
+
* Constructs the JSON structure that will be stored on IPFS.
|
|
8
|
+
*
|
|
9
|
+
* @param params - Permission parameters to create the grant file from
|
|
10
|
+
* @returns Grant file object for IPFS storage
|
|
11
|
+
*
|
|
12
|
+
* @category Runtime Permissions
|
|
13
|
+
* @example
|
|
14
|
+
* ```typescript
|
|
15
|
+
* const grantFile = createRuntimeGrantFile({
|
|
16
|
+
* datasetId: 123n,
|
|
17
|
+
* grantee: "0x...",
|
|
18
|
+
* task: "thinker/task:v1",
|
|
19
|
+
* operation: "aggregate_keywords",
|
|
20
|
+
* pricing: { price_per_file_vana: 0.1 },
|
|
21
|
+
* endBlock: 2000000n
|
|
22
|
+
* });
|
|
23
|
+
* ```
|
|
24
|
+
*/
|
|
25
|
+
export declare function createRuntimeGrantFile(params: RuntimePermissionParams): RuntimeGrantFile;
|
|
26
|
+
/**
|
|
27
|
+
* Stores grant file via relayer or direct IPFS
|
|
28
|
+
*
|
|
29
|
+
* @remarks
|
|
30
|
+
* Reuses the same upload pattern as data portability grants.
|
|
31
|
+
* If relayerUrl is provided, uploads via relayer. Otherwise, requires storageManager.
|
|
32
|
+
*
|
|
33
|
+
* @param grantFile - The grant file to store
|
|
34
|
+
* @param relayerUrl - Optional URL of the relayer service
|
|
35
|
+
* @returns Promise resolving to the IPFS URL
|
|
36
|
+
* @throws {NetworkError} When the upload fails
|
|
37
|
+
*
|
|
38
|
+
* @category Runtime Permissions
|
|
39
|
+
* @example
|
|
40
|
+
* ```typescript
|
|
41
|
+
* const grantFile = createRuntimeGrantFile(params);
|
|
42
|
+
* const ipfsUrl = await storeRuntimeGrantFile(grantFile, relayerUrl);
|
|
43
|
+
* console.log(`Grant stored at: ${ipfsUrl}`);
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
export declare function storeRuntimeGrantFile(grantFile: RuntimeGrantFile, relayerUrl?: string): Promise<string>;
|
|
47
|
+
/**
|
|
48
|
+
* Retrieves grant file from IPFS
|
|
49
|
+
*
|
|
50
|
+
* @remarks
|
|
51
|
+
* Converts ipfs:// URLs to gateway URLs and fetches the grant file.
|
|
52
|
+
* Uses Pinata gateway by default.
|
|
53
|
+
*
|
|
54
|
+
* @param ipfsHash - IPFS hash or full IPFS URL
|
|
55
|
+
* @returns Promise resolving to the parsed grant file
|
|
56
|
+
* @throws {NetworkError} When the fetch fails
|
|
57
|
+
*
|
|
58
|
+
* @category Runtime Permissions
|
|
59
|
+
* @example
|
|
60
|
+
* ```typescript
|
|
61
|
+
* const permission = await sdk.runtimePermissions.getPermission(1024n);
|
|
62
|
+
* const grantFile = await retrieveRuntimeGrantFile(permission.grant);
|
|
63
|
+
* console.log(`Price: ${grantFile.pricing.price_per_file_vana} VANA`);
|
|
64
|
+
* ```
|
|
65
|
+
*/
|
|
66
|
+
export declare function retrieveRuntimeGrantFile(ipfsHash: string): Promise<RuntimeGrantFile>;
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import { NetworkError } from "../errors";
|
|
2
|
+
function createRuntimeGrantFile(params) {
|
|
3
|
+
return {
|
|
4
|
+
grantee: params.grantee,
|
|
5
|
+
task: params.task,
|
|
6
|
+
operation: params.operation,
|
|
7
|
+
pricing: {
|
|
8
|
+
price_per_file_vana: params.pricing.price_per_file_vana,
|
|
9
|
+
...params.pricing.minimum_price_vana && {
|
|
10
|
+
minimum_price_vana: params.pricing.minimum_price_vana
|
|
11
|
+
},
|
|
12
|
+
...params.pricing.maximum_price_vana && {
|
|
13
|
+
maximum_price_vana: params.pricing.maximum_price_vana
|
|
14
|
+
}
|
|
15
|
+
},
|
|
16
|
+
parameters: params.parameters ?? {}
|
|
17
|
+
};
|
|
18
|
+
}
|
|
19
|
+
async function storeRuntimeGrantFile(grantFile, relayerUrl) {
|
|
20
|
+
if (relayerUrl) {
|
|
21
|
+
const response = await fetch(`${relayerUrl}/upload`, {
|
|
22
|
+
method: "POST",
|
|
23
|
+
headers: { "Content-Type": "application/json" },
|
|
24
|
+
body: JSON.stringify(grantFile)
|
|
25
|
+
});
|
|
26
|
+
if (!response.ok) {
|
|
27
|
+
const errorText = await response.text();
|
|
28
|
+
throw new NetworkError(
|
|
29
|
+
`Failed to upload grant file via relayer: ${errorText}`
|
|
30
|
+
);
|
|
31
|
+
}
|
|
32
|
+
const data = await response.json();
|
|
33
|
+
if (!data.url) {
|
|
34
|
+
throw new NetworkError("Relayer did not return a URL");
|
|
35
|
+
}
|
|
36
|
+
return data.url;
|
|
37
|
+
} else {
|
|
38
|
+
throw new Error(
|
|
39
|
+
"Direct IPFS upload not yet implemented. Use relayer or provide grantUrl."
|
|
40
|
+
);
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
async function retrieveRuntimeGrantFile(ipfsHash) {
|
|
44
|
+
const url = ipfsHash.startsWith("ipfs://") ? `https://gateway.pinata.cloud/ipfs/${ipfsHash.slice(7)}` : ipfsHash.startsWith("http") ? ipfsHash : `https://gateway.pinata.cloud/ipfs/${ipfsHash}`;
|
|
45
|
+
const response = await fetch(url);
|
|
46
|
+
if (!response.ok) {
|
|
47
|
+
throw new NetworkError(
|
|
48
|
+
`Failed to fetch grant file from ${url}: ${response.statusText}`
|
|
49
|
+
);
|
|
50
|
+
}
|
|
51
|
+
return await response.json();
|
|
52
|
+
}
|
|
53
|
+
export {
|
|
54
|
+
createRuntimeGrantFile,
|
|
55
|
+
retrieveRuntimeGrantFile,
|
|
56
|
+
storeRuntimeGrantFile
|
|
57
|
+
};
|
|
58
|
+
//# sourceMappingURL=runtimeGrantFiles.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/utils/runtimeGrantFiles.ts"],"sourcesContent":["import type {\n RuntimePermissionParams,\n RuntimeGrantFile,\n} from \"../types/runtimePermissions\";\nimport { NetworkError } from \"../errors\";\n\n/**\n * Creates runtime grant file structure for permission storage\n *\n * @remarks\n * Similar to createGrantFile() but for runtime permissions.\n * Constructs the JSON structure that will be stored on IPFS.\n *\n * @param params - Permission parameters to create the grant file from\n * @returns Grant file object for IPFS storage\n *\n * @category Runtime Permissions\n * @example\n * ```typescript\n * const grantFile = createRuntimeGrantFile({\n * datasetId: 123n,\n * grantee: \"0x...\",\n * task: \"thinker/task:v1\",\n * operation: \"aggregate_keywords\",\n * pricing: { price_per_file_vana: 0.1 },\n * endBlock: 2000000n\n * });\n * ```\n */\nexport function createRuntimeGrantFile(\n params: RuntimePermissionParams,\n): RuntimeGrantFile {\n return {\n grantee: params.grantee,\n task: params.task,\n operation: params.operation,\n pricing: {\n price_per_file_vana: params.pricing.price_per_file_vana,\n ...(params.pricing.minimum_price_vana && {\n minimum_price_vana: params.pricing.minimum_price_vana,\n }),\n ...(params.pricing.maximum_price_vana && {\n maximum_price_vana: params.pricing.maximum_price_vana,\n }),\n },\n parameters: params.parameters ?? {},\n };\n}\n\n/**\n * Stores grant file via relayer or direct IPFS\n *\n * @remarks\n * Reuses the same upload pattern as data portability grants.\n * If relayerUrl is provided, uploads via relayer. Otherwise, requires storageManager.\n *\n * @param grantFile - The grant file to store\n * @param relayerUrl - Optional URL of the relayer service\n * @returns Promise resolving to the IPFS URL\n * @throws {NetworkError} When the upload fails\n *\n * @category Runtime Permissions\n * @example\n * ```typescript\n * const grantFile = createRuntimeGrantFile(params);\n * const ipfsUrl = await storeRuntimeGrantFile(grantFile, relayerUrl);\n * console.log(`Grant stored at: ${ipfsUrl}`);\n * ```\n */\nexport async function storeRuntimeGrantFile(\n grantFile: RuntimeGrantFile,\n relayerUrl?: string,\n): Promise<string> {\n if (relayerUrl) {\n // Use relayer if available\n const response = await fetch(`${relayerUrl}/upload`, {\n method: \"POST\",\n headers: { \"Content-Type\": \"application/json\" },\n body: JSON.stringify(grantFile),\n });\n\n if (!response.ok) {\n const errorText = await response.text();\n throw new NetworkError(\n `Failed to upload grant file via relayer: ${errorText}`,\n );\n }\n\n const data = await response.json();\n if (!data.url) {\n throw new NetworkError(\"Relayer did not return a URL\");\n }\n\n return data.url;\n } else {\n // Direct IPFS upload would require storageManager\n // For now, throw error - can be implemented if needed\n throw new Error(\n \"Direct IPFS upload not yet implemented. Use relayer or provide grantUrl.\",\n );\n }\n}\n\n/**\n * Retrieves grant file from IPFS\n *\n * @remarks\n * Converts ipfs:// URLs to gateway URLs and fetches the grant file.\n * Uses Pinata gateway by default.\n *\n * @param ipfsHash - IPFS hash or full IPFS URL\n * @returns Promise resolving to the parsed grant file\n * @throws {NetworkError} When the fetch fails\n *\n * @category Runtime Permissions\n * @example\n * ```typescript\n * const permission = await sdk.runtimePermissions.getPermission(1024n);\n * const grantFile = await retrieveRuntimeGrantFile(permission.grant);\n * console.log(`Price: ${grantFile.pricing.price_per_file_vana} VANA`);\n * ```\n */\nexport async function retrieveRuntimeGrantFile(\n ipfsHash: string,\n): Promise<RuntimeGrantFile> {\n // Convert ipfs:// to gateway URL if needed\n const url = ipfsHash.startsWith(\"ipfs://\")\n ? `https://gateway.pinata.cloud/ipfs/${ipfsHash.slice(7)}`\n : ipfsHash.startsWith(\"http\")\n ? ipfsHash\n : `https://gateway.pinata.cloud/ipfs/${ipfsHash}`;\n\n const response = await fetch(url);\n if (!response.ok) {\n throw new NetworkError(\n `Failed to fetch grant file from ${url}: ${response.statusText}`,\n );\n }\n\n return await response.json();\n}\n"],"mappings":"AAIA,SAAS,oBAAoB;AAyBtB,SAAS,uBACd,QACkB;AAClB,SAAO;AAAA,IACL,SAAS,OAAO;AAAA,IAChB,MAAM,OAAO;AAAA,IACb,WAAW,OAAO;AAAA,IAClB,SAAS;AAAA,MACP,qBAAqB,OAAO,QAAQ;AAAA,MACpC,GAAI,OAAO,QAAQ,sBAAsB;AAAA,QACvC,oBAAoB,OAAO,QAAQ;AAAA,MACrC;AAAA,MACA,GAAI,OAAO,QAAQ,sBAAsB;AAAA,QACvC,oBAAoB,OAAO,QAAQ;AAAA,MACrC;AAAA,IACF;AAAA,IACA,YAAY,OAAO,cAAc,CAAC;AAAA,EACpC;AACF;AAsBA,eAAsB,sBACpB,WACA,YACiB;AACjB,MAAI,YAAY;AAEd,UAAM,WAAW,MAAM,MAAM,GAAG,UAAU,WAAW;AAAA,MACnD,QAAQ;AAAA,MACR,SAAS,EAAE,gBAAgB,mBAAmB;AAAA,MAC9C,MAAM,KAAK,UAAU,SAAS;AAAA,IAChC,CAAC;AAED,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,YAAY,MAAM,SAAS,KAAK;AACtC,YAAM,IAAI;AAAA,QACR,4CAA4C,SAAS;AAAA,MACvD;AAAA,IACF;AAEA,UAAM,OAAO,MAAM,SAAS,KAAK;AACjC,QAAI,CAAC,KAAK,KAAK;AACb,YAAM,IAAI,aAAa,8BAA8B;AAAA,IACvD;AAEA,WAAO,KAAK;AAAA,EACd,OAAO;AAGL,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACF;AAqBA,eAAsB,yBACpB,UAC2B;AAE3B,QAAM,MAAM,SAAS,WAAW,SAAS,IACrC,qCAAqC,SAAS,MAAM,CAAC,CAAC,KACtD,SAAS,WAAW,MAAM,IACxB,WACA,qCAAqC,QAAQ;AAEnD,QAAM,WAAW,MAAM,MAAM,GAAG;AAChC,MAAI,CAAC,SAAS,IAAI;AAChB,UAAM,IAAI;AAAA,MACR,mCAAmC,GAAG,KAAK,SAAS,UAAU;AAAA,IAChE;AAAA,EACF;AAEA,SAAO,MAAM,SAAS,KAAK;AAC7B;","names":[]}
|
|
@@ -145,12 +145,18 @@ class SignatureCache {
|
|
|
145
145
|
return (0, import_viem.toHex)(hashBytes);
|
|
146
146
|
}
|
|
147
147
|
/**
|
|
148
|
-
* Deterministic JSON replacer
|
|
149
|
-
*
|
|
148
|
+
* Deterministic JSON replacer for consistent cache key generation.
|
|
149
|
+
*
|
|
150
|
+
* @remarks
|
|
151
|
+
* Handles BigInt serialization and sorts object keys to ensure
|
|
152
|
+
* identical objects always produce the same hash regardless of
|
|
153
|
+
* property order.
|
|
150
154
|
*
|
|
151
155
|
* @param _key - The object key being serialized (unused)
|
|
152
156
|
* @param value - The value to serialize
|
|
153
157
|
* @returns The serialized value with sorted keys for objects
|
|
158
|
+
*
|
|
159
|
+
* @internal
|
|
154
160
|
*/
|
|
155
161
|
static deterministicReplacer(_key, value) {
|
|
156
162
|
if (typeof value === "bigint") {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/utils/signatureCache.ts"],"sourcesContent":["import type { Hash } from \"viem\";\nimport { getAddress, toHex } from \"viem\";\nimport type { VanaCacheAdapter } from \"../platform/interface\";\nimport { sha256 } from \"@noble/hashes/sha256\";\n\ninterface CachedSignature {\n signature: Hash;\n expires: number;\n}\n\n/**\n * Simple signature cache using platform cache adapter to avoid repeated signing of identical messages.\n *\n * @remarks\n * This cache significantly improves UX by avoiding repeated wallet signature prompts\n * for identical operations. It's particularly useful for operations that may be\n * retried or called multiple times with the same parameters.\n *\n * Features:\n * - Platform-appropriate storage (sessionStorage in browser, memory in Node.js)\n * - Configurable TTL (default 2 hours)\n * - Automatic cleanup of expired entries\n * - Cache keys based on wallet address + message hash\n *\n * @example\n * ```typescript\n * // Check cache before requesting signature\n * const cached = SignatureCache.get(cache, walletAddress, messageHash);\n * if (cached) {\n * return cached;\n * }\n *\n * // Request signature and cache it\n * const signature = await wallet.signTypedData(typedData);\n * SignatureCache.set(cache, walletAddress, messageHash, signature);\n * ```\n * @category Utilities\n */\nexport class SignatureCache {\n private static readonly PREFIX = \"vana_sig_\";\n private static readonly DEFAULT_TTL_HOURS = 2;\n\n /**\n * Get a cached signature if it exists and hasn't expired\n *\n * @param cache - Platform cache adapter instance\n * @param walletAddress - Wallet address that created the signature\n * @param messageHash - Hash of the message that was signed\n * @returns The cached signature if valid, null if expired or not found\n * @example\n * ```typescript\n * const messageHash = SignatureCache.hashMessage(typedData);\n * const cached = SignatureCache.get(cache, '0x123...', messageHash);\n * if (cached) {\n * console.log('Using cached signature:', cached);\n * }\n * ```\n */\n static get(\n cache: VanaCacheAdapter,\n walletAddress: string,\n messageHash: string,\n ): Hash | null {\n const key = this.getCacheKey(walletAddress, messageHash);\n\n try {\n const stored = cache.get(key);\n if (!stored) return null;\n\n const cached: CachedSignature = JSON.parse(stored);\n\n // Check if expired\n if (Date.now() > cached.expires) {\n cache.delete(key);\n return null;\n }\n\n return cached.signature;\n } catch {\n // Invalid JSON or storage error, clean up\n try {\n cache.delete(key);\n } catch {\n // Ignore cache cleanup errors\n }\n return null;\n }\n }\n\n /**\n * Store a signature in the cache with configurable TTL\n *\n * @param cache - Platform cache adapter instance\n * @param walletAddress - Wallet address that created the signature\n * @param messageHash - Hash of the message that was signed\n * @param signature - The signature to cache\n * @param ttlHours - Time to live in hours (default: 2)\n * @example\n * ```typescript\n * const signature = await wallet.signTypedData(typedData);\n * const messageHash = SignatureCache.hashMessage(typedData);\n *\n * // Cache for default 2 hours\n * SignatureCache.set(cache, walletAddress, messageHash, signature);\n *\n * // Cache for 24 hours\n * SignatureCache.set(cache, walletAddress, messageHash, signature, 24);\n * ```\n */\n static set(\n cache: VanaCacheAdapter,\n walletAddress: string,\n messageHash: string,\n signature: Hash,\n ttlHours: number = this.DEFAULT_TTL_HOURS,\n ): void {\n const key = this.getCacheKey(walletAddress, messageHash);\n const cached: CachedSignature = {\n signature,\n expires: Date.now() + ttlHours * 3600000, // Convert hours to milliseconds\n };\n\n try {\n cache.set(key, JSON.stringify(cached));\n } catch {\n // Storage quota exceeded or other error, ignore silently\n // Better to continue without caching than to fail\n }\n }\n\n /**\n * Clear all cached signatures (useful for testing or explicit cleanup)\n *\n * @param cache - Platform cache adapter instance\n * @example\n * ```typescript\n * // Clear all signatures when user logs out\n * SignatureCache.clear(cache);\n *\n * // Clear before running tests\n * beforeEach(() => {\n * SignatureCache.clear(cache);\n * });\n * ```\n */\n static clear(cache: VanaCacheAdapter): void {\n try {\n cache.clear();\n } catch {\n // Ignore storage errors\n }\n }\n\n private static getCacheKey(\n walletAddress: string,\n messageHash: string,\n ): string {\n return `${this.PREFIX}${getAddress(walletAddress)}:${messageHash}`;\n }\n\n /**\n * Generate a deterministic hash of a message object for cache key generation\n *\n * @remarks\n * Creates a cryptographically secure hash from complex objects including EIP-712 typed data.\n * Uses SHA-256 for collision resistance and deterministic key generation.\n * Handles BigInt serialization and sorts object keys for consistency.\n *\n * @param message - The message object to hash (typically EIP-712 typed data)\n * @returns A hex string hash (SHA-256) suitable for cache keys\n * @example\n * ```typescript\n * const typedData = {\n * domain: { name: 'Vana', version: '1' },\n * message: { nonce: 123n, grant: '...' }\n * };\n *\n * const hash = SignatureCache.hashMessage(typedData);\n * // Returns SHA-256 hash like: \"a1b2c3d4e5f6...\"\n * ```\n */\n static hashMessage(message: object): string {\n // Deterministically stringify the object with sorted keys\n const jsonString = JSON.stringify(message, this.deterministicReplacer);\n\n // Use SHA-256 for cryptographic hashing\n const hashBytes = sha256(new TextEncoder().encode(jsonString));\n return toHex(hashBytes);\n }\n\n /**\n * Deterministic JSON replacer that handles BigInt values and sorts object keys\n * This ensures consistent cache key generation for EIP-712 typed data\n *\n * @param _key - The object key being serialized (unused)\n * @param value - The value to serialize\n * @returns The serialized value with sorted keys for objects\n */\n private static deterministicReplacer(_key: string, value: unknown): unknown {\n if (typeof value === \"bigint\") {\n return `__BIGINT__${value.toString()}`;\n }\n // Sort object keys for deterministic serialization\n if (value !== null && typeof value === \"object\" && !Array.isArray(value)) {\n return Object.keys(value as Record<string, unknown>)\n .sort()\n .reduce(\n (sorted, key) => {\n sorted[key] = (value as Record<string, unknown>)[key];\n return sorted;\n },\n {} as Record<string, unknown>,\n );\n }\n return value;\n }\n}\n\n/**\n * Wrapper function to cache signature operations\n *\n * @param cache - The cache adapter to use for storage\n * @param walletAddress - The wallet address signing the message\n * @param typedData - The EIP-712 typed data being signed\n * @param signFn - Function that performs the actual signing\n * @param ttlHours - Cache TTL in hours (default 2)\n * @returns The signature (cached or newly generated)\n */\nexport async function withSignatureCache(\n cache: VanaCacheAdapter,\n walletAddress: string,\n typedData: Record<string, unknown>,\n signFn: () => Promise<Hash>,\n ttlHours?: number,\n): Promise<Hash> {\n // Create a hash of the typed data for the cache key\n const messageHash = SignatureCache.hashMessage(typedData);\n\n // Try to get from cache first\n const cached = SignatureCache.get(cache, walletAddress, messageHash);\n if (cached) {\n return cached;\n }\n\n // Not in cache, sign and store\n const signature = await signFn();\n SignatureCache.set(cache, walletAddress, messageHash, signature, ttlHours);\n\n return signature;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,kBAAkC;AAElC,oBAAuB;AAmChB,MAAM,eAAe;AAAA,EAC1B,OAAwB,SAAS;AAAA,EACjC,OAAwB,oBAAoB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkB5C,OAAO,IACL,OACA,eACA,aACa;AACb,UAAM,MAAM,KAAK,YAAY,eAAe,WAAW;AAEvD,QAAI;AACF,YAAM,SAAS,MAAM,IAAI,GAAG;AAC5B,UAAI,CAAC,OAAQ,QAAO;AAEpB,YAAM,SAA0B,KAAK,MAAM,MAAM;AAGjD,UAAI,KAAK,IAAI,IAAI,OAAO,SAAS;AAC/B,cAAM,OAAO,GAAG;AAChB,eAAO;AAAA,MACT;AAEA,aAAO,OAAO;AAAA,IAChB,QAAQ;AAEN,UAAI;AACF,cAAM,OAAO,GAAG;AAAA,MAClB,QAAQ;AAAA,MAER;AACA,aAAO;AAAA,IACT;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,OAAO,IACL,OACA,eACA,aACA,WACA,WAAmB,KAAK,mBAClB;AACN,UAAM,MAAM,KAAK,YAAY,eAAe,WAAW;AACvD,UAAM,SAA0B;AAAA,MAC9B;AAAA,MACA,SAAS,KAAK,IAAI,IAAI,WAAW;AAAA;AAAA,IACnC;AAEA,QAAI;AACF,YAAM,IAAI,KAAK,KAAK,UAAU,MAAM,CAAC;AAAA,IACvC,QAAQ;AAAA,IAGR;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,OAAO,MAAM,OAA+B;AAC1C,QAAI;AACF,YAAM,MAAM;AAAA,IACd,QAAQ;AAAA,IAER;AAAA,EACF;AAAA,EAEA,OAAe,YACb,eACA,aACQ;AACR,WAAO,GAAG,KAAK,MAAM,OAAG,wBAAW,aAAa,CAAC,IAAI,WAAW;AAAA,EAClE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAuBA,OAAO,YAAY,SAAyB;AAE1C,UAAM,aAAa,KAAK,UAAU,SAAS,KAAK,qBAAqB;AAGrE,UAAM,gBAAY,sBAAO,IAAI,YAAY,EAAE,OAAO,UAAU,CAAC;AAC7D,eAAO,mBAAM,SAAS;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,OAAe,sBAAsB,MAAc,OAAyB;AAC1E,QAAI,OAAO,UAAU,UAAU;AAC7B,aAAO,aAAa,MAAM,SAAS,CAAC;AAAA,IACtC;AAEA,QAAI,UAAU,QAAQ,OAAO,UAAU,YAAY,CAAC,MAAM,QAAQ,KAAK,GAAG;AACxE,aAAO,OAAO,KAAK,KAAgC,EAChD,KAAK,EACL;AAAA,QACC,CAAC,QAAQ,QAAQ;AACf,iBAAO,GAAG,IAAK,MAAkC,GAAG;AACpD,iBAAO;AAAA,QACT;AAAA,QACA,CAAC;AAAA,MACH;AAAA,IACJ;AACA,WAAO;AAAA,EACT;AACF;AAYA,eAAsB,mBACpB,OACA,eACA,WACA,QACA,UACe;AAEf,QAAM,cAAc,eAAe,YAAY,SAAS;AAGxD,QAAM,SAAS,eAAe,IAAI,OAAO,eAAe,WAAW;AACnE,MAAI,QAAQ;AACV,WAAO;AAAA,EACT;AAGA,QAAM,YAAY,MAAM,OAAO;AAC/B,iBAAe,IAAI,OAAO,eAAe,aAAa,WAAW,QAAQ;AAEzE,SAAO;AACT;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../../src/utils/signatureCache.ts"],"sourcesContent":["/**\n * Provides signature caching to improve UX by avoiding repeated wallet prompts.\n *\n * @remarks\n * This module implements a secure signature cache that stores signed messages\n * temporarily to avoid repeatedly prompting users for the same signature.\n * It uses platform-appropriate storage (sessionStorage in browser, memory in Node.js)\n * and includes automatic expiration and cleanup.\n *\n * @category Utilities\n * @module utils/signatureCache\n */\n\nimport type { Hash } from \"viem\";\nimport { getAddress, toHex } from \"viem\";\nimport type { VanaCacheAdapter } from \"../platform/interface\";\nimport { sha256 } from \"@noble/hashes/sha256\";\n\n/**\n * Represents a cached signature with expiration metadata.\n *\n * @internal\n */\ninterface CachedSignature {\n /** The cached signature hash */\n signature: Hash;\n /** Unix timestamp when this cache entry expires */\n expires: number;\n}\n\n/**\n * Simple signature cache using platform cache adapter to avoid repeated signing of identical messages.\n *\n * @remarks\n * This cache significantly improves UX by avoiding repeated wallet signature prompts\n * for identical operations. It's particularly useful for operations that may be\n * retried or called multiple times with the same parameters.\n *\n * Features:\n * - Platform-appropriate storage (sessionStorage in browser, memory in Node.js)\n * - Configurable TTL (default 2 hours)\n * - Automatic cleanup of expired entries\n * - Cache keys based on wallet address + message hash\n *\n * @example\n * ```typescript\n * // Check cache before requesting signature\n * const cached = SignatureCache.get(cache, walletAddress, messageHash);\n * if (cached) {\n * return cached;\n * }\n *\n * // Request signature and cache it\n * const signature = await wallet.signTypedData(typedData);\n * SignatureCache.set(cache, walletAddress, messageHash, signature);\n * ```\n * @category Utilities\n */\nexport class SignatureCache {\n private static readonly PREFIX = \"vana_sig_\";\n private static readonly DEFAULT_TTL_HOURS = 2;\n\n /**\n * Get a cached signature if it exists and hasn't expired\n *\n * @param cache - Platform cache adapter instance\n * @param walletAddress - Wallet address that created the signature\n * @param messageHash - Hash of the message that was signed\n * @returns The cached signature if valid, null if expired or not found\n * @example\n * ```typescript\n * const messageHash = SignatureCache.hashMessage(typedData);\n * const cached = SignatureCache.get(cache, '0x123...', messageHash);\n * if (cached) {\n * console.log('Using cached signature:', cached);\n * }\n * ```\n */\n static get(\n cache: VanaCacheAdapter,\n walletAddress: string,\n messageHash: string,\n ): Hash | null {\n const key = this.getCacheKey(walletAddress, messageHash);\n\n try {\n const stored = cache.get(key);\n if (!stored) return null;\n\n const cached: CachedSignature = JSON.parse(stored);\n\n // Check if expired\n if (Date.now() > cached.expires) {\n cache.delete(key);\n return null;\n }\n\n return cached.signature;\n } catch {\n // Invalid JSON or storage error, clean up\n try {\n cache.delete(key);\n } catch {\n // Ignore cache cleanup errors\n }\n return null;\n }\n }\n\n /**\n * Store a signature in the cache with configurable TTL\n *\n * @param cache - Platform cache adapter instance\n * @param walletAddress - Wallet address that created the signature\n * @param messageHash - Hash of the message that was signed\n * @param signature - The signature to cache\n * @param ttlHours - Time to live in hours (default: 2)\n * @example\n * ```typescript\n * const signature = await wallet.signTypedData(typedData);\n * const messageHash = SignatureCache.hashMessage(typedData);\n *\n * // Cache for default 2 hours\n * SignatureCache.set(cache, walletAddress, messageHash, signature);\n *\n * // Cache for 24 hours\n * SignatureCache.set(cache, walletAddress, messageHash, signature, 24);\n * ```\n */\n static set(\n cache: VanaCacheAdapter,\n walletAddress: string,\n messageHash: string,\n signature: Hash,\n ttlHours: number = this.DEFAULT_TTL_HOURS,\n ): void {\n const key = this.getCacheKey(walletAddress, messageHash);\n const cached: CachedSignature = {\n signature,\n expires: Date.now() + ttlHours * 3600000, // Convert hours to milliseconds\n };\n\n try {\n cache.set(key, JSON.stringify(cached));\n } catch {\n // Storage quota exceeded or other error, ignore silently\n // Better to continue without caching than to fail\n }\n }\n\n /**\n * Clear all cached signatures (useful for testing or explicit cleanup)\n *\n * @param cache - Platform cache adapter instance\n * @example\n * ```typescript\n * // Clear all signatures when user logs out\n * SignatureCache.clear(cache);\n *\n * // Clear before running tests\n * beforeEach(() => {\n * SignatureCache.clear(cache);\n * });\n * ```\n */\n static clear(cache: VanaCacheAdapter): void {\n try {\n cache.clear();\n } catch {\n // Ignore storage errors\n }\n }\n\n private static getCacheKey(\n walletAddress: string,\n messageHash: string,\n ): string {\n return `${this.PREFIX}${getAddress(walletAddress)}:${messageHash}`;\n }\n\n /**\n * Generate a deterministic hash of a message object for cache key generation\n *\n * @remarks\n * Creates a cryptographically secure hash from complex objects including EIP-712 typed data.\n * Uses SHA-256 for collision resistance and deterministic key generation.\n * Handles BigInt serialization and sorts object keys for consistency.\n *\n * @param message - The message object to hash (typically EIP-712 typed data)\n * @returns A hex string hash (SHA-256) suitable for cache keys\n * @example\n * ```typescript\n * const typedData = {\n * domain: { name: 'Vana', version: '1' },\n * message: { nonce: 123n, grant: '...' }\n * };\n *\n * const hash = SignatureCache.hashMessage(typedData);\n * // Returns SHA-256 hash like: \"a1b2c3d4e5f6...\"\n * ```\n */\n static hashMessage(message: object): string {\n // Deterministically stringify the object with sorted keys\n const jsonString = JSON.stringify(message, this.deterministicReplacer);\n\n // Use SHA-256 for cryptographic hashing\n const hashBytes = sha256(new TextEncoder().encode(jsonString));\n return toHex(hashBytes);\n }\n\n /**\n * Deterministic JSON replacer for consistent cache key generation.\n *\n * @remarks\n * Handles BigInt serialization and sorts object keys to ensure\n * identical objects always produce the same hash regardless of\n * property order.\n *\n * @param _key - The object key being serialized (unused)\n * @param value - The value to serialize\n * @returns The serialized value with sorted keys for objects\n *\n * @internal\n */\n private static deterministicReplacer(_key: string, value: unknown): unknown {\n if (typeof value === \"bigint\") {\n return `__BIGINT__${value.toString()}`;\n }\n // Sort object keys for deterministic serialization\n if (value !== null && typeof value === \"object\" && !Array.isArray(value)) {\n return Object.keys(value as Record<string, unknown>)\n .sort()\n .reduce(\n (sorted, key) => {\n sorted[key] = (value as Record<string, unknown>)[key];\n return sorted;\n },\n {} as Record<string, unknown>,\n );\n }\n return value;\n }\n}\n\n/**\n * Wraps signature operations with caching to avoid repeated prompts.\n *\n * @remarks\n * This helper function checks the cache before requesting a signature\n * and stores new signatures for future use. It significantly improves\n * UX for operations that may be retried or called multiple times.\n *\n * @param cache - The cache adapter to use for storage.\n * Obtain from platform adapter.\n * @param walletAddress - The wallet address signing the message.\n * Obtain from wallet connection.\n * @param typedData - The EIP-712 typed data being signed.\n * Typically permission or grant data.\n * @param signFn - Async function that performs the actual signing.\n * Usually calls wallet.signTypedData().\n * @param ttlHours - Cache TTL in hours.\n * Defaults to 2 hours.\n * @returns The signature (cached or newly generated)\n *\n * @example\n * ```typescript\n * const signature = await withSignatureCache(\n * platformAdapter.cache,\n * walletAddress,\n * typedData,\n * async () => wallet.signTypedData(typedData),\n * 24 // Cache for 24 hours\n * );\n * ```\n *\n * @category Utilities\n */\nexport async function withSignatureCache(\n cache: VanaCacheAdapter,\n walletAddress: string,\n typedData: Record<string, unknown>,\n signFn: () => Promise<Hash>,\n ttlHours?: number,\n): Promise<Hash> {\n // Create a hash of the typed data for the cache key\n const messageHash = SignatureCache.hashMessage(typedData);\n\n // Try to get from cache first\n const cached = SignatureCache.get(cache, walletAddress, messageHash);\n if (cached) {\n return cached;\n }\n\n // Not in cache, sign and store\n const signature = await signFn();\n SignatureCache.set(cache, walletAddress, messageHash, signature, ttlHours);\n\n return signature;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAcA,kBAAkC;AAElC,oBAAuB;AA0ChB,MAAM,eAAe;AAAA,EAC1B,OAAwB,SAAS;AAAA,EACjC,OAAwB,oBAAoB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkB5C,OAAO,IACL,OACA,eACA,aACa;AACb,UAAM,MAAM,KAAK,YAAY,eAAe,WAAW;AAEvD,QAAI;AACF,YAAM,SAAS,MAAM,IAAI,GAAG;AAC5B,UAAI,CAAC,OAAQ,QAAO;AAEpB,YAAM,SAA0B,KAAK,MAAM,MAAM;AAGjD,UAAI,KAAK,IAAI,IAAI,OAAO,SAAS;AAC/B,cAAM,OAAO,GAAG;AAChB,eAAO;AAAA,MACT;AAEA,aAAO,OAAO;AAAA,IAChB,QAAQ;AAEN,UAAI;AACF,cAAM,OAAO,GAAG;AAAA,MAClB,QAAQ;AAAA,MAER;AACA,aAAO;AAAA,IACT;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,OAAO,IACL,OACA,eACA,aACA,WACA,WAAmB,KAAK,mBAClB;AACN,UAAM,MAAM,KAAK,YAAY,eAAe,WAAW;AACvD,UAAM,SAA0B;AAAA,MAC9B;AAAA,MACA,SAAS,KAAK,IAAI,IAAI,WAAW;AAAA;AAAA,IACnC;AAEA,QAAI;AACF,YAAM,IAAI,KAAK,KAAK,UAAU,MAAM,CAAC;AAAA,IACvC,QAAQ;AAAA,IAGR;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,OAAO,MAAM,OAA+B;AAC1C,QAAI;AACF,YAAM,MAAM;AAAA,IACd,QAAQ;AAAA,IAER;AAAA,EACF;AAAA,EAEA,OAAe,YACb,eACA,aACQ;AACR,WAAO,GAAG,KAAK,MAAM,OAAG,wBAAW,aAAa,CAAC,IAAI,WAAW;AAAA,EAClE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAuBA,OAAO,YAAY,SAAyB;AAE1C,UAAM,aAAa,KAAK,UAAU,SAAS,KAAK,qBAAqB;AAGrE,UAAM,gBAAY,sBAAO,IAAI,YAAY,EAAE,OAAO,UAAU,CAAC;AAC7D,eAAO,mBAAM,SAAS;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,OAAe,sBAAsB,MAAc,OAAyB;AAC1E,QAAI,OAAO,UAAU,UAAU;AAC7B,aAAO,aAAa,MAAM,SAAS,CAAC;AAAA,IACtC;AAEA,QAAI,UAAU,QAAQ,OAAO,UAAU,YAAY,CAAC,MAAM,QAAQ,KAAK,GAAG;AACxE,aAAO,OAAO,KAAK,KAAgC,EAChD,KAAK,EACL;AAAA,QACC,CAAC,QAAQ,QAAQ;AACf,iBAAO,GAAG,IAAK,MAAkC,GAAG;AACpD,iBAAO;AAAA,QACT;AAAA,QACA,CAAC;AAAA,MACH;AAAA,IACJ;AACA,WAAO;AAAA,EACT;AACF;AAmCA,eAAsB,mBACpB,OACA,eACA,WACA,QACA,UACe;AAEf,QAAM,cAAc,eAAe,YAAY,SAAS;AAGxD,QAAM,SAAS,eAAe,IAAI,OAAO,eAAe,WAAW;AACnE,MAAI,QAAQ;AACV,WAAO;AAAA,EACT;AAGA,QAAM,YAAY,MAAM,OAAO;AAC/B,iBAAe,IAAI,OAAO,eAAe,aAAa,WAAW,QAAQ;AAEzE,SAAO;AACT;","names":[]}
|