Unlocker on EVM¶
This reference covers version 2.7.7 of the EVM Unlocker contracts, the version deployed on current networks. The source is in TokenTable's private tokentable-evm repository.
Installing the interfaces¶
The npm package @ethsign/tokentable-evm-contracts is at version 2.7.0, the last version published to npm. Its interfaces use the older names (ITokenTableUnlockerV2, ITTFutureTokenV2, ITTTrackerTokenV2, ITTUFeeCollector, ITTUDeployer), and a few signatures differ from this reference. Each contract page notes the differences.
// npm package 2.7.0: the 2.7.7 equivalent is ITTUnlocker
import {ITokenTableUnlockerV2} from "@ethsign/tokentable-evm-contracts/contracts/interfaces/ITokenTableUnlockerV2.sol";
Contracts¶
| Contract | 2.7.7 interface / contract | npm 2.7.0 name | Role |
|---|---|---|---|
| Unlocker | ITTUnlocker / TTUnlocker |
ITokenTableUnlockerV2 |
Holds deposits, stores presets and actuals, and pays out claims. |
| FutureToken | ITTFutureToken / TTFutureToken |
ITTFutureTokenV2 |
NFT minted per actual; its owner receives the unlocked tokens. |
| TrackerToken | ITTTrackerToken / TTTrackerToken |
ITTTrackerTokenV2 |
Read-only token that shows a recipient's claimable amount in their wallet. |
| Deployer | TTUDeployer, TTUBeaconManager, TTUMulticallDeployer |
ITTUDeployer |
Deploys an Unlocker, FutureToken and TrackerToken as one suite. |
| External Hook | ITTHook |
ITTHook |
Optional contract called on Unlocker actions, for access rules and integrations. |
| Fee Collector | ITTFeeCollector / TTFeeCollector |
ITTUFeeCollector |
Computes the fee charged on claims. |
| Versionable | IVersionable |
IVersionable |
Version string implemented by the TokenTable contracts. |
Presets and Actuals describes the structs the Unlocker uses, and the Changelog lists the release history.