The Unlock Interface*
Methods​ __initializeOwnable​ function __initializeOwnable(address sender) external nonpayable Copy Initialize the Ownable contract, granting contract ownership to the specified sender
Parameters​ Name Type Description sender address undefined
addLockTemplate​ function addLockTemplate(address impl, uint16 version) external nonpayable Copy Add a PublicLock template to be used for future calls to createLock.
This is used to upgrade conytract per version number
Parameters​ Name Type Description impl address undefined version uint16 undefined
chainId​ function chainId() external view returns (uint256) Copy Returns​ Name Type Description _0 uint256 undefined
computeAvailableDiscountFor​ function computeAvailableDiscountFor(address _purchaser, uint256 _keyPrice) external view returns (uint256 discount, uint256 tokens) Copy [DEPRECATED] Call to this function has been removed from PublicLock > v9.
[DEPRECATED] Kept for backwards compatibility This function returns the discount available for a user, when purchasing a a key from a lock. This does not modify the state. It returns both the discount and the number of tokens consumed to grant that discount.
Parameters​ Name Type Description _purchaser address undefined _keyPrice uint256 undefined
Returns​ Name Type Description discount uint256 undefined tokens uint256 undefined
configUnlock​ function configUnlock(address _udt, address _weth, uint256 _estimatedGasForPurchase, string _symbol, string _URI, uint256 _chainId) external nonpayable Copy Allows the owner to update configuration variables
Parameters​ Name Type Description _udt address undefined _weth address undefined _estimatedGasForPurchase uint256 undefined _symbol string undefined _URI string undefined _chainId uint256 undefined
createLock​ function createLock(uint256 _expirationDuration, address _tokenAddress, uint256 _keyPrice, uint256 _maxNumberOfKeys, string _lockName, bytes12) external nonpayable returns (address) Copy Create lock (legacy) This deploys a lock for a creator. It also keeps track of the deployed lock.
internally call createUpgradeableLock
Parameters​ Name Type Description _expirationDuration uint256 the duration of the lock (pass 0 for unlimited duration) _tokenAddress address set to the ERC20 token address, or 0 for ETH. _keyPrice uint256 the price of each key _maxNumberOfKeys uint256 the maximum nimbers of keys to be edited _lockName string the name of the lock param _salt [deprec] -- kept only for backwards copatibility This may be implemented as a sequence ID or with RNG. It's used with create2 to know the lock's address before the transaction is mined. _5 bytes12 undefined
Returns​ Name Type Description _0 address undefined
createUpgradeableLock​ function createUpgradeableLock(bytes data) external nonpayable returns (address) Copy Create lock (default) This deploys a lock for a creator. It also keeps track of the deployed lock.
this call is passed as encoded function - for instance: bytes memory data = abi.encodeWithSignature( 'initialize(address,uint256,address,uint256,uint256,string)', msg.sender, _expirationDuration, _tokenAddress, _keyPrice, _maxNumberOfKeys, _lockName );
Parameters​ Name Type Description data bytes bytes containing the call to initialize the lock template
Returns​ Name Type Description _0 address address of the create lock
createUpgradeableLockAtVersion​ function createUpgradeableLockAtVersion(bytes data, uint16 _lockVersion) external nonpayable returns (address) Copy Create an upgradeable lock using a specific PublicLock version
Parameters​ Name Type Description data bytes bytes containing the call to initialize the lock template (refer to createUpgradeableLock for more details) _lockVersion uint16 the version of the lock to use
Returns​ Name Type Description _0 address undefined
estimatedGasForPurchase​ function estimatedGasForPurchase() external view returns (uint256) Copy Returns​ Name Type Description _0 uint256 undefined
getGlobalBaseTokenURI​ function getGlobalBaseTokenURI() external view returns (string) Copy Redundant with globalBaseTokenURI() for backwards compatibility with v3 & v4 locks.
Returns​ Name Type Description _0 string undefined
getGlobalTokenSymbol​ function getGlobalTokenSymbol() external view returns (string) Copy Redundant with globalTokenSymbol() for backwards compatibility with v3 & v4 locks.
Returns​ Name Type Description _0 string undefined
globalBaseTokenURI​ function globalBaseTokenURI() external view returns (string) Copy Returns​ Name Type Description _0 string undefined
globalTokenSymbol​ function globalTokenSymbol() external view returns (string) Copy Returns​ Name Type Description _0 string undefined
grossNetworkProduct​ function grossNetworkProduct() external view returns (uint256) Copy Returns​ Name Type Description _0 uint256 undefined
initialize​ function initialize(address _unlockOwner) external nonpayable Copy Parameters​ Name Type Description _unlockOwner address undefined
initializeProxyAdmin​ function initializeProxyAdmin() external nonpayable Copy deploy a ProxyAdmin contract used to upgrade locks
isOwner​ function isOwner() external view returns (bool) Copy Returns true if the caller is the current owner.
Returns​ Name Type Description _0 bool bool True of the caller is the owner
function locks(address) external view returns (bool deployed, uint256 totalSales, uint256 yieldedDiscountTokens) Copy Parameters​ Name Type Description _0 address undefined
Returns​ Name Type Description deployed bool undefined totalSales uint256 undefined yieldedDiscountTokens uint256 undefined
networkBaseFee​ function networkBaseFee() external view returns (uint256) Copy Helper to get the network mining basefee as introduced in EIP-1559
this helper can be wrapped in try/catch statement to avoid revert in networks where EIP-1559 is not implemented
Returns​ Name Type Description _0 uint256 undefined
function owner() external view returns (address) Copy Returns the address of the current owner.
Returns​ Name Type Description _0 address undefined
proxyAdminAddress​ function proxyAdminAddress() external view Copy publicLockAddress​ function publicLockAddress() external view returns (address) Copy Returns​ Name Type Description _0 address undefined
publicLockImpls​ function publicLockImpls(uint16 _version) external view Copy Parameters​ Name Type Description _version uint16 undefined
publicLockLatestVersion​ function publicLockLatestVersion() external view Copy publicLockVersions​ function publicLockVersions(address _impl) external view Copy Parameters​ Name Type Description _impl address undefined
recordConsumedDiscount​ function recordConsumedDiscount(uint256 _discount, uint256 _tokens) external nonpayable Copy [DEPRECATED] Call to this function has been removed from PublicLock > v9.
[DEPRECATED] Kept for backwards compatibility This function will keep track of consumed discounts by a given user. It will also grant discount tokens to the creator who is granting the discount based on the amount of discount and compensation rate. This function is invoked by a previously deployed lock only.
Parameters​ Name Type Description _discount uint256 undefined _tokens uint256 undefined
recordKeyPurchase​ function recordKeyPurchase(uint256 _value, address _referrer) external nonpayable Copy This function keeps track of the added GDP, as well as grants of discount tokens to the referrer, if applicable. The number of discount tokens granted is based on the value of the referal, the current growth rate and the lock's discount token distribution rate This function is invoked by a previously deployed lock only.
Parameters​ Name Type Description _value uint256 undefined _referrer address undefined
renounceOwnership​ function renounceOwnership() external nonpayable Copy Leaves the contract without owner. It will not be possible to call onlyOwner functions anymore. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is only available to the owner.
resetTrackedValue​ function resetTrackedValue(uint256 _grossNetworkProduct, uint256 _totalDiscountGranted) external nonpayable Copy Parameters​ Name Type Description _grossNetworkProduct uint256 undefined _totalDiscountGranted uint256 undefined
setLockTemplate​ function setLockTemplate(address payable _publicLockAddress) external nonpayable Copy Upgrade the PublicLock template used for future calls to createLock.
This will initialize the template and revokeOwnership.
Parameters​ Name Type Description _publicLockAddress address payable undefined
setOracle​ function setOracle(address _tokenAddress, address _oracleAddress) external nonpayable Copy allows the owner to set the oracle address to use for value conversions setting the _oracleAddress to address(0) removes support for the token
This will also call update to ensure at least one datapoint has been recorded.
Parameters​ Name Type Description _tokenAddress address undefined _oracleAddress address undefined
totalDiscountGranted​ function totalDiscountGranted() external view returns (uint256) Copy Returns​ Name Type Description _0 uint256 undefined
transferOwnership​ function transferOwnership(address newOwner) external nonpayable Copy Transfers ownership of the contract to a new account (newOwner). Can only be called by the current owner.
Parameters​ Name Type Description newOwner address undefined
function udt() external view returns (address) Copy Returns​ Name Type Description _0 address undefined
uniswapOracles​ function uniswapOracles(address) external view returns (address) Copy Parameters​ Name Type Description _0 address undefined
Returns​ Name Type Description _0 address undefined
unlockVersion​ function unlockVersion() external pure returns (uint16) Copy Returns​ Name Type Description _0 uint16 undefined
upgradeLock​ function upgradeLock(address payable lockAddress, uint16 version) external nonpayable returns (address) Copy Upgrade a lock to a specific version
only available for publicLockVersion > 10 (proxyAdmin /required)
Parameters​ Name Type Description lockAddress address payable the existing lock address version uint16 the version number you are targeting Likely implemented with OpenZeppelin TransparentProxy contract
Returns​ Name Type Description _0 address undefined
function weth() external view returns (address) Copy Returns​ Name Type Description _0 address undefined