This project implements an Unlock PublicLock Hook that can be used on Locks smart contracts to ensure that users who are purchasing a key from a lock have entered the right password on the frontend application.
This process is secured and cannot be bypassed by calling the contract directly as the password is used to submit the transaction on-chain.
When the user enters a password on the frontend application, the password is used to generate a private key that is then used to sign the recipient's address. That signature is passed as the data argument on the purchase call.
A lock manager can set the right signer based on the password for a lock using setSigner.
The Unlock Protocol team has deployed and verified a version of this hook on the following networks:
- Ethereum:
0x936Ed3E71b5990bC9A94074835D08C6ca7bbFad0 - Polygon:
0x9F4AE507d7E91Ab37CF35f792940fE079bd4E24d - Gnosis Chain:
0x927D68eAE936Ec0111f01Fc4Ddd9cC57DB3f0Af2 - Optimism:
0x34EbEc0AE80A2d078DE5489f0f5cAa4d3aaEA355 - Abitrum:
0xd0b14797b9D08493392865647384974470202A78 - BNB Chain:
0x338b1f296217485bf4df6CE9f93ab4C73F72b57D
- Goerli:
0xCa837900f7DaB40787b608b6738d1B730f1d2759 - Mumbai:
0x34EbEc0AE80A2d078DE5489f0f5cAa4d3aaEA355
This lock deployed is deployed on Goerli and uses this password hook. This means you can only purchase a key if you go through this checkout URL and if you enter the right password: sek3e+-pass30rD.
If you don't enter the password, or if you use an incorrect password, the transaction will fail.
- First, you need to pick a password, then go to this page to generate the corresponding Ethereum address. You can also generate this locally if needed by checking out the repo and switching to the
gh-pagebranch.
- Then, click on which network your lock has been deployed on (list above) and head
Contract>Write Contract. Connect your wallet (you need to be connected as a lock's manager) and click onsetSigner. There, enter the lock address, and then the wallet address generated in the previous step.
- Finally, you need to point your lock to the hook. Using your lock's block explorer page, click on
Contract>Write as Proxy. Connect your wallet (you need to be connected as a lock's manager) and look forsetEventHooks. In the_onKeyPurchaseHookenter the address of the hook (from the list above), and enter0x0000000000000000000000000000000000000000for all the other hooks (unless of course, you want to use them...).
- Build a Checkout URL and make sure you include the
"password": trueoption in it so that users are prompted for the password when they go through the checkout flow!
You can deploy the hook on other chains by adding the chain to the hardhat.config.js config file and calling:
yarn run hardhat run scripts/deploy.js --network my-network
To verify the contract on block explorers, call :
yarn run hardhat verify --network my-network 0xhook-address
Running tests:
yarn run hardhat test test/sample-test.js
For lock that are prior to v12, please use the following: (or please, upgrade your locks!)
Production networks:
Test networks: