Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 2.41 KB

README.md

File metadata and controls

65 lines (42 loc) · 2.41 KB
Raw

Timelocked-Wallet

A Codeacademy Clarity Camp practice project.

The block height can be used to perform actions over time. If you know the average block time, then you can calculate roughly how many blocks will be mined in a specific time frame. This project uses this concept to create a wallet contract that unlocks at a specific block height.

Features

  • A user can deploy the time-locked wallet contract.
  • Then, the user specifies a block height at which the wallet unlocks and a beneficiary.
  • Anyone, not just the contract deployer, can send tokens to the contract.
  • The beneficiary can claim the tokens once the specified block height is reached.
  • Additionally, the beneficiary can transfer the right to claim the wallet to a different principal. (For whatever reason.)

Smart-Claimant

Creating a contract that can claim tokens from the time-locked wallet contract.

The custom claim function will:

  • Call claim on the time-locked wallet, exiting if it fails.
  • Read the balance of the current contract. We do not read the balance of the time-locked wallet because someone might have sent some tokens to the smart-claimant by mistake. We want to include those tokens as well.
  • Calculate an equal share for each recipient by dividing the total balance by the number of recipients.
  • Send the calculated share to each recipient.
  • Transfer the remainder in case of a rounding error. (Remember that integers have no decimal point.)

Running Tests

To run tests, run the following command

  clarinet test

Unit tests

timelocked-wallet

  • Allows the contract owner to lock an amount.
  • Does not allow anyone else to lock an amount.
  • Cannot be locked more than once.
  • Cannot set the unlock height to a value less than the current block height.
  • Allows the beneficiary to bestow the right to claim to someone else.
  • Does not allow anyone else to bestow the right to claim to someone else. (Not even the contract owner.)
  • Allows the beneficiary to claim the balance when the block height is reached.
  • Does not allow the beneficiary to claim the balance before the block-height is reached.
  • Nobody but the beneficiary can claim the balance once the block height is reached.

smart-claimant

  • Disburses tokens once it can claim the time-locked wallet balance

Project Source Code

The full source code of the project can be found here:

https://github.com/clarity-lang/book/tree/main/projects/timelocked-wallet