Contracts
Below is a clear overview of each major CryptoLegacy smart contract: its purpose, inheritance, key methods, events, and external interactions.
Table of Contents
BeneficiaryRegistry
Purpose
BeneficiaryRegistry maintains role-indexed registries that map hashed participant identifiers to CryptoLegacy contract addresses.
Inheritance
IBeneficiaryRegistryBuildManagerOwnable
Key Methods
setCryptoLegacyBeneficiary(...) - Adds or removes the calling CryptoLegacy from a beneficiary hash index.
setCryptoLegacyGuardian(...) - Adds or removes the calling CryptoLegacy from a guardian hash index.
setCryptoLegacyOwner(...) - Adds or removes the calling CryptoLegacy from an owner hash index.
setCryptoLegacyRecoveryAddresses(...) - Updates recovery-hash indexes for the calling CryptoLegacy by removing old and adding new hashes.
getCryptoLegacyListByBeneficiary(...) - Returns CryptoLegacy addresses indexed by a beneficiary hash.
getCryptoLegacyListByOwner(...) - Returns CryptoLegacy addresses indexed by an owner hash.
getCryptoLegacyListByGuardian(...) - Returns CryptoLegacy addresses indexed by a guardian hash.
getCryptoLegacyListByRecovery(...) - Returns CryptoLegacy addresses indexed by a recovery hash.
All Functions
constructor(...) - Initializes the registry and transfers ownership to
owner._setBlockNumberChange(...) - Records the current L1/L2 block number for the given CryptoLegacy contract.
setCryptoLegacyBeneficiary(...) - Adds or removes the calling CryptoLegacy from a beneficiary hash index.
setCryptoLegacyGuardian(...) - Adds or removes the calling CryptoLegacy from a guardian hash index.
setCryptoLegacyOwner(...) - Adds or removes the calling CryptoLegacy from an owner hash index.
setCryptoLegacyRecoveryAddresses(...) - Updates recovery-hash indexes for the calling CryptoLegacy by removing old and adding new hashes.
getCryptoLegacyListByBeneficiary(...) - Returns CryptoLegacy addresses indexed by a beneficiary hash.
getCryptoLegacyListByOwner(...) - Returns CryptoLegacy addresses indexed by an owner hash.
getCryptoLegacyListByGuardian(...) - Returns CryptoLegacy addresses indexed by a guardian hash.
getCryptoLegacyListByRecovery(...) - Returns CryptoLegacy addresses indexed by a recovery hash.
getCryptoLegacyBlockNumberChanges(...) - Returns recorded block numbers when the given CryptoLegacy triggered registry update calls.
getAllCryptoLegacyListByRoles(...) - Returns all CryptoLegacy lists for a given hash across beneficiary, owner, guardian, and recovery roles.
Events
Errors
Access / Roles
setCryptoLegacyBeneficiary: registered CryptoLegacy caller with approved build manager (_checkBuildManagerValid)setCryptoLegacyGuardian: registered CryptoLegacy caller with approved build manager (_checkBuildManagerValid)setCryptoLegacyOwner: registered CryptoLegacy caller with approved build manager (_checkBuildManagerValid)setCryptoLegacyRecoveryAddresses: registered CryptoLegacy caller with approved build manager (_checkBuildManagerValid)
Interacts With
ArbSys
Missing Links
None.
BuildManagerOwnable
Purpose
BuildManagerOwnable governs the allowlist of build-manager accounts used to authorize maintenance actions on CryptoLegacy contracts.
Inheritance
IBuildManagerOwnableOwnable
Key Methods
setBuildManager(...) - Adds or removes a build manager address from the allowed set.
getBuildManagerAdded(...) - Returns the list of all added build manager addresses.
All Functions
constructor() - Initializes ownership state via OpenZeppelin’s
Ownablebase.setBuildManager(...) - Adds or removes a build manager address from the allowed set.
_checkBuildManagerValid(...) - Verifies that a given CryptoLegacy contract was built by an added build manager and (optionally) that it has a specific owner.
getBuildManagerAdded() - Returns the list of all added build manager addresses.
Events
Errors
Access / Roles
setBuildManager:onlyOwner
Interacts With
ICryptoLegacyICryptoLegacyBuildManager
Missing Links
None.
Create3Factory
Purpose
Create3Factory provides deterministic contract deployment using CREATE3 salts with predictable target addresses.
Inheritance
Ownable
Key Methods
build(...) - Deploys a contract deterministically via CREATE3 using a salt and raw bytecode.
computeAddress(...) - Predicts the deterministic CREATE3 address for a given salt without deploying.
All Functions
constructor(...) - Initializes the factory and assigns ownership to the provided
owner.build(...) - Deploys a contract deterministically via CREATE3 using a salt and raw bytecode.
computeAddress(...) - Predicts the deterministic CREATE3 address for a given salt without deploying.
Events
Errors
None.
Access / Roles
build:onlyOwner
Interacts With
LibCreate3
Missing Links
None.
CryptoLegacy
Purpose
CryptoLegacy is the primary protocol contract that composes protocol plugins and exposes the diamond-based extension surface.
Inheritance
CryptoLegacyDiamondBaseCryptoLegacyOwnable
Key Methods
replacePlugin(...) - Replaces an existing set of plugins with a new set.
addPluginList(...) - Adds a list of plugins to the contract.
removePluginList(...) - Removes a list of plugins from the contract.
externalLens(...) - Returns the address of the external lens configured in the build manager.
All Functions
constructor(...) - Initializes core Diamond storage, sets the build manager and owner, timestamps the deployment, and installs initial plugins.
replacePlugin(...) - Replaces an existing set of plugins with a new set.
addPluginList(...) - Adds a list of plugins to the contract.
removePluginList(...) - Removes a list of plugins from the contract.
externalLens() - Returns the address of the external lens configured in the build manager.
Events
Errors
Access / Roles
replacePlugin:onlyOwneraddPluginList:onlyOwnerremovePluginList:onlyOwner
Interacts With
ICryptoLegacyICryptoLegacyBuildManagerICryptoLegacyPluginLibCryptoLegacyLibCryptoLegacyPluginsLibDiamond
Missing Links
None.
CryptoLegacyBuildManager
Purpose
CryptoLegacyBuildManager orchestrates protocol-instance deployment, fee collection, and registry wiring for new protocol instances.
Inheritance
ICryptoLegacyBuildManagerIERC721ReceiverOwnable
Key Methods
setRegistries(...) - Owner setter that updates Fee/Plugins/Beneficiary registries.
setFactory(...) - Owner setter that updates the deployment factory.
setSupplyLimit(...) - Owner setter for the minimum Lifetime NFT supply required to allow mass minting.
setExternalLens(...) - Owner setter for a helper "lens" address.
withdrawFee(...) - Owner can withdraw ETH from the contract to a recipient.
payFee(...) - Pays an update fee or, if sufficient, auto-switches to lifetime fee and mints/locks an NFT.
payInitialFee(...) - Pays the initial build fee (or lifetime) and optionally locks a Lifetime NFT.
payForMultipleLifetimeNft(...) - Mass mints Lifetime NFTs when supply threshold is met.
All Functions
receive() - Accepts plain ETH transfers to the build manager.
constructor(...) - Initializes registries and factory, stores the Lifetime NFT contract, and transfers ownership.
setRegistries(...) - Owner setter that updates Fee/Plugins/Beneficiary registries.
_setRegistries(...) - Internal storage setter for main registries.
setFactory(...) - Owner setter that updates the deployment factory.
_setFactory(...) - Internal storage setter for the factory contract.
setSupplyLimit(...) - Owner setter for the minimum Lifetime NFT supply required to allow mass minting.
setExternalLens(...) - Owner setter for a helper "lens" address.
withdrawFee(...) - Owner can withdraw ETH from the contract to a recipient.
payFee(...) - Pays an update fee or, if sufficient, auto-switches to lifetime fee and mints/locks an NFT.
_payFee(...) - Internal fee engine for build/update/lifetime fees, handling payment and optional NFT mint/lock.
_returnFee(...) - Refund helper to return surplus ETH to the caller.
_checkFee(...) - Validates that
valuecoversfee._mintAndLockLifetimeNft(...) - Mints a Lifetime NFT to this contract, approves the registry, and locks it cross-chain.
payInitialFee(...) - Pays the initial build fee (or lifetime) and optionally locks a Lifetime NFT.
payForMultipleLifetimeNft(...) - Mass mints Lifetime NFTs when supply threshold is met.
createCustomRef(...) - Creates a custom referral code and optionally locks it cross-chain; refunds any surplus.
_createCustomRef(...) - Internal custom-ref creation with cross-chain fee handling.
createRef(...) - Creates a short referral code and optionally locks it cross-chain; refunds surplus.
_createRef(...) - Internal short-ref creation with cross-chain fee handling.
updateCrossChainsRef(...) - Updates chain coverage for the caller’s referral code.
_createRefAndPayForBuild(...) - Internal helper to optionally create a referral and then obtain/pay the build fee.
buildCryptoLegacy(...) - Deploys and initializes a new CryptoLegacy instance after handling referral creation and fees.
_checkBuildArgs(...) - Validates required default timeouts in build arguments.
_getAndPayBuildFee(...) - Retrieves (and optionally pays) the initial build fee and always returns the update fee.
getUpdateFee(...) - Returns the configured update fee for a referral code.
getAndPayBuildFee(...) - Convenience entry point to fetch build/update fees and optionally pay if ETH is sent.
transferStuckNft(...) - Owner rescue function to transfer out an ERC721 token held by this contract.
onERC721Received(...) - ERC721 safe-transfer hook confirming receipt.
calculateCrossChainCreateRefFee(...) - Computes the total native fee needed to create/lock a referral across chains.
getFactoryAddress() - Returns the currently configured factory address.
isLifetimeNftLocked(...) - Checks whether a Lifetime NFT is locked for
owner.isLifetimeNftLockedAndUpdate(...) - For a calling CryptoLegacy, verifies ownership and then checks/updates the Lifetime NFT lock status.
isPluginRegistered(...) - Checks if a plugin is registered in the plugin registry.
isCryptoLegacyBuilt(...) - Returns whether a given CryptoLegacy address was deployed by this manager.
Events
Errors
Access / Roles
setRegistries:onlyOwnersetFactory:onlyOwnersetSupplyLimit:onlyOwnersetExternalLens:onlyOwnerwithdrawFee:onlyOwnertransferStuckNft:onlyOwner
Interacts With
IBeneficiaryRegistryICryptoLegacyICryptoLegacyFactoryIFeeRegistryILockChainGateILifetimeNftIPluginsRegistryCryptoLegacyBasePlugin
Missing Links
None.
CryptoLegacyDiamondBase
Purpose
CryptoLegacyDiamondBase provides shared diamond base behavior, including selector checks and static-call validation helpers.
Inheritance
ICryptoLegacyDiamondBaseDiamondLoupeFacet
Key Methods
staticCallChecker(...) - Self-call probe used by the fallback to detect whether the current context is a static call.
All Functions
staticCallChecker() - Self-call probe used by the fallback to detect whether the current context is a static call.
fallback() - Diamond fallback that routes unknown selectors to the correct facet via
delegatecall, caching the facet address on non-static calls.
Events
Errors
Access / Roles
staticCallChecker: self-call only (msg.sender == address(this))
Interacts With
ICryptoLegacyLibCryptoLegacyLibCryptoLegacyPluginsLibDiamond
Missing Links
None.
CryptoLegacyExternalLens
Purpose
CryptoLegacyExternalLens aggregates read-only status and portfolio views across CryptoLegacy-related components.
Inheritance
None.
Key Methods
isLifetimeActive(...) - Forwarder that reports whether lifetime mode is active on a target CryptoLegacy.
isPaused(...) - Forwarder that reports whether the target CryptoLegacy is paused.
buildManager(...) - Returns the build manager address of the target CryptoLegacy.
owner(...) - Returns the owner of the target CryptoLegacy.
updateInterval(...) - Returns the update interval of the target.
challengeTimeout(...) - Returns the challenge timeout of the target.
distributionStartAt(...) - Returns the distribution start timestamp.
lastFeePaidAt(...) - Returns the timestamp of the last fee payment.
All Functions
isLifetimeActive(...) - Forwarder that reports whether lifetime mode is active on a target CryptoLegacy.
isPaused(...) - Forwarder that reports whether the target CryptoLegacy is paused.
buildManager(...) - Returns the build manager address of the target CryptoLegacy.
owner(...) - Returns the owner of the target CryptoLegacy.
_baseData(...) - Internal helper that fetches base lens data from the target.
_listTokensData(...) - Internal helper that fetches list data for specified tokens.
updateInterval(...) - Returns the update interval of the target.
challengeTimeout(...) - Returns the challenge timeout of the target.
distributionStartAt(...) - Returns the distribution start timestamp.
lastFeePaidAt(...) - Returns the timestamp of the last fee payment.
lastUpdateAt(...) - Returns the timestamp of the last update.
initialFeeToPay(...) - Returns the initial fee required by the target.
updateFee(...) - Returns the update fee required by the target.
invitedByRefCode(...) - Returns the referral code associated with the target.
getBeneficiaries(...) - Returns beneficiaries and their configs from the target.
getTokensDistribution(...) - Returns token distribution info for a token list.
getCryptoLegacyBaseData(...) - Returns consolidated base data for the target.
getCryptoLegacyListData(...) - Returns aggregated list data for specified tokens.
getMessagesBlockNumbersByRecipient(...) - Returns message block numbers for a recipient hash.
getTransferBlockNumbers(...) - Returns block numbers where transfers occurred.
getVestedAndClaimedData(...) - Returns vesting/claimed data for a beneficiary across tokens.
getPluginInfoList(...) - Returns plugin metadata installed on the target.
getCryptoLegacyListWithStatuses(...) - Returns CryptoLegacy addresses for all roles tied to a hash plus default-guardian status per beneficiary entry.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
IBeneficiaryRegistryICryptoLegacyICryptoLegacyLensITrustedGuardiansPluginCryptoLegacyBasePluginLensPlugin
Missing Links
None.
CryptoLegacyFactory
Purpose
CryptoLegacyFactory creates new CryptoLegacy instances and controls which operators can trigger deployments.
Inheritance
ICryptoLegacyFactoryOwnable
Key Methods
setBuildOperator(...) - Adds or removes an authorized build operator.
createCryptoLegacy(...) - Deploys a new
CryptoLegacycontract at a deterministic address using CREATE3.cryptoLegacyBytecode(...) - Returns the full constructor bytecode for a
CryptoLegacydeployment.computeAddress(...) - Computes the deterministic address for a future
CryptoLegacydeployment.
All Functions
constructor(...) - Initializes the factory and sets the initial owner.
setBuildOperator(...) - Adds or removes an authorized build operator.
createCryptoLegacy(...) - Deploys a new
CryptoLegacycontract at a deterministic address using CREATE3.cryptoLegacyBytecode(...) - Returns the full constructor bytecode for a
CryptoLegacydeployment.computeAddress(...) - Computes the deterministic address for a future
CryptoLegacydeployment.
Events
Errors
Access / Roles
setBuildOperator:onlyOwner
Interacts With
LibCryptoLegacyDeploy
Missing Links
None.
CryptoLegacyOwnable
Purpose
CryptoLegacyOwnable implements ownership-transfer and pause controls shared by protocol contracts.
Inheritance
ICryptoLegacyOwnable
Key Methods
acceptOwnership(...) - Completes the two-step ownership transfer by moving ownership to
msg.sender.setPause(...) - Sets the pause flag for the CryptoLegacy contract.
pendingOwner(...) - Returns the current
pendingOwner.
All Functions
_transferOwnership(...) - Starts a two-step ownership transfer by setting
pendingOwnerand emitting the start event.acceptOwnership() - Completes the two-step ownership transfer by moving ownership to
msg.sender.setPause(...) - Sets the pause flag for the CryptoLegacy contract.
pendingOwner() - Returns the current
pendingOwner.
Events
Errors
Access / Roles
setPause:onlyOwneracceptOwnership:pendingOwneronly
Interacts With
ICryptoLegacyLibCryptoLegacyLibDiamond
Missing Links
None.
FeeRegistry
Purpose
FeeRegistry stores referral code metadata, fee percentages, and beneficiary split configuration for payment flows.
Inheritance
LockChainGateIFeeRegistry
Key Methods
initialize(...) - Initializes default percentages and the cross-chain gate configuration.
setCodeOperator(...) - Adds or removes an authorized referral-code operator.
setSupportedRefCodeInChains(...) - Adds or removes supported chain IDs for referral codes.
setFeeBeneficiaries(...) - Sets protocol fee beneficiaries and their shares.
setDefaultPct(...) - Updates global default discount/share percentages.
setRefererSpecificPct(...) - Sets custom discount/share percentages for a referrer’s code.
setContractCaseFee(...) - Sets the fee amount for a (contract, case) pair.
takeFee(...) - Charges a fee for a contract case and distributes referrer share.
All Functions
constructor() - Deploy-time constructor that disables initializers and sets the initial owner.
lockFeeRegistryStorage() - Returns a namespaced storage pointer for FeeRegistry state.
initialize(...) - Initializes default percentages and the cross-chain gate configuration.
setCodeOperator(...) - Adds or removes an authorized referral-code operator.
setSupportedRefCodeInChains(...) - Adds or removes supported chain IDs for referral codes.
setFeeBeneficiaries(...) - Sets protocol fee beneficiaries and their shares.
setDefaultPct(...) - Updates global default discount/share percentages.
_setDefaultPct(...) - Internal setter for default discount/share percentages.
setRefererSpecificPct(...) - Sets custom discount/share percentages for a referrer’s code.
setContractCaseFee(...) - Sets the fee amount for a (contract, case) pair.
takeFee(...) - Charges a fee for a contract case and distributes referrer share.
withdrawAccumulatedFee() - Distributes accumulated protocol fees to configured beneficiaries.
withdrawReferralAccumulatedFee(...) - Pays out a referrer’s accumulated unpaid share.
_setCustomCode(...) - Internal writer for a custom referral code’s ownership, recipient, and percentages.
_createCustomCode(...) - Internal creator for a new custom referral code.
_checkCodeNotZero(...) - Validates that a referral code is non-zero.
_checkSenderIsOperator(...) - Ensures caller is an authorized code operator.
createCustomCode(...) - Creates a custom referral code and optionally propagates it cross‑chain.
createCode(...) - Creates a generated referral code and optionally propagates it cross‑chain.
_setCrossChainsRef(...) - Internal helper to (create/update) code data across chains.
updateCrossChainsRef(...) - Updates cross-chain parameters for an existing referrer's code.
crossCreateCustomCode(...) - Cross-chain entry to create a custom code.
crossUpdateCustomCode(...) - Cross-chain entry to update code data.
_encodeCrossCreateCustomCodeCommand(...) - Encodes the cross-chain create code command payload.
_encodeCrossUpdateCustomCodeCommand(...) - Encodes the cross-chain update code command payload.
_checkSenderIsReferrer(...) - Ensures the caller owns the specified referral code.
_checkNewOwnerIsNotReferrer(...) - Prevents assigning a code to an address that already has one.
changeCodeReferrer(...) - Transfers code ownership to a new referrer and optionally updates cross‑chain.
changeRecipientReferrer(...) - Updates the payout recipient for a referral code and optionally propagates cross-chain.
getCodeOperatorsList() - Returns the list of authorized code operators.
isCodeOperator(...) - Checks whether an address is an authorized code operator.
getSupportedRefInChainsList() - Lists chain IDs where referral codes are supported.
isSupportedRefInChain(...) - Checks whether a chain ID supports referral codes.
getFeeBeneficiaries() - Returns protocol fee beneficiaries.
getCodePct(...) - Returns effective discount/share percentages for a code.
_getCodePct(...) - Internal resolver for a code’s effective percentages.
calculateFee(...) - Computes discount, share, and final fee for a code and base fee.
_calculateFee(...) - Internal computation of discount/share/fee for a code and base amount.
getContractCaseFee(...) - Retrieves the stored fee for a (contract, case) pair.
getContractCaseFeeForCode(...) - Retrieves the effective fee for a (contract, case) after applying a code’s discount.
getReferrerByAddress(...) - Returns referrer metadata by referrer address.
_getReferrerByAddress(...) - Internal resolver for referrer by address.
getReferrerByCode(...) - Returns referrer metadata by code.
_getReferrerByCode(...) - Internal resolver for referrer by code.
defaultSharePct() - Returns the default share percentage.
defaultDiscountPct() - Returns the default discount percentage.
refererByCode(...) - Returns raw referrer record for a code (without effective pcts).
codeByReferrer(...) - Returns the code associated with a referrer address.
accumulatedFee() - Returns the accumulated protocol fee balance.
Events
Errors
Access / Roles
initialize:initializersetCodeOperator:onlyOwnersetSupportedRefCodeInChains:onlyOwnersetFeeBeneficiaries:onlyOwnersetDefaultPct:onlyOwnersetRefererSpecificPct:onlyOwnersetContractCaseFee:onlyOwnertakeFee:nonReentrantwithdrawAccumulatedFee:nonReentrantwithdrawReferralAccumulatedFee:nonReentrantcreateCustomCode:nonReentrantcreateCode:nonReentrantupdateCrossChainsRef:nonReentrantcrossCreateCustomCode:nonReentrantcrossUpdateCustomCode:nonReentrantchangeCodeReferrer:nonReentrantchangeRecipientReferrer:nonReentrant
Interacts With
ILifetimeNft
Missing Links
None.
LegacyMessenger
Purpose
LegacyMessenger records recipient-linked legacy messages and emits block-indexed message events for off-chain tracking.
Inheritance
ILegacyMessengerBuildManagerOwnable
Key Methods
sendMessagesTo(...) - Emits per‑recipient message events and records the block number for each recipient.
getMessagesBlockNumbersByRecipient(...) - Returns the list of block numbers when a given recipient received messages.
All Functions
constructor(...) - Initializes the messenger and sets the contract owner.
sendMessagesTo(...) - Emits per‑recipient message events and records the block number for each recipient.
getMessagesBlockNumbersByRecipient(...) - Returns the list of block numbers when a given recipient received messages.
Events
Errors
Access / Roles
sendMessagesTo: registered CryptoLegacy caller with approved build manager (_checkBuildManagerValid)
Interacts With
ArbSys
Missing Links
None.
LifetimeNft
Purpose
LifetimeNft implements the protocol NFT with controlled minting and configurable metadata base URI.
Inheritance
ILifetimeNftERC721EnumerableOwnable
Key Methods
setBaseUri(...) - Updates the collection-wide base URI.
setMinterOperator(...) - Grants or revokes minting permission for an address.
mint(...) - Mints a new token to the specified owner.
tokensOfOwner(...) - Enumerates all token IDs owned by the given address.
getTier(...) - Computes the tier for a given token ID.
All Functions
constructor(...) - Initializes the ERC721 token with name, symbol, base URI, and owner.
setBaseUri(...) - Updates the collection-wide base URI.
_setBaseUri(...) - Internal helper to set the base URI and emit an event.
setMinterOperator(...) - Grants or revokes minting permission for an address.
mint(...) - Mints a new token to the specified owner.
_baseURI() - Returns the stored base URI for metadata composition.
tokensOfOwner(...) - Enumerates all token IDs owned by the given address.
getTier(...) - Computes the tier for a given token ID.
Events
Errors
Access / Roles
setBaseUri:onlyOwnersetMinterOperator:onlyOwner
Interacts With
None.
Missing Links
None.
LockChainGate
Purpose
LockChainGate manages lifetime-NFT lock/unlock flows and cross-chain routing parameters for bridge operations.
Inheritance
OwnableReentrancyGuardUpgradeableILockChainGate
Key Methods
setLockOperator(...) - Adds or removes an address from the lock operators set.
setDebridgeGate(...) - Sets the deBridgeGate contract used for cross-chain messages.
setDebridgeNativeFee(...) - Sets the per-chain native fee used when sending cross-chain messages.
setDestinationChainContract(...) - Public setter for the destination chain contract mapping.
setSourceChainContract(...) - Public setter for the source chain contract mapping.
setSourceAndDestinationChainContract(...) - Sets both source and destination contract addresses for a chain.
setLockPeriod(...) - Updates the NFT lock period and transfer timeout.
setReferralCode(...) - Sets deBridge referral code used in messages.
All Functions
constructor() - Deploy-time constructor that disables initializers and sets the Ownable owner.
lockChainGateStorage() - Returns the storage pointer for the LockChainGate storage struct.
_initializeLockChainGate(...) - Internal initializer to set Lifetime NFT address, lock config, owner, and reentrancy guard.
setLockOperator(...) - Adds or removes an address from the lock operators set.
setDebridgeGate(...) - Sets the deBridgeGate contract used for cross-chain messages.
setDebridgeNativeFee(...) - Sets the per-chain native fee used when sending cross-chain messages.
_setDestinationChainContract(...) - Internal setter for the destination chain contract mapping.
setDestinationChainContract(...) - Public setter for the destination chain contract mapping.
_setSourceChainContract(...) - Internal setter for source chain contract mapping.
setSourceChainContract(...) - Public setter for the source chain contract mapping.
setSourceAndDestinationChainContract(...) - Sets both source and destination contract addresses for a chain.
setLockPeriod(...) - Updates the NFT lock period and transfer timeout.
setReferralCode(...) - Sets deBridge referral code used in messages.
setCustomChainId(...) - Overrides the auto-detected chainId with a custom value.
_writeLockLifetimeNft(...) - Records a newly locked NFT for a holder.
lockLifetimeNft(...) - Locks a Lifetime NFT and optionally mirrors the lock on specified chains.
_calcAndReturnFee(...) - Computes surplus ETH after fees and returns it to caller.
_returnFee(...) - Sends ETH back to
msg.senderif_returnValue > 0.crossLockLifetimeNft(...) - Handles cross-chain lock message to record a lock from a source chain.
_lockLifetimeNftToChains(...) - Locks a token to multiple chains by sending cross-chain messages.
_checkFee(...) - Validates that
msg.valuematches the required fee within tolerance.lockLifetimeNftToChains(...) - Mirrors the caller’s existing lock to additional chains.
_lockLifetimeNftToChain(...) - Sends a cross-chain lock message to a single chain and records mirroring.
unlockLifetimeNft(...) - Unlocks a locally locked NFT back to the caller if conditions are satisfied.
unlockLifetimeNftFromChain(...) - Initiates cross-chain unlock to the source chain and clears local lock.
crossUnlockLifetimeNft(...) - Handles cross-chain unlock completion from a source chain.
crossUpdateNftOwner(...) - Updates owner mapping based on cross-chain transfer message.
_deleteTokenData(...) - Clears all lock-related mappings for a token and holder.
_onlyCrossChain(...) - Ensures the function is called by deBridge CallProxy from the expected source chain and contract.
_send(...) - Sends a cross-chain message via deBridge with flags set.
approveLifetimeNftTo(...) - Approves an address to unlock or transfer a locked NFT.
_transferLifetimeNftTo(...) - Internal mapping-only transfer of a locked NFT between holders.
transferLifetimeNftTo(...) - Transfers a locked NFT to a new holder locally and updates remote chains.
updateNftOwnerOnChainList(...) - Sends owner-update messages for the caller’s locked NFT to specified chains.
_updateNftOwnerOnChainList(...) - Internal routine to update NFT owner on a list of chains.
_updateLifetimeNftOwnerOnChain(...) - Sends owner-update for a single chain and records mirroring.
_encodeCrossLockCommand(...) - Encodes the cross-chain lock command calldata.
_encodeCrossUnlockCommand(...) - Encodes the cross-chain unlock command calldata.
_encodeCrossUpdateOwnerCommand(...) - Encodes the cross-chain update-owner command calldata.
_checkDestinationLockedChain(...) - Ensures destination chain contract is configured.
_checkTokenLocked(...) - Validates that a holder currently has a locked token and returns its id.
_checkCrossChainLock(...) - Ensures the token is not currently locked via cross-chain lock source id.
_checkTooEarly(...) - Enforces that the lock period has elapsed for a holder.
_checkSource(...) - Ensures source chain contract is configured.
_checkHolderTokenLock(...) - Verifies that
_holderis recorded as the holder of_tokenId.getLockedToChainsIdsOfAccount(...) - Returns destination chain ids where the account’s token is mirrored.
_getLockedToChainsIdsOfAccount(...) - Internal getter for mirrored chain IDs of
_holder.getLockedUntil(...) - Returns the timestamp when
_holdercan unlock._getLockedUntil(...) - Internal computation of unlock timestamp.
getLockedToChainsIds(...) - Returns mirrored chain ids for a given token id.
lockPeriod() - Getter for current lock period.
transferTimeout() - Getter for transfer timeout.
referralCode() - Getter for deBridge referral code.
ownerOfTokenId(...) - Returns owner address recorded for a locked token.
lockedNftFromChainId(...) - Returns the source chain id that locked a token, if any.
lockedNftApprovedTo(...) - Returns the address approved for a locked NFT.
lockedNft(...) - Returns the
LockedNftrecord for a holder.getDeBridgeChainNativeFeeAndCheck(...) - Returns required native fee for a chain and verifies
msg.valuematches policy._getDeBridgeChainNativeFeeAndCheck(...) - Internal compute-and-check fee helper.
getDeBridgeChainNativeFee(...) - View function to compute native fee for a chain.
_getDeBridgeChainNativeFee(...) - Internal fee computation for a chain.
deBridgeGate() - Returns the configured deBridgeGate address.
lifetimeNft() - Returns the associated LifetimeNft address.
deBridgeChainConfig(...) - Returns cross-chain configuration for a chain id.
getLockOperatorsList() - Returns all lock operator addresses.
isLockOperator(...) - Checks whether an address is a lock operator.
calculateCrossChainCreateRefNativeFee(...) - Computes total native fee for cross-chain referral creation.
isNftLocked(...) - Returns whether a holder has a locked NFT.
_isNftLocked(...) - Internal check if a holder has a locked token id.
isNftLockedAndUpdate(...) - Returns whether the holder has a locked NFT and refreshes lock time if expired.
getChainId() - Returns the effective chain id (custom or EVM).
_getChainId(...) - Internal effective chain id getter.
Events
Errors
Access / Roles
_initializeLockChainGate:initializersetLockOperator:onlyOwnersetDebridgeGate:onlyOwnersetDebridgeNativeFee:onlyOwnersetDestinationChainContract:onlyOwnersetSourceChainContract:onlyOwnersetSourceAndDestinationChainContract:onlyOwnersetLockPeriod:onlyOwnersetReferralCode:onlyOwnersetCustomChainId:onlyOwnerlockLifetimeNft:nonReentrantcrossLockLifetimeNft:nonReentrantlockLifetimeNftToChains:nonReentrantunlockLifetimeNft:nonReentrantunlockLifetimeNftFromChain:nonReentrantcrossUnlockLifetimeNft:nonReentrantcrossUpdateNftOwner:nonReentrantapproveLifetimeNftTo:nonReentranttransferLifetimeNftTo:nonReentrantupdateNftOwnerOnChainList:nonReentrant
Interacts With
FlagsICallProxyIDeBridgeGateILifetimeNft
Missing Links
None.
MultiPermit
Purpose
MultiPermit batches token permit and approval calls to reduce transaction overhead for treasury flows.
Inheritance
None.
Key Methods
approveTreasuryTokensToLegacy(...) - Executes multiple ERC‑2612
permitapprovals in a single transaction.
All Functions
constructor() - Deploys the MultiPermit helper contract.
approveTreasuryTokensToLegacy(...) - Executes multiple ERC‑2612
permitapprovals in a single transaction.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
PluginsRegistry
Purpose
PluginsRegistry tracks approved plugins and versioned plugin metadata used by protocol composition logic.
Inheritance
IPluginsRegistryOwnable
Key Methods
addPlugin(...) - Registers a plugin and records a description block number, then emits
AddPlugin.addPluginDescription(...) - Appends a new description block number for an existing plugin and emits
AddPluginDescription.removePlugin(...) - Unregisters a plugin and emits
RemovePlugin.isPluginRegistered(...) - Returns whether
_pluginis currently registered.getPluginMetadata(...) - Reads a plugin’s
name,version, and its description block numbers.getPluginDescriptionBlockNumbers(...) - Returns the full array of description block numbers for
_plugin.getPluginAddressList(...) - Returns an array of all registered plugin addresses.
getPluginInfoList(...) - Aggregates metadata for all registered plugins into an array of
PluginInfo.
All Functions
constructor(...) - Initializes ownership and sets the provided
_owneras the contract owner.addPlugin(...) - Registers a plugin and records a description block number, then emits
AddPlugin.addPluginDescription(...) - Appends a new description block number for an existing plugin and emits
AddPluginDescription.removePlugin(...) - Unregisters a plugin and emits
RemovePlugin.isPluginRegistered(...) - Returns whether
_pluginis currently registered.getPluginMetadata(...) - Reads a plugin’s
name,version, and its description block numbers.getPluginDescriptionBlockNumbers(...) - Returns the full array of description block numbers for
_plugin.getPluginAddressList() - Returns an array of all registered plugin addresses.
getPluginInfoList() - Aggregates metadata for all registered plugins into an array of
PluginInfo.
Events
Errors
None.
Access / Roles
addPlugin:onlyOwneraddPluginDescription:onlyOwnerremovePlugin:onlyOwner
Interacts With
ArbSysICryptoLegacyPlugin
Missing Links
None.
ProxyBuilder
Purpose
ProxyBuilder deploys proxy instances and binds them to the configured proxy-admin authority.
Inheritance
Ownable
Key Methods
setProxyAdmin(...) - Updates the ProxyAdmin controller address.
build(...) - Deploys a
TransparentUpgradeableProxydeterministically via CREATE3.proxyBytecode(...) - Produces creation bytecode for
TransparentUpgradeableProxy.computeAddress(...) - Computes the deterministic CREATE3 address for a given salt.
All Functions
constructor(...) - Initializes the builder with an optional ProxyAdmin and sets the owner.
setProxyAdmin(...) - Updates the ProxyAdmin controller address.
build(...) - Deploys a
TransparentUpgradeableProxydeterministically via CREATE3.proxyBytecode(...) - Produces creation bytecode for
TransparentUpgradeableProxy.computeAddress(...) - Computes the deterministic CREATE3 address for a given salt.
Events
Errors
Access / Roles
setProxyAdmin:onlyOwnerbuild:onlyOwner
Interacts With
LibCreate3
Missing Links
None.
ProxyBuilderAdmin
Purpose
ProxyBuilderAdmin centralizes administrative controls for deployed beneficiary proxies in the protocol deployment stack.
Inheritance
ProxyAdmin
Key Methods
None.
All Functions
constructor(...) - Initializes the ProxyBuilderAdmin and sets the initial owner.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
SignatureRoleTimelock
Purpose
SignatureRoleTimelock enforces role-based timelocks and scheduled execution for restricted function calls.
Inheritance
ISignatureRoleTimelockAccessControlReentrancyGuard
Key Methods
setMaxExecutionPeriod(...) - Updates the maximum allowed execution window after timelock expiry.
setRoleAccounts(...) - Batch adds, removes, or replaces role accounts.
renounceRole(...) - Disabled AccessControl function; always reverts.
addSignatureRoleList(...) - Batch-assigns signature roles to target functions.
removeSignatureRoleList(...) - Batch-removes signature role bindings.
scheduleCallList(...) - Schedules a batch of authorized calls with per-signature timelocks.
executeCallList(...) - Executes a batch of scheduled calls after their timelocks expire.
cancelCallList(...) - Cancels pending scheduled calls (admin-only).
All Functions
constructor(...) - Initializes admin role, seeds role accounts, and installs initial signature roles with timelocks.
setMaxExecutionPeriod(...) - Updates the maximum allowed execution window after timelock expiry.
setRoleAccounts(...) - Batch adds, removes, or replaces role accounts.
_addRoleAccount(...) - Adds an account to a role and grants it in AccessControl.
_getAddressIndex(...) - Finds index of address in array or returns
type(uint256).max._getBytes4Index(...) - Finds index of bytes4 selector in array or returns
type(uint256).max._removeRoleAccount(...) - Removes an account from a role and revokes it in AccessControl.
renounceRole(...) - Disabled AccessControl function; always reverts.
addSignatureRoleList(...) - Batch-assigns signature roles to target functions.
_addSignatureRole(...) - Adds a single
(target, selector)signature role binding.removeSignatureRoleList(...) - Batch-removes signature role bindings.
_removeSignatureRole(...) - Removes a single
(target, selector)signature role binding.scheduleCallList(...) - Schedules a batch of authorized calls with per-signature timelocks.
_checkRole(...) - AccessControl hook override to enforce role checks with custom error.
_scheduleCall(...) - Schedules a single authorized call with timelock and execution window.
executeCallList(...) - Executes a batch of scheduled calls after their timelocks expire.
_executeCall(...) - Executes an individual scheduled call when permitted by time window.
cancelCallList(...) - Cancels pending scheduled calls (admin-only).
_cancelCall(...) - Cancels a single scheduled call if still pending.
getRoleAccounts(...) - Returns accounts that hold a given role.
getTargets() - Lists all targets that have signature role bindings.
getTargetSigs(...) - Returns signature role details for a given target.
getCallId(...) - Computes a deterministic call ID for a pending call.
getCall(...) - Returns details of a scheduled call.
getCallsList(...) - Paginates scheduled call IDs and their details.
getCallIds() - Returns all scheduled call IDs.
getCallsLength() - Returns the number of scheduled calls.
Events
Errors
Access / Roles
setMaxExecutionPeriod:onlyCurrentAddresssetRoleAccounts:onlyCurrentAddressaddSignatureRoleList:onlyCurrentAddressremoveSignatureRoleList:onlyCurrentAddressscheduleCallList:nonReentrantexecuteCallList:nonReentrantcancelCallList:nonReentrant, onlyRole
Interacts With
None.
Missing Links
None.
WethUnwrapIWETH (Interface)
Purpose
WethUnwrapIWETH defines the minimal WETH transfer and withdrawal calls required by the WethUnwrap helper contract.
Inheritance
None.
Key Methods
transferFrom(...) - Transfers WETH from one address to another.
withdraw(...) - Burns WETH and releases the same amount of native ETH.
All Functions
transferFrom(...) - Transfers WETH from one address to another.
withdraw(...) - Burns WETH and releases the same amount of native ETH.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
WethUnwrap
Purpose
WethUnwrap is a helper contract that pulls WETH from the caller, unwraps it into native ETH, and forwards the ETH back to the caller through a callback payload. It exists to support plugin flows that need native ETH for downstream protocol actions while keeping the unwrap logic isolated.
Inheritance
None.
Key Methods
unwrap_weth(...) - Pulls WETH from the caller, unwraps it to ETH, and immediately forwards the ETH back with callback calldata.
All Functions
constructor(...) - Stores the canonical WETH contract address used for unwrap operations.
unwrap_weth(...) - Pulls WETH from the caller, unwraps it to ETH, and immediately forwards the ETH back with callback calldata.
receive(...) - Accepts native ETH released by the WETH contract during an unwrap.
Events
None.
Errors
Access / Roles
None.
Interacts With
WethUnwrapIWETH
Missing Links
None.
ArbSys (Interface)
Purpose
ArbSys defines the Arbitrum system interface used for chain-specific context queries.
Inheritance
None.
Key Methods
arbBlockNumber(...) - Returns the current Arbitrum L2 block number.
All Functions
arbBlockNumber() - Returns the current Arbitrum L2 block number.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
Flags (Library)
Purpose
Flags centralizes bit-flag read/write helpers used by storage-efficient modules.
Inheritance
None.
Key Methods
getFlag(...) - Tests whether a specific bit is enabled inside a packed flags word.
setFlag(...) - Returns a new flags word with a specific bit set or cleared.
All Functions
getFlag(...) - Tests whether a specific bit is enabled inside a packed flags word.
setFlag(...) - Returns a new flags word with a specific bit set or cleared.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
IAaveV3Pool (Interface)
Purpose
IAaveV3Pool defines the subset of Aave V3 pool calls used by the beneficiary-supply plugin for supply, withdrawal, and reserve-data access.
Inheritance
None.
Key Methods
supply(...) - Supplies an asset into the Aave V3 pool on behalf of a target account.
withdraw(...) - Withdraws a reserve asset from Aave V3 to a recipient address.
All Functions
supply(...) - Supplies an asset into the Aave V3 pool on behalf of a target account.
withdraw(...) - Withdraws a reserve asset from Aave V3 to a recipient address.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
IAaveV3PoolDataProvider (Interface)
Purpose
IAaveV3PoolDataProvider exposes reserve-token metadata used by the Aave beneficiary-supply plugin to discover the aToken corresponding to an underlying asset.
Inheritance
None.
Key Methods
getReserveTokensAddresses(...) - Returns the token-contract addresses associated with an Aave reserve.
All Functions
getReserveTokensAddresses(...) - Returns the token-contract addresses associated with an Aave reserve.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
IBeneficiaryRegistry (Interface)
Purpose
IBeneficiaryRegistry specifies the external registry API for beneficiary/owner/guardian/recovery indexing.
Inheritance
None.
Key Methods
setCryptoLegacyBeneficiary(...) - Registers or removes a CryptoLegacy contract for a beneficiary hash.
setCryptoLegacyOwner(...) - Registers or removes a CryptoLegacy contract for an owner hash.
setCryptoLegacyGuardian(...) - Toggles guardian-role membership for a CryptoLegacy contract.
setCryptoLegacyRecoveryAddresses(...) - Batch updates recovery-role mappings for a CryptoLegacy contract.
getAllCryptoLegacyListByRoles(...) - Returns all CryptoLegacy addresses associated with a hash across roles.
All Functions
setCryptoLegacyBeneficiary(...) - Registers or removes a CryptoLegacy contract for a beneficiary hash.
setCryptoLegacyOwner(...) - Registers or removes a CryptoLegacy contract for an owner hash.
setCryptoLegacyGuardian(...) - Toggles guardian-role membership for a CryptoLegacy contract.
setCryptoLegacyRecoveryAddresses(...) - Batch updates recovery-role mappings for a CryptoLegacy contract.
getAllCryptoLegacyListByRoles(...) - Returns all CryptoLegacy addresses associated with a hash across roles.
Events
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
IBuildManagerOwnable (Interface)
Purpose
IBuildManagerOwnable defines owner-controlled build-manager allowlist operations.
Inheritance
None.
Key Methods
None.
All Functions
None.
Events
Errors
Access / Roles
None.
Interacts With
None.
Missing Links
None.
ICallProxy (Interface)
Purpose
ICallProxy defines the cross-chain call relay interface and sender-submission metadata accessors.
Inheritance
None.
Key Methods
submissionChainIdFrom(...) - Returns the source chain ID for the current cross-chain submission.
submissionNativeSender(...) - Returns the original sender (encoded as bytes) of the cross-chain submission.
call(...) - Executes a cross-chain call with optional native asset transfer.
callERC20(...) - Executes a cross-chain call that also transfers ERC20 tokens.
All Functions
submissionChainIdFrom() - Returns the source chain ID for the current cross-chain submission.
submissionNativeSender() - Returns the original sender (encoded as bytes) of the cross-chain submission.
call(...) - Executes a cross-chain call with optional native asset transfer.
callERC20(...) - Executes a cross-chain call that also transfers ERC20 tokens.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
ICryptoLegacy (Interface)
Purpose
ICryptoLegacy defines the primary protocol storage and operational interface consumed by plugins and managers.
Inheritance
None.
Key Methods
buildManager(...) - Returns the build manager contract associated with the CryptoLegacy instance.
owner(...) - Returns the current diamond owner address.
All Functions
buildManager() - Returns the build manager contract associated with the CryptoLegacy instance.
owner() - Returns the current diamond owner address.
Events
Errors
Access / Roles
None.
Interacts With
None.
Missing Links
None.
ICryptoLegacyBuildManager (Interface)
Purpose
ICryptoLegacyBuildManager defines the deployment, fee-payment, and registry setup interface for protocol-instance creation.
Inheritance
None.
Key Methods
payInitialFee(...) - Collects the initial protocol fee when a CryptoLegacy instance is created.
payFee(...) - Processes ongoing registry update fees for an existing CryptoLegacy.
getUpdateFee(...) - Returns the configured update fee for a referral code.
isLifetimeNftLocked(...) - Checks whether the owner’s lifetime NFT is locked.
isLifetimeNftLockedAndUpdate(...) - Checks and updates lifetime NFT lock status in a single call.
isPluginRegistered(...) - Returns whether a plugin address is approved by the build manager.
isCryptoLegacyBuilt(...) - Indicates whether a CryptoLegacy address was deployed via the build manager.
pluginsRegistry(...) - Returns the plugins registry contract address.
All Functions
payInitialFee(...) - Collects the initial protocol fee when a CryptoLegacy instance is created.
payFee(...) - Processes ongoing registry update fees for an existing CryptoLegacy.
getUpdateFee(...) - Returns the configured update fee for a referral code.
isLifetimeNftLocked(...) - Checks whether the owner’s lifetime NFT is locked.
isLifetimeNftLockedAndUpdate(...) - Checks and updates lifetime NFT lock status in a single call.
isPluginRegistered(...) - Returns whether a plugin address is approved by the build manager.
isCryptoLegacyBuilt(...) - Indicates whether a CryptoLegacy address was deployed via the build manager.
pluginsRegistry() - Returns the plugins registry contract address.
getFactoryAddress() - Returns the configured factory contract address.
beneficiaryRegistry() - Returns the beneficiary registry address used by the build manager.
externalLens() - Returns the external lens contract used for off-chain queries.
Events
Errors
Access / Roles
None.
Interacts With
None.
Missing Links
None.
ICryptoLegacyDiamondBase (Interface)
Purpose
ICryptoLegacyDiamondBase defines base diamond helper calls shared by core protocol contracts.
Inheritance
None.
Key Methods
None.
All Functions
None.
Events
Errors
Access / Roles
None.
Interacts With
None.
Missing Links
None.
ICryptoLegacyFactory (Interface)
Purpose
ICryptoLegacyFactory defines protocol-instance deployment and build-operator management functions.
Inheritance
None.
Key Methods
createCryptoLegacy(...) - Deploys a new CryptoLegacy diamond with the supplied owner, plugin list, and optional CREATE2 parameters.
setBuildOperator(...) - Grants or revokes build-operator permissions for the factory.
All Functions
createCryptoLegacy(...) - Deploys a new CryptoLegacy diamond with the supplied owner, plugin list, and optional CREATE2 parameters.
setBuildOperator(...) - Grants or revokes build-operator permissions for the factory.
Events
Errors
Access / Roles
None.
Interacts With
None.
Missing Links
None.
ICryptoLegacyLens (Interface)
Purpose
ICryptoLegacyLens defines read-only lens calls for protocol status, messages, and beneficiary data.
Inheritance
None.
Key Methods
getMessagesBlockNumbersByRecipient(...) - Returns the message block numbers recorded for a recipient hash.
getVestedAndClaimedData(...) - Returns per-token vested and claimed data for a beneficiary.
getCryptoLegacyBaseData(...) - Returns the core configuration snapshot for a CryptoLegacy.
getCryptoLegacyListData(...) - Returns aggregated beneficiaries, transfers, plugins, and token distribution data.
All Functions
getMessagesBlockNumbersByRecipient(...) - Returns the message block numbers recorded for a recipient hash.
getVestedAndClaimedData(...) - Returns per-token vested and claimed data for a beneficiary.
getCryptoLegacyBaseData() - Returns the core configuration snapshot for a CryptoLegacy.
getCryptoLegacyListData(...) - Returns aggregated beneficiaries, transfers, plugins, and token distribution data.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
ICryptoLegacyOwnable (Interface)
Purpose
ICryptoLegacyOwnable defines ownership and pause control calls for CryptoLegacy-compatible modules.
Inheritance
None.
Key Methods
None.
All Functions
None.
Events
Errors
Access / Roles
None.
Interacts With
None.
Missing Links
None.
ICryptoLegacyPlugin (Interface)
Purpose
ICryptoLegacyPlugin defines the plugin ABI for selectors, setup hooks, and plugin metadata.
Inheritance
None.
Key Methods
getSigs(...) - Returns the function selectors supported by the plugin.
getSetupSigs(...) - Returns the setup selectors required when installing the plugin.
getPluginName(...) - Returns the human-readable plugin name.
getPluginVer(...) - Returns the plugin version number.
All Functions
getSigs() - Returns the function selectors supported by the plugin.
getSetupSigs() - Returns the setup selectors required when installing the plugin.
getPluginName() - Returns the human-readable plugin name.
getPluginVer() - Returns the plugin version number.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
ICryptoLegacyUpdaterPlugin (Interface)
Purpose
ICryptoLegacyUpdaterPlugin defines updater-plugin behavior for role and state migration operations.
Inheritance
None.
Key Methods
None.
All Functions
None.
Events
Errors
Access / Roles
None.
Interacts With
None.
Missing Links
None.
IDeBridgeGate (Interface)
Purpose
IDeBridgeGate defines bridge-gateway calls for message delivery and token movement across chains.
Inheritance
None.
Key Methods
isSubmissionUsed(...) - Reports whether a deBridge submission has already been claimed.
getNativeInfo(...) - Returns the origin chain metadata for a wrapped asset.
callProxy(...) - Exposes the call proxy contract used to execute bridged payloads on the destination chain.
globalFixedNativeFee(...) - Returns the global base native fee charged for bridging operations.
globalTransferFeeBps(...) - Returns the global percentage fee (in basis points) applied to bridged transfers.
sendMessage(...) - Submits a cross-chain message to a destination contract without transferring assets.
sendMessage(...) - Submits a cross-chain message with explicit flags and referral code.
send(...) - Bridges assets from the native chain to a destination chain.
All Functions
isSubmissionUsed(...) - Reports whether a deBridge submission has already been claimed.
getNativeInfo(...) - Returns the origin chain metadata for a wrapped asset.
callProxy() - Exposes the call proxy contract used to execute bridged payloads on the destination chain.
globalFixedNativeFee() - Returns the global base native fee charged for bridging operations.
globalTransferFeeBps() - Returns the global percentage fee (in basis points) applied to bridged transfers.
sendMessage(...) - Submits a cross-chain message to a destination contract without transferring assets.
sendMessage(...) - Submits a cross-chain message with explicit flags and referral code.
send(...) - Bridges assets from the native chain to a destination chain.
claim(...) - Claims bridged assets on the destination chain.
withdrawFee(...) - Withdraws accumulated protocol fees for an asset.
getDebridgeChainAssetFixedFee(...) - Returns the fixed native fee for an asset on a specific chain.
Events
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
IDiamondCut (Interface)
Purpose
IDiamondCut defines facet-cut structures and upgrade entrypoints for the diamond proxy standard.
Inheritance
None.
Key Methods
diamondCut(...) - External entry point for applying diamond facet cuts with optional initialization.
All Functions
diamondCut(...) - External entry point for applying diamond facet cuts with optional initialization.
Events
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
IDiamondLoupe (Interface)
Purpose
IDiamondLoupe defines introspection views for facets, selectors, and interface support.
Inheritance
None.
Key Methods
facets(...) - Returns the full list of facet addresses together with their selectors.
facetFunctionSelectors(...) - Returns the selector list exposed by a specific facet.
facetAddresses(...) - Lists every facet address installed on the diamond.
facetAddress(...) - Resolves which facet implements a given selector.
All Functions
facets() - Returns the full list of facet addresses together with their selectors.
facetFunctionSelectors(...) - Returns the selector list exposed by a specific facet.
facetAddresses() - Lists every facet address installed on the diamond.
facetAddress(...) - Resolves which facet implements a given selector.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
IFeeRegistry (Interface)
Purpose
IFeeRegistry defines referral and fee lookup APIs used by builders and plugins.
Inheritance
None.
Key Methods
getContractCaseFee(...) - Returns the configured base fee for a specific contract-case combination.
getContractCaseFeeForCode(...) - Returns the effective fee for a contract-case after applying a referral code’s discount.
takeFee(...) - Charges the calculated fee for a contract-case and processes referral payouts.
createCustomCode(...) - Creates a specific referral code and optionally pushes it to other chains.
createCode(...) - Generates a new referral code and optionally propagates it cross-chain.
updateCrossChainsRef(...) - Updates cross-chain propagation settings for an existing referral code.
accumulatedFee(...) - Returns the protocol fee balance awaiting distribution.
getSupportedRefInChainsList(...) - Lists the chain IDs where referral codes are currently supported.
All Functions
getContractCaseFee(...) - Returns the configured base fee for a specific contract-case combination.
getContractCaseFeeForCode(...) - Returns the effective fee for a contract-case after applying a referral code’s discount.
takeFee(...) - Charges the calculated fee for a contract-case and processes referral payouts.
createCustomCode(...) - Creates a specific referral code and optionally pushes it to other chains.
createCode(...) - Generates a new referral code and optionally propagates it cross-chain.
updateCrossChainsRef(...) - Updates cross-chain propagation settings for an existing referral code.
accumulatedFee() - Returns the protocol fee balance awaiting distribution.
getSupportedRefInChainsList() - Lists the chain IDs where referral codes are currently supported.
Events
Errors
Access / Roles
None.
Interacts With
None.
Missing Links
None.
ILockChainGate (Interface)
Purpose
ILockChainGate defines lock-gate operations for locking, unlocking, and bridge-synchronized NFT state.
Inheritance
None.
Key Methods
lockLifetimeNft(...) - Locks a lifetime NFT and optionally propagates the lock across chains.
isNftLocked(...) - Reports whether the owner has an active lifetime NFT lock.
isNftLockedAndUpdate(...) - Checks lock status and updates timing when required.
calculateCrossChainCreateRefNativeFee(...) - Computes the total native fee required for cross-chain referral creation.
All Functions
lockLifetimeNft(...) - Locks a lifetime NFT and optionally propagates the lock across chains.
isNftLocked(...) - Reports whether the owner has an active lifetime NFT lock.
isNftLockedAndUpdate(...) - Checks lock status and updates timing when required.
calculateCrossChainCreateRefNativeFee(...) - Computes the total native fee required for cross-chain referral creation.
Events
Errors
Access / Roles
None.
Interacts With
None.
Missing Links
None.
ILegacyMessenger (Interface)
Purpose
ILegacyMessenger defines message-sending and retrieval calls for legacy communication records.
Inheritance
None.
Key Methods
None.
All Functions
None.
Events
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
ILido (Interface)
Purpose
ILido defines the subset of Lido staking and share-transfer calls required by integrations.
Inheritance
None.
Key Methods
submit(...) - Stakes ETH into Lido and mints stETH, crediting the caller.
transferShares(...) - Transfers a specified amount of Lido shares to another address.
transferSharesFrom(...) - Transfers Lido shares from one address to another using allowance semantics.
sharesOf(...) - Returns the number of Lido shares owned by an account.
All Functions
submit(...) - Stakes ETH into Lido and mints stETH, crediting the caller.
transferShares(...) - Transfers a specified amount of Lido shares to another address.
transferSharesFrom(...) - Transfers Lido shares from one address to another using allowance semantics.
sharesOf(...) - Returns the number of Lido shares owned by an account.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
ILidoWithdrawalQueue (Interface)
Purpose
ILidoWithdrawalQueue defines the withdrawal-request and claim calls used by the Lido staking beneficiary plugin. It standardizes request and claim entry points so Lido-side exits can be orchestrated through a stable interface.
Inheritance
None.
Key Methods
requestWithdrawals(...) - Requests ETH withdrawals for stETH amounts through Lido's withdrawal queue.
requestWithdrawalsWstETH(...) - Requests ETH withdrawals for wstETH amounts through the Lido queue.
claimWithdrawals(...) - Claims finalized Lido withdrawals for previously created request IDs.
All Functions
requestWithdrawals(...) - Requests ETH withdrawals for stETH amounts through Lido's withdrawal queue.
requestWithdrawalsWstETH(...) - Requests ETH withdrawals for wstETH amounts through the Lido queue.
claimWithdrawals(...) - Claims finalized Lido withdrawals for previously created request IDs.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
ILifetimeNft (Interface)
Purpose
ILifetimeNft defines NFT minting and metadata administration calls required by protocol modules.
Inheritance
IERC721Enumerable
Key Methods
mint(...) - Mints a new Lifetime NFT to the specified owner.
setMinterOperator(...) - Grants or revokes minting permission for an address.
setBaseUri(...) - Updates the base metadata URI used for token metadata.
All Functions
mint(...) - Mints a new Lifetime NFT to the specified owner.
setMinterOperator(...) - Grants or revokes minting permission for an address.
setBaseUri(...) - Updates the base metadata URI used for token metadata.
Events
None.
Errors
Access / Roles
None.
Interacts With
None.
Missing Links
None.
IPermit2 (Interface)
Purpose
IPermit2 defines the token-allowance approval call used by the Uniswap V4 beneficiary-swap plugin before handing control to the Universal Router.
Inheritance
None.
Key Methods
approve(...) - Grants a spender an ERC20 transfer allowance through Permit2.
All Functions
approve(...) - Grants a spender an ERC20 transfer allowance through Permit2.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
IPluginsRegistry (Interface)
Purpose
IPluginsRegistry defines plugin registration and plugin-metadata query functions.
Inheritance
None.
Key Methods
getPluginDescriptionBlockNumbers(...) - Returns the history of description update block numbers for a plugin.
isPluginRegistered(...) - Indicates whether a plugin is registered in the registry.
addPlugin(...) - Registers a new plugin address with an accompanying description.
addPluginDescription(...) - Appends an additional description entry for an existing plugin.
removePlugin(...) - Deregisters a plugin and removes it from the registry list.
All Functions
getPluginDescriptionBlockNumbers(...) - Returns the history of description update block numbers for a plugin.
isPluginRegistered(...) - Indicates whether a plugin is registered in the registry.
addPlugin(...) - Registers a new plugin address with an accompanying description.
addPluginDescription(...) - Appends an additional description entry for an existing plugin.
removePlugin(...) - Deregisters a plugin and removes it from the registry list.
Events
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
ISafeMinimalMultisig (Interface)
Purpose
ISafeMinimalMultisig defines proposal lifecycle and signature-voting structures for multisig flows.
Inheritance
None.
Key Methods
None.
All Functions
None.
Events
Errors
Access / Roles
None.
Interacts With
None.
Missing Links
None.
ISignatureRoleTimelock (Interface)
Purpose
ISignatureRoleTimelock defines role assignment, signature mapping, and scheduled-call state for timelocked execution.
Inheritance
None.
Key Methods
None.
All Functions
None.
Events
Errors
Access / Roles
None.
Interacts With
None.
Missing Links
None.
IStataToken (Interface)
Purpose
IStataToken defines the wrapped-aToken interface used by the Aave beneficiary plugin for minting and redeeming Stata positions.
Inheritance
None.
Key Methods
deposit(...) - Deposits reserve assets into a StataToken vault and mints shares.
redeem(...) - Redeems StataToken shares for the underlying reserve asset.
depositATokens(...) - Deposits aTokens into the StataToken vault and mints shares.
redeemATokens(...) - Redeems StataToken shares directly into aTokens.
All Functions
deposit(...) - Deposits reserve assets into a StataToken vault and mints shares.
redeem(...) - Redeems StataToken shares for the underlying reserve asset.
depositATokens(...) - Deposits aTokens into the StataToken vault and mints shares.
redeemATokens(...) - Redeems StataToken shares directly into aTokens.
asset(...) - Returns the underlying reserve asset tracked by the StataToken vault.
balanceOf(...) - Returns the StataToken share balance held by an account.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
IStataTokenFactory (Interface)
Purpose
IStataTokenFactory defines the lookup and deployment interface for Stata token wrappers that the Aave beneficiary plugin uses when converting between aTokens and wrapped positions.
Inheritance
None.
Key Methods
getStataToken(...) - Resolves the StataToken vault address for an underlying reserve asset.
createStataTokens(...) - Deploys StataToken vaults for one or more underlying reserve assets.
All Functions
getStataToken(...) - Resolves the StataToken vault address for an underlying reserve asset.
createStataTokens(...) - Deploys StataToken vaults for one or more underlying reserve assets.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
ITrustedGuardiansPlugin (Interface)
Purpose
ITrustedGuardiansPlugin defines guardian-plugin state checks used by integrations and plugins.
Inheritance
None.
Key Methods
isGuardiansInitialized(...) - Reports whether the guardian configuration has been fully initialised.
All Functions
isGuardiansInitialized() - Reports whether the guardian configuration has been fully initialised.
Events
Errors
Access / Roles
None.
Interacts With
None.
Missing Links
None.
IUniversalRouter (Interface)
Purpose
IUniversalRouter defines the command-batch execution surface used by the Uniswap V4 beneficiary plugin to route exact-input swaps.
Inheritance
None.
Key Methods
execute(...) - Executes a Universal Router command bundle before the deadline expires.
All Functions
execute(...) - Executes a Universal Router command bundle before the deadline expires.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
IWETH (Interface)
Purpose
IWETH defines the wrapped-ETH mint, burn, approval, and balance calls used by helper contracts and plugins that bridge between native ETH and ERC-20 WETH.
Inheritance
None.
Key Methods
deposit(...) - Wraps native ETH into WETH.
withdraw(...) - Unwraps WETH back into native ETH.
approve(...) - Approves a spender to transfer WETH on the caller's behalf.
All Functions
deposit(...) - Wraps native ETH into WETH.
withdraw(...) - Unwraps WETH back into native ETH.
approve(...) - Approves a spender to transfer WETH on the caller's behalf.
balanceOf(...) - Returns the WETH token balance held by an address.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
IWstETH (Interface)
Purpose
IWstETH defines wrapped-stETH conversion calls used by the Lido beneficiary plugin when moving between stETH and wstETH positions.
Inheritance
None.
Key Methods
wrap(...) - Wraps stETH into non-rebasing wstETH shares.
unwrap(...) - Unwraps wstETH into rebasing stETH.
All Functions
wrap(...) - Wraps stETH into non-rebasing wstETH shares.
unwrap(...) - Unwraps wstETH into rebasing stETH.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
None.
Missing Links
None.
DiamondLoupeFacet
Purpose
DiamondLoupeFacet implements EIP-2535 loupe views for facet discovery and selector introspection.
Inheritance
IDiamondLoupeIERC165
Key Methods
facets(...) - Lists every facet installed on the diamond along with their selectors.
facetFunctionSelectors(...) - Returns the selectors exposed by a single facet.
facetAddresses(...) - Returns the ordered list of facet addresses in the diamond.
facetAddress(...) - Resolves the facet address implementing a given selector, with plugin-aware fallback.
storageFacetAddress(...) - Reads the raw facet address mapped to a selector without plugin fallback.
supportsInterface(...) - Reports ERC-165 interface support flags for the diamond.
All Functions
facets() - Lists every facet installed on the diamond along with their selectors.
facetFunctionSelectors(...) - Returns the selectors exposed by a single facet.
facetAddresses() - Returns the ordered list of facet addresses in the diamond.
facetAddress(...) - Resolves the facet address implementing a given selector, with plugin-aware fallback.
storageFacetAddress(...) - Reads the raw facet address mapped to a selector without plugin fallback.
supportsInterface(...) - Reports ERC-165 interface support flags for the diamond.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
ICryptoLegacyPluginLibCryptoLegacyPluginsLibDiamond
Missing Links
None.
LibCLUtils (Library)
Purpose
LibCLUtils provides shared ERC-20 approval helpers used by migration and plugin flows. It centralizes the low-level approval call so callers can handle failures consistently.
Inheritance
None.
Key Methods
approveToken(...) - Performs a low-level ERC-20 approval call and normalizes non-standard return behavior.
All Functions
approveToken(...) - Performs a low-level ERC-20 approval call and normalizes non-standard return behavior.
Events
None.
Errors
Access / Roles
None.
Interacts With
None.
Missing Links
None.
LibClaimMigrationCore (Library)
Purpose
LibClaimMigrationCore provides the fixed-point math and shared distribution-sync helpers used by both one-step and two-step beneficiary claim migrations.
Inheritance
None.
Key Methods
calculateFractionAndRatio(...) - Calculates the migration fraction and exchange ratio for a conversion step.
applyMigrationFormula(...) - Reallocates one beneficiary's claimed balances across a migration boundary.
syncDistributions(...) - Updates distribution totals and last-balance snapshots after a migration.
All Functions
calculateFractionAndRatio(...) - Calculates the migration fraction and exchange ratio for a conversion step.
applyMigrationFormula(...) - Reallocates one beneficiary's claimed balances across a migration boundary.
syncDistributions(...) - Updates distribution totals and last-balance snapshots after a migration.
Events
None.
Errors
Access / Roles
None.
Interacts With
ICryptoLegacy
Missing Links
None.
LibOneStepClaimMigration (Library)
Purpose
LibOneStepClaimMigration provides the immediate claim-migration path that updates beneficiary accounting in a single execution flow.
Inheritance
None.
Key Methods
migrate(...) - Migrates beneficiary claim accounting for an atomic token conversion.
_migrateClaims(...) - Applies the migration formula to every beneficiary in the current CryptoLegacy set.
All Functions
migrate(...) - Migrates beneficiary claim accounting for an atomic token conversion.
_migrateClaims(...) - Applies the migration formula to every beneficiary in the current CryptoLegacy set.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
ICryptoLegacyLibClaimMigrationCore
Missing Links
None.
LibTwoStepClaimMigration (Library)
Purpose
LibTwoStepClaimMigration provides the delayed claim-migration flow that stages pending state, finalizes migrations later, or abandons them when necessary.
Inheritance
None.
Key Methods
start(...) - Starts a delayed claim migration when the source token leaves before the destination token arrives.
complete(...) - Completes a delayed migration after the destination token arrives.
abandon(...) - Abandons an active pending migration and restores cached claim state.
All Functions
isActive(...) - Returns whether a pending two-step migration is currently active.
getPendingTokens(...) - Returns the token pair involved in the active pending migration.
start(...) - Starts a delayed claim migration when the source token leaves before the destination token arrives.
complete(...) - Completes a delayed migration after the destination token arrives.
abandon(...) - Abandons an active pending migration and restores cached claim state.
_applyPendingMigration(...) - Applies the cached pending-migration snapshot to all beneficiaries.
Events
None.
Errors
Access / Roles
None.
Interacts With
ICryptoLegacyLibClaimMigrationCore
Missing Links
None.
LibCreate3 (Library)
Purpose
LibCreate3 provides low-level CREATE3 deployment primitives and deterministic address derivation helpers.
Inheritance
None.
Key Methods
codeSize(...) - Returns the bytecode size at a target address.
create3(...) - Deploys bytecode deterministically with CREATE3 forwarding zero ether.
create3(...) - Deterministically deploys contracts using the CREATE3 pattern, optionally forwarding ETH.
addressOf(...) - Computes the deterministic address yielded by CREATE3 for a given salt.
All Functions
codeSize(...) - Returns the bytecode size at a target address.
create3(...) - Deploys bytecode deterministically with CREATE3 forwarding zero ether.
create3(...) - Deterministically deploys contracts using the CREATE3 pattern, optionally forwarding ETH.
addressOf(...) - Computes the deterministic address yielded by CREATE3 for a given salt.
Events
None.
Errors
Access / Roles
None.
Interacts With
None.
Missing Links
None.
LibCryptoLegacy (Library)
Purpose
LibCryptoLegacy provides shared storage accessors and validation checks for core protocol logic.
Inheritance
None.
Key Methods
getCryptoLegacyStorage(...) - Returns the storage slot backing the CryptoLegacy diamond data.
_checkDisabledFunc(...) - Ensures a flagged core function is not disabled by configuration.
_checkDistributionStart(...) - Guards flows that must execute before distribution begins.
_isDistributionStarted(...) - Reports whether the distribution window is active.
_checkOwner(...) - Enforces that the caller is the diamond owner and the initial fee was paid.
_checkSenderOwner(...) - Validates that
msg.sendermatches the diamond owner._checkPause(...) - Blocks execution when the CryptoLegacy contract is paused.
_setPause(...) - Updates the pause flag while distribution is inactive.
All Functions
getCryptoLegacyStorage() - Returns the storage slot backing the CryptoLegacy diamond data.
_checkDisabledFunc(...) - Ensures a flagged core function is not disabled by configuration.
_checkDistributionStart(...) - Guards flows that must execute before distribution begins.
_isDistributionStarted(...) - Reports whether the distribution window is active.
_checkOwner() - Enforces that the caller is the diamond owner and the initial fee was paid.
_checkSenderOwner() - Validates that
msg.sendermatches the diamond owner._checkPause(...) - Blocks execution when the CryptoLegacy contract is paused.
_setPause(...) - Updates the pause flag while distribution is inactive.
_getPause(...) - Reads the pause status from storage.
_checkAddressIsBeneficiary(...) - Verifies that an address corresponds to a registered beneficiary.
_checkDistributionReadyForBeneficiary(...) - Ensures the caller is a registered beneficiary and distribution is active.
_checkDistributionReady(...) - Validates that the distribution window is open.
_getBeneficiariesCount(...) - Returns the number of registered beneficiaries.
_isLifetimeActiveAndUpdate(...) - Queries the build manager to determine if a lifetime NFT is locked and updates state accordingly.
_takeFee(...) - Core fee processing routine covering lifetime, build-manager, and manual transfer paths.
_checkFee(...) - Validates a fee payment matches expectations.
_checkNoFee() - Reverts when
msg.valueis non-zero._sendFeeByTransfer(...) - Pays fees via direct ETH transfers, optionally splitting referral amounts.
_transferFee(...) - Performs a low-level ETH transfer with a configurable gas stipend.
_tokenPrepareToDistribute(...) - Reconciles token distribution state with the contract’s current ERC20 balance.
_getBeneficiaryClaimed(...) - Reads the claimed amount for a beneficiary/token pair.
_setBeneficiaryClaimed(...) - Updates the claimed amount for a beneficiary/token pair.
_getTotalClaimed(...) - Aggregates claimed amounts for a token across all beneficiaries.
_getStartAndEndDate(...) - Calculates a beneficiary’s vesting window based on distribution start.
_getVestedAndClaimedAmount(...) - Computes vesting progress and claimable amounts for a beneficiary/token pair.
_getBeneficiaryConfigAndVesting(...) - Retrieves config and vesting storage for a beneficiary, enforcing existence.
_setCryptoLegacyToBeneficiaryRegistry(...) - Adds or removes a single entity from the external BeneficiaryRegistry.
_setCryptoLegacyListToBeneficiaryRegistry(...) - Updates recovery address lists in the BeneficiaryRegistry.
_getBeneficiaryRegistry(...) - Retrieves the BeneficiaryRegistry from the build manager, swallowing errors.
_gasBySelector(...) - Computes the gas stipend for an external call, applying the configured multiplier.
_gasWithoutMultiplierBySelector(...) - Provides base gas estimates for known external calls.
_updateOwnerInBeneficiaryRegistry(...) - Swaps the owner entry in the BeneficiaryRegistry.
_transferTreasuryTokensToLegacy(...) - Moves ERC20 balances from guardians/holders into the CryptoLegacy contract.
_transferTokensFromLegacy(...) - Sends ERC20 tokens from the CryptoLegacy contract to specified recipients.
_addressToHash(...) - Returns the keccak256 hash of an address.
_addressWithSaltToHash(...) - Hashes an address together with an additional salt.
Events
Errors
Access / Roles
None.
Interacts With
ArbSysIBeneficiaryRegistryICryptoLegacyICryptoLegacyBuildManagerILockChainGateLibDiamond
Missing Links
None.
LibCryptoLegacyDeploy (Library)
Purpose
LibCryptoLegacyDeploy encapsulates deployment helpers and deterministic-salt derivation for protocol-instance creation paths.
Inheritance
None.
Key Methods
_deployByCreate3(...) - Deterministically deploys a contract via CREATE3 and records the deployment event.
_getContractOwnerSalt(...) - Derives an owner-specific salt for CREATE3 deployments.
_computeAddress(...) - Predicts the deterministic CREATE3 deployment address.
All Functions
_deployByCreate3(...) - Deterministically deploys a contract via CREATE3 and records the deployment event.
_getContractOwnerSalt(...) - Derives an owner-specific salt for CREATE3 deployments.
_computeAddress(...) - Predicts the deterministic CREATE3 deployment address.
Events
Errors
Access / Roles
None.
Interacts With
LibCreate3
Missing Links
None.
LibCryptoLegacyPlugins (Library)
Purpose
LibCryptoLegacyPlugins provides plugin validation, selector registration, and plugin lifecycle helpers.
Inheritance
None.
Key Methods
_validatePlugin(...) - Ensures a plugin address is approved by the build manager.
_addPluginList(...) - Wires a batch of plugins into the diamond.
_removePlugin(...) - Removes a plugin’s selectors from the diamond.
_getFacetAddressPosition(...) - Locates a facet’s index within diamond storage.
_addFacetAddressIfNotExists(...) - Appends a new facet address to storage when necessary.
_removeFacetAddress(...) - Removes a facet address from storage using swap-and-pop.
addFunctions(...) - Registers selectors from a facet in diamond storage.
removeFunctions(...) - Unregisters selectors associated with a facet.
All Functions
_validatePlugin(...) - Ensures a plugin address is approved by the build manager.
_addPluginList(...) - Wires a batch of plugins into the diamond.
_removePlugin(...) - Removes a plugin’s selectors from the diamond.
_getFacetAddressPosition(...) - Locates a facet’s index within diamond storage.
_addFacetAddressIfNotExists(...) - Appends a new facet address to storage when necessary.
_removeFacetAddress(...) - Removes a facet address from storage using swap-and-pop.
addFunctions(...) - Registers selectors from a facet in diamond storage.
removeFunctions(...) - Unregisters selectors associated with a facet.
_findFacetBySelector(...) - Searches installed plugins for a selector match.
Events
Errors
Access / Roles
None.
Interacts With
ICryptoLegacyICryptoLegacyPluginLibDiamond
Missing Links
None.
LibDiamond (Library)
Purpose
LibDiamond centralizes EIP-2535 storage layout and facet-cut execution helpers.
Inheritance
None.
Key Methods
diamondStorage(...) - Returns the Diamond storage struct anchored at the EIP-2535 slot.
setContractOwner(...) - Updates the diamond owner and emits the ownership transfer event.
contractOwner(...) - Reads the current diamond owner from storage.
enforceIsContractOwner(...) - Reverts unless the caller is the diamond owner.
diamondCut(...) - Applies a batch of facet modifications and optionally executes initialization logic.
addFunctions(...) - Adds new selectors for a facet during a diamond cut.
replaceFunctions(...) - Swaps existing selectors to point at a new facet implementation.
removeFunctions(...) - Removes selectors from the diamond’s routing table.
All Functions
diamondStorage() - Returns the Diamond storage struct anchored at the EIP-2535 slot.
setContractOwner(...) - Updates the diamond owner and emits the ownership transfer event.
contractOwner() - Reads the current diamond owner from storage.
enforceIsContractOwner() - Reverts unless the caller is the diamond owner.
diamondCut(...) - Applies a batch of facet modifications and optionally executes initialization logic.
addFunctions(...) - Adds new selectors for a facet during a diamond cut.
replaceFunctions(...) - Swaps existing selectors to point at a new facet implementation.
removeFunctions(...) - Removes selectors from the diamond’s routing table.
addFacet(...) - Registers a facet address in diamond storage.
addFunction(...) - Records a selector → facet mapping within diamond storage.
removeFunction(...) - Deletes a selector mapping and tidies facet metadata.
initializeDiamondCut(...) - Runs optional initialization logic after a diamond cut.
enforceHasContractCode(...) - Asserts that a target address contains contract bytecode.
Events
Errors
Access / Roles
None.
Interacts With
IDiamondCut
Missing Links
None.
LibSafeMinimalBeneficiaryMultisig (Library)
Purpose
LibSafeMinimalBeneficiaryMultisig provides beneficiary-oriented multisig validation and proposal-state helpers.
Inheritance
None.
Key Methods
_checkIsMultisigExecutor(...) - Verifies that the caller is the multisig executor (the contract itself).
_initializationStatus(...) - Reports whether multisig storage has been fully initialised.
_getVotersAndConfirmations(...) - Returns the beneficiary voter list and active confirmation threshold.
_getProposalListWithStatuses(...) - Builds a list of all multisig proposals along with confirmation metadata.
_getProposalWithStatus(...) - Returns a single proposal enriched with confirmation flags and derived metadata.
_getRequiredConfirmations(...) - Derives the confirmation threshold, applying defaults and clamping.
_getVoters(...) - Retrieves the current beneficiary voter identifiers.
_getDefaultRequiredConfirmations(...) - Computes the default confirmation threshold for the current beneficiary set.
All Functions
_checkIsMultisigExecutor() - Verifies that the caller is the multisig executor (the contract itself).
_initializationStatus(...) - Reports whether multisig storage has been fully initialised.
_getVotersAndConfirmations(...) - Returns the beneficiary voter list and active confirmation threshold.
_getProposalListWithStatuses(...) - Builds a list of all multisig proposals along with confirmation metadata.
_getProposalWithStatus(...) - Returns a single proposal enriched with confirmation flags and derived metadata.
_getRequiredConfirmations(...) - Derives the confirmation threshold, applying defaults and clamping.
_getVoters(...) - Retrieves the current beneficiary voter identifiers.
_getDefaultRequiredConfirmations(...) - Computes the default confirmation threshold for the current beneficiary set.
_setConfirmations(...) - Persists an explicit confirmation threshold for the current voter set.
_initializeIfNot(...) - Lazily initialises multisig settings when first needed.
_propose(...) - Creates a multisig proposal on behalf of the caller.
_confirm(...) - Records a beneficiary confirmation for a proposal.
_cancel(...) - Allows a voter to withdraw their confirmation (and potentially cancel the proposal).
_withdrawHeldEth(...) - Transfers accumulated ETH credits for a voter to a recipient.
Events
Errors
Access / Roles
None.
Interacts With
ICryptoLegacyISafeMinimalMultisigLibCryptoLegacyLibSafeMinimalMultisig
Missing Links
None.
LibSafeMinimalMultisig (Library)
Purpose
LibSafeMinimalMultisig provides generic proposal, signature, and quorum helpers for minimal multisig flows.
Inheritance
None.
Key Methods
_checkIsMultisigExecutor(...) - Rejects calls from anything other than the multisig executor contract.
_checkIsSenderAllowed(...) - Authenticates the caller against the allowed voter list.
_setVotersAndConfirmations(...) - Stores the authoritative voter list and quorum threshold.
_initializationStatus(...) - Indicates whether multisig storage has been initialised.
_calcDefaultConfirmations(...) - Computes a majority quorum for a given voter count.
_isMethodAllowed(...) - Checks whether a selector is permitted for multisig execution.
_isVoterAllowed(...) - Determines whether a voter hash exists in the authorised set.
_getConfirmedCount(...) - Counts confirmations recorded for a proposal.
All Functions
_checkIsMultisigExecutor() - Rejects calls from anything other than the multisig executor contract.
_checkIsSenderAllowed(...) - Authenticates the caller against the allowed voter list.
_setVotersAndConfirmations(...) - Stores the authoritative voter list and quorum threshold.
_initializationStatus(...) - Indicates whether multisig storage has been initialised.
_calcDefaultConfirmations(...) - Computes a majority quorum for a given voter count.
_isMethodAllowed(...) - Checks whether a selector is permitted for multisig execution.
_isVoterAllowed(...) - Determines whether a voter hash exists in the authorised set.
_getConfirmedCount(...) - Counts confirmations recorded for a proposal.
_getProposalListWithStatusesAndStorageVoters(...) - Returns every proposal alongside stored voter metadata.
_getProposalWithStatus(...) - Derives a proposal’s confirmation status relative to a voter set.
_propose(...) - Creates a proposal and records the proposer’s confirmation.
_getPendingProposalForVoter(...) - Fetches a proposal and authenticated voter, ensuring it is still pending.
_cancel(...) - Removes a voter’s confirmation and cancels the proposal if no approvals remain.
_confirm(...) - Records a voter’s confirmation and executes the proposal upon quorum.
_execute(...) - Performs the proposal’s target call once quorum is achieved.
_updateHeldEth(...) - Credits any leftover ETH from proposal execution to a voter.
_withdrawHeldEth(...) - Withdraws a voter’s accumulated ETH balance to a recipient.
Events
Errors
Access / Roles
None.
Interacts With
ISafeMinimalMultisigLibCryptoLegacy
Missing Links
None.
LibTrustedGuardiansPlugin (Library)
Purpose
LibTrustedGuardiansPlugin provides storage and vote-state helpers for guardian-based plugin logic.
Inheritance
None.
Key Methods
getPluginStorage(...) - Provides typed storage access for the Trusted Guardians plugin.
_resetGuardianVoting(...) - Clears guardian voting state and resets the distribution schedule.
All Functions
getPluginStorage() - Provides typed storage access for the Trusted Guardians plugin.
_resetGuardianVoting(...) - Clears guardian voting state and resets the distribution schedule.
Events
Errors
None.
Access / Roles
None.
Interacts With
ICryptoLegacyITrustedGuardiansPluginLibCryptoLegacyLibDiamond
Missing Links
None.
BeneficiaryAaveV3SupplyPlugin
Purpose
BeneficiaryAaveV3SupplyPlugin routes beneficiary-approved Aave V3 supply, withdrawal, and Stata-token conversion flows through the plugin multisig.
Inheritance
ICryptoLegacyPluginReentrancyGuardUpgradeable
Key Methods
baavesSetMultisigConfig(...) - Updates the beneficiary multisig confirmation threshold for the plugin.
baavesSupply(...) - Supplies a reserve asset into Aave V3 and migrates beneficiary claims into the corresponding aToken.
baavesWithdraw(...) - Withdraws a reserve asset from Aave V3 and migrates beneficiary claims from the aToken back into the reserve asset.
baavesWrapATokenToStataToken(...) - Wraps rebasing aTokens into non-rebasing StataToken shares.
baavesRedeemFromStataToken(...) - Redeems StataToken shares directly into the reserve asset in one step.
All Functions
constructor(...) - Stores the Aave V3 and StataToken integration addresses used by the beneficiary plugin.
getSigs(...) - Returns the selectors exposed by the Aave beneficiary plugin.
getSetupSigs(...) - Returns the setup-time selectors required by the Aave beneficiary plugin.
getMultisigAllowedMethods(...) - Lists selectors that beneficiary multisig proposals are allowed to execute.
getPluginName(...) - Returns the unique plugin name string.
getPluginVer(...) - Returns the semantic version for the Aave beneficiary plugin.
modifier onlyDistributionReady - Restricts execution to phases where beneficiary distribution is already active.
getPluginMultisigStorage(...) - Retrieves the plugin-specific multisig storage slot.
baavesSetMultisigConfig(...) - Updates the beneficiary multisig confirmation threshold for the plugin.
baavesPropose(...) - Creates a multisig proposal for an allowed Aave beneficiary action.
baavesConfirm(...) - Confirms an existing plugin proposal and executes it once quorum is reached.
baavesCancel(...) - Removes the caller's confirmation from a pending plugin proposal.
baavesGetInitializationStatus(...) - Reports whether the plugin's multisig configuration has been initialized.
baavesGetVotersAndConfirmations(...) - Returns the beneficiary voter list and current confirmation threshold.
baavesGetProposalWithStatus(...) - Returns a single multisig proposal together with its derived execution status.
baavesGetProposalListWithStatuses(...) - Returns the full plugin proposal list with derived statuses.
baavesSupply(...) - Supplies a reserve asset into Aave V3 and migrates beneficiary claims into the corresponding aToken.
baavesWithdraw(...) - Withdraws a reserve asset from Aave V3 and migrates beneficiary claims from the aToken back into the reserve asset.
baavesWrapATokenToStataToken(...) - Wraps rebasing aTokens into non-rebasing StataToken shares.
baavesUnwrapStataTokenToAToken(...) - Redeems StataToken shares back into rebasing aTokens.
baavesDepositToStataToken(...) - Deposits a reserve asset directly into its StataToken wrapper in one step.
baavesRedeemFromStataToken(...) - Redeems StataToken shares directly into the reserve asset in one step.
_getAToken(...) - Resolves the aToken address for a given reserve asset.
_getStataToken(...) - Resolves the StataToken wrapper address for a given reserve asset.
Events
Errors
Access / Roles
baaves*state-changing execution methods requireonlyDistributionReady; proposal lifecycle also enforces beneficiary multisig confirmation rules.
Interacts With
IAaveV3PoolIAaveV3PoolDataProviderIStataTokenIStataTokenFactoryISafeMinimalMultisigLibCryptoLegacyLibSafeMinimalBeneficiaryMultisig
Missing Links
None.
BeneficiaryLidoStakingPlugin
Purpose
BeneficiaryLidoStakingPlugin gates beneficiary-approved Lido staking, wrapping, withdrawal-request, and migration flows behind the plugin multisig.
Inheritance
ICryptoLegacyPluginReentrancyGuardUpgradeable
Key Methods
blsSetMultisigConfig(...) - Updates the beneficiary multisig confirmation threshold for the Lido plugin.
blsLidoStakeWethToStEth(...) - Unwraps WETH and stakes the resulting ETH into Lido, minting stETH.
blsLidoRequestStEthWithdrawal(...) - Requests stETH withdrawals from the Lido withdrawal queue and starts a pending migration to WETH.
blsLidoClaimWithdrawals(...) - Claims finalized Lido withdrawals, wraps the received ETH into WETH, and completes the pending migration.
blsLidoAbandonMigration(...) - Abandons the active Lido two-step migration and restores claim state.
All Functions
constructor(...) - Stores the helper contract used to unwrap WETH into native ETH for the Lido flows.
getSigs(...) - Returns the selectors exposed by the Lido beneficiary plugin.
getSetupSigs(...) - Returns the setup-time selectors required by the Lido beneficiary plugin.
getMultisigAllowedMethods(...) - Lists selectors that beneficiary multisig proposals are allowed to execute.
getPluginName(...) - Returns the unique plugin name string.
getPluginVer(...) - Returns the semantic version for the Lido beneficiary plugin.
modifier onlyDistributionReady - Restricts execution to phases where beneficiary distribution is already active.
getPluginMultisigStorage(...) - Retrieves the plugin-specific multisig storage slot.
getPendingMigrationStorage(...) - Retrieves the plugin-local storage slot that holds the active two-step migration state.
getLidoWithdrawalStorage(...) - Retrieves the plugin-local storage slot that caches pending Lido withdrawal request IDs.
getBeneficiarySwitchGuardStorage(...) - Retrieves the plugin-local guard storage that freezes beneficiary switching while migration is pending.
blsSetMultisigConfig(...) - Updates the beneficiary multisig confirmation threshold for the Lido plugin.
blsPropose(...) - Creates a multisig proposal for an allowed Lido beneficiary action.
blsConfirm(...) - Confirms an existing Lido plugin proposal and executes it once quorum is reached.
blsCancel(...) - Removes the caller's confirmation from a pending Lido multisig proposal.
blsGetInitializationStatus(...) - Reports whether the plugin multisig configuration has been initialized.
blsGetVotersAndConfirmations(...) - Returns the current multisig voter list and confirmation threshold for the Lido plugin.
blsGetProposalWithStatus(...) - Fetches a single proposal and its per-voter confirmation flags.
blsGetProposalListWithStatuses(...) - Returns all plugin proposals with confirmation metadata.
blsLidoGetPendingRequestIds(...) - Returns the currently cached Lido withdrawal request IDs used by the fair-claim path.
blsLidoGetPendingMigration(...) - Returns the details of the currently pending two-step migration.
blsLidoStakeWethToStEth(...) - Unwraps WETH and stakes the resulting ETH into Lido, minting stETH.
blsLidoWrapWethToWstEth(...) - Unwraps WETH and wraps the resulting ETH directly into wstETH.
blsLidoRequestStEthWithdrawal(...) - Requests stETH withdrawals from the Lido withdrawal queue and starts a pending migration to WETH.
blsLidoRequestWstEthWithdrawal(...) - Requests wstETH withdrawals from the Lido withdrawal queue and starts a pending migration to WETH.
blsLidoClaimWithdrawals(...) - Claims finalized Lido withdrawals, wraps the received ETH into WETH, and completes the pending migration.
blsLidoUnsafeClaimWithdrawals(...) - Claims finalized Lido withdrawals without completing claim-migration reconciliation.
blsLidoAbandonMigration(...) - Abandons the active Lido two-step migration and restores claim state.
blsLidoWrapStEthToWstEth(...) - Wraps rebasing stETH into non-rebasing wstETH and migrates claim accounting in one step.
blsLidoUnwrapWstEthToStEth(...) - Unwraps wstETH into stETH and migrates claim accounting in one step.
_storeLidoRequestIds(...) - Replaces the cached pending-request list with the request IDs returned by Lido.
_activateBeneficiarySwitchGuard(...) - Freezes beneficiary switching while a delayed migration is pending.
_releaseBeneficiarySwitchGuard(...) - Restores beneficiary-switch timelocks and clears the migration guard snapshot.
_setTokenBeneficiaryClaimsToZero(...) - Clears every beneficiary's claimed balance for a given token.
Events
Errors
Access / Roles
bls*state-changing execution methods requireonlyDistributionReady; proposal lifecycle also enforces beneficiary multisig confirmation rules.
Interacts With
ILidoIWstETHILidoWithdrawalQueueWethUnwrapISafeMinimalMultisigLibCryptoLegacyLibSafeMinimalBeneficiaryMultisigLibTwoStepClaimMigration
Missing Links
None.
BeneficiaryPluginAddRights
Purpose
BeneficiaryPluginAddRights lets the beneficiary multisig approve and execute additional plugin-list installs for the CryptoLegacy diamond after distribution begins.
Inheritance
ICryptoLegacyPluginReentrancyGuardUpgradeable
Key Methods
getSigs(...) - Lists the external function selectors exposed by this plugin.
getSetupSigs(...) - Reports setup-time selectors required by the plugin.
getMultisigAllowedMethods(...) - Lists selectors that multisig proposals are permitted to execute.
getPluginName(...) - Returns the human-readable plugin identifier.
getPluginVer(...) - Reports the semantic version number for the plugin.
barSetMultisigConfig(...) - Updates multisig confirmation thresholds for beneficiary actions.
barPropose(...) - Creates a multisig proposal for an allowed beneficiary action.
barConfirm(...) - Confirms an existing multisig proposal and executes it once quorum is reached.
All Functions
getSigs() - Lists the external function selectors exposed by this plugin.
getSetupSigs() - Reports setup-time selectors required by the plugin.
getMultisigAllowedMethods() - Lists selectors that multisig proposals are permitted to execute.
getPluginName() - Returns the human-readable plugin identifier.
getPluginVer() - Reports the semantic version number for the plugin.
getPluginMultisigStorage() - Retrieves the plugin-specific multisig storage slot.
barSetMultisigConfig(...) - Updates multisig confirmation thresholds for beneficiary actions.
barPropose(...) - Creates a multisig proposal for an allowed beneficiary action.
barConfirm(...) - Confirms an existing multisig proposal and executes it once quorum is reached.
barCancel(...) - Removes the caller’s confirmation from a pending multisig proposal.
barAddPluginList(...) - Executes the approved plugin-addition proposal.
barWithdrawHeldEth(...) - Allows a voter to withdraw ETH accrued during proposal execution.
barGetHeldEth(...) - Returns the held ETH balance for a beneficiary voter.
barGetInitializationStatus() - Reports whether the multisig configuration has been initialized.
barGetVotersAndConfirmations() - Returns the current multisig voter list and confirmation threshold.
barGetProposalWithStatus(...) - Fetches a single proposal and its per-voter confirmation flags.
barGetProposalListWithStatuses() - Returns all multisig proposals with confirmation metadata.
Events
None.
Errors
None.
Access / Roles
barSetMultisigConfig:owneronly, oraddress(this)when distribution is readybarPropose:nonReentrant, onlyDistributionReadybarConfirm:nonReentrant, onlyDistributionReadybarCancel:nonReentrant, onlyDistributionReadybarAddPluginList:onlyDistributionReadybarWithdrawHeldEth:nonReentrant
Interacts With
ICryptoLegacyISafeMinimalMultisigLibCryptoLegacyLibCryptoLegacyPluginsLibSafeMinimalBeneficiaryMultisig
Missing Links
None.
BeneficiaryUniswapV4SwapPlugin
Purpose
BeneficiaryUniswapV4SwapPlugin executes beneficiary-approved Uniswap V4 exact-input swaps through the plugin multisig and the Universal Router dispatcher.
Inheritance
ICryptoLegacyPluginReentrancyGuardUpgradeable
Key Methods
bunisSetMultisigConfig(...) - Updates the beneficiary multisig confirmation threshold for the swap plugin.
bunisSwapExactInputSingle(...) - Executes a single-hop exact-input Uniswap V4 swap and migrates claims into the output token.
bunisSwapExactInput(...) - Executes a multi-hop exact-input Uniswap V4 swap and migrates claims into the final output token.
All Functions
constructor(...) - Stores the Universal Router and Permit2 addresses used by the plugin.
getSigs(...) - Returns the selectors exposed by the Uniswap V4 beneficiary plugin.
getSetupSigs(...) - Returns setup-time selectors required by the Uniswap V4 beneficiary plugin.
getMultisigAllowedMethods(...) - Lists selectors that beneficiary multisig proposals are allowed to execute.
getPluginName(...) - Returns the unique plugin name string.
getPluginVer(...) - Returns the semantic version for the Uniswap V4 beneficiary plugin.
modifier onlyDistributionReady - Restricts execution to phases where beneficiary distribution is already active.
getPluginMultisigStorage(...) - Retrieves the plugin-specific multisig storage slot.
bunisSetMultisigConfig(...) - Updates the beneficiary multisig confirmation threshold for the swap plugin.
bunisPropose(...) - Creates a multisig proposal for an allowed Uniswap V4 beneficiary action.
bunisConfirm(...) - Confirms an existing plugin proposal and executes it once quorum is reached.
bunisCancel(...) - Removes the caller's confirmation from a pending plugin proposal.
bunisGetInitializationStatus(...) - Reports whether the plugin's multisig configuration has been initialized.
bunisGetVotersAndConfirmations(...) - Returns the beneficiary voter list and current confirmation threshold.
bunisGetProposalWithStatus(...) - Returns a single multisig proposal together with its derived execution status.
bunisGetProposalListWithStatuses(...) - Returns the full plugin proposal list with derived statuses.
bunisSwapExactInputSingle(...) - Executes a single-hop exact-input Uniswap V4 swap and migrates claims into the output token.
bunisSwapExactInput(...) - Executes a multi-hop exact-input Uniswap V4 swap and migrates claims into the final output token.
_executeExactInputSingleRouter(...) - Encodes and submits the single-hop exact-input swap command sequence to the Universal Router.
_executeExactInputRouter(...) - Encodes and submits the multi-hop exact-input swap command sequence to the Universal Router.
Events
Errors
Access / Roles
bunis*state-changing execution methods requireonlyDistributionReady; proposal lifecycle also enforces beneficiary multisig confirmation rules.
Interacts With
IPermit2IUniversalRouterISafeMinimalMultisigLibCryptoLegacyLibSafeMinimalBeneficiaryMultisig
Missing Links
None.
CryptoLegacyBasePlugin
Purpose
CryptoLegacyBasePlugin implements core legacy distribution and claim workflows reused across protocol instances.
Inheritance
ICryptoLegacyCryptoLegacyOwnableReentrancyGuardUpgradeable
Key Methods
getSigs(...) - Lists the primary external selectors exposed by the base plugin.
getSetupSigs(...) - Lists view selectors needed during plugin setup.
getPluginName(...) - Returns the canonical plugin name.
getPluginVer(...) - Returns the plugin’s semantic version.
getCryptoLegacyVer(...) - Returns the base CryptoLegacy protocol version.
initializeByBuildManager(...) - Initializes core storage via the authorized build manager.
owner(...) - Returns the current contract owner.
isPaused(...) - Returns whether the contract is currently paused.
All Functions
getSigs() - Lists the primary external selectors exposed by the base plugin.
getSetupSigs() - Lists view selectors needed during plugin setup.
getPluginName() - Returns the canonical plugin name.
getPluginVer() - Returns the plugin’s semantic version.
getCryptoLegacyVer() - Returns the base CryptoLegacy protocol version.
constructor() - Empty constructor for upgradeable deployment pattern.
initializeByBuildManager(...) - Initializes core storage via the authorized build manager.
owner() - Returns the current contract owner.
isPaused() - Returns whether the contract is currently paused.
buildManager() - Returns the associated build manager contract.
transferOwnership(...) - Begins the two-step ownership transfer process.
payInitialFee(...) - Pays the one-time initial fee and unpauses the contract.
setBeneficiaries(...) - Updates beneficiary list and configs under owner control.
_setBeneficiaries(...) - Internal routine to add, update, or remove beneficiary records.
update(...) - Periodic upkeep that charges update fees and resets the distribution timer.
setGasLimitMultiplier(...) - Adjusts the gas multiplier used for fee-related calls.
initiateChallenge() - Starts the challenge window when upkeep is overdue.
transferTreasuryTokensToLegacy(...) - Pulls treasury tokens from holders into the legacy contract for distribution.
_claimTokenWithVesting(...) - Internal helper to distribute vested ERC20 tokens.
beneficiaryClaim(...) - Enables a beneficiary to claim vested ERC20 tokens.
beneficiarySwitch(...) - Allows a beneficiary to switch their identifier hash.
sendMessagesToBeneficiary(...) - Owner broadcast of off-chain messages to beneficiaries.
isLifetimeActive() - Checks if the owner’s lifetime NFT is locked.
getGasBySelector(...) - Returns the stored gas hint for a selector.
Events
Errors
Access / Roles
initializeByBuildManager:initializer;buildManageronly callertransferOwnership:onlyOwnerpayInitialFee:nonReentrantsetBeneficiaries:onlyOwnerupdate:nonReentrant, onlyOwnersetGasLimitMultiplier:nonReentrant, onlyOwnertransferTreasuryTokensToLegacy:nonReentrantbeneficiaryClaim:nonReentrantsendMessagesToBeneficiary:onlyOwner
Interacts With
ArbSysIBeneficiaryRegistryLibCryptoLegacyLibDiamond
Missing Links
None.
LegacyRecoveryPlugin
Purpose
LegacyRecoveryPlugin implements recovery-governance flows for regaining control through proposal-based execution.
Inheritance
ICryptoLegacyPluginReentrancyGuardUpgradeable
Key Methods
getSigs(...) - Lists the public selectors exposed by the recovery plugin facet.
getSetupSigs(...) - Reports selectors required during plugin setup.
getMultisigAllowedMethods(...) - Enumerates selectors that recovery multisig proposals may execute.
getPluginName(...) - Returns the canonical plugin identifier.
getPluginVer(...) - Reports the plugin version.
lrSetMultisigConfig(...) - Owner-only configuration of recovery multisig voters and threshold.
lrPropose(...) - Submits a new recovery multisig proposal.
lrConfirm(...) - Confirms a recovery proposal and executes it when quorum is met.
All Functions
getSigs() - Lists the public selectors exposed by the recovery plugin facet.
getSetupSigs() - Reports selectors required during plugin setup.
getMultisigAllowedMethods() - Enumerates selectors that recovery multisig proposals may execute.
getPluginName() - Returns the canonical plugin identifier.
getPluginVer() - Reports the plugin version.
getPluginMultisigStorage() - Retrieves plugin-specific multisig storage.
lrSetMultisigConfig(...) - Owner-only configuration of recovery multisig voters and threshold.
lrPropose(...) - Submits a new recovery multisig proposal.
lrConfirm(...) - Confirms a recovery proposal and executes it when quorum is met.
lrCancel(...) - Removes the caller’s confirmation from a pending recovery proposal.
lrTransferTreasuryTokensToLegacy(...) - Multisig-executor action to pull treasury ERC20 tokens into the legacy contract.
lrWithdrawTokensFromLegacy(...) - Multisig-executor withdrawal of tokens from the legacy contract to designated recipients.
lrResetGuardianVoting() - Multisig-executor action to reset guardian voting state and distribution start timestamp.
lrWithdrawHeldEth(...) - Allows a voter to withdraw ETH accumulated during proposal execution.
lrGetHeldEth(...) - Returns the held ETH balance for a given voter hash.
lrGetInitializationStatus() - Indicates whether the recovery multisig has been initialized.
lrGetProposalWithStatus(...) - Retrieves a specific proposal and its confirmation status.
lrGetProposalListWithStatuses() - Returns all recovery proposals with confirmation metadata.
Events
None.
Errors
None.
Access / Roles
lrSetMultisigConfig:onlyOwnerlrTransferTreasuryTokensToLegacy:nonReentrantlrWithdrawTokensFromLegacy:nonReentrantlrResetGuardianVoting:nonReentrantlrWithdrawHeldEth:nonReentrant
Interacts With
IBeneficiaryRegistryICryptoLegacyISafeMinimalMultisigLibCryptoLegacyLibSafeMinimalMultisigLibTrustedGuardiansPlugin
Missing Links
None.
LensPlugin
Purpose
LensPlugin exposes read-only protocol views to aggregate operational and beneficiary-related state.
Inheritance
ICryptoLegacyPluginICryptoLegacyLens
Key Methods
getSigs(...) - Enumerates every externally exposed selector for the Lens plugin.
getSetupSigs(...) - Reports setup-time selectors required by the Lens plugin.
getPluginName(...) - Reveals the human-readable name of the plugin.
getPluginVer(...) - Returns the semantic version of the Lens plugin.
updateInterval(...) - Reads the configured update interval for the CryptoLegacy instance.
challengeTimeout(...) - Exposes the challenge timeout value.
distributionStartAt(...) - Returns when beneficiary distribution began.
lastFeePaidAt(...) - Reports the block timestamp of the last paid maintenance fee.
All Functions
getSigs() - Enumerates every externally exposed selector for the Lens plugin.
getSetupSigs() - Reports setup-time selectors required by the Lens plugin.
getPluginName() - Reveals the human-readable name of the plugin.
getPluginVer() - Returns the semantic version of the Lens plugin.
updateInterval() - Reads the configured update interval for the CryptoLegacy instance.
challengeTimeout() - Exposes the challenge timeout value.
distributionStartAt() - Returns when beneficiary distribution began.
lastFeePaidAt() - Reports the block timestamp of the last paid maintenance fee.
lastUpdateAt() - Exposes the timestamp of the most recent
update()call.initialFeeToPay() - Provides the initial fee amount required when activating a CryptoLegacy instance.
updateFee() - Returns the recurring fee charged per update interval.
invitedByRefCode() - Exposes the referral code associated with the CryptoLegacy instance.
getBeneficiaryClaimed(...) - Returns how much of a given token a beneficiary has already claimed.
getOriginalBeneficiaryHash(...) - Reveals the original beneficiary hash mapped to a derived hash.
getBeneficiaryConfig(...) - Retrieves the vesting configuration for a beneficiary hash.
getBeneficiaries() - Lists all beneficiaries, their original hashes, and configurations.
_getBeneficiaries(...) - Internal helper that assembles beneficiary hashes, originals, and configs.
getTransferBlockNumbers() - Returns the block numbers recorded for asset movements involving the CryptoLegacy contract.
getTokensDistribution(...) - Summarises distribution totals for a token list.
_getTokensDistribution(...) - Internal aggregator that builds per-token distribution data.
getCryptoLegacyBaseData() - Returns a snapshot of the core CryptoLegacy configuration.
getCryptoLegacyListData(...) - Provides a comprehensive snapshot including beneficiaries, plugins, and token distributions.
getMessagesBlockNumbersByRecipient(...) - Lists when messages were received for a beneficiary.
getVestedAndClaimedData(...) - Calculates vested, claimable, and claimed token amounts for a beneficiary.
_getPluginInfoList(...) - Internal helper that compiles plugin metadata for all installed facets.
_getPluginMetadata(...) - Fetches metadata for a specific plugin address.
getPluginInfoList() - Exposes metadata for all plugins attached to the CryptoLegacy instance.
getPluginMetadata(...) - Returns metadata for a specific plugin address through the lens facet.
Events
None.
Errors
None.
Access / Roles
None.
Interacts With
ICryptoLegacyLibCryptoLegacyLibDiamond
Missing Links
None.
NftLegacyPlugin
Purpose
NftLegacyPlugin implements NFT-oriented legacy management and related beneficiary operations.
Inheritance
ICryptoLegacyPluginReentrancyGuardUpgradeable
Key Methods
getSigs(...) - Lists the externally callable selectors for the NFT inheritance facet.
getSetupSigs(...) - Reports any setup-time selectors required by the NFT plugin.
getPluginName(...) - Returns the human-readable identifier for the NFT plugin.
getPluginVer(...) - Provides the semantic version of the NFT plugin.
setNftBeneficiary(...) - Assigns a beneficiary hash and claim delay to multiple NFTs.
transferNftTokensToLegacy(...) - Pulls configured NFTs into the CryptoLegacy contract once distribution is ready.
beneficiaryClaimNft(...) - Lets the designated beneficiary withdraw NFTs after the claim delay.
All Functions
getSigs() - Lists the externally callable selectors for the NFT inheritance facet.
getSetupSigs() - Reports any setup-time selectors required by the NFT plugin.
getPluginName() - Returns the human-readable identifier for the NFT plugin.
getPluginVer() - Provides the semantic version of the NFT plugin.
getPluginStorage() - Returns the plugin’s dedicated storage slot.
setNftBeneficiary(...) - Assigns a beneficiary hash and claim delay to multiple NFTs.
transferNftTokensToLegacy(...) - Pulls configured NFTs into the CryptoLegacy contract once distribution is ready.
beneficiaryClaimNft(...) - Lets the designated beneficiary withdraw NFTs after the claim delay.
Events
Errors
Access / Roles
setNftBeneficiary:onlyOwnertransferNftTokensToLegacy:nonReentrantbeneficiaryClaimNft:nonReentrant
Interacts With
ICryptoLegacyLibCryptoLegacy
Missing Links
None.
ReceiveEthPlugin
Purpose
ReceiveEthPlugin enables a CryptoLegacy instance to accept plain ETH transfers and wrap the accumulated ETH into WETH when a beneficiary triggers the wrapping flow.
Inheritance
ICryptoLegacyPlugin
Key Methods
getSigs(...) - Returns the selectors exposed by the receive-ETH plugin.
getSetupSigs(...) - Returns setup-time selectors required for the receive-ETH plugin.
wrapEthToWeth(...) - Wraps all ETH currently held by the CryptoLegacy diamond into WETH.
All Functions
constructor(...) - Stores the WETH contract address used when wrapping received ETH.
getSigs(...) - Returns the selectors exposed by the receive-ETH plugin.
getSetupSigs(...) - Returns setup-time selectors required for the receive-ETH plugin.
getPluginName(...) - Returns the unique plugin name string.
getPluginVer(...) - Returns the semantic version for the receive-ETH plugin.
wrapEthToWeth(...) - Wraps all ETH currently held by the CryptoLegacy diamond into WETH.
receive(...) - Accepts plain ETH transfers routed into the facet by the diamond.
Events
Errors
Access / Roles
wrapEthToWeth: beneficiary caller after the distribution-ready checks enforced byLibCryptoLegacyreceive: open plain-ETH entry point
Interacts With
ICryptoLegacyIWETHLibCryptoLegacy
Missing Links
None.
TrustedGuardiansPlugin
Purpose
TrustedGuardiansPlugin implements guardian-voting logic for distribution and safety-critical transitions.
Inheritance
ICryptoLegacyPluginITrustedGuardiansPluginReentrancyGuardUpgradeable
Key Methods
getSigs(...) - Enumerates every externally exposed selector for guardian management.
getSetupSigs(...) - Reports setup-time selectors that the facet expects during installation.
getPluginName(...) - Returns the facet’s human-readable identifier.
getPluginVer(...) - Exposes the semantic version of the guardians facet.
initializeGuardians(...) - Configures the guardian roster, threshold, and challenge timeout in a single owner call.
setGuardians(...) - Updates the guardian membership without touching threshold configuration.
setGuardiansConfig(...) - Updates guardian quorum configuration while preserving the existing guardian list.
guardiansVoteForDistribution(...) - Records a guardian vote and optionally accelerates distribution start.
All Functions
getSigs() - Enumerates every externally exposed selector for guardian management.
getSetupSigs() - Reports setup-time selectors that the facet expects during installation.
getPluginName() - Returns the facet’s human-readable identifier.
getPluginVer() - Exposes the semantic version of the guardians facet.
_isGuardianVoted(...) - Checks whether a guardian hash already appears in the vote ledger.
_checkGuardianAndRemoveInvalid(...) - Validates a stored guardian vote and prunes it if the guardian is no longer recognised.
_checkGuardian() - Ensures the caller is a registered guardian and the contract has paid its initial fee.
_checkGuardianNotVoted() - Validates that the caller is an authorised guardian who has not yet voted.
_getGuardians(...) - Resolves the active guardian set, falling back to beneficiaries when no explicit list exists.
_getGuardiansThreshold(...) - Computes the effective vote threshold for guardians.
_getGuardiansChallengeTimeout(...) - Retrieves the challenge timeout applied once guardians reach quorum.
initializeGuardians(...) - Configures the guardian roster, threshold, and challenge timeout in a single owner call.
setGuardians(...) - Updates the guardian membership without touching threshold configuration.
_setGuardians(...) - Internal helper that mutates the guardian set and beneficiary registry.
setGuardiansConfig(...) - Updates guardian quorum configuration while preserving the existing guardian list.
_setGuardiansConfig(...) - Writes guardian threshold and timeout parameters with validation.
_afterGuardiansSet(...) - Validates quorum bounds and clears guardian vote progress.
guardiansVoteForDistribution() - Records a guardian vote and optionally accelerates distribution start.
guardiansTransferTreasuryTokensToLegacy(...) - Allows guardians to move treasury ERC20 balances into the CryptoLegacy contract once distribution is live.
resetGuardianVoting() - Owner-controlled reset that clears guardian votes, resets distribution start, and processes the upkeep fee.
_isGuardiansInitialized(...) - Indicates whether a dedicated guardian set is stored.
isGuardiansInitialized() - Public getter indicating whether guardians have been explicitly set.
getGuardiansData() - Provides a snapshot of guardian hashes, votes, quorum, and timeout.
checkGuardiansVotedAndGetGuardiansData() - Guardian-only getter that also reports whether the caller has voted.
Events
Errors
Access / Roles
initializeGuardians:nonReentrant, onlyOwnersetGuardians:nonReentrant, onlyOwnersetGuardiansConfig:nonReentrant, onlyOwnerguardiansVoteForDistribution:nonReentrantguardiansTransferTreasuryTokensToLegacy:nonReentrantresetGuardianVoting:nonReentrant, onlyOwner
Interacts With
IBeneficiaryRegistryICryptoLegacyLibCryptoLegacyLibSafeMinimalMultisigLibTrustedGuardiansPlugin
Missing Links
None.
UpdateRolePlugin
Purpose
UpdateRolePlugin implements controlled updates of beneficiary, guardian, and related role assignments.
Inheritance
ICryptoLegacyPluginReentrancyGuardUpgradeable
Key Methods
getSigs(...) - Lists external selectors provided by the updater role facet.
getSetupSigs(...) - Reports setup selectors required during facet installation.
getPluginName(...) - Returns the human-readable name of the updater facet.
getPluginVer(...) - Reveals the semantic version for the updater role facet.
owner(...) - Returns the current diamond owner address.
getUpdaterList(...) - Returns the full set of updater addresses.
isUpdater(...) - Checks whether a given address currently has update permissions.
setUpdater(...) - Adds or removes authorised updaters.
All Functions
getSigs() - Lists external selectors provided by the updater role facet.
getSetupSigs() - Reports setup selectors required during facet installation.
getPluginName() - Returns the human-readable name of the updater facet.
getPluginVer() - Reveals the semantic version for the updater role facet.
getPluginStorage() - Returns the plugin-specific storage slot used for updater data.
owner() - Returns the current diamond owner address.
getUpdaterList() - Returns the full set of updater addresses.
isUpdater(...) - Checks whether a given address currently has update permissions.
setUpdater(...) - Adds or removes authorised updaters.
updateByUpdater(...) - Lets authorised updaters execute the
updateflow while paying required fees before distribution begins.
Events
Errors
Access / Roles
setUpdater:nonReentrant, onlyOwnerupdateByUpdater:nonReentrant, onlyUpdater
Interacts With
ICryptoLegacyICryptoLegacyUpdaterPluginLibCryptoLegacyLibDiamond
Missing Links
None.
Last updated