Skip to main content

API Surface Tables (generated)

Complete, compiler-derived reference tables for the on-chain ABI surface and the SDK export surface at monorepo commit d3bdb17. Unlike the curated pages, these tables are generated from code (forge inspect + the TypeScript compiler API), include inherited members, and are regenerated rather than edited; see the header of scripts/api-surface/generate.mjs for provenance and refresh instructions.

Contract ABI surface

Selectors and event topics are compiler-derived. Inherited members (UUPS proxy, AccessControl, Pausable, the Permissioned/RootBuffer abstracts, shared ProofLib errors) are included, because integrators see them in the ABI and in reverts.

ASPRegistry

Functions (10)

SignatureSelector
ACCESS_ROUTER()0x67ad047b
UPGRADE_INTERFACE_VERSION()0xad3cb1cc
associationSets(uint256)0xddb6afa9
initialize()0x8129fc1c
latestASPRoot()0x36149de2
latestIPFSCID()0x210f34f0
proxiableUUID()0x52d1902d
registerLabel(bytes)0x35604e87
updateASPRoot(uint256,bytes)0x5bced48c
upgradeToAndCall(address,bytes)0x4f1ef286

Events (4)

SignatureTopic0
ASPRootUpdated(uint256,bytes)0x2effd619afa1b348e26a571cc56deb6372df0594824958af70b3341ef3a1d095
Initialized(uint64)0xc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d2
LabelRegistered(bytes)0x4482ecab5f8791b4727cce36d0203847bc2f5fd14788bf277967cc9fcc4d2ad5
Upgraded(address)0xbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b

Errors (14)

SignatureSelector
ASPRegistry_EmptyASPRoot()0xca458c8c
ASPRegistry_EmptyAssociationSet()0xb89692d7
ASPRegistry_EmptyIPFSCID()0x05fd9be6
ASPRegistry_RootOutOfField()0xab1d379b
AddressEmptyCode(address)0x9996b315
ERC1967InvalidImplementation(address)0x4c9c8ce3
ERC1967NonPayable()0xb398979f
FailedCall()0xd6bda275
InvalidInitialization()0xf92ee8a9
NotInitializing()0xd7e6bcf8
Permissioned_InvalidAccessRouter()0xa61e16aa
Permissioned_NotAuthorized()0x4259e7de
UUPSUnauthorizedCallContext()0xe07c8dba
UUPSUnsupportedProxiableUUID(bytes32)0xaa1d49a4

AccessRouter

Functions (7)

SignatureSelector
DEFAULT_ADMIN_ROLE()0xa217fddf
getRoleAdmin(bytes32)0x248a9ca3
grantRole(bytes32,address)0x2f2ff15d
hasRole(bytes32,address)0x91d14854
renounceRole(bytes32,address)0x36568abe
revokeRole(bytes32,address)0xd547741f
supportsInterface(bytes4)0x01ffc9a7

Events (3)

SignatureTopic0
RoleAdminChanged(bytes32,bytes32,bytes32)0xbd79b86ffe0ab8e8776151514217cd7cacd52c909f66475c3af44e129f0b00ff
RoleGranted(bytes32,address,address)0x2f8788117e7eff1d82e926ec794901d17c78024a50270940304540a733656f0d
RoleRevoked(bytes32,address,address)0xf6391f5c32d9c69d2a47ea670b442974b53935d1edc7fd64eb21e047a839171b

Errors (3)

SignatureSelector
AccessControlBadConfirmation()0x6697b232
AccessControlUnauthorizedAccount(address,bytes32)0xe2517d3f
AccessRouter_AdminRoleEscalation(bytes32)0xf8f7a094

Entrypoint

Functions (11)

SignatureSelector
ACCESS_ROUTER()0x67ad047b
UPGRADE_INTERFACE_VERSION()0xad3cb1cc
assets(address)0xf11b8188
deposit((uint256[2],uint256[2][2],uint256[2],uint256[4]),(bytes32,bytes),bytes)0x5dc67ea4
initialize(address)0xc4d66de8
poolVault()0x4b47002c
proxiableUUID()0x52d1902d
setAssetConfiguration(address,(bool,uint256,uint256,uint256))0xd3ed0048
setPoolVault(address)0x51cb9ad3
sweep(address,address)0xb8dc491b
upgradeToAndCall(address,bytes)0x4f1ef286

Events (6)

SignatureTopic0
AssetConfigurationSet(address,IEntrypoint.AssetConfig)0xdcf0db4a8dbed3a51b1e0591b42395e93069d1ea8a95c5fe855ed196cf0fd845
Deposited(address,address,uint256,uint256)0xf5681f9d0db1b911ac18ee83d515a1cf1051853a9eae418316a2fdf7dea427c5
Initialized(uint64)0xc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d2
PoolVaultSet(address,address)0x62f1cee08e3e6a6743e3c4add6a0689102e68b0cca97a1fcee40948fdef5b048
Swept(address,address,uint256)0x7b09c29f9106defeccc9ac3b823f3aad0b470d120e5df7aed033b5c43a4bf718
Upgraded(address)0xbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b

Errors (17)

SignatureSelector
AddressEmptyCode(address)0x9996b315
ERC1967InvalidImplementation(address)0x4c9c8ce3
ERC1967NonPayable()0xb398979f
Entrypoint_AssetNotEnabled()0xa725f4dd
Entrypoint_BelowMinAmount()0x1be82a3e
Entrypoint_InvalidETHAmount()0xadd8ac22
Entrypoint_InvalidFeeBPS()0xfbb51a86
Entrypoint_InvalidMinAmount()0x01b9d724
Entrypoint_UnexpectedETHAmount()0xf22e12e2
FailedCall()0xd6bda275
InvalidInitialization()0xf92ee8a9
NotInitializing()0xd7e6bcf8
Permissioned_InvalidAccessRouter()0xa61e16aa
Permissioned_NotAuthorized()0x4259e7de
ProofLib_TokenIdNotCanonical(uint256)0x11297127
UUPSUnauthorizedCallContext()0xe07c8dba
UUPSUnsupportedProxiableUUID(bytes32)0xaa1d49a4

Keystore

Functions (21)

SignatureSelector
ACCESS_ROUTER()0x67ad047b
SET_AUTH_POLICY_TYPEHASH()0x26d17752
UPGRADE_INTERFACE_VERSION()0xad3cb1cc
currentRoot()0xfdab463d
eip712Domain()0x84b0196e
initialize(uint256,uint256)0xe4a30116
initializeEIP712()0x630fcbfb
isKnownRoot(uint256)0xa6232a93
keystoreRootLiveness()0xf7a8f72f
maxKeystoreTreeSize()0x6c550aee
nullifyingKeys(address)0x696f0061
previousRoots(uint256)0xfb12c4bc
proxiableUUID()0x52d1902d
setAuthPolicy(uint256,uint256)0x735aeddc
setAuthPolicyWithSig(address,uint256,uint256,uint256,bytes)0xe6c97c2b
setKeystoreRootLiveness(uint256)0x40796db6
setMaxKeystoreTreeSize(uint256)0x23ca781e
setViewingKey(bytes32)0x73897d65
updateAuthPolicy(uint256,uint256,uint256[])0x8e0b26e3
upgradeToAndCall(address,bytes)0x4f1ef286
viewingKeys(address)0x03bb850a

Events (12)

SignatureTopic0
AuthPolicySet(address,uint256,uint256)0xb4ee8d3465bf3f6a10d98aaacfe5182818740ee7527ce0d60b039d381e854773
AuthPolicyUpdated(address,uint256,uint256)0x0ed010b673dadbcbc5c3cd7061f311226282bfee27c28a77a062e6e4944e5d31
EIP712DomainChanged()0x0a6387c9ea3628b88a633bb4f3b151770f70085117a15f9bf3787cda53f13d31
Initialized(uint64)0xc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d2
KeystoreRootLivenessUpdated(uint256,uint256)0x52df8002b8a858ad74302a8a03c7ebb4f84661f88b5add8d4ccd645f211c0f3a
LeafInserted(uint256,uint256,uint256)0xcb249c8292372bd11f567786635483fca9e635030baafca55ff1a8940141d221
LeafUpdated(uint256,uint256,uint256)0x1a55748e50dfa0d2cd84f9107dc6c3f3dba3758de858289c1e9ff80318f7efcf
LeavesInserted(uint256[],uint256,uint256)0x71efc8d0e20326390b50623dcb30bcaa5f572ec195c93b9aa78779e2da452947
MaxKeystoreTreeSizeUpdated(uint256,uint256)0xda61470a96cd83a059c52001fc678fcb230e76a5e1f70bde6c601f8f5ae3cfd4
RootSuperseded(uint256,uint256,uint256)0xcd04b9375290da66da4bb3483c0db4137c29a53612518a58d28b1b5780409d7e
Upgraded(address)0xbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b
ViewingKeySet(address,bytes32,bytes32)0x9c75a803e347607503973ae12ae2ec4b172a73215c0e166147f948901ef43ea9

Errors (18)

SignatureSelector
AddressEmptyCode(address)0x9996b315
ERC1967InvalidImplementation(address)0x4c9c8ce3
ERC1967NonPayable()0xb398979f
FailedCall()0xd6bda275
InvalidInitialization()0xf92ee8a9
Keystore_AuthPolicyAlreadySet()0x70d48a55
Keystore_AuthPolicyNotSet()0xe2e716bd
Keystore_InvalidMaxTreeSize()0x3542d539
Keystore_InvalidNullifyingKeyHash()0xbde6fb2a
Keystore_InvalidSignature()0x0ae65d93
Keystore_KeystoreTreeFull()0x384dd891
Keystore_OutOfScalarField()0x8379dcb3
Keystore_SignatureExpired()0xfae4046b
NotInitializing()0xd7e6bcf8
Permissioned_InvalidAccessRouter()0xa61e16aa
Permissioned_NotAuthorized()0x4259e7de
UUPSUnauthorizedCallContext()0xe07c8dba
UUPSUnsupportedProxiableUUID(bytes32)0xaa1d49a4

PoolVault

Functions (29)

SignatureSelector
ACCESS_ROUTER()0x67ad047b
UPGRADE_INTERFACE_VERSION()0xad3cb1cc
aspRegistry()0x014154c8
commitments(uint256)0x49ce8997
currentRootIndex()0x90eeb02b
deposit((uint256[2],uint256[2][2],uint256[2],uint256[4]),(bytes32,bytes))0x37d38383
depositVerifier()0x26120c88
initialize(uint32,(uint8,uint8,(address,bytes4))[],address,address,address,address,uint256)0xc9d514f6
isKnownRoot(uint256)0xa6232a93
keystore()0x772a0001
maxStateTreeSize()0xe61c366a
pause()0x8456cb59
paused()0x5c975abb
proxiableUUID()0x52d1902d
ragequit((uint256[2],uint256[2][2],uint256[2],uint256[7]))0x769284c2
ragequitVerifier()0x5b62be4f
rootHistorySize()0x4f802cc3
roots(uint256)0xc2b40ae4
setAspRegistry(address)0x3aa3ea24
setDepositVerifier(address)0x2c6ce78b
setKeystore(address)0x2b3bce94
setMaxStateTreeSize(uint256)0x28154216
setRagequitVerifier(address)0x455a2405
setVerifier(uint8,uint8,(address,bytes4))0xb0843688
spentNullifiers(uint256)0x811608fd
transact((uint256[2],uint256[2][2],uint256[2],uint256[][]),(address,bytes),(bytes32,bytes)[])0x85afaff4
unpause()0x3f4ba83a
upgradeToAndCall(address,bytes)0x4f1ef286
verifiers(bytes32)0xefe1c950

Events (17)

SignatureTopic0
AspRegistrySet(address,address)0x9d0f31e5d21b76df0cf2552d52a4bbc8cc7316c95244d089f6df510d9dabcca7
DepositVerifierSet(address,address)0x228210577df043868c4cab0bffa11c80975c8d3e47695d6d3896f357472859aa
Deposited(uint256,address,uint256,address)0xed45e0df2bf0e287a792a7b79b19292af5cbab76cc8819049bf37aa067bf8501
Initialized(uint64)0xc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d2
KeystoreSet(address,address)0xea86dd1404c182ba093ef7be5a9222c98133fd8b127347d6809282bc72a2f069
LeafInserted(uint256,uint256,uint256)0xcb249c8292372bd11f567786635483fca9e635030baafca55ff1a8940141d221
LeafUpdated(uint256,uint256,uint256)0x1a55748e50dfa0d2cd84f9107dc6c3f3dba3758de858289c1e9ff80318f7efcf
LeavesInserted(uint256[],uint256,uint256)0x71efc8d0e20326390b50623dcb30bcaa5f572ec195c93b9aa78779e2da452947
MaxStateTreeSizeUpdated(uint256,uint256)0x909761ace9165e7cc0fc3ed0d6e72f87edbaf745075c5d00a8a5dacde2b931b7
Note(bytes32,bytes)0xf91eecda0527fb78e7a77f32ebf4f2b99a7ee58727e00050d9c1e9a6c7f10741
Paused(address)0x62e78cea01bee320cd4e420270b5ea74000d11b0c9f74754ebdbfc544b05a258
Ragequit(address,address,uint256,uint256,uint256,uint256)0x507455b25c1a4595720da5b6a8f6b76e4aa36db987a63b47266112d3cbf2e103
RagequitVerifierSet(address,address)0x5b5e76eca93b9f3f2a7ada60f30a2d38312345160196510e7c6743fa22fb5ad8
Transacted(uint256[],uint256[],address,uint256,address)0x10763cc44bf9290f53ec1afd9f70684d93fe62b7d1956d9a18410ae38da9d048
Unpaused(address)0x5db9ee0a495bf2e6ff9c91a7834c1ba4fdd244a5e8aa4e537bd38aeae4b073aa
Upgraded(address)0xbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b
VerifierConfigured(uint256,uint256,address,bytes4)0xcd537c23f72bac7ae6690ca3da761748318e5830aac7d1b666f0500ec8f7c918

Errors (36)

SignatureSelector
AddressEmptyCode(address)0x9996b315
ERC1967InvalidImplementation(address)0x4c9c8ce3
ERC1967NonPayable()0xb398979f
EnforcedPause()0xd93c0665
ExpectedPause()0x8dfc202b
FailedCall()0xd6bda275
InvalidInitialization()0xf92ee8a9
NotInitializing()0xd7e6bcf8
Permissioned_InvalidAccessRouter()0xa61e16aa
Permissioned_NotAuthorized()0x4259e7de
PoolVault_CommitmentAlreadyUsed()0xd5c4014d
PoolVault_CommitmentNotFound()0x5f1ecd03
PoolVault_InvalidASPRoot()0xbc158616
PoolVault_InvalidDepositProof()0x08bf478d
PoolVault_InvalidMaxTreeSize()0x190f5753
PoolVault_InvalidOwnerAddress()0x7db3fe30
PoolVault_InvalidProcessor()0xbf5488bb
PoolVault_InvalidRagequitProof()0xfdd2f81e
PoolVault_InvalidTransactProof()0x7c9a7f95
PoolVault_InvalidValue()0x5193e9ce
PoolVault_NullifierAlreadySpent()0x66f527f1
PoolVault_ProofContextMismatch()0x59dfbba8
PoolVault_StateTreeFull()0xf2608d7d
PoolVault_TokenIdMustBeZeroOnInternalTransfer()0x6422a609
PoolVault_UnexpectedETHAmount()0x04677ccd
PoolVault_UnknownKeystoreRoot()0x67837531
PoolVault_UnknownStateRoot()0xaece4b7d
PoolVault_ZeroValueRagequit()0x70a5f342
ProofLib_TokenIdNotCanonical(uint256)0x11297127
ReentrancyGuardReentrantCall()0x3ee5aeb5
RootBuffer_InvalidSize()0x1dada500
TransactVerifierRouter_InvalidZeroParameter()0x5f675530
TransactVerifierRouter_UnsupportedCircuitConfiguration(uint256,uint256)0x1d317139
TransactVerifierRouter_VerifierCallReverted(bytes)0x6d800616
UUPSUnauthorizedCallContext()0xe07c8dba
UUPSUnsupportedProxiableUUID(bytes32)0xaa1d49a4

PrivacyPoolRelay

Functions (8)

SignatureSelector
ANNOUNCER()0x04e6b741
ENTRYPOINT()0xe8eb3cc6
MAX_BATCH()0x950bff9f
POOL()0x7535d246
registerAndRelay(address,uint256,uint256,uint256,bytes,(uint256[2],uint256[2][2],uint256[2],uint256[][]),(address,bytes),(bytes32,bytes)[])0xaaa7a340
relay((uint256[2],uint256[2][2],uint256[2],uint256[][]),(address,bytes),(bytes32,bytes)[])0xace97342
relayAndAnnounce((uint256[2],uint256[2][2],uint256[2],uint256[][]),(address,bytes),(bytes32,bytes)[],(uint256,address,bytes,bytes))0xc4c87453
relayBatch((uint256[2],uint256[2][2],uint256[2],uint256[][])[],(address,bytes)[],(bytes32,bytes)[][])0xc4056d6b

Events (2)

SignatureTopic0
Relayed(address,address,uint256,address,uint256,uint256)0xd1b9445f341fec280e18122a3b33b6fe749accb395541acf5d202550b3a9b320
RelayedBatch(address,address,uint256,address,uint256,uint256,uint256)0xc2d326574cbb76a0a65fd60e94981ba75041b9f47f2f5760881546aac11ed81a

Errors (17)

SignatureSelector
PrivacyPoolRelay_AnnouncementRecipientMismatch()0x3815c166
PrivacyPoolRelay_BatchLengthMismatch()0x56eed43a
PrivacyPoolRelay_BatchTooLarge()0xec225273
PrivacyPoolRelay_EmptyBatch()0xe3196ff2
PrivacyPoolRelay_FeeExceedsMax()0x126501fa
PrivacyPoolRelay_FeeExceedsWithdrawal()0x08bd4a2b
PrivacyPoolRelay_InconsistentAsset()0x255351c8
PrivacyPoolRelay_InconsistentRecipient()0x71825c3a
PrivacyPoolRelay_NativeGasMismatch()0x3790ec3d
PrivacyPoolRelay_OnlyPoolCanSendETH()0xdbd90844
PrivacyPoolRelay_RootHistoryTooSmall()0xe264e2ba
PrivacyPoolRelay_ZeroAnnouncer()0xc4d16dd7
PrivacyPoolRelay_ZeroEntrypoint()0xe20372cc
PrivacyPoolRelay_ZeroPool()0xb33ca2db
PrivacyPoolRelay_ZeroRecipient()0x02cc0c04
PrivacyPoolRelay_ZeroWithdrawal()0x89e74081
ProofLib_TokenIdNotCanonical(uint256)0x11297127

PPRouter

Functions (15)

SignatureSelector
A_TOKEN()0x9ef0159f
DUST_RECIPIENT()0xe1d5ac2f
ENTRYPOINT()0xe8eb3cc6
NATIVE_MODE()0x549672a2
POOL()0x7535d246
POOL_VAULT()0xdc6ae985
UNDERLYING()0xc5d664c6
VAULT()0x411557d1
ZAP()0x3e09ed96
depositExactShares((uint256[2],uint256[2][2],uint256[2],uint256[4]),(bytes32,bytes),bytes,uint256)0xc63148e8
depositExactSharesNative((uint256[2],uint256[2][2],uint256[2],uint256[4]),(bytes32,bytes),bytes)0x31c09bb4
quote(uint256)0xed1bd76c
quoteWithdraw(uint256)0xec211840
skim()0x1dd19cb4
withdrawToUnderlying((uint256[2],uint256[2][2],uint256[2],uint256[][]),(address,bytes),(bytes32,bytes)[],uint256)0x23b370bb

Events (3)

SignatureTopic0
Deposited(address,address,uint256,uint256,uint256)0x8bab6aed5a508937051a144e61d6e61336834a66aaee250a00613ae6f744c422
Skimmed(address,uint256)0xb0477b3d4d588e76d76df1c6cf069311c9dc4f742f19d0f74a70f58803d0768f
WithdrawnToUnderlying(address,address,address,uint256,uint256,address,uint256,uint256,uint256)0xa3d5ae3284df0c2cdde6ee0f85695bfc815298b124dde25caba72fd1e2c491b7

Errors (20)

SignatureSelector
FailedCall()0xd6bda275
InsufficientBalance(uint256,uint256)0xcf479181
PPRouter_AssetMismatch(address)0x3d8c2936
PPRouter_BelowMinUnderlying(uint256,uint256)0x120637b6
PPRouter_DirectEthTransfer()0x4344a77b
PPRouter_FeeExceedsMax()0x31bae423
PPRouter_FeeExceedsWithdrawal()0x09a64c28
PPRouter_InvalidProcessor()0x5fa02c03
PPRouter_NativeGasMismatch()0x24b7e50c
PPRouter_NotNativeMode()0x093c7b6e
PPRouter_SharesNotReceived()0x443b96b8
PPRouter_SharesStranded()0xf58dc788
PPRouter_SlippageExceeded(uint256,uint256)0x46314e2c
PPRouter_ZeroAddress()0xf202f780
PPRouter_ZeroRecipient()0x6d2aa205
PPRouter_ZeroValue()0x934a31a9
PPRouter_ZeroWithdrawal()0x79aaee89
ProofLib_TokenIdNotCanonical(uint256)0x11297127
ReentrancyGuardReentrantCall()0x3ee5aeb5
SafeERC20FailedOperation(address)0x5274afe7

PPRouterFactory

Functions (12)

SignatureSelector
DUST_RECIPIENT()0xe1d5ac2f
ENTRYPOINT()0xe8eb3cc6
POOL()0x7535d246
POOL_VAULT()0xdc6ae985
allRouters(uint256)0xa5218fd8
createRouter(address,address)0x7f629efc
createRouterNative(address,address)0x7b908f0d
owner()0x8da5cb5b
renounceOwnership()0x715018a6
routerFor(address)0x791c1eed
routersCount()0xd7581e69
transferOwnership(address)0xf2fde38b

Events (2)

SignatureTopic0
OwnershipTransferred(address,address)0x8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0
RouterCreated(address,address,address)0x9a72e5b99bd48e099df9943f900b94e5f66ae290a628c88c94b5d183c7026edb

Errors (6)

SignatureSelector
OwnableInvalidOwner(address)0x1e4fbdf7
OwnableUnauthorizedAccount(address)0x118cdaa7
PPRouterFactory_AlreadyDeployed()0xfc250522
PPRouterFactory_NotAavePoolAToken()0xbe442208
PPRouterFactory_RenounceDisabled()0xa4a5b672
PPRouterFactory_ZeroAddress()0x6df314df

PPYieldToken

Functions (48)

SignatureSelector
MAX_BPS()0xfd967f47
MAX_FEE_BPS()0xd55be8c6
acceptOwnership()0x79ba5097
accumulatedFees()0x587f5ed7
admin()0xf851a440
allowance(address,address)0xdd62ed3e
approve(address,uint256)0x095ea7b3
asset()0x38d52e0f
balanceOf(address)0x70a08231
claimFees()0xd294f093
claimFees(address)0x15a0ea6a
claimRewards(address[],address)0x77d5d857
claimableFees()0xc3192f14
convertToAssets(uint256)0x07a2d13a
convertToShares(uint256)0xc6e6f592
decimals()0x313ce567
deposit(uint256,address)0x6e553f65
exchangeRate()0x3ba0b9a9
feeBps()0x24a9d853
lastCheckpointBalance()0xde047a41
maxDeposit(address)0x402d267d
maxMint(address)0xc63d75b6
maxRedeem(address)0xd905777e
maxWithdraw(address)0xce96cb77
mint(uint256,address)0x94bf804d
name()0x06fdde03
owner()0x8da5cb5b
pause()0x8456cb59
paused()0x5c975abb
pendingOwner()0xe30c3978
previewDeposit(uint256)0xef8b30f7
previewMint(uint256)0xb3d7f6b9
previewRedeem(uint256)0x4cdad506
previewWithdraw(uint256)0x0a28a477
redeem(uint256,address,address)0xba087652
renounceOwnership()0x715018a6
rescueToken(address,address,uint256)0xe5711e8b
rewardsController()0x6bb65f53
setFeeBps(uint256)0x72c27b62
setRewardsController(address)0xbee36bb3
symbol()0x95d89b41
totalAssets()0x01e1d114
totalSupply()0x18160ddd
transfer(address,uint256)0xa9059cbb
transferFrom(address,address,uint256)0x23b872dd
transferOwnership(address)0xf2fde38b
unpause()0x3f4ba83a
withdraw(uint256,address,address)0xb460af94

Events (12)

SignatureTopic0
Approval(address,address,uint256)0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925
Deposit(address,address,uint256,uint256)0xdcbc1c05240f31ff3ad067ef1ee35ce4997762752e3a095284754544f4c709d7
FeeUpdated(uint256,uint256)0x528d9479e9f9889a87a3c30c7f7ba537e5e59c4c85a37733b16e57c62df61302
FeesClaimed(address,uint256)0x9493e5bbe4e8e0ac67284469a2d677403d0378a85a59e341d3abc433d0d9a209
OwnershipTransferStarted(address,address)0x38d16b8cac22d99fc7c124b9cd0de2d3fa1faef420bfe791d8c362d765e22700
OwnershipTransferred(address,address)0x8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0
Paused(address)0x62e78cea01bee320cd4e420270b5ea74000d11b0c9f74754ebdbfc544b05a258
RewardsControllerUpdated(address,address)0x7fd36e80e8f3c5380f5057403bd046f0a36b96e84f573554ffaba7023671d39c
TokenRescued(address,address,uint256)0x4143f7b5cb6ea007914c32b8a3e64cebc051d7f493fa0755454da1e47701e125
Transfer(address,address,uint256)0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef
Unpaused(address)0x5db9ee0a495bf2e6ff9c91a7834c1ba4fdd244a5e8aa4e537bd38aeae4b073aa
Withdraw(address,address,address,uint256,uint256)0xfbde797d201c681b91056529119e0b02407c7bb96a4a2c75c01fc9667232c8db

Errors (24)

SignatureSelector
ERC20InsufficientAllowance(address,uint256,uint256)0xfb8f41b2
ERC20InsufficientBalance(address,uint256,uint256)0xe450d38c
ERC20InvalidApprover(address)0xe602df05
ERC20InvalidReceiver(address)0xec442f05
ERC20InvalidSender(address)0x96c6fd1e
ERC20InvalidSpender(address)0x94280d62
ERC4626ExceededMaxDeposit(address,uint256,uint256)0x79012fb2
ERC4626ExceededMaxMint(address,uint256,uint256)0x284ff667
ERC4626ExceededMaxRedeem(address,uint256,uint256)0xb94abeec
ERC4626ExceededMaxWithdraw(address,uint256,uint256)0xfe9cceec
EnforcedPause()0xd93c0665
ExpectedPause()0x8dfc202b
OwnableInvalidOwner(address)0x1e4fbdf7
OwnableUnauthorizedAccount(address)0x118cdaa7
PPYieldToken_CannotRescueAsset()0xccb34d47
PPYieldToken_FeeTooHigh()0x006221df
PPYieldToken_RenounceDisabled()0x17eb7ab6
PPYieldToken_RewardsControllerNotSet()0x82377900
PPYieldToken_UnsupportedDecimals()0xa558b0f2
PPYieldToken_ZeroAddress()0x10b94a5f
PPYieldToken_ZeroAssets()0x78468ceb
PPYieldToken_ZeroShares()0xfa08a11f
ReentrancyGuardReentrantCall()0x3ee5aeb5
SafeERC20FailedOperation(address)0x5274afe7

PPYieldTokenFactory

Functions (8)

SignatureSelector
POOL()0x7535d246
allWrappers(uint256)0x60ccbbb9
createWrapper(address,uint256,address,string,string,uint256)0x3b42ed36
owner()0x8da5cb5b
renounceOwnership()0x715018a6
transferOwnership(address)0xf2fde38b
wrapperFor(address)0x922b8e22
wrappersCount()0x6895eb13

Events (2)

SignatureTopic0
OwnershipTransferred(address,address)0x8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0
WrapperCreated(address,address,address,address)0x98ab71c1be89036c2cebe0e545d719dfcb0218308949b7561c5d8435eb267814

Errors (8)

SignatureSelector
OwnableInvalidOwner(address)0x1e4fbdf7
OwnableUnauthorizedAccount(address)0x118cdaa7
PPYieldTokenFactory_AlreadyDeployed()0x5671237d
PPYieldTokenFactory_NotAavePoolAToken()0x4c12fb9d
PPYieldTokenFactory_RenounceDisabled()0x76c945bc
PPYieldTokenFactory_ZeroAddress()0x882b221c
PPYieldTokenFactory_ZeroSeed()0xc5a82657
SafeERC20FailedOperation(address)0x5274afe7

PPYieldTokenZap

Functions (8)

SignatureSelector
A_TOKEN()0x9ef0159f
POOL()0x7535d246
UNDERLYING()0xc5d664c6
VAULT()0x411557d1
buyFixedYieldToken(uint256,address,uint256)0xf9e1c875
depositUnderlying(uint256,address)0xee778c59
quoteBuy(uint256)0x4beb394c
redeemToUnderlying(uint256,address)0x7aa6a9fd

Events (3)

SignatureTopic0
ZappedIn(address,address,uint256,uint256)0xfa707f77ebcda0bf41456fb6c0e4d47abfd2859138980d219e1aad2dcd2dd912
ZappedInExact(address,address,uint256,uint256)0x4424c37b1a0187f63955da244eba37b53b3bfe9e548edc273d4b1fb7f0f47514
ZappedOut(address,address,uint256,uint256)0x9b0706dfda5e5a496719e8f815b896ffd00d81981af5c681ed9272716b5f9238

Errors (5)

SignatureSelector
PPYieldTokenZap_InsufficientWrap(uint256,uint256)0xb95dfddb
PPYieldTokenZap_SlippageExceeded(uint256,uint256)0x2c2f6301
PPYieldTokenZap_ZeroAddress()0xba65e121
PPYieldTokenZap_ZeroAmount()0x8abc2ca5
SafeERC20FailedOperation(address)0x5274afe7

PPYieldTokenZapFactory

Functions (8)

SignatureSelector
POOL()0x7535d246
allZaps(uint256)0xdbc9be0f
createZap(address)0x648f1845
owner()0x8da5cb5b
renounceOwnership()0x715018a6
transferOwnership(address)0xf2fde38b
zapFor(address)0x7c5b32c2
zapsCount()0x42fb1a19

Events (2)

SignatureTopic0
OwnershipTransferred(address,address)0x8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0
ZapCreated(address,address,address)0xc786c252ddd2fada3e555343baffee60cfaedd1e4c994a1413989897fa6669fb

Errors (6)

SignatureSelector
OwnableInvalidOwner(address)0x1e4fbdf7
OwnableUnauthorizedAccount(address)0x118cdaa7
PPYieldTokenZapFactory_AlreadyDeployed()0x496249de
PPYieldTokenZapFactory_NotAavePoolAToken()0x9b605c1a
PPYieldTokenZapFactory_RenounceDisabled()0x8631a0b2
PPYieldTokenZapFactory_ZeroAddress()0xf2d3924b

ERC5564Announcer

Functions (1)

SignatureSelector
announce(uint256,address,bytes,bytes)0x4d1f9583

Events (1)

SignatureTopic0
Announcement(uint256,address,address,bytes,bytes)0x5f0eab8057630ba7676c49b4f21a0231414e79474595be8e4c432fbf6bf0f4e7

RelaySwaps

Functions (18)

SignatureSelector
ENTRYPOINT()0xe8eb3cc6
NATIVE_ASSET()0xbf53253b
POOL()0x7535d246
ROUTING_TYPEHASH()0x940e2001
approveRouter(address)0xf259cd27
approveZap(address)0xd5a0ce0d
approvedRouters(address)0x445b1e4b
approvedZapList()0xe086e32f
approvedZaps(address)0xf0986c90
changeOwnership(address)0x2af4c31e
execute((uint256[2],uint256[2][2],uint256[2],uint256[][]),(address,bytes),(bytes32,bytes)[])0xdbc4a257
executeUnwrapped((uint256[2],uint256[2][2],uint256[2],uint256[][]),(address,bytes),(bytes32,bytes)[],address)0xd35babdb
owner()0x8da5cb5b
removeRouter(address)0x6ae0b154
removeZap(address)0x6b292747
renounceOwnership()0x715018a6
rescue(address,address,uint256)0x20ff430b
transferOwnership(address)0xf2fde38b

Events (8)

SignatureTopic0
Executed(address,address,uint256,address,uint256)0x533053a5fad9470861fb5df750d47e5f011faa03daba05299fe4bdc65f52d519
OwnershipTransferred(address,address)0x8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0
Rescued(address,address,uint256)0x3af790fafda720819b2fc6e15090606e81154e0ac9a92d38ecad006d99d20ecc
RouterAdded(address)0x81639ab8f3fbb025b1e08849071d6ba211e0153cc8c447680595775116b67a1a
RouterRemoved(address)0xbd6d178d515bf811c86f393b42367076da766033c8ebd94ea5a7e3eaf69d1c46
Unwrapped(address,address,uint256,uint256,uint256)0x64758e333223572d0904f73cf9548d54babe347920ee770f9837c1fcb51a15b9
ZapApproved(address,address,address)0x227f6ea9ac9c774169d882488e7d4a7998e64a90fb49a7888f861b89f2c5c18b
ZapRemoved(address)0xa2c1a6307beb1ae9ac09cdddb84751e92658c044bd500f72e8cc4875df1a1837

Errors (33)

SignatureSelector
OwnableInvalidOwner(address)0x1e4fbdf7
OwnableUnauthorizedAccount(address)0x118cdaa7
ProofLib_TokenIdNotCanonical(uint256)0x11297127
Reentrancy()0xab143c06
RelaySwaps_FeeExceedsMax()0x19fe1824
RelaySwaps_FeeExceedsWithdrawal()0xdc7bb80c
RelaySwaps_GasSwapInsufficient()0xbc170963
RelaySwaps_GasSwapMaxInputExceedsWithdrawal()0x8fd6fa17
RelaySwaps_GasSwapNativeInput()0xe40382f1
RelaySwaps_InputBalanceDeficit()0x6d151ea0
RelaySwaps_InsufficientOutput()0xfcada1bc
RelaySwaps_InvalidApprovalAddress()0x909d3bfd
RelaySwaps_InvalidSwapTarget()0x49db72e5
RelaySwaps_InvalidZap()0xebf9ab4a
RelaySwaps_MinOutputWithoutRecipient()0x12845670
RelaySwaps_NativeGasMismatch()0x392645a0
RelaySwaps_NativeGasWithoutRecipient()0x40306da9
RelaySwaps_RenounceDisabled()0xd3a87324
RelaySwaps_SwapFailed()0x5dd06cc4
RelaySwaps_UnwrapZeroOutput()0x6f30911f
RelaySwaps_ZapATokenMismatch()0xafe21a08
RelaySwaps_ZapInvalidUnderlying()0x015c1054
RelaySwaps_ZapShareMismatch()0x8613b424
RelaySwaps_ZapShareNotPoolAsset()0xf31525f5
RelaySwaps_ZapUnderlyingMismatch()0x098ced7d
RelaySwaps_ZeroApprovalAddress()0x51954406
RelaySwaps_ZeroDustRecipient()0x81acf105
RelaySwaps_ZeroEntrypoint()0x374230ec
RelaySwaps_ZeroFeeRecipient()0x344a238f
RelaySwaps_ZeroMinOutputWithRecipient()0xabb9eed9
RelaySwaps_ZeroPool()0x7090ddc8
RelaySwaps_ZeroSwapTarget()0x23896e94
RelaySwaps_ZeroWithdrawal()0xcd142ff0

Role constants

RoleValueSource
AUTH_TYPE_DIRECT_KEY0src/utils/Constants.sol:10
COMMITMENT_LEAF_TAG3_791_694_183_000_795_315_792_098_099_581_407_680_958_131_641_292_811_872_617_553_086_713_867_485_913src/utils/Constants.sol:15
DEFAULT_ADMIN_ROLE0x00src/utils/RolesConstants.sol:6
DEPOSITOR_ROLE0x8f4f2da22e8ac8f11e15f9fc141cddbb5deea8800186560abb6e68c5496619a9src/utils/RolesConstants.sol:24
ENTRYPOINT_MANAGER_ROLE0x44d1edca1a8c82068d362f32692edfb8d350106d36d0fc25bc46d65fa2546cfbsrc/utils/RolesConstants.sol:21
NATIVE_ASSET0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeEsrc/utils/Constants.sol:7
NULLIFIER_LEAF_TAG1_480_564_842_420_020_354_887_207_755_615_370_381_236_762_558_448_265_256_256_653_429_412_951_563_031src/utils/Constants.sol:21
OPS_ADMIN_ROLE0x7281a06530430c928fbd948f9c020be986527f437101783d53aeb9ba7cc0d064src/utils/RolesConstants.sol:9
PAUSER_ROLE0x65d7a28e3265b37a6474929f336521b332c1681b933f6cb9f3376673440d862asrc/utils/RolesConstants.sol:15
POSTMAN_ROLE0x67bf1f13d02b19255ab652c6b587de65b84296a60f6aee2d0db7817882a1270fsrc/utils/RolesConstants.sol:27
UNPAUSER_ROLE0x427da25fe773164f88948d3e215c94b6554e2ed5e5f203a821c9f2f6131cf75asrc/utils/RolesConstants.sol:18
UPGRADER_ROLE0x189ab7a9244df0848122154315af71fe140f3db0fe014031783b0946b8c9d2e3src/utils/RolesConstants.sol:12

SDK export surface (@privacy-pools-v2/sdk)

890 names reach the public entrypoint (80 interface, 247 class, 225 variable, 279 typealias, 58 function, 1 enum), but only 531 of them are exported as runtime values from packages/sdk/src/external.ts. The rest arrive through export type * from "./internal.js" and are type-only: they cannot be imported as values, and instanceof checks against them are impossible from the published package. Catch type-only errors by matching error.name.

Runtime classes (247)

Importable as values; new and instanceof work.

AccountExportMismatch

Source: src/errors/PoolSessionExport.ts:18

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

AllowanceCheckFailed

Source: src/errors/PoolSessionDeposit.ts:65

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

AlreadyRegistered

Source: src/errors/KeystoreManager.ts:20

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

ASPClient

Source: src/services/ASPClient.ts:26

MemberType
getAssociationSetRoot() => Promise<Hash>
getAssociationSetLeaves() => Promise<Hash[]>
getMerkleProof(labelHash: Hash) => Promise<MerkleProof>
getLabelStatus(label: Hash) => Promise<LabelStatus>
getASPPublicKey() => Promise<PublicKey>

ASPClientBaseError

Source: src/errors/ASPClient.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

ASPLeavesRootMismatch

Source: src/errors/ASPClient.ts:87

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

ASPRegistryInteractor

Source: src/services/contractInteractors/ASPRegistryInteractor.ts:18

MemberType
getLatestASPRoot() => Promise<Hash>
getLatestAssociationSetData() => Promise<{ root: Hash; ipfsCID: string; }>

ASPUnavailable

Source: src/errors/ASPClient.ts:20

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

AssetNotEnabled

Source: src/errors/PoolSessionDeposit.ts:29

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

AssetNotRelayable

Source: src/errors/BatchWithdraw.ts:33

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

AssetNotSupported

Source: src/errors/PoolSessionTransact.ts:81

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

AtRestDecryptionError

Source: src/errors/EncryptedStorage.ts:23

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

BatchRoutingInvalid

Source: src/errors/BatchWithdraw.ts:78

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

BatchRoutingMismatch

Source: src/errors/BatchWithdraw.ts:62

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

BatchTooLarge

Source: src/errors/BatchWithdraw.ts:20

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

BatchWithdrawBaseError

Source: src/errors/BatchWithdraw.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

BatchWithdrawOrchestrator

Source: src/services/poolSessions/BatchWithdrawOrchestrator.ts:53

MemberType
warmMerkleCaches() => Promise<void>
prepareBatchWithdraw(params: BatchWithdrawParams) => Promise<BatchPrepareResult>
persistBatchNoteUpdates(spentNotes: Note[], changePendingNotes: PendingNote[], txHash: Hash, verification: SpentNoteVerification) => Promise<void>
prepareSelfSubmitBatch(params: SelfSubmitBatchParams) => Promise<SelfSubmitBatchPrepareResult>
submitSelfSubmitBatch(prepared: SelfSubmitBatchPrepareResult) => Promise<Hash>

BelowMinimumAmount

Source: src/errors/PoolSessionDeposit.ts:38

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

CIDDigestMismatch

Source: src/errors/IPFSContent.ts:28

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

CircuitArtifactLoadFailed

Source: src/errors/ProofService.ts:23

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

CircuitArtifactMultihashMismatch

Source: src/errors/ProofService.ts:36

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

CircuitNotAvailable

Source: src/errors/ProofService.ts:43

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

ContractCallError

Source: src/errors/ContractInteractor.ts:11

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

ContractInteractorBaseError

Source: src/errors/ContractInteractor.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

ContractReadError

Source: src/errors/RPCInteractor.ts:14

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

CrossChainReshieldNotImplemented

Source: src/errors/PoolSessionTransact.ts:55

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

CryptoService

Source: src/services/CryptoService.ts:56

MemberType
ecdh(privateKey: Secret, publicKey: string) => Secret
encrypt(data: Uint8Array, secret: Secret) => Hex
decrypt(ciphertext: Hex, secret: Secret) => Uint8Array
generateSecret() => Secret
generateEphemeralKeyPair() => KeyPair
derivePaymentRequestKeyPair(viewingPrivateKey: Secret, ownerAddress: Address, paymentId: Hex) => KeyPair
deriveKeysFromSignature(config: DeriveFromSignatureConfig) => DerivedKeyMaterial

CryptoServiceBaseError

Source: src/errors/CryptoService.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

CurrentLeafNotFound

Source: src/errors/PoolSessionKeystore.ts:69

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

DataServiceBaseError

Source: src/errors/DataService.ts:1

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

DecryptionError

Source: src/errors/NoteDiscoveryService.ts:11

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

DepositBelowMinimum

Source: src/errors/PoolSessionTransact.ts:90

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

DepositProofFailed

Source: src/errors/PoolSessionDeposit.ts:56

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

DepositRecipientViewingKeyUnregistered

Source: src/errors/PoolSessionDeposit.ts:81

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

DepositTargetMismatch

Source: src/errors/PoolSessionTransact.ts:116

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

DepositWitnessFailed

Source: src/errors/PoolSessionDeposit.ts:47

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

DestinationChainNotSupported

Source: src/errors/PoolSessionTransact.ts:126

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

DestinationDepositTargetMismatch

Source: src/errors/PoolSessionTransact.ts:134

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

DestinationDepositUnaffordable

Source: src/errors/PoolSessionTransact.ts:166

MemberType
affordableNoteValue'0x${string}'
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

DuplicateYieldDeployment

Source: src/errors/Yield.ts:58

MemberType
name"DuplicateYieldDeployment"
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

DustRescueRecipientConflict

Source: src/errors/PoolSessionTransact.ts:149

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

ECDHComputationError

Source: src/errors/CryptoService.ts:47

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

EIP1193WalletInteractor

Source: src/services/walletInteractors/EIP1193WalletInteractor.ts:34

MemberType
sendTransaction(tx: PreparedTransaction) => Promise<Hex>
signTypedData(typedData: Eip712TypedData) => Promise<Hex>
getAccounts() => Promise<Address[]>
getChainId() => Promise<number>

EmptyBatchSelection

Source: src/errors/BatchWithdraw.ts:11

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

EncryptedStorageBaseError

Source: src/errors/EncryptedStorage.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

EncryptedStorageService

Source: src/services/storage/EncryptedStorageService.ts:73

MemberType
#innerIStorageService
#kdfParamsAtRestScryptParams
#passphraseBytesUint8Array<ArrayBufferLike> | undefined
#derivedKeyUint8Array<ArrayBufferLike> | undefined
#keyPromisePromise<Uint8Array<ArrayBufferLike>> | undefined
#disposedboolean
get<T>(key: string) => Promise<T | null>
set<T>(key: string, value: T) => Promise<void>
delete(key: string) => Promise<void>
clear() => Promise<void>
dispose() => void
#ensureKey() => Promise<Uint8Array>
#loadOrCreateKey() => Promise<Uint8Array>
#loadOrCreateHeader() => Promise<StoredHeader>
#recordAad(key: string) => Uint8Array
#assertRecord(record: StoredRecord, key: string) => void
#assertHeader(header: StoredHeader) => void

EntrypointInteractor

Source: src/services/contractInteractors/EntrypointInteractor.ts:37

MemberType
getAddress() => Address
getPoolVaultAddress() => Promise<Address>
getASPRegistryAddress() => Promise<Address>
getAssetConfig(asset: Address) => Promise<AssetConfig>
getAllowance(token: Address, owner: Address, spender: Address) => Promise<Hash>
encodeDeposit(proof: EVMProof, noteData: NoteData, aspCiphertext: Hex, msgValue: Hex) => PreparedTransaction
encodeApprove(token: Address, amount: Hex) => PreparedTransaction
submitTransaction(tx: PreparedTransaction) => Promise<Hex>

EventReadError

Source: src/errors/RPCInteractor.ts:82

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

FailedToHashInputs

Source: src/errors/HashService.ts:16

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

FailedToInitializePoseidon

Source: src/errors/HashService.ts:30

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

FeeCommitmentExpired

Source: src/errors/RelayerInteractor.ts:29

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

FileStorageService

Source: src/services/storage/FileStorageService.ts:13

MemberType
get<T>(key: string) => Promise<T | null>
set<T>(key: string, value: T) => Promise<void>
delete(key: string) => Promise<void>
clear() => Promise<void>

GetBlockNumberError

Source: src/errors/RPCInteractor.ts:66

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

GetBlockNumberFailed

Source: src/errors/DataService.ts:15

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

Groth16Prover

Source: src/services/Groth16Prover.ts:10

MemberType
fullProve(input: CircuitInputs, wasm: Uint8Array, provingKey: Uint8Array) => Promise<{ proof: Groth16Proof; publicSignals: PublicSignals; }>
verify(verificationKey: VerificationKey, publicSignals: PublicSignals, proof: Groth16Proof) => Promise<boolean>

HashServiceBaseError

Source: src/errors/HashService.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

HashServiceNotInitialized

Source: src/errors/HashService.ts:23

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

HttpASPDataProvider

Source: src/services/aspDataProviders/HttpASPDataProvider.ts:35

MemberType
getRoot() => Promise<Hash>
getLeaves() => Promise<Hash[]>
getLabelStatus(label: Hash) => Promise<LabelStatus>
getASPPublicKey() => Promise<PublicKey>
getEventSnapshot() => Promise<EventSnapshot>
getNoteEvents(fromBlock?: Hex, toBlock?: Hex) => Promise<{ events: NoteEvent[]; lastSyncedBlock: Hex; }>

HTTPClient

Source: src/services/HTTPClient.ts:19

MemberType
get<T>(url: string, options?: HTTPRequestOptions) => Promise<T>
post<T>(url: string, body: unknown, options?: HTTPRequestOptions) => Promise<T>
getBinary(url: string, options?: HTTPRequestOptions) => Promise<Uint8Array>

HTTPClientBaseError

Source: src/errors/HTTPClient.ts:1

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

HTTPRequestFailed

Source: src/errors/HTTPClient.ts:11

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

HTTPResponseError

Source: src/errors/HTTPClient.ts:26

MemberType
statusnumber
statusTextstring
bodystring | undefined
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InfeasibleBatchFee

Source: src/errors/BatchWithdraw.ts:47

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InMemoryCacheStore

Source: src/services/storage/InMemoryCacheStore.ts:8

MemberType
get(key: string) => Promise<Uint8Array | null>
set(key: string, value: Uint8Array) => Promise<void>

InMemoryStorageService

Source: src/services/storage/InMemoryStorageService.ts:9

MemberType
get<T>(key: string) => Promise<T | null>
set<T>(key: string, value: T) => Promise<void>
delete(key: string) => Promise<void>
clear() => Promise<void>

InsufficientChangeValueForFee

Source: src/errors/PoolSessionTransact.ts:47

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InsufficientTransactValue

Source: src/errors/PoolSessionTransact.ts:40

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidABIFunctionName

Source: src/errors/RPCInteractor.ts:58

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidAddNoteParams

Source: src/errors/PoolSessionNoteManager.ts:8

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidAddress

Source: src/errors/KeyDerivation.ts:22

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidAddressArgument

Source: src/errors/ContractInteractor.ts:29

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidASPCID

Source: src/errors/ASPClient.ts:74

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidASPCipherText

Source: src/errors/ASPClient.ts:61

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidASPClientConfig

Source: src/errors/ASPClient.ts:11

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidASPProof

Source: src/errors/ASPClient.ts:38

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidAtRestPassphrase

Source: src/errors/EncryptedStorage.ts:11

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidBuilderConfig

Source: src/errors/PoolSessionBuilder.ts:10

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidChain

Source: src/errors/RPCInteractor.ts:42

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidCIDFormat

Source: src/errors/IPFSContent.ts:15

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidCipherText

Source: src/errors/CryptoService.ts:20

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidContractAddress

Source: src/errors/RPCInteractor.ts:50

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidContractResult

Source: src/errors/ContractInteractor.ts:47

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidDepositParams

Source: src/errors/PoolSessionDeposit.ts:20

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidDepositWitnessInputs

Source: src/errors/WitnessPreparationService.ts:8

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidEncryptedRecord

Source: src/errors/EncryptedStorage.ts:36

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidHashArgument

Source: src/errors/ContractInteractor.ts:38

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidHashInputs

Source: src/errors/HashService.ts:9

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidInteractorAddress

Source: src/errors/ContractInteractor.ts:20

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidKeystoreManagerConfig

Source: src/errors/KeystoreManager.ts:11

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidLeaf

Source: src/errors/MerkleService.ts:23

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidLeaves

Source: src/errors/MerkleService.ts:16

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidLineageError

Source: src/errors/NoteManager.ts:56

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidMarkNoteExitedParams

Source: src/errors/PoolSessionNoteManager.ts:22

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidMarkNoteSpentParams

Source: src/errors/PoolSessionNoteManager.ts:15

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidMerkleProof

Source: src/errors/MerkleService.ts:37

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidNoteError

Source: src/errors/NoteManager.ts:32

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidPaymentRequestParams

Source: src/errors/PaymentRequest.ts:11

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidPaymentRequestState

Source: src/errors/PaymentRequest.ts:29

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidPoolSessionConfig

Source: src/errors/PoolSessionDeposit.ts:11

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidPoolSessionKeystoreConfig

Source: src/errors/PoolSessionKeystore.ts:11

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidPoolSessionRagequitConfig

Source: src/errors/PoolSessionRagequit.ts:13

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidPoolSessionTransactConfig

Source: src/errors/PoolSessionTransact.ts:13

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidPrivateKey

Source: src/errors/CryptoService.ts:29

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidProof

Source: src/errors/ProofService.ts:64

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidPublicKey

Source: src/errors/CryptoService.ts:38

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidRageQuitParams

Source: src/errors/PoolSessionRagequit.ts:22

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidRagequitWitnessInputs

Source: src/errors/WitnessPreparationService.ts:22

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidRelayerConfig

Source: src/errors/RelayerInteractor.ts:8

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidRotationIndex

Source: src/errors/KeystoreManager.ts:29

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidRpcUrl

Source: src/errors/RPCInteractor.ts:23

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidSecret

Source: src/errors/CryptoService.ts:11

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidSignature

Source: src/errors/KeyDerivation.ts:13

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidStatusTransitionError

Source: src/errors/NoteManager.ts:22

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidStorageFilename

Source: src/errors/StorageAdapter.ts:33

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidStorageStateError

Source: src/errors/StorageAdapter.ts:20

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidSwapAndDepositParams

Source: src/errors/PoolSessionSwapDeposit.ts:11

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidTransactDimensions

Source: src/errors/ProofService.ts:50

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidTransactParams

Source: src/errors/PoolSessionTransact.ts:22

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidTransactWitnessInputs

Source: src/errors/WitnessPreparationService.ts:15

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidTxHash

Source: src/errors/DataService.ts:8

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidViemRPCInteractorConfig

Source: src/errors/RPCInteractor.ts:34

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidWitness

Source: src/errors/ProofService.ts:57

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidYieldAddress

Source: src/errors/Yield.ts:49

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

InvalidYieldAmount

Source: src/errors/Yield.ts:37

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

IpfsASPDataProvider

Source: src/services/aspDataProviders/IpfsASPDataProvider.ts:25

MemberType
getRoot() => Promise<Hash>
getLeaves() => Promise<Hash[]>
getLabelStatus(_label: Hash) => Promise<LabelStatus>
getASPPublicKey() => Promise<PublicKey>
getEventSnapshot() => Promise<EventSnapshot>
getNoteEvents(_fromBlock?: Hex, _toBlock?: Hex) => Promise<{ events: NoteEvent[]; lastSyncedBlock: Hex; }>

IpfsCircuitArtifacts

Source: src/services/circuitArtifacts/IpfsCircuitArtifacts.ts:42

MemberType
getWasm(circuitName: string) => Promise<Uint8Array>
getProvingKey(circuitName: string) => Promise<Uint8Array>
getVerificationKey(circuitName: string) => Promise<Uint8Array>

IPFSContentBaseError

Source: src/errors/IPFSContent.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

IPFSFetchFailed

Source: src/errors/ASPClient.ts:47

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

KeyDerivationBaseError

Source: src/errors/KeyDerivation.ts:5

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

KeystoreAlreadyRegistered

Source: src/errors/PoolSessionKeystore.ts:49

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

KeystoreInteractor

Source: src/services/contractInteractors/KeystoreInteractor.ts:39

MemberType
getAddress() => Address
getNullifyingKeyHash(account: Address) => Promise<Hash>
getViewingKey(account: Address) => Promise<Hash>
isKnownRoot(root: Hash) => Promise<boolean>
getKeystoreLeaves() => Promise<Hash[]>
exportLeafCache() => LeafCacheSeed | undefined
getCurrentAuthorizerDigest(account: Address) => Promise<Hash | null>
encodeSetAuthPolicy(authDigest: Hash, nullifyingKeyHash: Hash) => PreparedTransaction
encodeUpdateAuthPolicy(oldAuthDigest: Hash, newAuthDigest: Hash, siblingNodes: Hash[]) => PreparedTransaction
encodeSetViewingKey(viewingKey: Hex) => PreparedTransaction
submitTransaction(tx: PreparedTransaction) => Promise<Hex>
signTypedData(typedData: Eip712TypedData) => Promise<Hex>

KeystoreManager

Source: src/services/KeystoreManager.ts:27

MemberType
getPrivateNullifyingKey() => Secret
getPrivateRevocableKey() => Secret
getRevocableKeyIndex() => Hex
getViewingKeyPair() => ViewingKeyPair
applyRotation(newIndex: Hex, newKey: Secret) => void
isRegistered(chainId: number) => boolean
markRegistered(chainId: number) => void
fromSignature(config: DeriveFromSignatureConfig, dependencies: { cryptoService: ICryptoService; }) => KeystoreManager

KeystoreManagerError

Source: src/errors/KeystoreManager.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

KeystoreNotRegistered

Source: src/errors/PoolSessionKeystore.ts:60

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

LabelNotInSet

Source: src/errors/ASPClient.ts:29

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

LeafNotFound

Source: src/errors/MerkleService.ts:9

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

LiFiDepositCalldataNotFound

Source: src/errors/SwapQuoteProvider.ts:52

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

LiFiDepositTargetNotFound

Source: src/errors/SwapQuoteProvider.ts:64

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

LiFiRecipientNotFound

Source: src/errors/SwapQuoteProvider.ts:76

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

LiFiSwapQuoteProvider

Source: src/services/LiFiSwapQuoteProvider.ts:38

MemberType
getSwapStatus(params: SwapStatusRequest) => Promise<SwapStatusResult>
getSwapQuote(params: SwapQuoteRequest) => Promise<SwapQuoteResult>
getSwapAndDepositQuote(params: SwapAndDepositQuoteRequest) => Promise<SwapAndDepositQuoteResult>

LocalCircuitArtifacts

Source: src/services/circuitArtifacts/LocalCircuitArtifacts.ts:7

MemberType
getWasm(circuitName: string) => Promise<Uint8Array>
getProvingKey(circuitName: string) => Promise<Uint8Array>
getVerificationKey(circuitName: string) => Promise<Uint8Array>

LocalStorageService

Source: src/services/storage/LocalStorageService.ts:8

MemberType
get<T>(key: string) => Promise<T | null>
set<T>(key: string, value: T) => Promise<void>
delete(key: string) => Promise<void>
clear() => Promise<void>

MerkleProofVerificationFailed

Source: src/errors/MerkleService.ts:44

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

MerkleService

Source: src/services/MerkleService.ts:28

MemberType
generateMerkleProof(leaves: Hex[], leaf: Hex) => Promise<MerkleProof>
padSiblings(siblings: Hex[], maxDepth: number) => Hex[]
computeRoot(leaves: Hex[]) => Promise<Hex>
verifyMerkleProof(proof: MerkleProof) => Promise<boolean>

MerkleServiceBaseError

Source: src/errors/MerkleService.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

NoteCommitmentNotMined

Source: src/errors/PoolSessionNoteManager.ts:33

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

NoteComputationService

Source: src/services/NoteComputationService.ts:39

MemberType
computeNoteAddressHash(ownerAddress: Address, noteSecret: Secret) => Hex
computePrecommitment(noteAddressHash: Hex, tokenId: Address, value: Hex) => Hex
computeLabel(precommitment: Hex, depositSecret: Secret) => Hex
computeFullCommitment(params: { noteAddressHash: Hex; tokenId: Address; value: Hex; label: Hex; }) => Hex
computeAuthDigest(privateRevocableKey: Secret) => Hex
computeNullifier(privateNullifyingKey: Secret, commitment: Hex) => Hex
computeLabelHash(label: Hex) => Hex
encodeNotePayload(payload: NotePayload) => Uint8Array
decodeNotePayload(bytes: Uint8Array) => NotePayload
generateNoteData(payload: NotePayload, recipientViewingPubKey: Hex, hint?: Hex) => NoteData
encodePaymentRequestNotePayload(payload: PaymentRequestNotePayload) => Uint8Array
decodePaymentRequestNotePayload(bytes: Uint8Array) => PaymentRequestNotePayload
generatePaymentRequestNoteData(payload: PaymentRequestNotePayload, recipientViewingPubKey: Hex, hint?: Hex) => NoteData

NoteComputationServiceBaseError

Source: src/errors/NoteComputationService.ts:1

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

NoteConflictError

Source: src/errors/NoteManager.ts:47

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

NoteDiscoveryScanFailed

Source: src/errors/PoolSessionNoteDiscovery.ts:11

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

NoteDiscoveryService

Source: src/services/NoteDiscoveryService.ts:30

MemberType
scanTargeted(events: NoteEvent[], contacts: Contact[], viewingPrivKey: Secret, ownerAddress: Address) => DiscoveredNote[]
decryptNotePayload(encryptedPayload: Hex, sharedSecret: Secret) => NotePayload
scanCatchAll(events: NoteEvent[], viewingPrivKey: Secret, ownerAddress: Address) => DiscoveredNote[]
scanPaymentRequests(events: NoteEvent[], requests: PaymentRequestRecord[]) => DiscoveredNote[]
scanStealthDeposits(events: NoteEvent[], credentials: ScanCredentials) => DiscoveredNote[]

NoteDiscoveryServiceBaseError

Source: src/errors/NoteDiscoveryService.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

NoteManager

Source: src/services/NoteManager.ts:35

MemberType
loadFromStorage() => Promise<void>
addNote(note: Note) => void
updateNoteStatus(commitmentHash: Hash, status: NoteStatus, currentBlock?: Hex) => void
deleteNote(commitmentHash: Hash) => void
updateNote(oldCommitment: Hash, newCommitment: Hash, newValue: Hex) => void
getNotes(filters?: NoteFilters) => Note[]
getNote(commitmentHash: Hash) => Note
getNoteLineage(label: Label) => NoteLineage
getAllLineages() => NoteLineage[]
computeAggregates(lineage: NoteLineage) => void
getSyncCursor() => Hex
setSyncCursor(blockNumber: Hex) => void
flush() => Promise<void>
exportState() => NoteManagerExport
importState(data: NoteManagerExport, options?: { overwrite?: boolean; }) => Promise<void>

NoteManagerBaseError

Source: src/errors/NoteManager.ts:4

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

NoteNotFoundError

Source: src/errors/NoteManager.ts:13

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

NoteStorageAdapter

Source: src/services/storage/NoteStorageAdapter.ts:17

MemberType
saveState(state: NoteManagerState) => Promise<void>
getState() => Promise<NoteManagerState | null>
clearState() => Promise<void>

PayloadAddressHashMismatch

Source: src/errors/KeyDerivation.ts:35

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

PayloadDecodeError

Source: src/errors/NoteComputationService.ts:15

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

PayloadEncodeError

Source: src/errors/NoteComputationService.ts:8

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

PayloadParseError

Source: src/errors/NoteDiscoveryService.ts:20

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

PaymentRequestBaseError

Source: src/errors/PaymentRequest.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

PaymentRequestExpired

Source: src/errors/PaymentRequest.ts:50

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

PaymentRequestNotFoundError

Source: src/errors/PaymentRequest.ts:20

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

PaymentRequestService

Source: src/services/PaymentRequestService.ts:43

MemberType
loadFromStorage() => Promise<void>
generate(params: GeneratePaymentRequestParams) => Promise<PaymentRequestRecord>
list(filter?: { status?: PaymentRequestStatus; }) => Promise<PaymentRequestRecord[]>
getOpenRequests() => Promise<PaymentRequestRecord[]>
getScannableRequests() => Promise<PaymentRequestRecord[]>
markFulfilled(paymentId: Hex, fulfillment: PaymentRequestFulfillment) => Promise<void>
archive(paymentId: Hex) => Promise<void>
clear() => Promise<void>
exportState() => SerializedPaymentRequestRecord[]
importState(records: SerializedPaymentRequestRecord[]) => Promise<void>

PaymentRequestStorageAdapter

Source: src/services/storage/PaymentRequestStorageAdapter.ts:24

MemberType
saveState(state: PaymentRequestServiceState) => Promise<void>
getState() => Promise<PaymentRequestServiceState | null>
clearState() => Promise<void>

PinoLogger

Source: src/utils/PinoLogger.ts:16

MemberType
child(service: string) => ILogger
levelstring
debug(msg: string, obj?: object) => void
info(msg: string, obj?: object) => void
warn(msg: string, obj?: object) => void
error(msg: string, obj?: object) => void
fatal(msg: string, obj?: object) => void
create(options?: LoggerOptions) => ILogger

PoolSession

Source: src/services/poolSessions/PoolSession.ts:125

MemberType
chainIdnumber
yieldYieldSessions | undefined
yieldsreadonly YieldSessions[]
yieldFor(tokenAddress: Address) => YieldSessions | undefined
exportKeystoreLeafCache() => LeafCacheSeed | undefined
exportStateLeafCache() => LeafCacheSeed | undefined
prepareDeposit(params: DepositParams) => Promise<PrepareDepositResult>
prepareDepositFor(params: DepositForParams) => Promise<PrepareDepositResult>
deposit(params: DepositParams) => Promise<TxReceipt>
executeDeposit(result: PrepareDepositResult) => Promise<TxReceipt>
depositFor(params: DepositForParams) => Promise<TxReceipt>
prepareColdStartTransfer(params: ColdStartTransferParams) => Promise<PrepareTransferResult>
prepareTransfer(params: TransferParams) => Promise<PrepareTransferResult>
relayTransfer(params: RelayTransferParams) => Promise<TransferResult>
prepareWithdraw(params: WithdrawParams) => Promise<PrepareWithdrawResult>
relayWithdraw(params: ExecuteWithdrawRelayerParams) => Promise<TxReceipt>
prepareRegisterAndWithdrawRelay(params: ExecuteWithdrawRelayerParams, registration: PreparedRelayedRegistration) => Promise<PrepareRegisterAndWithdrawResult>
registerAndWithdraw(params: ExecuteRegisterAndWithdrawRelayerParams) => Promise<TxReceipt>
transfer(params: TransferParams) => Promise<TransferResult>
executeTransfer(opts: ExecuteTransferParams) => Promise<TransferResult>
generatePaymentRequest(params: GeneratePaymentRequestParams) => Promise<PaymentRequest>
prepareFulfillPaymentRequest(params: FulfillPaymentRequestParams) => Promise<PrepareTransferResult>
withdraw(params: WithdrawParams) => Promise<TxReceipt>
executeWithdraw(result: PrepareWithdrawResult) => Promise<TxReceipt>
prepareBatchWithdraw(params: BatchWithdrawSessionParams) => Promise<PrepareBatchWithdrawResult>
relayBatchWithdraw(params: PrepareBatchWithdrawResult) => Promise<TxReceipt>
prepareSwapQuote(params: PrepareSwapQuoteParams) => Promise<PreparedSwapQuote>
relayWithdrawAndSwap(params: ExecuteWithdrawAndSwapRelayerParams) => Promise<TxReceipt>
estimateReshieldAmount(params: EstimateReshieldParams) => Promise<ReshieldEstimate>
prepareReshieldQuote(params: PrepareReshieldQuoteParams) => Promise<PreparedReshieldQuote>
relayReshield(params: ReshieldParams) => Promise<TxReceipt>
estimateReshieldCrosschainAmount(params: EstimateReshieldCrosschainParams) => Promise<ReshieldCrosschainEstimate>
prepareReshieldCrosschainQuote(params: PrepareReshieldCrosschainQuoteParams) => Promise<PreparedReshieldCrosschainQuote>
relayReshieldCrosschain(params: ReshieldCrosschainParams) => Promise<TxReceipt>
getSwapStatus(params: SwapStatusRequest) => Promise<SwapStatusResult>
prepareSwapAndDeposit(params: SwapAndDepositParams) => Promise<PrepareSwapAndDepositResult>
executeSwapAndDeposit(result: PrepareSwapAndDepositResult) => Promise<TxReceipt>
swapAndDeposit(params: SwapAndDepositParams) => Promise<TxReceipt>
selfSubmitBatchWithdraw(params: SelfSubmitBatchParams) => Promise<TxReceipt>
prepareSelfSubmitBatch(params: SelfSubmitBatchParams) => Promise<SelfSubmitBatchPrepareResult>
executeSelfSubmitBatch(prepared: SelfSubmitBatchPrepareResult) => Promise<TxReceipt>
isKeystoreRegistered() => Promise<boolean>
prepareRegisterKeystore(options?: RegisterKeystoreOptions) => Promise<RegisterKeystoreResult>
prepareRelayedRegistration(options: RelayedRegistrationOptions) => Promise<PreparedRelayedRegistration>
buildSetAuthPolicyTypedData(deadline: Hex) => SetAuthPolicyTypedData
registerKeystore(options?: RegisterKeystoreOptions) => Promise<TxReceipt[]>
executeRegisterKeystore(result: RegisterKeystoreResult) => Promise<TxReceipt[]>
getRevocableKeyIndex() => Hex
discoverRevocableKeyIndex(config: Omit<DeriveFromSignatureConfig, "revocableKeyIndex">, gapLimit?: number) => Promise<Hex>
prepareRotateRevocableKey(config: RotateRevocableKeyConfig) => Promise<RotateRevocableKeyResult>
executeRotateRevocableKey(result: RotateRevocableKeyResult) => Promise<RotateRevocableKeyOutcome>
rotateRevocableKey(config: RotateRevocableKeyConfig) => Promise<RotateRevocableKeyOutcome>
prepareRageQuit(params: RageQuitParams) => Promise<PrepareRageQuitResult>
rageQuit(params: RageQuitParams) => Promise<TxReceipt>
executeRageQuit(result: PrepareRageQuitResult) => Promise<TxReceipt>
discoverNotes(params?: DiscoverNotesParams) => Promise<Note[]>
purgePhantomNotes(params?: PurgePhantomNotesParams) => Promise<Hash[]>
addNotes(params: AddNoteParams[]) => Promise<void>
markNotesSpent(params: MarkNoteSpentParams[]) => Promise<void>
markNotesExited(params: MarkNoteExitedParams[]) => Promise<void>
exportAccount() => Promise<AccountExport>
importAccount(data: AccountExport) => Promise<void>
exportAccountSealed(passphrase: string | Uint8Array) => Promise<SealedEnvelope>
importAccountSealed(sealed: SealedEnvelope, passphrase: string | Uint8Array) => Promise<void>
importReceivedNote(note: Note) => Promise<void>

PoolSessionBatchWithdraw

Source: src/services/poolSessions/PoolSessionBatchWithdraw.ts:39

MemberType
prepareBatchWithdraw(params: BatchWithdrawSessionParams) => Promise<PrepareBatchWithdrawResult>
relayBatchWithdraw(params: PrepareBatchWithdrawResult) => Promise<TxReceipt>
selfSubmitBatchWithdraw(params: SelfSubmitBatchParams) => Promise<TxReceipt>
prepareSelfSubmitBatch(params: SelfSubmitBatchParams) => Promise<SelfSubmitBatchPrepareResult>
executeSelfSubmitBatch(prepared: SelfSubmitBatchPrepareResult) => Promise<TxReceipt>

PoolSessionBuilder

Source: src/services/poolSessions/PoolSessionBuilder.ts:176

MemberType
#configCfg | undefined
#overridesPoolSessionBuilderOverrides
#sharedStorageServiceIStorageService | undefined
create() => Promise<PoolSession>
withCryptoService(cryptoService: ICryptoService) => PoolSessionBuilder<Cfg>
withYieldDeployment(yieldDeployment: YieldDeployment) => PoolSessionBuilder<Cfg>
withDestinationYieldDepositTargets(targets: YieldDepositTarget[]) => PoolSessionBuilder<Cfg>
withYieldDeployments(yieldDeployments: YieldDeployment[]) => PoolSessionBuilder<Cfg>
withRelayerDetails(details: RelayerChainDetails) => PoolSessionBuilder<Cfg>
withSwapQuoteProvider(swapQuoteProvider: ISwapQuoteProvider) => PoolSessionBuilder<Cfg>
withSwapAndDepositQuoteProvider(swapAndDepositQuoteProvider: ISwapAndDepositQuoteProvider) => PoolSessionBuilder<Cfg>
withHashService(hashService: IHashService) => PoolSessionBuilder<Cfg>
withMerkleService(merkleService: IMerkleService) => PoolSessionBuilder<Cfg>
withHttpClient(httpClient: IHTTPClient) => PoolSessionBuilder<Cfg>
withRpcInteractor(rpcInteractor: IRPCInteractor) => PoolSessionBuilder<Cfg>
withEntrypointInteractor(this: Cfg extends { deployment: DeploymentAddresses; } ? ConflictError<"ERROR: remove 'deployment' from config before calling .with*Interactor() (interactor overrides and explicit
withDestinationEntrypointInteractor(destinationEntrypointInteractor: IEntrypointInteractor) => PoolSessionBuilder<Cfg>
withKeystoreInteractor(this: Cfg extends { deployment: DeploymentAddresses; } ? ConflictError<"ERROR: remove 'deployment' from config before calling .with*Interactor() (interactor overrides and explicit
withVaultInteractor(this: Cfg extends { deployment: DeploymentAddresses; } ? ConflictError<"ERROR: remove 'deployment' from config before calling .with*Interactor() (interactor overrides and explicit
withAspRegistryInteractor(this: Cfg extends { deployment: DeploymentAddresses; } ? ConflictError<"ERROR: remove 'deployment' from config before calling .with*Interactor() (interactor overrides and explicit
withAspDataProvider(this: Cfg extends { aspUrl: string; } | { ipfsGatewayUrl: string; } ? ConflictError<"ERROR: remove 'aspUrl'/'ipfsGatewayUrl' from config before calling .withAspDataProvider()"> :
withAspClient(this: Cfg extends { aspPublicKey: string; } ? ConflictError<"ERROR: remove 'aspPublicKey' from config before calling .withAspClient() (the provided client owns its own public key)
withRelayerInteractor(this: Cfg extends { relayers: RelayerInfo[]; } ? ConflictError<"ERROR: remove 'relayers' from config before calling .withRelayerInteractor()"> : PoolSessionBuilder<Cfg>, relayerIn
withCircuitArtifacts(this: Cfg extends { circuitArtifactsDir: string; } | { circuitGatewayUrls: string[]; } ? ConflictError<"ERROR: remove 'circuitArtifactsDir'/'circuitGatewayUrls' from config before
withCircuitCacheStore(cacheStore: ICacheStore) => PoolSessionBuilder<Cfg>
withGroth16Prover(groth16Prover: IGroth16Prover) => PoolSessionBuilder<Cfg>
withProofService(proofService: IProofService) => PoolSessionBuilder<Cfg>
withWitnessPreparationService(witnessPreparationService: IWitnessPreparationService) => PoolSessionBuilder<Cfg>
withNoteComputationService(noteComputationService: INoteComputationService) => PoolSessionBuilder<Cfg>
withNoteManager(noteManager: INoteManager) => PoolSessionBuilder<Cfg>
withKeystoreManager(this: Cfg extends { protocolKeys: object; } ? ConflictError<"ERROR: remove 'protocolKeys' from config before calling .withKeystoreManager()"> : PoolSessionBuilder<Cfg>, keystoreMa
withStorageService(this: Cfg extends { persistentStorage: PersistentStorageConfig; } ? ConflictError<"ERROR: remove 'persistentStorage' from config before calling .withStorageService() (declarative
withEncryptedStorage(this: Cfg extends { persistentStorage: PersistentStorageConfig; } ? ConflictError<"ERROR: remove 'persistentStorage' from config before calling .withEncryptedStorage() (declarativ
withWalletInteractor(this: Cfg extends { walletInteractor: WalletInteractorConfig; } ? ConflictError<"ERROR: remove 'walletInteractor' from config before calling .withWalletInteractor() (declarative w
withNoteStorageAdapter(this: Cfg extends { persistentStorage: PersistentStorageConfig; } ? ConflictError<"ERROR: remove 'persistentStorage' from config before calling .withNoteStorageAdapter() (declarat
withPaymentRequestStorageAdapter(this: Cfg extends { persistentStorage: PersistentStorageConfig; } ? ConflictError<"ERROR: remove 'persistentStorage' from config before calling .withPaymentRequestStorageAdapter()
withNoteDiscoveryService(noteDiscoveryService: INoteDiscoveryService) => PoolSessionBuilder<Cfg>
withPaymentRequestService(paymentRequestService: IPaymentRequestService) => PoolSessionBuilder<Cfg>
fromConfig<Cfg extends PoolSessionBuilderConfig>(config: Cfg) => PoolSessionBuilder<Cfg>

PoolSessionBuilderBaseError

Source: src/errors/PoolSessionBuilder.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

PoolSessionDeposit

Source: src/services/poolSessions/PoolSessionDeposit.ts:57

MemberType
prepareDeposit(params: DepositParams) => Promise<PrepareDepositResult>
prepareDepositFor(params: DepositForParams) => Promise<PrepareDepositResult>
deposit(params: DepositParams) => Promise<TxReceipt>
executeDeposit(result: PrepareDepositResult) => Promise<TxReceipt>
depositFor(params: DepositForParams) => Promise<TxReceipt>

PoolSessionDepositBaseError

Source: src/errors/PoolSessionDeposit.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

PoolSessionExport

Source: src/services/poolSessions/PoolSessionExport.ts:31

MemberType
exportAccount() => Promise<AccountExport>
exportAccountSealed(passphrase: string | Uint8Array) => Promise<SealedEnvelope>
importAccount(data: AccountExport) => Promise<void>
importAccountSealed(sealed: SealedEnvelope, passphrase: string | Uint8Array) => Promise<void>
importReceivedNote(note: Note) => Promise<void>

PoolSessionExportBaseError

Source: src/errors/PoolSessionExport.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

PoolSessionFactory

Source: src/services/poolSessions/PoolSessionFactory.ts:51

MemberType
create(config: PoolSessionConfig, deps?: PoolSessionDependencies) => PoolSession

PoolSessionKeystore

Source: src/services/poolSessions/PoolSessionKeystore.ts:51

MemberType
isKeystoreRegistered() => Promise<boolean>
prepareRegisterKeystore(options?: RegisterKeystoreOptions) => Promise<RegisterKeystoreResult>
prepareRelayedRegistration(options: RelayedRegistrationOptions) => Promise<PreparedRelayedRegistration>
buildSetAuthPolicyTypedData(deadline: Hex) => SetAuthPolicyTypedData
registerKeystore(options?: RegisterKeystoreOptions) => Promise<TxReceipt[]>
executeRegisterKeystore(result: RegisterKeystoreResult) => Promise<TxReceipt[]>
getRevocableKeyIndex() => Hex
discoverRevocableKeyIndex(config: Omit<DeriveFromSignatureConfig, "revocableKeyIndex">, gapLimit?: number) => Promise<Hex>
prepareRotateRevocableKey(config: RotateRevocableKeyConfig) => Promise<RotateRevocableKeyResult>
executeRotateRevocableKey(result: RotateRevocableKeyResult) => Promise<RotateRevocableKeyOutcome>
rotateRevocableKey(config: RotateRevocableKeyConfig) => Promise<RotateRevocableKeyOutcome>

PoolSessionKeystoreBaseError

Source: src/errors/PoolSessionKeystore.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

PoolSessionLeafCacheBaseError

Source: src/errors/PoolSessionLeafCache.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

PoolSessionNoteDiscovery

Source: src/services/poolSessions/PoolSessionNoteDiscovery.ts:84

MemberType
discoverNotes(params?: DiscoverNotesParams) => Promise<Note[]>
purgePhantomNotes(params?: PurgePhantomNotesParams) => Promise<Hash[]>

PoolSessionNoteDiscoveryBaseError

Source: src/errors/PoolSessionNoteDiscovery.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

PoolSessionNoteManager

Source: src/services/poolSessions/PoolSessionNoteManager.ts:27

MemberType
addNotes(params: AddNoteParams[]) => Promise<void>
markNotesSpent(params: MarkNoteSpentParams[]) => Promise<void>
markNotesExited(params: MarkNoteExitedParams[]) => Promise<void>

PoolSessionNoteManagerBaseError

Source: src/errors/PoolSessionNoteManager.ts:1

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

PoolSessionRagequit

Source: src/services/poolSessions/PoolSessionRagequit.ts:43

MemberType
prepareRageQuit(params: RageQuitParams) => Promise<PrepareRageQuitResult>
rageQuit(params: RageQuitParams) => Promise<TxReceipt>
executeRageQuit(result: PrepareRageQuitResult) => Promise<TxReceipt>

PoolSessionRagequitBaseError

Source: src/errors/PoolSessionRagequit.ts:4

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

PoolSessionReshield

Source: src/services/poolSessions/PoolSessionReshield.ts:73

MemberType
estimateReshieldAmount(params: EstimateReshieldParams) => Promise<ReshieldEstimate>
prepareReshieldQuote(params: PrepareReshieldQuoteParams) => Promise<PreparedReshieldQuote>
relayReshield(params: ReshieldParams) => Promise<TxReceipt>

PoolSessionReshieldCrosschain

Source: src/services/poolSessions/PoolSessionReshieldCrosschain.ts:123

MemberType
estimateReshieldCrosschainAmount(params: EstimateReshieldCrosschainParams) => Promise<ReshieldCrosschainEstimate>
prepareReshieldCrosschainQuote(params: PrepareReshieldCrosschainQuoteParams) => Promise<PreparedReshieldCrosschainQuote>
relayReshieldCrosschain(params: ReshieldCrosschainParams) => Promise<TxReceipt>

PoolSessionSwapDeposit

Source: src/services/poolSessions/PoolSessionSwapDeposit.ts:84

MemberType
prepareSwapAndDeposit(params: SwapAndDepositParams) => Promise<PrepareSwapAndDepositResult>
executeSwapAndDeposit(result: PrepareSwapAndDepositResult) => Promise<TxReceipt>
swapAndDeposit(params: SwapAndDepositParams) => Promise<TxReceipt>

PoolSessionSwapDepositBaseError

Source: src/errors/PoolSessionSwapDeposit.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

PoolSessionTransactBaseError

Source: src/errors/PoolSessionTransact.ts:4

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

PoolSessionTransfer

Source: src/services/poolSessions/PoolSessionTransfer.ts:59

MemberType
prepareColdStartTransfer(params: ColdStartTransferParams) => Promise<PrepareTransferResult>
prepareTransfer(params: TransferParams) => Promise<PrepareTransferResult>
relayTransfer(params: RelayTransferParams) => Promise<TransferResult>
transfer(params: TransferParams) => Promise<TransferResult>
executeTransfer(opts: ExecuteTransferParams) => Promise<TransferResult>
generatePaymentRequest(params: GeneratePaymentRequestParams) => Promise<PaymentRequest>
prepareFulfillPaymentRequest(params: FulfillPaymentRequestParams) => Promise<PrepareTransferResult>

PoolSessionWithdraw

Source: src/services/poolSessions/PoolSessionWithdraw.ts:42

MemberType
prepareWithdraw(params: WithdrawParams) => Promise<PrepareWithdrawResult>
relayWithdraw(params: ExecuteWithdrawRelayerParams) => Promise<TxReceipt>
prepareRegisterAndWithdrawRelay(params: ExecuteWithdrawRelayerParams, registration: PreparedRelayedRegistration) => Promise<PrepareRegisterAndWithdrawResult>
registerAndWithdraw(params: ExecuteRegisterAndWithdrawRelayerParams) => Promise<TxReceipt>
withdraw(params: WithdrawParams) => Promise<TxReceipt>
executeWithdraw(result: PrepareWithdrawResult) => Promise<TxReceipt>

PoolSessionWithdrawAndSwap

Source: src/services/poolSessions/PoolSessionWithdrawAndSwap.ts:59

MemberType
prepareSwapQuote(params: PrepareSwapQuoteParams) => Promise<PreparedSwapQuote>
relayWithdrawAndSwap(params: ExecuteWithdrawAndSwapRelayerParams) => Promise<TxReceipt>

PoolSessionYieldDeposit

Source: src/services/poolSessions/PoolSessionYieldDeposit.ts:40

MemberType
sharesForUnderlying(underlyingAmount: bigint) => Promise<bigint>
sizeSharesForBudget(budget: bigint, headroomPpm?: bigint) => Promise<BudgetSizedYieldDeposit>
prepareYieldDeposit(params: YieldDepositParams) => Promise<PreparedYieldDeposit>

PoolSessionYieldWithdraw

Source: src/services/poolSessions/PoolSessionYieldWithdraw.ts:40

MemberType
prepareYieldWithdraw(params: YieldWithdrawParams) => Promise<PreparedYieldWithdraw>
prepareYieldWithdrawRelay(params: YieldWithdrawRelayParams) => Promise<PreparedYieldWithdrawRelay>

PoolVaultInteractor

Source: src/services/contractInteractors/PoolVaultInteractor.ts:54

MemberType
getAddress() => Address
getCommitmentTimestamp(commitmentHash: Hash) => Promise<Hash>
getNullifierTimestamp(nullifierHash: Hash) => Promise<Hash>
isKnownRoot(root: Hash) => Promise<boolean>
getStateLeaves() => Promise<Hash[]>
exportLeafCache() => LeafCacheSeed | undefined
getNoteEvents(fromBlock?: Hex, toBlock?: Hex) => Promise<NoteEvent[]>
getTransactedEvents(fromBlock?: Hex, toBlock?: Hex) => Promise<TransactedEvent[]>
getDepositedEvents(fromBlock?: Hex, toBlock?: Hex) => Promise<DepositedEvent[]>
getRagequitEvents(fromBlock?: Hex, toBlock?: Hex) => Promise<RagequitEvent[]>
encodeRagequit(proof: EVMProof) => PreparedTransaction
encodeTransact(proof: EVMProof, transactPubSignals: bigint[][], transactParams: TransactParams, noteData: NoteData[]) => PreparedTransaction
submitTransaction(tx: PreparedTransaction) => Promise<Hex>
extractSpentNullifiers(logs: TxLog[]) => Hex[]

PoseidonHashService

Source: src/services/PoseidonHashService.ts:21

MemberType
hash(inputs: Hex[]) => Hex
create() => Promise<PoseidonHashService>

PPRouterInteractor

Source: src/services/contractInteractors/PPRouterInteractor.ts:21

MemberType
getAddress() => Address
quote(value: bigint) => Promise<YieldQuote>
quoteWithdraw(shares: bigint) => Promise<bigint>

PPYieldTokenInteractor

Source: src/services/contractInteractors/PPYieldTokenInteractor.ts:26

MemberType
getAddress() => Address
exchangeRate() => Promise<bigint>
previewDeposit(assets: bigint) => Promise<bigint>
previewRedeem(shares: bigint) => Promise<bigint>
encodeRedeem(shares: bigint, receiver: Address, owner: Address) => PreparedTransaction

PPYieldTokenZapInteractor

Source: src/services/contractInteractors/PPYieldTokenZapInteractor.ts:20

MemberType
getAddress() => Address
encodeRedeemToUnderlying(shares: bigint, receiver: Address) => PreparedTransaction

PreparedTransactionBaseError

Source: src/errors/PreparedTransaction.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

ProofGenerationFailed

Source: src/errors/ProofService.ts:9

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

ProofService

Source: src/services/ProofService.ts:40

MemberType
proveDeposit(witness: CircuitInputs) => Promise<DepositProof>
proveTransact(witness: CircuitInputs, nInputs: number, mOutputs: number) => Promise<TransactProof>
proveRagequit(witness: CircuitInputs) => Promise<RagequitProof>
verifyDeposit(proof: DepositProof) => Promise<boolean>
verifyTransact(proof: TransactProof, nInputs: number, mOutputs: number) => Promise<boolean>
verifyRagequit(proof: RagequitProof) => Promise<boolean>
loadCircuit(circuitName: string) => Promise<void>
formatForEVM(proofResult: ProofResult) => EVMProof

ProofServiceBaseError

Source: src/errors/ProofService.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

ProofVerificationFailed

Source: src/errors/ProofService.ts:16

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

RagequitAddresslessNoteError

Source: src/errors/PoolSessionRagequit.ts:45

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

RagequitNoteAlreadyExitedError

Source: src/errors/PoolSessionRagequit.ts:31

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

RecipientViewingKeyUnregistered

Source: src/errors/PoolSessionTransact.ts:71

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

RegistrationCheckFailed

Source: src/errors/PoolSessionKeystore.ts:35

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

RegistrationDeadlineInPast

Source: src/errors/PoolSessionKeystore.ts:23

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

RelayerInteractor

Source: src/services/RelayerInteractor.ts:57

MemberType
getRelayers() => Promise<RelayerInfo[]>
getChainDetails(relayer: RelayerEndpoint) => Promise<RelayerChainDetails>
getTransferQuote(relayer: RelayerInfo, params: TransferQuoteParams) => Promise<TransferRelayerQuote>
getWithdrawalQuote(relayer: RelayerInfo, params: WithdrawalQuoteParams) => Promise<WithdrawalRelayerQuote>
getBatchWithdrawalQuote(relayer: RelayerInfo, params: BatchWithdrawalQuoteParams) => Promise<BatchWithdrawalRelayerQuote>
relayTransfer(relayer: RelayerInfo, params: TransferRelayParams) => Promise<Hex>
relayWithdrawal(relayer: RelayerInfo, params: WithdrawalRelayParams) => Promise<Hex>
submitRelayedRegistration(_relayer: RelayerInfo, _params: RegisterKeystoreRelayParams) => Promise<Hex>
relayRegisterAndWithdrawal(relayer: RelayerInfo, params: RegisterAndWithdrawalRelayParams) => Promise<Hex>
relayWithAnnounce(relayer: RelayerInfo, params: RelayAndAnnounceRelayParams) => Promise<Hex>
getSwapQuote{ (relayer: RelayerInfo, params: SwapQuoteParams & { commit: true; }): Promise<SwapRelayerQuote>; (relayer: RelayerInfo, params: SwapQuoteParams & { commit: false; }): Promise<Unco
relaySwap(relayer: RelayerInfo, params: SwapRelayParams) => Promise<Hex>
relayBatchWithdrawal(relayer: RelayerInfo, params: BatchWithdrawalRelayParams) => Promise<Hex>

RelayerInteractorBaseError

Source: src/errors/RelayerInteractor.ts:1

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

RelayerRejected

Source: src/errors/RelayerInteractor.ts:22

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

RelayerRequestFailed

Source: src/errors/RelayerInteractor.ts:15

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

RelayFeeExceedsMax

Source: src/errors/PoolSessionTransact.ts:98

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

RelaySwapsLayoutMismatch

Source: src/errors/SwapQuoteProvider.ts:39

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

RevocableKeyIndexNotFound

Source: src/errors/PoolSessionKeystore.ts:97

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

RotationKeyMismatch

Source: src/errors/PoolSessionKeystore.ts:83

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

RPCInteractorBaseError

Source: src/errors/RPCInteractor.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

StateInvariantViolation

Source: src/errors/PoolSessionNoteDiscovery.ts:26

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

StorageAdapterBaseError

Source: src/errors/StorageAdapter.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

StorageQuotaError

Source: src/errors/StorageAdapter.ts:11

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

SwapAndDepositQuoteFailed

Source: src/errors/PoolSessionSwapDeposit.ts:20

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

SwapQuoteFailed

Source: src/errors/SwapQuoteProvider.ts:8

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

SwapQuoteMismatch

Source: src/errors/PoolSessionTransact.ts:108

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

SwapQuoteProviderBaseError

Source: src/errors/SwapQuoteProvider.ts:1

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

SwapStatusFailed

Source: src/errors/SwapQuoteProvider.ts:15

MemberType
retryableboolean
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

TransactNoteNotActive

Source: src/errors/PoolSessionTransact.ts:31

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

TransactOrchestrator

Source: src/services/poolSessions/TransactOrchestrator.ts:59

MemberType
ownerAddress'0x${string}'
poolAddress'0x${string}'
submit(tx: PreparedTransaction) => Promise<Hash>
warmMerkleCaches() => Promise<void>
prepareTransact(params: PrepareTransactParams) => Promise<PrepareTransactResult>
persistNoteUpdates(spentNotes: Note[], pendingOutputNotes: PendingNote[], txHash: Hash, verification: SpentNoteVerification) => Promise<boolean>
prepareRecipientNotes(recipientNotes: PendingNote[], txHash: Hash) => Promise<Note[]>
encodeRelayBatch(relayAddress: Address, items: RelayBatchItem[]) => PreparedTransaction

TreeGenerationError

Source: src/errors/MerkleService.ts:30

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

UnallowedLiFiAddress

Source: src/errors/SwapQuoteProvider.ts:28

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

UnexpectedDepositCalldata

Source: src/errors/Yield.ts:15

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

UnexpectedTransactionTarget

Source: src/errors/PreparedTransaction.ts:16

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

UnexpectedWithdrawCalldata

Source: src/errors/Yield.ts:28

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

UnsupportedChainId

Source: src/errors/PoolSessionBuilder.ts:18

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

ViemRPCInteractor

Source: src/services/ViemRPCInteractor.ts:96

MemberType
readContract{ <const TAbi extends Abi, TFunctionName extends ContractFunctionName<TAbi, "pure" | "view">>(params: ViemReadContractParams<TAbi, TFunctionName>): Promise<ContractFunctionReturnTy
getBlockNumber() => Promise<Hex>
getFinalizedBlockNumber() => Promise<FinalizedBlockResult>
waitForTransactionReceipt(hash: Hex) => Promise<TxReceipt>
getLogs(params: GetLogsParams) => Promise<DecodedEventLog[]>
getLogsPaginated(params: GetLogsParams) => Promise<DecodedEventLog[]>
create(config: CreateViemRPCInteractorConfig, deps?: ViemRPCInteractorDependencies) => ViemRPCInteractor

ViemWalletInteractor

Source: src/services/walletInteractors/ViemWalletInteractor.ts:25

MemberType
sendTransaction(tx: PreparedTransaction) => Promise<Hex>
signTypedData(typedData: Eip712TypedData) => Promise<Hex>
getAccounts() => Promise<Address[]>
getChainId() => Promise<number>

WaitForReceiptError

Source: src/errors/RPCInteractor.ts:74

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

WaitForTransactionFailed

Source: src/errors/DataService.ts:22

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

WalletInteractorBaseError

Source: src/errors/WalletInteractor.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

WalletNoAccountsError

Source: src/errors/WalletInteractor.ts:29

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

WalletNotAvailable

Source: src/errors/ContractInteractor.ts:56

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

WalletSendTransactionFailed

Source: src/errors/WalletInteractor.ts:11

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

WalletSignTypedDataFailed

Source: src/errors/WalletInteractor.ts:20

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

WitnessPreparationFailed

Source: src/errors/WitnessPreparationService.ts:29

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

WitnessPreparationService

Source: src/services/WitnessPreparationService.ts:40

MemberType
buildDepositWitness(inputs: BuildDepositWitnessInputs) => Promise<DepositCircuitInputs>
buildTransactWitness(inputs: BuildTransactWitnessInputs) => Promise<TransactCircuitInputs>
buildRagequitWitness(inputs: BuildRagequitWitnessInputs) => Promise<RagequitWitness>

WitnessPreparationServiceError

Source: src/errors/WitnessPreparationService.ts:1

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

YieldSessionBaseError

Source: src/errors/Yield.ts:2

MemberType
namestring
messagestring
stackstring | undefined
causeunknown
captureStackTrace(targetObject: object, constructorOpt?: Function) => void
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]) => any
stackTraceLimitnumber

Runtime functions (58)

FunctionSignatureSource
aeadDecrypt(key: Uint8Array<ArrayBufferLike>, ciphertext: '0x${string}', aad: Uint8Array<ArrayBufferLike>): Uint8Array<ArrayBufferLike>src/utils/AtRestSealing.ts:81
aeadEncrypt(key: Uint8Array<ArrayBufferLike>, plaintext: Uint8Array<ArrayBufferLike>, aad: Uint8Array<ArrayBufferLike>): '0x${string}'src/utils/AtRestSealing.ts:70
assertBoundedScryptParams(kdf: { N: number; r: number; p: number; dkLen: number; }): voidsrc/utils/AtRestSealing.ts:186
assertDepositEmbeddedInLiFiCalldata(lifiTransactionData: '0x${string}', depositCallData: '0x${string}', depositTargetAddress: '0x${string}', chainId: number): voidsrc/utils/LiFiContainmentCheck.ts:93
assertFeeCommitmentLive(expirationMs: number): voidsrc/utils/RelayerQuotes.ts:118
assertLifiBudget(lifiFromAmount: string, amount: '0x${string}', feeAmount: string): voidsrc/utils/LiFiBudget.ts:33
assertPayoutRoutingMatchesQuote(data: '0x${string}', expectedRecipient: '0x${string}', expectedFeeAmount: bigint, expectedNativeGas: bigint | { requested: boolean; }): voidsrc/services/poolSessions/payoutRoutingGuard.ts:36
assertPreparedTxMatches(tx: PreparedTransaction, expected: { to: '0x${string}'; abi: Abi; functionName: string; }): { functionName: string; args: readonly unknown[]; }src/utils/PreparedTxValidation.ts:21
assertYieldDepositMatches(target: YieldDepositTarget, result: Pick<PrepareDepositResult, "to" | "callData" | "msgValue" | "pendingNote">, budget?: bigint | undefined): voidsrc/utils/YieldSwapOutput.ts:50
assertZapApproved(rpcInteractor: IRPCInteractor, processorAddress: '0x${string}', share: '0x${string}', wrapper: YieldSwapWrapper): Promise<void>src/utils/YieldSwapInput.ts:30
atRestRecordAad(marker: string, version: number, storageKey: string): Uint8Array<ArrayBufferLike>src/utils/AtRestSealing.ts:102
buildSetAuthPolicyTypedData(args: BuildSetAuthPolicyTypedDataArgs): Eip712TypedDatasrc/services/keystoreEip712.ts:34
bytesToBigIntBE(bytes: Uint8Array<ArrayBufferLike>): bigintsrc/utils/KeyDerivationHelpers.ts:7
canonicalTokenAddress(address: string): '0x${string}'src/utils/TokenIdentity.ts:33
capBridgeOutputToInput(estimatedMinOutput: bigint, netSwapAmount: bigint, quote: { fromTokenSymbol?: string | undefined; toTokenSymbol?: string | undefined; fromTokenDecimals?: numbesrc/utils/SameAssetBridge.ts:51
clampToCurve25519(bytes: Uint8Array<ArrayBufferLike>): '0x${string}'src/utils/KeyDerivationHelpers.ts:45
computeBatchFees(args: ComputeBatchFeesArgs): bigint[]src/services/poolSessions/computeBatchFees.ts:74
computeBatchItemFee(args: ComputeBatchItemFeeArgs): bigintsrc/services/poolSessions/computeBatchFees.ts:41
decodeNoteData(dataHex: '0x${string}'): { ephemeralPubKey: '0x${string}'; encryptedPayload: '0x${string}'; }src/utils/NoteDataCodec.ts:17
decodeRelaySwapRouting(data: '0x${string}'): RelaySwapRoutingsrc/utils/RelaySwapRouting.ts:50
decodeStargateDestBudget(data: '0x${string}'): bigint | undefinedsrc/utils/StargateCalldata.ts:94
defaultMaxUnderlyingIn(underlyingNeeded: bigint): bigintsrc/services/poolSessions/PoolSessionYieldDeposit.ts:255
deriveAtRestKey(passphrase: Uint8Array<ArrayBufferLike>, salt: Uint8Array<ArrayBufferLike>, params: AtRestScryptParams): Promise<...>src/utils/AtRestSealing.ts:43
encodeNoteData(ephemeralPubKey: '0x${string}', encryptedPayload: '0x${string}'): '0x${string}'src/utils/NoteDataCodec.ts:40
getYieldDeployment(chainId: number, deployments?: Readonly<Record<number, YieldDeployment>>): YieldDeployment | undefinedsrc/constant/Yield.ts:336
groupByLabel<T extends { label: Label; }>(items: T[]): Map<'0x${string}', T[]>src/utils/groupByLabel.ts:12
inferVettingFeeBps(value: bigint, total: bigint): bigintsrc/services/poolSessions/PoolSessionYieldDeposit.ts:274
isPpUsdcSymbol(symbol: string): booleansrc/constant/Yield.ts:357
isSameAssetBridgeQuote(quote: { fromTokenSymbol?: string | undefined; toTokenSymbol?: string | undefined; fromTokenDecimals?: number | undefined; toTokenDecimals?: number | undefinedsrc/utils/SameAssetBridge.ts:23
isSameToken(a: string, b: string): booleansrc/utils/TokenIdentity.ts:50
isYieldToken(chainId: number, tokenAddress: string, deployments?: Readonly<Record<number, YieldDeployment>>): booleansrc/constant/Yield.ts:347
openSealed<T>(envelope: SealedEnvelope, passphrase: string | Uint8Array<ArrayBufferLike>): Promise<T>src/utils/AtRestSealing.ts:156
parseCID(cidString: string): ParsedCIDsrc/utils/IPFSContent.ts:16
parseEventSnapshotTolerant(raw: unknown): { snapshot: EventSnapshot; issues: SnapshotRowIssue[]; degraded: Partial<Record<SnapshotArrayName, number>>; }src/schemas/EventSnapshot.ts:234
parsePaymentRequest(raw: string): PaymentRequestsrc/schemas/PaymentRequest.ts:112
passphraseToBytes(passphrase: string | Uint8Array<ArrayBufferLike>): Uint8Array<ArrayBufferLike>src/utils/AtRestSealing.ts:28
planApprovals(current: bigint, needed: bigint, encode: (amount: bigint) => PreparedTransaction): PreparedTransaction[]src/utils/Erc20Approval.ts:19
ppmHeadroom(amount: bigint, ppm?: bigint): bigintsrc/services/poolSessions/PoolSessionYieldDeposit.ts:264
prepareYieldSwapDeposit(target: YieldDepositTarget, budget: bigint, headroomPpm?: bigint | undefined): Promise<PrepareDepositResult>src/utils/YieldSwapOutput.ts:28
previewRedeemNet(wrapper: YieldSwapWrapper, netShares: bigint): Promise<bigint>src/utils/YieldSwapInput.ts:63
reduceToBN254Scalar(bytes: Uint8Array<ArrayBufferLike>): '0x${string}'src/utils/KeyDerivationHelpers.ts:31
relayerInfoFromDetails(relayer: { url: string; name: string; status?: "active" | "inactive" | undefined; }, details: RelayerChainDetails): RelayerInfosrc/utils/RelayerDetails.ts:13
relaySwapsAddressFromDetails(details: RelayerChainDetails): '0x${string}' | undefinedsrc/utils/RelayerDetails.ts:52
resolveCommitmentTimestamp(poolVaultInteractor: IPoolVaultInteractor, commitment: '0x${string}', opts?: ResolveCommitmentTimestampOptions): Promise<...>src/utils/CommitmentTimestamp.ts:40
sealValue<T>(value: T, passphrase: string | Uint8Array<ArrayBufferLike>, params?: AtRestScryptParams): Promise<SealedEnvelope>src/utils/AtRestSealing.ts:125
selectNotesForFullWithdraw(args: SelectNotesForFullWithdrawArgs): BatchWithdrawGroup[]src/services/poolSessions/selectNotesForFullWithdraw.ts:38
serializePaymentRequest(request: PaymentRequest): stringsrc/schemas/PaymentRequest.ts:100
settleRelayerQuotes<TInfo extends { name: string; }, TQuote>(relayers: TInfo[], fetch: (relayer: TInfo) => Promise<TQuote>, logger?: ILogger | undefined): Promise<TQuote[]>src/utils/RelayerQuotes.ts:25
settleSwapRelayerQuotes(relayerInteractor: IRelayerInteractor, params: TransferQuoteParams & { recipient: '0x${string}'; fallbackAddress?: '0x${string}' | undefined; amount: string; .src/utils/RelayerQuotes.ts:134
settleTransferRelayerQuotes(relayerInteractor: IRelayerInteractor, params: TransferQuoteParams, logger?: ILogger | undefined): Promise<PrepareTransferRelayerQuotes[]>src/utils/RelayerQuotes.ts:84
settleWithdrawRelayerQuotes(relayerInteractor: IRelayerInteractor, params: WithdrawalQuoteParams, logger?: ILogger | undefined): Promise<PrepareWithdrawRelayerQuotes[]>src/utils/RelayerQuotes.ts:61
sleep(ms: number): Promise<void>src/utils/sleep.ts:5
u64beCounter(n: bigint): Uint8Array<ArrayBufferLike>src/utils/KeyDerivationHelpers.ts:16
verifyBytesAgainstCID(bytes: Uint8Array<ArrayBufferLike>, cidString: string): voidsrc/utils/IPFSContent.ts:46
yieldDeploymentsFromDetails(details: RelayerChainDetails): YieldDeployment[]src/utils/RelayerDetails.ts:38
yieldDepositFundingToken(target: YieldDepositTarget): '0x${string}'src/utils/YieldSwapOutput.ts:23
yieldDepositTargetFor(targets: YieldDepositTarget[], share: '0x${string}'): YieldDepositTarget | undefinedsrc/utils/YieldSwapOutput.ts:13
yieldWrapperFor(wrappers: readonly YieldSwapWrapper[], tokenId: '0x${string}'): YieldSwapWrapper | undefinedsrc/utils/YieldSwapInput.ts:14

Runtime variable exports (225)

APP_DERIVATION_INFO, APP_IDENTIFIER, ASPCipherTextPayloadSchema, ASPClientConfigSchema, ASPPublicKeyResponseSchema, ASP_REGISTRY_ABI, ASP_ROOT_CACHE_TTL_MS, ASSOCIATION_SET_MAX_DEPTH, AT_REST_ENVELOPE_AAD, AT_REST_SALT_BYTES, AUTH0_REVOCABLE_PREFIX, AUTH_TYPE_DIRECT_KEY, AddNoteParamsSchema, AddressSchema, AllowanceArgsSchema, AssetConfigSchema, BN254_SCALAR_MODULUS, BaseNoteSchema, BatchFeeCommitmentSchema, BatchWithdrawalQuoteParamsSchema, BatchWithdrawalRelayItemSchema, BatchWithdrawalRelayParamsSchema, BatchWithdrawalRelayerQuoteSchema, BigIntSchema, BlindNoteRlpSchema, BooleanSchema, BuildDepositWitnessInputsSchema, BuildRagequitWitnessInputsSchema, BuildTransactWitnessInputsSchema, CALLDATA_VERIFICATION_EXTRACT_MAIN_ABI, CALLDATA_VERIFICATION_EXTRACT_SWAP_ABI, CATCH_ALL_TAG, CID_CODEC_DAG_PB, CID_CODEC_RAW, CIRCUIT_NAME_PATTERN, COMMITMENT_LEAF_TAG, CROSS_CHAIN_DEPOSIT_RATE_HEADROOM_PPM, ChainSchema, CiphertextSchema, CircuitInputsSchema, ColdStartTransferParamsSchema, ContractInteractorConfigSchema, DEFAULT_AT_REST_SCRYPT_PARAMS, DEFAULT_CIRCUIT_MANIFEST, DEFAULT_IPFS_GATEWAY_URLS, DEFAULT_LIFI_INTEGRATOR, DEFAULT_REQUEST_EXPIRY_MS, DEFAULT_REVOCABLE_KEY_GAP_LIMIT, DEPLOYMENTS, DEPOSIT_RATE_HEADROOM_PPM, DEPOSIT_SHARES_DISCOUNT_BPS, DEPOSIT_SLIPPAGE_BPS, DecimalRepresentationToHexSchema, DepositForParamsSchema, DepositParamsSchema, DepositSecretSchema, DepositedEventArgsSchema, EMPTY_ADDRESS, EMPTY_BYTES32, EMPTY_CIPHERTEXT, EMPTY_NOTE_DATA, ENCRYPTED_STORAGE_HEADER_KEY, ENCRYPTED_STORAGE_HEADER_MARKER, ENCRYPTED_STORAGE_RECORD_MARKER, ENCRYPTED_STORAGE_VERSION, ENTRYPOINT_ABI, ENTRYPOINT_DEPOSIT_ABI, ERC20_ABI, ERC20_APPROVE_ABI, FeeCommitmentSchema, FulfillPaymentRequestParamsSchema, GENERATED_TAG_BYTES, GeneratePaymentRequestParamsSchema, Groth16ProofSchema, Groth16PublicSignalsSchema, HTTPClientConfigSchema, HashInputSchema, HexSchema, HttpASPDataProviderConfigSchema, IDENTITY_DOMAIN, IPFSLeavesPayloadSchema, KEYSTORE_ABI, KEYSTORE_AUTH_EVENTS_ABI, KEYSTORE_EIP712_DOMAIN_NAME, KEYSTORE_EIP712_DOMAIN_VERSION, KEYSTORE_EVENTS_ABI, KEYSTORE_MAX_DEPTH, KEYSTORE_WRITE_ABI, KEY_BYTES, KIND_BLIND, KIND_BLIND_HEX, KIND_FULL, KIND_FULL_HEX, KeystoreAuthEventLogArgsSchema, KeystoreEventLogArgsSchema, KeystoreManagerConfigSchema, LIFI_NATIVE_TOKEN_ADDRESS, LOCAL_FORK_YIELD_DEPLOYMENT, LabelStatusSchema, LeavesInsertedEventArgsSchema, LeavesSchema, MAX_BATCH, MAX_INPUTS, MAX_OUTPUTS, METADATA_STANDARD, MIN_INPUTS, MIN_OUTPUTS, MULTIHASH_SHA2_256_CODE, MarkNoteExitedParamsSchema, MarkNoteSpentParamsSchema, MerkleProofSchema, NATIVE_ASSET_ADDRESS, NONCE_BYTES, NOTE_PAYLOAD_VERSION, NOTE_PAYLOAD_VERSION_HEX, NULLIFYING_INFO, NoteAddressHashSchema, NoteDataSchema, NoteEventSchema, NoteEventsResponseSchema, NoteManagerStateSchema, NoteSchema, NumericStringSchema, OutputNoteParamsSchema, PAYMENT_REQUEST_KEY_INFO, PAYOUT_ROUTING_ABI, PAYOUT_ROUTING_ARRAY_ABI, POOL_VAULT_ABI, POOL_VAULT_ALL_EVENTS_ABI, POOL_VAULT_DEPOSITED_EVENT_ABI, POOL_VAULT_EVENTS_ABI, POOL_VAULT_LEAVES_INSERTED_ABI, POOL_VAULT_NOTE_EVENT_ABI, POOL_VAULT_RAGEQUIT_ABI, POOL_VAULT_RAGEQUIT_EVENT_ABI, POOL_VAULT_TRANSACTED_EVENT_ABI, POOL_VAULT_TRANSACT_ABI, PP_RELAY_BATCH_ABI, PP_ROUTER_ABI, PP_ROUTER_DEPOSIT_ABI, PP_ROUTER_DEPOSIT_NATIVE_ABI, PP_ROUTER_WITHDRAW_ABI, PP_YIELD_TOKEN_ABI, PP_YIELD_TOKEN_REDEEM_ABI, PP_YIELD_TOKEN_ZAP_REDEEM_ABI, PROTOCOL_SALT, PaymentRequestSchema, PaymentRequestServiceStateSchema, PaymentRequestStatusSchema, PendingNoteSchema, PoolSessionBuilderConfigSchema, PoolSessionDepositConfigSchema, PoolSessionKeystoreConfigSchema, PoolSessionRagequitConfigSchema, ProofResultSchema, ProofSchema, PublicKeySchema, RELAY_SWAPS_APPROVED_ROUTERS_ABI, RELAY_SWAPS_APPROVED_ZAPS_ABI, RELAY_SWAPS_ROUTING_TYPEHASH_ABI, RELAY_SWAP_ROUTING_ABI, RELAY_SWAP_ROUTING_TYPEHASH, ROOT_DERIVATION_INFO, RageQuitParamsSchema, RagequitEventArgsSchema, RecipientDiscoveryDataSchema, RegisterAndWithdrawalRelayParamsSchema, RegisterKeystoreRelayParamsSchema, RelayAndAnnounceRelayParamsSchema, RelayedRegistrationFieldsSchema, RelayerChainDetailsSchema, RelayerInfoSchema, RelayerInteractorConfigSchema, RelayerQuoteSchema, RelayerUrlSchema, RelayerYieldWrapperSchema, RpcUrlSchema, SAFE_STORAGE_FILENAME_PATTERN, SCAN_EXPIRY_GRACE_MS, SDK_FEATURES, SEPOLIA_CHAIN_ID, SET_AUTH_POLICY_PRIMARY_TYPE, SET_AUTH_POLICY_TYPES, SHA256_OF_EMPTY_INPUT, STATE_MAX_DEPTH, STORAGE_KEYS, SUPPORTED_CHAIN_IDS, SWAP_DUST_TOLERANCE_BPS, SecretSchema, SignatureSchema, StealthAnnouncementFieldsSchema, StoredPaymentRequestRecordSchema, SwapAndDepositParamsSchema, SwapFeeCommitmentSchema, SwapQuoteParamsSchema, SwapRelayParamsSchema, SwapRelayerQuoteSchema, TransactDimensionsSchema, TransactOrchestratorConfigSchema, TransactedEventArgsSchema, TransferParamsSchema, TransferQuoteParamsSchema, TransferRelayParamsSchema, TxHashSchema, UncommittedQuoteSchema, VALID_STATUS_TRANSITIONS, VIEWING_DOMAIN, VIEWING_KEY_INFO, ViewingPrivateKeySchema, WITHDRAW_SLIPPAGE_BPS, WithdrawParamsSchema, WithdrawalFeeCommitmentSchema, WithdrawalQuoteParamsSchema, WithdrawalRelayParamsSchema, WithdrawalRelayerQuoteSchema, YIELD_BPS_DENOMINATOR, YIELD_DEPLOYMENTS, YIELD_DISPLAY_BADGE, YIELD_DISPLAY_SYMBOL, YIELD_PPM_DENOMINATOR, ZAP_SUPPLY_BUFFER_UNITS, bigintToHex, decodeASPCipherText, encodeASPCipherText, utils

Runtime enum exports (1)

NoteStatus

Type-only interface exports (80)

AccountExport, AddNoteParams, AtRestKdfDescriptor, AtRestScryptParams, Contact, DiscoveredNote, EncryptedStorageServiceConfig, FileStorageServiceConfig, IASPClient, IASPDataProvider, IASPRegistryInteractor, IBatchWithdrawOrchestrator, ICacheStore, ICircuitArtifacts, IContractInteractor, ICryptoService, IEntrypointInteractor, IGroth16Prover, IHTTPClient, IHashService, IKeystoreInteractor, IKeystoreManager, ILogger, IMerkleService, INoteComputationService, INoteDiscoveryService, INoteManager, INoteStorageAdapter, IPPRouterInteractor, IPPYieldTokenInteractor, IPPYieldTokenZapInteractor, IPaymentRequestService, IPaymentRequestStorageAdapter, IPoolSession, IPoolSessionBatchWithdraw, IPoolSessionDeposit, IPoolSessionExport, IPoolSessionKeystore, IPoolSessionNoteDiscovery, IPoolSessionNoteManager, IPoolSessionRagequit, IPoolSessionReshield, IPoolSessionReshieldCrosschain, IPoolSessionSwapDeposit, IPoolSessionTransfer, IPoolSessionWithdraw, IPoolSessionWithdrawAndSwap, IPoolSessionYieldDeposit, IPoolSessionYieldWithdraw, IPoolVaultInteractor, IProofService, IRPCInteractor, IRelayerInteractor, IStorageService, ISwapAndDepositQuoteProvider, ISwapProvider, ISwapQuoteProvider, ITransactOrchestrator, IWalletInteractor, IWitnessPreparationService, InternalLineage, LocalStorageServiceConfig, MarkNoteExitedParams, MarkNoteSpentParams, NoteDiscoveryServiceConfig, NoteDiscoveryServiceDependencies, NoteEvent, NoteFilters, NoteLineage, NoteManagerConfig, NoteManagerDependencies, NoteManagerExport, NoteManagerState, NotePayload, PaymentRequestNotePayload, PoolSessionExportConfig, PoolSessionExportDependencies, PoolSessionNoteManagerConfig, PoolSessionNoteManagerDependencies, SealedEnvelope

Type-only typealias exports (279)

ASPCipherTextPayload, ASPClientConfig, ASPClientDependencies, Address, AssetConfig, BatchFeeCommitment, BatchPrepareResult, BatchWithdrawGroup, BatchWithdrawItem, BatchWithdrawOrchestratorConfig, BatchWithdrawOrchestratorDependencies, BatchWithdrawParams, BatchWithdrawSessionParams, BatchWithdrawalQuoteParams, BatchWithdrawalRelayItem, BatchWithdrawalRelayParams, BatchWithdrawalRelayerQuote, BudgetSizedYieldDeposit, BuildDepositWitnessInputs, BuildRagequitWitnessInputs, BuildSetAuthPolicyTypedDataArgs, BuildTransactWitnessInputs, CachedCircuitArtifacts, CircuitArtifactCIDs, CircuitInputs, CircuitManifest, ColdStartTransferParams, ComputeBatchFeesArgs, ComputeBatchItemFeeArgs, ContractInteractorConfig, ContractInteractorReadDependencies, ContractInteractorWriteDependencies, CreateViemRPCInteractorConfig, DecodedEventLog, DecodingKeys, DeploymentAddresses, DepositCircuitInputs, DepositForDiscoveryData, DepositForParams, DepositInternalParams, DepositParams, DepositProof, DepositedEvent, DeriveFromSignatureConfig, DerivedKeyMaterial, DerivedKeys, DiscoverNotesParams, DustRescueOptIn, EIP1193Provider, EIP1193WalletInteractorConfig, EVMProof, Eip712Domain, Eip712Field, Eip712MessageValue, Eip712TypedData, EncodingKeys, EstimateReshieldCrosschainParams, EstimateReshieldParams, EventSnapshot, EventSnapshotDrops, ExecuteRegisterAndWithdrawRelayerParams, ExecuteTransferParams, ExecuteWithdrawAndSwapRelayerParams, ExecuteWithdrawRelayerParams, FeeCommitment, FinalizedBlockResult, FulfillPaymentRequestParams, G1Point, G2Point, GeneratePaymentRequestParams, GetLogsParams, GtElement, HTTPClientConfig, HTTPClientDependencies, HTTPRequestOptions, Hash, Hex, HttpASPDataProviderConfig, HttpASPDataProviderDependencies, IpfsASPDataProviderConfig, IpfsASPDataProviderDependencies, IpfsCircuitArtifactsConfig, IpfsCircuitArtifactsDependencies, KeyPair, KeystoreInteractorDependencies, KeystoreManagerConfig, Label, LabelStatus, LeafCacheSeed, LiFiSwapQuoteProviderConfig, LiFiSwapQuoteProviderDependencies, LocalCircuitArtifactsConfig, MerkleProof, MerkleServiceConfig, MerkleServiceDependencies, Note, NoteComputationServiceConfig, NoteComputationServiceDependencies, NoteData, OutputNoteParams, ParsedCID, PaymentRequest, PaymentRequestFulfillment, PaymentRequestRecord, PaymentRequestServiceConfig, PaymentRequestServiceDependencies, PaymentRequestServiceState, PaymentRequestStatus, PendingNote, PersistentStorageConfig, PoolSessionBatchWithdrawConfig, PoolSessionBatchWithdrawDependencies, PoolSessionBuilderConfig, PoolSessionConfig, PoolSessionDependencies, PoolSessionDepositConfig, PoolSessionDepositDependencies, PoolSessionKeystoreConfig, PoolSessionKeystoreDependencies, PoolSessionNoteDiscoveryConfig, PoolSessionNoteDiscoveryDependencies, PoolSessionRagequitConfig, PoolSessionRagequitDependencies, PoolSessionReshieldConfig, PoolSessionReshieldCrosschainConfig, PoolSessionReshieldCrosschainDependencies, PoolSessionReshieldDependencies, PoolSessionSimpleConfig, PoolSessionSwapDepositConfig, PoolSessionSwapDepositDependencies, PoolSessionTransferConfig, PoolSessionTransferDependencies, PoolSessionWithdrawAndSwapConfig, PoolSessionWithdrawAndSwapDependencies, PoolSessionWithdrawConfig, PoolSessionWithdrawDependencies, PoolSessionYieldDepositConfig, PoolSessionYieldDepositDependencies, PoolSessionYieldWithdrawConfig, PoolSessionYieldWithdrawDependencies, PoolVaultInteractorDependencies, PoseidonHashServiceDependencies, PoseidonInstance, PrepareBatchWithdrawResult, PrepareDepositResult, PrepareRageQuitResult, PrepareRegisterAndWithdrawResult, PrepareReshieldCrosschainQuoteParams, PrepareReshieldQuoteParams, PrepareSwapAndDepositResult, PrepareSwapQuoteParams, PrepareSwapRelayerQuotes, PrepareTransactBase, PrepareTransactParams, PrepareTransactResult, PrepareTransferRelayerQuotes, PrepareTransferResult, PrepareWithdrawRelayerQuotes, PrepareWithdrawResult, PreparedRelayedRegistration, PreparedReshieldCrosschainQuote, PreparedReshieldQuote, PreparedSwapQuote, PreparedTransaction, PreparedYieldDeposit, PreparedYieldWithdraw, PreparedYieldWithdrawRelay, Proof, ProofResult, ProofServiceConfig, ProofServiceDependencies, ProtocolKeys, PublicKey, PurgePhantomNotesParams, RageQuitParams, RagequitCircuitInputs, RagequitEvent, RagequitProof, RagequitWitness, ReadContractParams, RecipientDiscoveryData, RegisterAndWithdrawalRelayParams, RegisterKeystoreOptions, RegisterKeystoreRelayParams, RegisterKeystoreResult, RelayAndAnnounceRelayParams, RelayBatchItem, RelaySwapDustRescue, RelaySwapRouting, RelayTransferParams, RelayedRegistrationFields, RelayedRegistrationOptions, RelayerChainDetails, RelayerEndpoint, RelayerInfo, RelayerInteractorConfig, RelayerInteractorDependencies, RelayerYieldWrapper, ReshieldCrosschainEstimate, ReshieldCrosschainParams, ReshieldEstimate, ReshieldParams, ResolveCommitmentTimestampOptions, ResolvedTransferRecipient, RotateRevocableKeyConfig, RotateRevocableKeyOutcome, RotateRevocableKeyResult, Secret, SelectNotesForFullWithdrawArgs, SelfSubmitBatchParams, SelfSubmitBatchPrepareResult, SerializedPaymentRequestRecord, SetAuthPolicyTypedData, SnapshotArrayDrops, SnapshotArrayName, SnapshotDeposit, SnapshotLeaf, SnapshotRagequit, SnapshotRowIssue, SnapshotTransact, SpentNoteVerification, StatusRagequit, StatusTransact, StealthAnnouncementFields, StealthRecipientIdentifier, StoredPaymentRequestRecord, SwapAndDepositParams, SwapAndDepositQuoteRequest, SwapAndDepositQuoteResult, SwapDepositSourceChainConfig, SwapFeeCommitment, SwapQuoteParams, SwapQuoteRequest, SwapQuoteResult, SwapRelayParams, SwapRelayerQuote, SwapStatus, SwapStatusRequest, SwapStatusResult, SwapSubstatus, SwapTransactionInfo, TransactCircuitInputs, TransactOrchestratorConfig, TransactOrchestratorDependencies, TransactParams, TransactProof, TransactWitness, TransactedEvent, TransferParams, TransferQuoteParams, TransferRelayParams, TransferRelayerQuote, TransferResult, TxLog, TxReceipt, UncommittedQuote, UtilsDependencies, VerificationKey, ViemRPCInteractorConfig, ViemRPCInteractorDependencies, ViemWalletInteractorConfig, ViewingKeyPair, WalletInteractorConfig, WithdrawAndSwapParams, WithdrawParams, WithdrawalFeeCommitment, WithdrawalQuoteParams, WithdrawalRelayParams, WithdrawalRelayerQuote, WitnessPreparationServiceConfig, WitnessPreparationServiceDependencies, YieldDeployment, YieldDepositParams, YieldDepositTarget, YieldQuote, YieldSessions, YieldSwapWrapper, YieldWithdrawParams, YieldWithdrawRelayParams