35 |
36 |
40 |
41 |
42 |
66 |
67 |
159 |
160 | )
161 | }
162 |
--------------------------------------------------------------------------------
/packages/app/components/AmountInput.tsx:
--------------------------------------------------------------------------------
1 | import { ComponentProps, ReactNode, useEffect, useState } from "react"
2 | import cls from "./Input.module.css"
3 | import Field from "./Field"
4 | import React from "react"
5 | import { BigNumber } from "ethers"
6 | import { formatUnits, parseUnits } from "ethers/lib/utils"
7 |
8 | type Props = ComponentProps
64 | {
73 | const value = sanitize(ev.target.value)
74 | setState(value)
75 |
76 | let parsed: BigNumber | undefined = undefined
77 | try {
78 | parsed = parseUnits(value, decimals)
79 | } catch (e) {
80 | } finally {
81 | onChange(parsed)
82 | }
83 | }}
84 | />
85 | {unit && {unit}}
86 |
87 | {value && max && value.gt(max) && (
88 |
89 | You've entered an amount that exceeds your balance.
90 |
91 | )}
92 |
78 |
131 |
132 | )
133 | }
134 |
135 | export default Balance
136 |
--------------------------------------------------------------------------------
/packages/app/components/Button.module.css:
--------------------------------------------------------------------------------
1 | .default {
2 | background: transparent;
3 | border-radius: 8px;
4 | border: 2px solid #001428;
5 | box-shadow: 1px 2px 10px rgba(40, 54, 61, 0.18);
6 | color: #001428;
7 | cursor: pointer;
8 | display: block;
9 | font-size: 1em;
10 | font-weight: 700;
11 | line-height: 46px;
12 | margin: 0.5em auto;
13 | max-width: 360px;
14 | transition: background 0.12s ease-in-out;
15 | width: 100%;
16 | }
17 | .default:hover {
18 | background: #04203d;
19 | }
20 | .default:disabled {
21 | cursor: not-allowed;
22 | opacity: 0.4;
23 | }
24 |
25 | .primary {
26 | background: #001428;
27 | border-radius: 8px;
28 | border: none;
29 | box-shadow: 1px 2px 10px rgba(40, 54, 61, 0.18);
30 | color: white;
31 | cursor: pointer;
32 | display: flex;
33 | flex-wrap: nowrap;
34 | justify-content: center;
35 | font-size: 1em;
36 | font-weight: 700;
37 | line-height: 50px;
38 | margin: 1em auto 0.5em;
39 | max-width: 360px;
40 | white-space: nowrap;
41 | transition: background 0.12s ease-in-out;
42 | width: 100%;
43 | }
44 | .primary:hover {
45 | background: #04203d;
46 | }
47 | .primary:disabled {
48 | color: #b3aeb7;
49 | cursor: not-allowed;
50 | opacity: 0.4;
51 | }
52 |
53 | .link {
54 | background: none;
55 | border: none;
56 | color: #001428;
57 | cursor: pointer;
58 | display: inline;
59 | padding: 0;
60 | text-decoration: underline;
61 | }
62 |
63 | .link:hover {
64 | color: #5d6d74;
65 | }
66 |
--------------------------------------------------------------------------------
/packages/app/components/Button.tsx:
--------------------------------------------------------------------------------
1 | import React, {
2 | ButtonHTMLAttributes,
3 | ComponentProps,
4 | DetailedHTMLProps,
5 | } from "react"
6 | import clsx from "clsx"
7 | import cls from "./Button.module.css"
8 |
9 | type Props = ComponentProps<"button"> & {
10 | primary?: boolean
11 | link?: boolean
12 | }
13 | const Button: React.FC
79 | 
85 |
86 |
87 |
85 |
88 |
98 | {balance && lockToken && (
99 |
89 | {balance ? formatToken(balance, decimals) : "…"}{" "}
90 | {lockToken ? lockTokenSymbol : tokenSymbol}
91 |
92 | {balanceInUsd !== undefined && (
93 |
94 | {!balance?.isZero() && "~"}$ {formatUsd(balanceInUsd)}
95 |
96 | )}
97 |
100 |
122 | {balanceToken && balanceLockToken && (
123 | <>
124 |
129 | )}
130 | {percentLocked}%
125 | Locked
126 |
127 | )}
128 | {children}
10 | )
11 |
12 | export default Card
13 |
--------------------------------------------------------------------------------
/packages/app/components/Connect/Identicon.module.css:
--------------------------------------------------------------------------------
1 | .identicon {
2 | align-items: center;
3 | background: #e8e7e6;
4 | border: none;
5 | border-radius: 999px;
6 | display: flex;
7 | height: 36px;
8 | justify-content: center;
9 | position: relative;
10 | transition: opacity 0.12s ease-in-out;
11 | width: 36px;
12 | }
13 | .identicon img,
14 | .identicon canvas {
15 | border-radius: 999px;
16 | overlow: hidden;
17 | }
18 |
19 | .identicon.isLarge {
20 | height: 60px;
21 | width: 60px;
22 | }
23 |
24 | .statusJewel {
25 | background: #f02525;
26 | border: 2px solid white;
27 | border-radius: 999px;
28 | bottom: 0;
29 | height: 0.75rem;
30 | position: absolute;
31 | right: 0;
32 | width: 0.75rem;
33 | z-index: 1;
34 | }
35 |
36 | .statusJewel.isLarge {
37 | height: 1rem;
38 | width: 1rem;
39 | }
40 |
41 | .statusJewel.isConnected {
42 | background: #008c73;
43 | }
44 |
--------------------------------------------------------------------------------
/packages/app/components/Connect/Identicon.tsx:
--------------------------------------------------------------------------------
1 | import { useAccount, useEnsAvatar } from "wagmi"
2 | import makeBlockie from "ethereum-blockies-base64"
3 | import clsx from "clsx"
4 | import cls from "./Identicon.module.css"
5 | import { useMemo } from "react"
6 |
7 | type Props = {
8 | large?: boolean
9 | }
10 |
11 | const Identicon: React.FC
22 | {/* eslint-disable-next-line @next/next/no-img-element */}
23 | {avatar && 
}
24 | {!avatar && blockie && 
}
25 | {!avatar && !blockie && (
26 | 
32 | )}
33 |
40 |
41 | )
42 | }
43 |
44 | export default Identicon
45 |
--------------------------------------------------------------------------------
/packages/app/components/Connect/index.module.css:
--------------------------------------------------------------------------------
1 | .container {
2 | align-items: center;
3 | display: flex;
4 | justify-content: flex-end;
5 | position: relative;
6 | position: relative;
7 | width: 100%;
8 | }
9 |
10 | .button {
11 | background: none;
12 | border: none;
13 | cursor: pointer;
14 | }
15 |
16 | .button:hover .arrow {
17 | opacity: 0.7;
18 | }
19 |
20 | .identiconWrapper {
21 | align-items: center;
22 | display: flex;
23 | gap: 0.5rem;
24 | }
25 |
26 | .arrow {
27 | margin-left: 0.5rem;
28 | transition: opacity 0.12s ease-in-out;
29 | }
30 |
31 | .dropdown {
32 | background: #ffffff;
33 | border-radius: 0.5rem;
34 | box-shadow: 1px 2px 10px rgba(40, 54, 61, 0.18);
35 | padding: 1rem 0 0.5rem;
36 | position: absolute;
37 | right: 0;
38 | top: calc(100% + 0.5rem);
39 | width: 280px;
40 | z-index: 99;
41 | }
42 |
43 | .row {
44 | padding-left: 1rem;
45 | padding-right: 1rem;
46 | display: flex;
47 | justify-content: center;
48 | }
49 |
50 | .dropdownAccountDetails {
51 | display: flex;
52 | flex-direction: column;
53 | padding: 1rem 0.75rem;
54 | }
55 |
56 | .dropdownAddress {
57 | align-items: center;
58 | background-color: #f7f5f5;
59 | border-radius: 3px;
60 | display: flex;
61 | font-size: 11px;
62 | justify-content: center;
63 | line-height: 1;
64 | margin: 0.5rem auto 0;
65 | padding: 0.5rem;
66 | }
67 |
68 | .dropdownDivider {
69 | background-color: #e8e7e6;
70 | height: 2px;
71 | margin: 4px 0;
72 | min-height: 2px;
73 | width: 100%;
74 | }
75 |
76 | .dropdownSplitRow {
77 | align-items: center;
78 | display: flex;
79 | font-size: 12px;
80 | justify-content: space-between;
81 | padding: 0 1rem;
82 | }
83 |
84 | .dropdownListFlex {
85 | display: flex;
86 | align-items: center;
87 | }
88 |
89 | .dropdownConnectedJewel {
90 | background-color: #008c73;
91 | border-radius: 999px;
92 | height: 6px;
93 | margin-right: 0.25rem;
94 | transform: translateY(-1px);
95 | width: 6px;
96 | }
97 |
98 | .dropdownNetworkJewel {
99 | background-color: none;
100 | border: 2px solid #e8e7e6;
101 | border-radius: 999px;
102 | height: 8px;
103 | margin-right: 0.25rem;
104 | transform: translateY(-1px);
105 | width: 8px;
106 | }
107 |
108 | button.dropdownButton {
109 | line-height: 40px;
110 | width: 100%;
111 | }
112 |
113 | .wrapper {
114 | align-items: center;
115 | display: flex;
116 | flex-direction: column;
117 | padding: 0 1rem;
118 | }
119 |
120 | .marginTop {
121 | display: flex;
122 | justify-content: center;
123 | margin-top: 1rem;
124 | width: 100%;
125 | }
126 |
127 | .address {
128 | margin-right: 0.5rem;
129 | }
130 |
--------------------------------------------------------------------------------
/packages/app/components/Connect/index.tsx:
--------------------------------------------------------------------------------
1 | "use client"
2 | import { useRef, useState } from "react"
3 | import useOnClickOutside from "use-onclickoutside"
4 | import copy from "copy-to-clipboard"
5 | import { useAccount, useDisconnect, useEnsName, usePublicClient } from "wagmi"
6 | import truncateEthAddress from "truncate-eth-address"
7 | import Identicon from "./Identicon"
8 | import Button from "../Button"
9 | import cls from "./index.module.css"
10 | import IconButton, { IconLinkButton } from "../IconButton"
11 | import { useAppKit } from "@reown/appkit/react"
12 |
13 | const Connect: React.FC = () => {
14 | const publicClient = usePublicClient()
15 | const { address, isConnected, connector } = useAccount()
16 | const { data: ensName } = useEnsName({
17 | address,
18 | })
19 |
20 | const { open } = useAppKit()
21 |
22 | const { disconnect } = useDisconnect()
23 |
24 | const [showDropdown, setShowDropdown] = useState(false)
25 | const ref = useRef(null)
26 | useOnClickOutside(ref, () => setShowDropdown(false))
27 |
28 | const explorer = publicClient?.chain?.blockExplorers?.default
29 |
30 | return (
31 | <>
32 |
32 | )}
33 |
40 |
33 |
45 |
46 | {showDropdown && (
47 |
133 |
134 | )
135 | }
136 |
137 | export default Connect
138 |
--------------------------------------------------------------------------------
/packages/app/components/ConnectHint.tsx:
--------------------------------------------------------------------------------
1 | import { useAccount, useSwitchChain, useChainId } from "wagmi"
2 | import { CHAINS } from "../config"
3 | import Card from "./Card"
4 | import Button from "./Button"
5 | import { useAppKit } from "@reown/appkit/react"
6 |
7 | const ConnectHint: React.FC = () => {
8 | const { isConnected } = useAccount()
9 | const chainId = useChainId()
10 | const { switchChain } = useSwitchChain()
11 |
12 | const { open } = useAppKit()
13 |
14 | const connectedToUnsupportedChain =
15 | isConnected && !CHAINS.some(({ id }) => id === chainId)
16 |
17 | if (chainId && !connectedToUnsupportedChain) {
18 | return null
19 | }
20 |
21 | return (
22 |
48 | {isConnected ? (
49 | <>
50 |
131 | )}
132 |
51 |
79 |
80 |
52 |
54 | {address && (
55 |
56 | {
63 | copy(address)
64 | }}
65 | icon="copy"
66 | title="Copy to clipboard"
67 | />
68 | {explorer && (
69 |
77 | )}
78 |
57 | {ensName
58 | ? `${ensName} (${truncateEthAddress(address)})`
59 | : truncateEthAddress(address)}
60 |
61 |
81 | Status
82 |
87 |
88 |
83 |
84 | Connected
85 |
86 |
89 | Network
90 |
95 | {connector?.id !== "gnosisSafe" && (
96 | <>
97 |
98 |
91 |
92 | {publicClient?.chain?.name || "Unsupported network"}
93 |
94 |
99 |
109 |
110 |
111 | )}
112 |
113 | ) : (
114 |
115 | Connect a Wallet
116 |
129 | )}
130 |
117 |
119 |
120 |
127 |
128 |
12 |
31 | )
32 | }
33 |
34 | export default DepositAndWithdraw
35 |
--------------------------------------------------------------------------------
/packages/app/components/Field.module.css:
--------------------------------------------------------------------------------
1 | .container {
2 | display: block;
3 | }
4 |
5 | .header {
6 | display: flex;
7 | }
8 |
9 | .label {
10 | font-size: 0.875em;
11 | font-weight: 700;
12 | color: #5d6d74;
13 | display: block;
14 | }
15 |
16 | .meta {
17 | font-weight: 400;
18 | margin-left: auto;
19 | font-size: 0.875em;
20 | }
21 |
--------------------------------------------------------------------------------
/packages/app/components/Field.tsx:
--------------------------------------------------------------------------------
1 | import { ReactNode } from "react"
2 | import clsx from "clsx"
3 | import cls from "./Field.module.css"
4 |
5 | type Props = {
6 | className?: string
7 | label?: ReactNode
8 | meta?: ReactNode
9 | htmlFor?: string
10 | }
11 |
12 | const Field: React.FC
13 |
19 |
25 |
26 |
27 | {activeTab === "deposit" &&
30 |
5 |
12 |
13 | )
14 |
15 | export default GnosisLogo
16 |
--------------------------------------------------------------------------------
/packages/app/components/IconButton.module.css:
--------------------------------------------------------------------------------
1 | .button {
2 | background-color: transparent;
3 | border: none;
4 | cursor: pointer;
5 | border-radius: 12px;
6 | width: 24px;
7 | height: 24px;
8 | display: block;
9 | padding: 0;
10 | align-items: center;
11 | justify-content: center;
12 | display: flex;
13 | }
14 |
15 | .button:hover {
16 | background-color: #f0efee;
17 | }
18 |
--------------------------------------------------------------------------------
/packages/app/components/IconButton.tsx:
--------------------------------------------------------------------------------
1 | import cls from "./IconButton.module.css"
2 |
3 | interface Props {
4 | onClick?(): void
5 | icon: string
6 | title: string
7 | }
8 |
9 | const IconButton: React.FC
12 | 
35 |
36 | )
37 |
38 | export default IconButton
39 |
--------------------------------------------------------------------------------
/packages/app/components/Input.module.css:
--------------------------------------------------------------------------------
1 | .wrapper {
2 | background: #f0efee;
3 | border-radius: 0.5em;
4 | color: #5D6D74;
5 | display: flex;
6 | line-height: 56px;
7 | }
8 |
9 | .input {
10 | background: none;
11 | border: none;
12 | flex-grow: 1;
13 | font-family: Averta, sans-serif;
14 | font-size: 1em;
15 | padding: 0 16px;
16 | }
17 |
18 | .unit {
19 | padding: 0 16px;
20 | }
21 |
22 | .errorText {
23 | color: #F02525;
24 | font-size: 12px;
25 | }
--------------------------------------------------------------------------------
/packages/app/components/LockedBalance.tsx:
--------------------------------------------------------------------------------
1 | import Balance from "./Balance"
2 | import Card from "./Card"
3 | import utility from "../styles/utility.module.css"
4 |
5 | const LockedBalance: React.FC = () => (
6 | 10 | 11 | Lock 12 | 13 | GNO 14 |
15 | ) 16 | 17 | export default LockedGnoLogo 18 | -------------------------------------------------------------------------------- /packages/app/components/Notice.module.css: -------------------------------------------------------------------------------- 1 | .container { 2 | background: #ffffff; 3 | border-radius: 8px; 4 | border-top: 4px solid #f02525; 5 | bottom: 80px; 6 | box-shadow: 0 24px 24px rgba(0, 0, 0, 0.05); 7 | color: #5d6d74; 8 | left: 1em; 9 | padding: 2rem; 10 | position: fixed; 11 | right: 1em; 12 | z-index: 999; 13 | } 14 | 15 | .close { 16 | position: absolute; 17 | right: 0.5rem; 18 | top: 0.5rem; 19 | } 20 | 21 | @media screen and (min-width: 650px) { 22 | .container { 23 | left: auto; 24 | max-width: 350px; 25 | right: 2em; 26 | } 27 | } 28 | 29 | .noticeTitle { 30 | font-weight: 700; 31 | margin-bottom: 1em; 32 | } 33 | 34 | .errorText { 35 | font-family: monospace; 36 | font-size: 14px; 37 | max-height: calc(100vh - 300px); 38 | overflow: auto; 39 | } 40 | -------------------------------------------------------------------------------- /packages/app/components/Notice.tsx: -------------------------------------------------------------------------------- 1 | import IconButton from "./IconButton" 2 | import cls from "./Notice.module.css" 3 | 4 | const Notice: React.FC<{ onDismiss: () => void }> = ({ 5 | children, 6 | onDismiss, 7 | }) => ( 8 |
9 |
15 | )
16 |
17 | export default Notice
18 |
--------------------------------------------------------------------------------
/packages/app/components/PercentOfTotal.module.css:
--------------------------------------------------------------------------------
1 | .container {
2 | display: flex;
3 | gap: 4px;
4 | }
5 |
6 | .infoBubble {
7 | position: relative;
8 | }
9 | .infoBubble img {
10 | width: 16px;
11 | height: 16px;
12 | cursor: help;
13 | }
14 |
15 | .dropdown {
16 | background: #ffffff;
17 | border-radius: 0.5rem;
18 | box-shadow: 1px 2px 10px rgba(40, 54, 61, 0.18);
19 | padding: 0.5rem 1rem;
20 | position: absolute;
21 | right: 0;
22 | bottom: calc(100% + 4px);
23 | width: 360px;
24 | display: none;
25 | z-index: 99;
26 | }
27 | .infoBubble:hover .dropdown {
28 | display: block;
29 | }
30 |
--------------------------------------------------------------------------------
/packages/app/components/PercentOfTotalHint.tsx:
--------------------------------------------------------------------------------
1 | import { BigNumber } from "ethers"
2 | import cls from "./PercentOfTotal.module.css"
3 | import useTotalLocked from "./useTotalLocked"
4 |
5 | const SUPPLY_OF_COW = 50000000
6 |
7 | const formatAmount = (amount: number) =>
8 | new Intl.NumberFormat("en-US", {
9 | maximumSignificantDigits: 6,
10 | }).format(amount)
11 |
12 | const PercentOfTotalHint: React.FC<{ balance?: BigNumber }> = ({ balance }) => {
13 | const [totalLocked] = useTotalLocked()
14 |
15 | const percent =
16 | balance && totalLocked && totalLocked.gt(0)
17 | ? balance.mul(100).mul(1e4).div(totalLocked).toNumber() / 1e4 // precision to 4 decimal places
18 | : 0
19 |
20 | if (percent === 0) return null
21 |
22 | return (
23 |
10 |
12 | There was an error. Please try again.
13 | {children}
14 |
24 | {percent}% of total
25 |
42 | )
43 | }
44 |
45 | export default PercentOfTotalHint
46 |
--------------------------------------------------------------------------------
/packages/app/components/Spinner.module.css:
--------------------------------------------------------------------------------
1 | .spinner {
2 | padding: 0 8px;
3 | text-align: center;
4 | display: inline-block;
5 | }
6 |
7 | .spinner > div {
8 | width: 8px;
9 | height: 8px;
10 | background-color: white;
11 |
12 | border-radius: 100%;
13 | display: inline-block;
14 | -webkit-animation: sk-bouncedelay 1.4s infinite ease-in-out both;
15 | animation: sk-bouncedelay 1.4s infinite ease-in-out both;
16 | }
17 |
18 | .spinner .bounce1 {
19 | -webkit-animation-delay: -0.32s;
20 | animation-delay: -0.32s;
21 | }
22 |
23 | .spinner .bounce2 {
24 | -webkit-animation-delay: -0.16s;
25 | animation-delay: -0.16s;
26 | }
27 |
28 | @-webkit-keyframes sk-bouncedelay {
29 | 0%,
30 | 80%,
31 | 100% {
32 | -webkit-transform: scale(0);
33 | }
34 | 40% {
35 | -webkit-transform: scale(1);
36 | }
37 | }
38 |
39 | @keyframes sk-bouncedelay {
40 | 0%,
41 | 80%,
42 | 100% {
43 | -webkit-transform: scale(0);
44 | transform: scale(0);
45 | }
46 | 40% {
47 | -webkit-transform: scale(1);
48 | transform: scale(1);
49 | }
50 | }
51 |
--------------------------------------------------------------------------------
/packages/app/components/Spinner.tsx:
--------------------------------------------------------------------------------
1 | import cls from "./Spinner.module.css"
2 |
3 | const Spinner: React.FC = () => (
4 |
26 | 
27 |
41 |
27 |
28 |
40 | 29 | Your current share of the total locked GNO would give you a grant of 30 | 31 | ~{formatAmount((percent / 100) * SUPPLY_OF_COW)} $COW. 32 | {" "} 33 | This value will go down as more people lock their GNO. 34 |
35 |36 | A total of 50M $COW are distributed to people committing to hold 37 | their GNO long-term. 38 |
39 |
5 |
6 |
7 |
8 |
9 | )
10 |
11 | export default Spinner
12 |
--------------------------------------------------------------------------------
/packages/app/components/UseGnoBanner/UseGnoBanner.module.css:
--------------------------------------------------------------------------------
1 | .cardLink {
2 | }
3 |
4 | .card {
5 | background-image: url(/gnochainbg.svg);
6 | background-size: 120%;
7 | background-position: center;
8 | padding: 30px;
9 | position: relative;
10 | color: white;
11 | box-shadow: 1px 2px 10px 0px #0b243185;
12 | transition: all 0.3s ease;
13 | }
14 |
15 | .cardLink:hover .card {
16 | transform: translateY(-2px);
17 | filter: brightness(1.06);
18 | box-shadow: 2px 4px 15px 0px #0b243185;
19 | }
20 |
21 | .card img {
22 | position: absolute;
23 | right: -75px;
24 | top: -10px;
25 | height: 120%;
26 | }
27 |
28 | .card h2 {
29 | margin: 0 0 0.5rem 0;
30 | font-size: 1.2rem;
31 | }
32 |
33 | .card p {
34 | margin: 0;
35 | width: 70%;
36 | line-height: 1.5;
37 | }
38 |
39 | @media screen and (max-width: 650px) {
40 | .card {
41 | overflow: hidden;
42 | background-size: initial;
43 | }
44 | .card h2,
45 | .card p {
46 | width: 60%;
47 | }
48 |
49 | .card img {
50 | right: -100px;
51 | top: -5px;
52 | height: 120%;
53 | }
54 | }
55 |
56 | @media screen and (max-width: 415px) {
57 | .card img {
58 | right: -130px;
59 | top: -5px;
60 | height: 120%;
61 | }
62 | }
63 |
64 | @media screen and (max-width: 350px) {
65 | .card h2,
66 | .card p {
67 | width: 100%;
68 | text-align: center;
69 | }
70 | .card img {
71 | display: none;
72 | }
73 | }
74 |
--------------------------------------------------------------------------------
/packages/app/components/UseGnoBanner/index.tsx:
--------------------------------------------------------------------------------
1 | import Card from "../Card"
2 |
3 | import classes from "./UseGnoBanner.module.css"
4 |
5 | const UseGNOBanner = () => {
6 | return (
7 |
8 | 
10 | Not sure where to use your GNO?
11 |12 | Click here to explore all the valuable uses on Gnosis Chain and 13 | Ethereum 14 |
15 |-
14 |
- Lock Deadline 16 |
-
17 | {new Intl.DateTimeFormat("default", { dateStyle: "medium" }).format(
18 | config.depositDeadline
19 | )}
20 |
21 | 22 | {deadlineIsToday && 23 | new Intl.DateTimeFormat("default", { 24 | timeStyle: "long", 25 | }).format(config.depositDeadline)} 26 |27 |
28 |
- Lock Duration 31 |
- {formatDuration(config.lockDuration)} 32 |
15 |
29 |
30 |
33 |
34 | -
19 |
- Unlock Date 21 |
- 22 | {new Intl.DateTimeFormat("default", { dateStyle: "medium" }).format( 23 | new Date(config.depositDeadline.getTime() + config.lockDuration) 24 | )} 25 | 26 |
- Time remaining 29 |
- 30 | {hoursRemaining <= 48 31 | ? pluralize(hoursRemaining, "Hour") 32 | : `${daysRemaining} Days`} 33 | 34 |
20 |
27 |
28 |
35 |
36 | -
10 |
- Unlock Date 12 |
- Lock Period Over 🎉 13 |
11 |
14 |
15 |
13 |
14 |
49 | )
50 | }
51 |
52 | export default TotalLockedBreakdown
53 |
--------------------------------------------------------------------------------
/packages/app/components/stats/TotalLockedStat.tsx:
--------------------------------------------------------------------------------
1 | import { formatToken } from "./formatToken"
2 | import cls from "./Stats.module.css"
3 | import useTokenLockConfig from "../useTokenLockConfig"
4 | import useTotalLocked from "../useTotalLocked"
5 | import TotalLockedBreakdown from "./TotalLockedBreakdown"
6 |
7 | const TotalLockedStat: React.FC = () => {
8 | const config = useTokenLockConfig()
9 | const [totalLocked] = useTotalLocked()
10 |
11 | return (
12 |
14 |
15 |
48 | -
16 |
- GNO locked on Mainnet: 18 |
- 19 | {breakdown.mainnet 20 | ? formatToken(breakdown.mainnet, config.decimals) 21 | : "…"} 22 | 23 |
- GNO locked on Gnosis Chain: 26 |
- 27 | {breakdown.gnosisChain 28 | ? formatToken(breakdown.gnosisChain, config.decimals) 29 | : "…"} 30 | 31 |
- GNO staked by Gnosis Beacon Chain validators: 34 |
- 35 | {breakdown.staked 36 | ? formatToken(breakdown.staked, config.decimals) 37 | : "…"} 38 | 39 |
- Total locked GNO: 42 |
- 43 | {totalLocked ? formatToken(totalLocked, config.decimals) : "…"} 44 | 45 |
17 |
24 |
25 |
32 |
33 |
40 |
41 |
46 |
13 |
14 |
17 | {totalLocked ? formatToken(totalLocked, config.decimals) : "…"}
18 |
19 | )
20 | }
21 |
22 | export default TotalLockedStat
23 |
--------------------------------------------------------------------------------
/packages/app/components/stats/formatDuration.ts:
--------------------------------------------------------------------------------
1 | const MILLIS_PER_DAY = 24 * 60 * 60 * 1000
2 |
3 | export const pluralize = (number: number, unit: string) => {
4 | const rounded = Math.round(number)
5 | return `${rounded} ${unit}${rounded === 1 ? "" : "s"}`
6 | }
7 |
8 | const closeToFull = (dividend: number, divisor: number, fuzziness = 2) => {
9 | const remainder = dividend % divisor
10 | return remainder <= fuzziness || divisor - remainder <= fuzziness
11 | }
12 |
13 | const formatDuration = (millis: number) => {
14 | const days = millis / MILLIS_PER_DAY
15 |
16 | if ((days >= 365 && closeToFull(days, 365)) || days > 3 * 365) {
17 | return pluralize(days / 365, "Year")
18 | }
19 |
20 | if ((days >= 30 && closeToFull(days, 30)) || days > 90) {
21 | return pluralize(days / 30, "Month")
22 | }
23 |
24 | return pluralize(days, "Day")
25 | }
26 |
27 | export default formatDuration
28 |
--------------------------------------------------------------------------------
/packages/app/components/stats/formatToken.ts:
--------------------------------------------------------------------------------
1 | import { BigNumber } from "ethers"
2 | import { formatUnits } from "ethers/lib/utils"
3 |
4 | export const formatToken = (bigNumber: BigNumber, decimals: number) =>
5 | new Intl.NumberFormat("en-US", {
6 | maximumFractionDigits: 0,
7 | }).format(parseFloat(formatUnits(bigNumber, decimals)))
8 |
--------------------------------------------------------------------------------
/packages/app/components/stats/index.ts:
--------------------------------------------------------------------------------
1 | export { default as StatsDeposit } from "./StatsDeposit"
2 | export { default as StatsLocked } from "./StatsLocked"
3 | export { default as StatsWithdraw } from "./StatsWithdraw"
4 |
--------------------------------------------------------------------------------
/packages/app/components/tokenContract.ts:
--------------------------------------------------------------------------------
1 | import {
2 | useReadContract,
3 | useWriteContract,
4 | } from "wagmi"
5 | import useTokenLockConfig from "./useTokenLockConfig"
6 | import { erc20Abi } from 'viem'
7 |
8 | type Config = { enabled?: boolean; watch?: boolean; args?: any }
9 |
10 | export const useTokenContractRead = (
11 | functionName: string,
12 | config: Config = {}
13 | ) => {
14 | const { tokenAddress } = useTokenLockConfig()
15 | return useReadContract({
16 | ...config,
17 | address: tokenAddress as `0x${string}`,
18 | abi: erc20Abi,
19 | functionName: functionName as any,
20 | })
21 | }
22 |
23 | export const useTokenContractWrite = (functionName: string, args: any) => {
24 | const { data: hash, writeContract } = useWriteContract()
25 | const { tokenAddress } = useTokenLockConfig()
26 | return writeContract({
27 | address: tokenAddress as `0x${string}`,
28 | abi: erc20Abi,
29 | functionName: functionName as any,
30 | args,
31 | })
32 | }
33 |
--------------------------------------------------------------------------------
/packages/app/components/tokenLockContract.ts:
--------------------------------------------------------------------------------
1 | import { useChainId } from "wagmi"
2 | import {
3 | useReadContract,
4 | } from "wagmi"
5 | import { CONTRACT_ADDRESSES } from "../config"
6 | import { TOKEN_LOCK_ABI } from "../abi/tokenLock"
7 |
8 | type Config = { enabled?: boolean; watch?: boolean; args?: any }
9 |
10 | export const useTokenLockContractRead = (
11 | functionName: string,
12 | config: Config = {}
13 | ) => {
14 | const chainId = useChainId()
15 | return useReadContract({
16 | ...config,
17 | address: CONTRACT_ADDRESSES[chainId] as `0x${string}`,
18 | abi: TOKEN_LOCK_ABI,
19 | functionName,
20 | })
21 | }
--------------------------------------------------------------------------------
/packages/app/components/useTokenLockConfig.tsx:
--------------------------------------------------------------------------------
1 | "use client"
2 | import { CONTRACT_ADDRESSES } from "@/config"
3 | import { createContext, useContext, useEffect, useState } from "react"
4 | import { useChainId, useReadContract } from "wagmi"
5 | import { TOKEN_LOCK_ABI } from "../abi/tokenLock"
6 | import { erc20Abi } from "viem"
7 |
8 | interface TokeLockConfig {
9 | depositDeadline: Date
10 | lockDuration: number
11 | tokenAddress: string
12 | tokenName: string
13 | tokenSymbol: string
14 | lockTokenName: string
15 | lockTokenSymbol: string
16 | decimals: number
17 | }
18 |
19 | const ConfigContext = createContextTotal GNO Locked
15 |
40 | //
41 | // Lock GNO
42 | //
46 | // {!isProd && }
47 | //
48 | //
49 |
50 | //
51 | //
55 |
56 | //
57 | //
81 |
82 | //
174 | //
175 | // )
176 | // }
177 |
178 | // export default Home
179 |
--------------------------------------------------------------------------------
/packages/app/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "token-lock-app",
3 | "private": true,
4 | "scripts": {
5 | "dev": "next dev",
6 | "build": "next build",
7 | "start": "next start",
8 | "lint": "next lint",
9 | "format": "prettier '(components|pages)/**/*.(ts|tsx)' -w"
10 | },
11 | "dependencies": {
12 | "@gnosis.pm/safe-apps-provider": "^0.9.3",
13 | "@gnosis.pm/safe-apps-sdk": "^6.2.0",
14 | "@reown/appkit": "^1.6.3",
15 | "@reown/appkit-adapter-wagmi": "^1.6.3",
16 | "@tanstack/react-query": "^5.62.16",
17 | "copy-to-clipboard": "^3.3.1",
18 | "ethereum-blockies-base64": "^1.0.2",
19 | "ethers": "^5.5.3",
20 | "next": "^15.1.3",
21 | "react": "18.2.0",
22 | "react-dom": "18.2.0",
23 | "truncate-eth-address": "^1.0.2",
24 | "use-onclickoutside": "^0.4.0",
25 | "viem": "^2.22.4",
26 | "wagmi": "^2.14.6"
27 | },
28 | "devDependencies": {
29 | "@types/node": "17.0.8",
30 | "@types/react": "17.0.38",
31 | "@types/react-modal": "^3.13.1",
32 | "eslint": "8.6.0",
33 | "eslint-config-next": "^15.1.4",
34 | "prettier": "^2.5.1",
35 | "typescript": "^5.3.2"
36 | }
37 | }
38 |
--------------------------------------------------------------------------------
/packages/app/public/Averta-ExtraBold.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/gnosis/token-lock/a5d2ffc3a554e19d1bc184c9d6c49bfc0b08da48/packages/app/public/Averta-ExtraBold.woff2
--------------------------------------------------------------------------------
/packages/app/public/Averta-normal.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/gnosis/token-lock/a5d2ffc3a554e19d1bc184c9d6c49bfc0b08da48/packages/app/public/Averta-normal.woff2
--------------------------------------------------------------------------------
/packages/app/public/AvertaBold.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/gnosis/token-lock/a5d2ffc3a554e19d1bc184c9d6c49bfc0b08da48/packages/app/public/AvertaBold.woff2
--------------------------------------------------------------------------------
/packages/app/public/arrow.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/packages/app/public/close.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/packages/app/public/connectors/coinbase.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/packages/app/public/connectors/injected.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/packages/app/public/connectors/metamask.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/packages/app/public/connectors/walletconnect.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/packages/app/public/copy.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/packages/app/public/discordicon.svg:
--------------------------------------------------------------------------------
1 |
4 |
--------------------------------------------------------------------------------
/packages/app/public/etherscan.svg:
--------------------------------------------------------------------------------
1 |
7 |
--------------------------------------------------------------------------------
/packages/app/public/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/gnosis/token-lock/a5d2ffc3a554e19d1bc184c9d6c49bfc0b08da48/packages/app/public/favicon.ico
--------------------------------------------------------------------------------
/packages/app/public/github.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/gnosis/token-lock/a5d2ffc3a554e19d1bc184c9d6c49bfc0b08da48/packages/app/public/github.png
--------------------------------------------------------------------------------
/packages/app/public/gno.svg:
--------------------------------------------------------------------------------
1 |
7 |
--------------------------------------------------------------------------------
/packages/app/public/gnochainbg.svg:
--------------------------------------------------------------------------------
1 |
100 |
--------------------------------------------------------------------------------
/packages/app/public/gnochainfuture.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/gnosis/token-lock/a5d2ffc3a554e19d1bc184c9d6c49bfc0b08da48/packages/app/public/gnochainfuture.png
--------------------------------------------------------------------------------
/packages/app/public/gnosisguild.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/gnosis/token-lock/a5d2ffc3a554e19d1bc184c9d6c49bfc0b08da48/packages/app/public/gnosisguild.png
--------------------------------------------------------------------------------
/packages/app/public/google9cc8a77ba2e504cb.html:
--------------------------------------------------------------------------------
1 | google-site-verification: google9cc8a77ba2e504cb.html
--------------------------------------------------------------------------------
/packages/app/public/identicon.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/packages/app/public/info.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/packages/app/public/lock.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/packages/app/public/manifest.json:
--------------------------------------------------------------------------------
1 | {
2 | "short_name": "Lock GNO",
3 | "name": "Lock GNO",
4 | "description": "Lock GNO for 12 months to receive a $COW airdrop boost",
5 | "iconPath": "lock.svg"
6 | }
7 |
--------------------------------------------------------------------------------
/packages/app/public/open.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/packages/app/public/twittericon.svg:
--------------------------------------------------------------------------------
1 |
4 |
--------------------------------------------------------------------------------
/packages/app/public/unlocked.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/packages/app/styles/Home.module.css:
--------------------------------------------------------------------------------
1 | .header {
2 | align-items: center;
3 | background-color: white;
4 | display: flex;
5 | height: var(--navHeight, 66px);
6 | justify-content: space-between;
7 | padding-left: 2em;
8 | padding-right: 2em;
9 | }
10 | @media screen and (max-width: 650px) {
11 | .header {
12 | padding-left: 1em;
13 | padding-right: 1em;
14 | }
15 | }
16 |
17 | .main {
18 | align-items: stretch;
19 | display: flex;
20 | flex-direction: column;
21 | flex: 1;
22 | gap: 2em;
23 | justify-content: flex-start;
24 | margin: auto;
25 | max-width: 500px;
26 | min-height: calc(100vh - (var(--navHeight, 66px) * 2));
27 | padding: 2rem 1rem;
28 | }
29 |
30 | .footer {
31 | padding-left: 2rem;
32 | padding-right: 2rem;
33 | color: #5d6d74;
34 | }
35 | @media screen and (max-width: 650px) {
36 | .footer {
37 | padding-left: 1em;
38 | padding-right: 1em;
39 | }
40 | }
41 |
42 | .footerContainer {
43 | align-items: center;
44 | border-top: 1px solid #b2b5b2;
45 | font-size: 10px;
46 | display: flex;
47 | justify-content: flex-start;
48 | }
49 | .left {
50 | align-items: center;
51 | display: flex;
52 | height: var(--navHeight, 66px);
53 | justify-content: flex-start;
54 | gap: 1em;
55 | }
56 | .right {
57 | align-items: center;
58 | display: flex;
59 | height: var(--navHeight, 66px);
60 | justify-content: flex-end;
61 | flex: 1;
62 | }
63 |
64 | .right > * {
65 | align-items: center;
66 | display: flex;
67 | margin-left: 1rem;
68 | }
69 |
70 | .footer a {
71 | cursor: pointer;
72 | transition: opacity 0.12s ease-in-out;
73 | }
74 |
75 | .footer a:hover {
76 | opacity: 0.7;
77 | }
78 |
79 | .divider {
80 | background-color: #b2b5b2;
81 | height: 1.25rem;
82 | width: 1px;
83 | }
84 |
85 | .gg {
86 | color: #5d6d74;
87 | }
88 |
89 | .logo {
90 | margin-left: 0.5rem;
91 | }
92 |
--------------------------------------------------------------------------------
/packages/app/styles/globals.css:
--------------------------------------------------------------------------------
1 | @font-face {
2 | font-family: "Averta";
3 | font-style: normal;
4 | font-weight: 400;
5 | font-display: swap;
6 | src: local("Averta-Regular"),
7 | url(../public/Averta-normal.woff2) format("woff2");
8 | }
9 | @font-face {
10 | font-family: "Averta";
11 | font-style: normal;
12 | font-weight: 700;
13 | font-display: swap;
14 | src: local("Averta-Bold"),
15 | url(../public/AvertaBold.woff2) format("woff2");
16 | }
17 | @font-face {
18 | font-family: "Averta";
19 | font-style: normal;
20 | font-weight: 800;
21 | font-display: swap;
22 | src: local("Averta-Extrabold"),
23 | url(../public/Averta-ExtraBold.woff2) format("woff2");
24 | }
25 |
26 | :root {
27 | --navHeight: 66px;
28 | }
29 |
30 | html,
31 | body {
32 | padding: 0;
33 | margin: 0;
34 | font-family: Averta, sans-serif;
35 | font-size: 16px;
36 | color: #001428;
37 | background-color: #e8e7e6;
38 | }
39 |
40 | a {
41 | color: inherit;
42 | text-decoration: none;
43 | color: #001428;
44 | }
45 |
46 | button {
47 | font-family: Averta, sans-serif;
48 | }
49 |
50 | * {
51 | box-sizing: border-box;
52 | }
53 |
--------------------------------------------------------------------------------
/packages/app/styles/utility.module.css:
--------------------------------------------------------------------------------
1 | /* ----- Utility ----- */
2 |
3 | /* Margin */
4 | .mt4 {
5 | margin-top: 0.5rem;
6 | }
7 | .mt8 {
8 | margin-top: 1rem;
9 | }
10 |
11 | /* Padding */
12 | .pb8 {
13 | padding-bottom: 1rem;
14 | }
--------------------------------------------------------------------------------
/packages/app/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "paths": {
4 | "@/config": [
5 | "./config"
6 | ]
7 | },
8 | "lib": [
9 | "dom",
10 | "dom.iterable",
11 | "esnext"
12 | ],
13 | "allowJs": true,
14 | "skipLibCheck": true,
15 | "strict": true,
16 | "noEmit": true,
17 | "esModuleInterop": true,
18 | "module": "esnext",
19 | "moduleResolution": "bundler",
20 | "resolveJsonModule": true,
21 | "isolatedModules": true,
22 | "jsx": "preserve",
23 | "incremental": true,
24 | "plugins": [
25 | {
26 | "name": "next"
27 | }
28 | ],
29 | "target": "ES2017"
30 | },
31 | "include": [
32 | "**/*.ts",
33 | "**/*.tsx",
34 | "next-env.d.ts",
35 | ".next/types/**/*.ts"
36 | ],
37 | "exclude": [
38 | "node_modules"
39 | ]
40 | }
41 |
--------------------------------------------------------------------------------
/packages/app/wagmi.ts:
--------------------------------------------------------------------------------
1 | // import { createAppKit } from "@reown/appkit/react"
2 | // import { mainnet, gnosis } from "@reown/appkit/networks"
3 | // import { WagmiAdapter } from "@reown/appkit-adapter-wagmi"
4 |
5 | // export const projectId = 'af31daed827da866f82e0b2141bb0bee'
6 |
7 | // export const wagmiAdapter = new WagmiAdapter({
8 | // networks: [mainnet, gnosis],
9 | // projectId,
10 | // })
11 |
12 | // createAppKit({
13 | // adapters: [wagmiAdapter],
14 | // networks: [mainnet, gnosis],
15 | // projectId,
16 | // features: {
17 | // analytics: true,
18 | // },
19 | // })
20 |
--------------------------------------------------------------------------------
/packages/contracts/.env.template:
--------------------------------------------------------------------------------
1 | MNEMONIC=
2 | INFURA_KEY=
3 | ETHERSCAN_API_KEY=
--------------------------------------------------------------------------------
/packages/contracts/.eslintrc.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | root: true,
3 | env: {
4 | es2020: true,
5 | node: true,
6 | },
7 | parser: "@typescript-eslint/parser",
8 | parserOptions: {
9 | ecmaVersion: 2020,
10 | },
11 | plugins: ["@typescript-eslint", "import", "prettier"],
12 | extends: [
13 | "eslint:recommended",
14 | "plugin:import/recommended",
15 | "plugin:import/typescript",
16 | "plugin:@typescript-eslint/recommended",
17 | "plugin:prettier/recommended",
18 | "prettier",
19 | ],
20 | ignorePatterns: ["build/", "node_modules/", "coverage/", ".openzeppelin"],
21 | }
22 |
--------------------------------------------------------------------------------
/packages/contracts/.gitignore:
--------------------------------------------------------------------------------
1 |
2 | build/
3 | .openzeppelin/
4 | typechain-types/
5 | env
6 | .env
7 | coverage*
8 |
--------------------------------------------------------------------------------
/packages/contracts/.mocharc.json:
--------------------------------------------------------------------------------
1 | {
2 | "spec": ["test/**/*.spec.ts"],
3 | "watchFiles": ["test/**/*.spec.ts"],
4 | "require": "ts-node/register/files",
5 | "timeout": 20000
6 | }
7 |
--------------------------------------------------------------------------------
/packages/contracts/.solcover.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | skipFiles: ["test/TestToken.sol"],
3 | mocha: {
4 | grep: "@skip-on-coverage", // Find everything with this tag
5 | invert: true, // Run the grep's inverse set.
6 | },
7 | }
8 |
--------------------------------------------------------------------------------
/packages/contracts/.solhint.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "solhint:recommended",
3 | "plugins": ["prettier"],
4 | "rules": {
5 | "compiler-version": "off",
6 | "func-visibility": [
7 | "warn",
8 | {
9 | "ignoreConstructors": true
10 | }
11 | ],
12 | "prettier/prettier": "error",
13 | "not-rely-on-time": "off",
14 | "reason-string": "off",
15 | "no-empty-blocks": "off",
16 | "avoid-low-level-calls": "off"
17 | }
18 | }
19 |
--------------------------------------------------------------------------------
/packages/contracts/.vscode/settings.json:
--------------------------------------------------------------------------------
1 | {
2 | "typescript.tsdk": "node_modules/typescript/lib"
3 | }
4 |
--------------------------------------------------------------------------------
/packages/contracts/audits/GnosisTokenLockJan2022.pdf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/gnosis/token-lock/a5d2ffc3a554e19d1bc184c9d6c49bfc0b08da48/packages/contracts/audits/GnosisTokenLockJan2022.pdf
--------------------------------------------------------------------------------
/packages/contracts/contracts/TokenLock.sol:
--------------------------------------------------------------------------------
1 | // SPDX-License-Identifier: LGPL-3.0-only
2 | pragma solidity ^0.8.6;
3 |
4 | import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
5 | import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
6 | import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
7 |
8 | contract TokenLock is OwnableUpgradeable, IERC20 {
9 | ERC20 public token;
10 | uint256 public depositDeadline;
11 | uint256 public lockDuration;
12 |
13 | string public name;
14 | string public symbol;
15 | uint256 public override totalSupply;
16 | mapping(address => uint256) public override balanceOf;
17 |
18 | /// Withdraw amount exceeds sender's balance of the locked token
19 | error ExceedsBalance();
20 | /// Deposit is not possible anymore because the deposit period is over
21 | error DepositPeriodOver();
22 | /// Withdraw is not possible because the lock period is not over yet
23 | error LockPeriodOngoing();
24 | /// Could not transfer the designated ERC20 token
25 | error TransferFailed();
26 | /// ERC-20 function is not supported
27 | error NotSupported();
28 |
29 | function initialize(
30 | address _owner,
31 | address _token,
32 | uint256 _depositDeadline,
33 | uint256 _lockDuration,
34 | string memory _name,
35 | string memory _symbol
36 | ) public initializer {
37 | __Ownable_init();
38 | transferOwnership(_owner);
39 | token = ERC20(_token);
40 | depositDeadline = _depositDeadline;
41 | lockDuration = _lockDuration;
42 | name = _name;
43 | symbol = _symbol;
44 | totalSupply = 0;
45 | }
46 |
47 | /// @dev Deposit tokens to be locked until the end of the locking period
48 | /// @param amount The amount of tokens to deposit
49 | function deposit(uint256 amount) public {
50 | if (block.timestamp > depositDeadline) {
51 | revert DepositPeriodOver();
52 | }
53 |
54 | balanceOf[msg.sender] += amount;
55 | totalSupply += amount;
56 |
57 | if (!token.transferFrom(msg.sender, address(this), amount)) {
58 | revert TransferFailed();
59 | }
60 |
61 | emit Transfer(msg.sender, address(this), amount);
62 | }
63 |
64 | /// @dev Withdraw tokens after the end of the locking period or during the deposit period
65 | /// @param amount The amount of tokens to withdraw
66 | function withdraw(uint256 amount) public {
67 | if (
68 | block.timestamp > depositDeadline &&
69 | block.timestamp < depositDeadline + lockDuration
70 | ) {
71 | revert LockPeriodOngoing();
72 | }
73 | if (balanceOf[msg.sender] < amount) {
74 | revert ExceedsBalance();
75 | }
76 |
77 | balanceOf[msg.sender] -= amount;
78 | totalSupply -= amount;
79 |
80 | if (!token.transfer(msg.sender, amount)) {
81 | revert TransferFailed();
82 | }
83 |
84 | emit Transfer(address(this), msg.sender, amount);
85 | }
86 |
87 | /// @dev Returns the number of decimals of the locked token
88 | function decimals() public view returns (uint8) {
89 | return token.decimals();
90 | }
91 |
92 | /// @dev Lock claim tokens are non-transferrable: ERC-20 transfer is not supported
93 | function transfer(address, uint256) external pure override returns (bool) {
94 | revert NotSupported();
95 | }
96 |
97 | /// @dev Lock claim tokens are non-transferrable: ERC-20 allowance is not supported
98 | function allowance(address, address)
99 | external
100 | pure
101 | override
102 | returns (uint256)
103 | {
104 | revert NotSupported();
105 | }
106 |
107 | /// @dev Lock claim tokens are non-transferrable: ERC-20 approve is not supported
108 | function approve(address, uint256) external pure override returns (bool) {
109 | revert NotSupported();
110 | }
111 |
112 | /// @dev Lock claim tokens are non-transferrable: ERC-20 transferFrom is not supported
113 | function transferFrom(
114 | address,
115 | address,
116 | uint256
117 | ) external pure override returns (bool) {
118 | revert NotSupported();
119 | }
120 | }
121 |
--------------------------------------------------------------------------------
/packages/contracts/contracts/test/TestToken.sol:
--------------------------------------------------------------------------------
1 | // SPDX-License-Identifier: LGPL-3.0-only
2 | pragma solidity ^0.8.0;
3 |
4 | import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
5 |
6 | contract TestToken is ERC20 {
7 | address public owner;
8 |
9 | uint8 internal tokenDecimals;
10 |
11 | constructor(uint8 _decimals) ERC20("Test", "T") {
12 | owner = msg.sender;
13 | tokenDecimals = _decimals;
14 | }
15 |
16 | modifier onlyOwner() {
17 | require(msg.sender == owner, "Only callable by owner");
18 | _;
19 | }
20 |
21 | function decimals() public view override returns (uint8) {
22 | return tokenDecimals;
23 | }
24 |
25 | function mint(address to, uint256 amount) public onlyOwner {
26 | _mint(to, amount);
27 | }
28 | }
29 |
--------------------------------------------------------------------------------
/packages/contracts/contracts/test/TestTokenFailingTransfer.sol:
--------------------------------------------------------------------------------
1 | // SPDX-License-Identifier: LGPL-3.0-only
2 | pragma solidity ^0.8.0;
3 |
4 | import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
5 |
6 | contract TestTokenFailingTransfer is ERC20 {
7 | address public owner;
8 |
9 | uint8 internal tokenDecimals;
10 |
11 | constructor(uint8 _decimals) ERC20("Test", "T") {
12 | owner = msg.sender;
13 | tokenDecimals = _decimals;
14 | }
15 |
16 | modifier onlyOwner() {
17 | require(msg.sender == owner, "Only callable by owner");
18 | _;
19 | }
20 |
21 | function decimals() public view override returns (uint8) {
22 | return tokenDecimals;
23 | }
24 |
25 | function mint(address to, uint256 amount) public onlyOwner {
26 | _mint(to, amount);
27 | }
28 |
29 | function transfer(address, uint256)
30 | public
31 | pure
32 | override
33 | returns (bool success)
34 | {
35 | return false;
36 | }
37 | }
38 |
--------------------------------------------------------------------------------
/packages/contracts/contracts/test/TestTokenFailingTransferFrom.sol:
--------------------------------------------------------------------------------
1 | // SPDX-License-Identifier: LGPL-3.0-only
2 | pragma solidity ^0.8.0;
3 |
4 | import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
5 |
6 | contract TestTokenFailingTransferFrom is ERC20 {
7 | address public owner;
8 |
9 | uint8 internal tokenDecimals;
10 |
11 | constructor(uint8 _decimals) ERC20("Test", "T") {
12 | owner = msg.sender;
13 | tokenDecimals = _decimals;
14 | }
15 |
16 | modifier onlyOwner() {
17 | require(msg.sender == owner, "Only callable by owner");
18 | _;
19 | }
20 |
21 | function decimals() public view override returns (uint8) {
22 | return tokenDecimals;
23 | }
24 |
25 | function mint(address to, uint256 amount) public onlyOwner {
26 | _mint(to, amount);
27 | }
28 |
29 | function transferFrom(
30 | address,
31 | address,
32 | uint256
33 | ) public pure override returns (bool success) {
34 | return false;
35 | }
36 | }
37 |
--------------------------------------------------------------------------------
/packages/contracts/hardhat.config.ts:
--------------------------------------------------------------------------------
1 | import "@typechain/hardhat"
2 | import "@nomiclabs/hardhat-ethers"
3 | import "@nomiclabs/hardhat-waffle"
4 | import "@nomiclabs/hardhat-etherscan"
5 | import "@openzeppelin/hardhat-upgrades"
6 | import "solidity-coverage"
7 | import "hardhat-deploy"
8 | import "hardhat-gas-reporter"
9 | import dotenv from "dotenv"
10 | import { HttpNetworkUserConfig } from "hardhat/types"
11 | import yargs from "yargs"
12 |
13 | const argv = yargs
14 | .option("network", {
15 | type: "string",
16 | default: "hardhat",
17 | })
18 | .help(false)
19 | .version(false).argv as { network: string }
20 |
21 | // Load environment variables.
22 | dotenv.config()
23 | const { INFURA_KEY, MNEMONIC, ETHERSCAN_API_KEY, PK } = process.env
24 |
25 | import "./src/tasks/initialDeploy"
26 | import "./src/tasks/upgrade"
27 | import "./src/tasks/verify"
28 | import "./src/tasks/initializeImplementation"
29 |
30 | const DEFAULT_MNEMONIC =
31 | "candy maple cake sugar pudding cream honey rich smooth crumble sweet treat"
32 |
33 | const sharedNetworkConfig: HttpNetworkUserConfig = {}
34 | if (PK) {
35 | sharedNetworkConfig.accounts = [PK]
36 | } else {
37 | sharedNetworkConfig.accounts = {
38 | mnemonic: MNEMONIC || DEFAULT_MNEMONIC,
39 | }
40 | }
41 |
42 | if (["rinkeby", "mainnet"].includes(argv.network) && INFURA_KEY === undefined) {
43 | throw new Error(
44 | `Could not find Infura key in env, unable to connect to network ${argv.network}`
45 | )
46 | }
47 |
48 | export default {
49 | paths: {
50 | artifacts: "build/artifacts",
51 | cache: "build/cache",
52 | sources: "contracts",
53 | },
54 | solidity: {
55 | compilers: [{ version: "0.8.6" }],
56 | settings: {
57 | optimizer: {
58 | enabled: true,
59 | runs: 200,
60 | },
61 | },
62 | },
63 | networks: {
64 | hardhat: {
65 | allowUnlimitedContractSize: true,
66 | },
67 | mainnet: {
68 | ...sharedNetworkConfig,
69 | url: `https://mainnet.infura.io/v3/${INFURA_KEY}`,
70 | },
71 | goerli: {
72 | ...sharedNetworkConfig,
73 | url: `https://goerli.infura.io/v3/${INFURA_KEY}`,
74 | },
75 | gnosischain: {
76 | ...sharedNetworkConfig,
77 | url: "https://xdai.poanetwork.dev",
78 | },
79 | },
80 | namedAccounts: {
81 | deployer: 0,
82 | },
83 | mocha: {
84 | timeout: 2000000,
85 | },
86 | etherscan: {
87 | apiKey: ETHERSCAN_API_KEY,
88 | },
89 | }
90 |
--------------------------------------------------------------------------------
/packages/contracts/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "token-lock",
3 | "version": "1.0.0",
4 | "description": "Lock ERC-20 tokens for a pre-defined amount of time",
5 | "directories": {
6 | "test": "test"
7 | },
8 | "scripts": {
9 | "build": "hardhat compile",
10 | "test": "hardhat test",
11 | "test:watch": "mocha -w",
12 | "deploy": "hardhat initialDeploy --network",
13 | "verify": "hardhat verifyEtherscan --network",
14 | "upgrade": "hardhat upgrade --network",
15 | "coverage": "hardhat coverage",
16 | "lint": "yarn lint:sol && yarn lint:ts",
17 | "lint:sol": "solhint 'contracts/**/*.sol'",
18 | "lint:ts": "eslint --max-warnings 0 .",
19 | "fmt:sol": "prettier 'contracts/**/*.sol' -w",
20 | "fmt:ts": "prettier '(src|test)/**/*.ts' -w",
21 | "prepack": "yarn build"
22 | },
23 | "repository": {
24 | "type": "git"
25 | },
26 | "author": "jan-felix.schwarz@gnosis.io",
27 | "license": "LGPL-3.0+",
28 | "devDependencies": {
29 | "@gnosis.pm/zodiac": "1.0.3",
30 | "@nomiclabs/hardhat-ethers": "2.0.3",
31 | "@nomiclabs/hardhat-etherscan": "2.1.8",
32 | "@nomiclabs/hardhat-waffle": "2.0.1",
33 | "@openzeppelin/hardhat-upgrades": "1.12.0",
34 | "@typechain/ethers-v5": "8.0.5",
35 | "@typechain/hardhat": "3.1.0",
36 | "@types/chai": "4.3.0",
37 | "@types/dotenv": "8.2.0",
38 | "@types/mocha": "9.0.0",
39 | "@types/node": "17.0.8",
40 | "@types/yargs": "17.0.8",
41 | "@typescript-eslint/eslint-plugin": "5.9.0",
42 | "@typescript-eslint/parser": "5.9.0",
43 | "argv": "0.0.2",
44 | "chai": "4.3.4",
45 | "debug": "4.3.3",
46 | "dotenv": "10.0.0",
47 | "eslint": "8.6.0",
48 | "eslint-config-prettier": "8.3.0",
49 | "eslint-plugin-import": "2.25.4",
50 | "eslint-plugin-no-only-tests": "2.6.0",
51 | "eslint-plugin-prettier": "4.0.0",
52 | "ethereum-waffle": "3.4.0",
53 | "ethers": "5.5.2",
54 | "hardhat": "2.8.0",
55 | "hardhat-deploy": "0.9.24",
56 | "hardhat-gas-reporter": "1.0.6",
57 | "prettier": "2.5.1",
58 | "prettier-plugin-solidity": "1.0.0-beta.19",
59 | "solc": "0.8.11",
60 | "solhint": "3.3.6",
61 | "solhint-plugin-prettier": "0.0.5",
62 | "solidity-coverage": "0.7.17",
63 | "ts-node": "10.4.0",
64 | "typechain": "6.1.0",
65 | "typescript": "4.5.4",
66 | "yargs": "17.3.1"
67 | },
68 | "dependencies": {
69 | "@gnosis.pm/mock-contract": "4.0.0",
70 | "@gnosis.pm/safe-contracts": "1.3.0",
71 | "@openzeppelin/contracts": "4.4.1",
72 | "@openzeppelin/contracts-upgradeable": "4.4.1"
73 | },
74 | "resolutions": {
75 | "bitcore-lib": "8.25.0"
76 | }
77 | }
78 |
--------------------------------------------------------------------------------
/packages/contracts/src/tasks/initialDeploy.ts:
--------------------------------------------------------------------------------
1 | import "hardhat-deploy"
2 | import "@nomiclabs/hardhat-ethers"
3 | import { task, types } from "hardhat/config"
4 |
5 | task("initialDeploy", "Deploys a fresh TokenLock contract")
6 | .addParam("owner", "Address of the owner", undefined, types.string)
7 | .addParam("token", "Address of the token to lock", undefined, types.string)
8 | .addParam(
9 | "depositDeadline",
10 | "Unix timestamp (seconds) of the deposit deadline",
11 | undefined,
12 | types.int
13 | )
14 | .addParam(
15 | "lockDuration",
16 | "Lock duration in seconds, period starts after the deposit deadline",
17 | undefined,
18 | types.int
19 | )
20 | .addParam(
21 | "name",
22 | "Name of the token representing the claim on the locked token",
23 | undefined,
24 | types.string
25 | )
26 | .addParam(
27 | "symbol",
28 | "Symbol of the token representing the claim on the locked token",
29 | undefined,
30 | types.string
31 | )
32 | .setAction(async (taskArgs, hre) => {
33 | const [caller] = await hre.ethers.getSigners()
34 | console.log("Using the account:", caller.address)
35 | const TokenLock = await hre.ethers.getContractFactory("TokenLock")
36 | const tokenLock = await hre.upgrades.deployProxy(TokenLock, [
37 | taskArgs.owner,
38 | taskArgs.token,
39 | taskArgs.depositDeadline,
40 | taskArgs.lockDuration,
41 | taskArgs.name,
42 | taskArgs.symbol,
43 | ])
44 |
45 | console.log("TokenLock proxy deployed to:", tokenLock.address)
46 | console.log("Waiting for deploy transaction to be mined...")
47 |
48 | await tokenLock.deployed()
49 | const implementationAddress =
50 | await hre.upgrades.erc1967.getImplementationAddress(tokenLock.address)
51 | console.log(
52 | "Using the logic implementation contract deployed at:",
53 | implementationAddress
54 | )
55 | })
56 |
57 | export {}
58 |
--------------------------------------------------------------------------------
/packages/contracts/src/tasks/initializeImplementation.ts:
--------------------------------------------------------------------------------
1 | import { task, types } from "hardhat/config"
2 |
3 | task("initializeImplementation", "Initializes the implementation contract")
4 | .addParam(
5 | "implementation",
6 | "Address of the implementation contract to initialize",
7 | undefined,
8 | types.string
9 | )
10 | .setAction(async (taskArgs, hre) => {
11 | const [caller] = await hre.ethers.getSigners()
12 | const TokenLock = await hre.ethers.getContractFactory("TokenLock", caller)
13 | const tokenLock = TokenLock.attach(taskArgs.implementation)
14 |
15 | const DEAD_ADDRESS = "0x000000000000000000000000000000000000dead"
16 | try {
17 | const tx = await tokenLock.initialize(
18 | DEAD_ADDRESS,
19 | DEAD_ADDRESS,
20 | 0,
21 | 0,
22 | "",
23 | ""
24 | )
25 | await tx.wait()
26 | console.log(
27 | `Contract at ${taskArgs.implementation} has been successfully initialized`
28 | )
29 | } catch (e) {
30 | const error = e as Error & { error: Error }
31 | if (
32 | "error" in error &&
33 | "message" in error.error &&
34 | error.error.message ===
35 | "execution reverted: Initializable: contract is already initialized"
36 | ) {
37 | console.warn(
38 | `Contract at ${taskArgs.implementation} is already initialized`
39 | )
40 | } else {
41 | throw e
42 | }
43 | }
44 | })
45 |
--------------------------------------------------------------------------------
/packages/contracts/src/tasks/upgrade.ts:
--------------------------------------------------------------------------------
1 | import "hardhat-deploy"
2 | import "@nomiclabs/hardhat-ethers"
3 |
4 | import { task, types } from "hardhat/config"
5 |
6 | task("upgrade", "Upgrades the logic of an existing TokenLock contract")
7 | .addParam(
8 | "proxy",
9 | "Address of the existing token lock proxy",
10 | undefined,
11 | types.string
12 | )
13 | .setAction(async (taskArgs, hre) => {
14 | const [caller] = await hre.ethers.getSigners()
15 | console.log("Using the account:", caller.address)
16 | const TokenLock = await hre.ethers.getContractFactory("TokenLock")
17 | const tokenLock = await hre.upgrades.upgradeProxy(taskArgs.proxy, TokenLock)
18 |
19 | console.log(
20 | `Latest version of the implementation deployed to: ${tokenLock.address}`
21 | )
22 |
23 | console.log(
24 | `Proxy at ${taskArgs.proxy} upgraded to use implementation at ${tokenLock.address}`
25 | )
26 | })
27 |
28 | export {}
29 |
--------------------------------------------------------------------------------
/packages/contracts/src/tasks/verify.ts:
--------------------------------------------------------------------------------
1 | import { task, types } from "hardhat/config"
2 |
3 | task("verifyEtherscan", "Verifies the contract on etherscan")
4 | .addParam(
5 | "implementation",
6 | "Address of the implementation contract to verify",
7 | undefined,
8 | types.string
9 | )
10 | .setAction(async (taskArgs, hardhatRuntime) => {
11 | await hardhatRuntime.run("verify", {
12 | address: taskArgs.implementation,
13 | constructorArgsParams: [],
14 | })
15 | })
16 |
--------------------------------------------------------------------------------
/packages/contracts/test/TokenLock.spec.ts:
--------------------------------------------------------------------------------
1 | import { expect } from "chai"
2 | import { deployments, ethers, upgrades, network } from "hardhat"
3 | import "@nomiclabs/hardhat-ethers"
4 | import { BigNumber } from "@ethersproject/bignumber"
5 |
6 | import { TokenLock as TokenLockT } from "../typechain-types"
7 |
8 | import { SignerWithAddress } from "@nomiclabs/hardhat-ethers/signers"
9 |
10 | describe("TokenLock", () => {
11 | let owner: SignerWithAddress
12 | let user: SignerWithAddress
13 |
14 | const ONE = BigNumber.from(10).pow(18)
15 |
16 | const now = Math.round(Date.now() / 1000)
17 | const oneWeek = 7 * 24 * 60 * 60
18 |
19 | const setupTest = deployments.createFixture(async () => {
20 | ;[owner, user] = await ethers.getSigners()
21 |
22 | await deployments.fixture()
23 | const Token = await ethers.getContractFactory("TestToken")
24 | const token = await Token.deploy(18)
25 | const TokenLock = await ethers.getContractFactory("TokenLock")
26 |
27 | await token.mint(user.address, ONE)
28 |
29 | return { Token, token, TokenLock }
30 | })
31 |
32 | it("is upgradable", async () => {
33 | const { TokenLock, token } = await setupTest()
34 |
35 | const instance = await upgrades.deployProxy(TokenLock, [
36 | owner.address,
37 | token.address,
38 | now + oneWeek,
39 | 2 * oneWeek,
40 | "Locked TestToken",
41 | "LTT",
42 | ])
43 |
44 | const TokenLockV2 = await ethers.getContractFactory("TokenLock")
45 | expect(TokenLockV2).to.not.equal(TokenLock)
46 |
47 | const upgraded = (await upgrades.upgradeProxy(
48 | instance.address,
49 | TokenLockV2
50 | )) as TokenLockT
51 | expect(await upgraded.name()).to.equal("Locked TestToken")
52 | })
53 |
54 | it("cannot be upgraded by others", async () => {
55 | const { token } = await setupTest()
56 | const TokenLock = await ethers.getContractFactory("TokenLock", {
57 | signer: owner,
58 | })
59 |
60 | const instance = (await upgrades.deployProxy(TokenLock, [
61 | owner.address,
62 | token.address,
63 | now + oneWeek,
64 | 2 * oneWeek,
65 | "Locked TestToken",
66 | "LTT",
67 | ])) as TokenLockT
68 |
69 | const TokenLockV2 = await ethers.getContractFactory("TokenLock", {
70 | signer: user,
71 | })
72 |
73 | await expect(
74 | upgrades.upgradeProxy(instance.address, TokenLockV2)
75 | ).to.be.revertedWith("Ownable: caller is not the owner")
76 | })
77 |
78 | it("should revert with NotSupported() if one the unsupported ERC-20 functions is called", async () => {
79 | const { TokenLock, token } = await setupTest()
80 |
81 | const tokenLock = (await upgrades.deployProxy(TokenLock, [
82 | owner.address,
83 | token.address,
84 | now + oneWeek,
85 | 2 * oneWeek,
86 | "Locked TestToken",
87 | "LTT",
88 | ])) as TokenLockT
89 |
90 | await expect(
91 | tokenLock.allowance(user.address, user.address)
92 | ).to.be.revertedWith("NotSupported()")
93 | await expect(tokenLock.approve(user.address, 1000)).to.be.revertedWith(
94 | "NotSupported()"
95 | )
96 | await expect(tokenLock.transfer(user.address, 100)).to.be.revertedWith(
97 | "NotSupported()"
98 | )
99 | await expect(
100 | tokenLock.transferFrom(user.address, user.address, 100)
101 | ).to.be.revertedWith("NotSupported()")
102 | })
103 |
104 | describe("initialize", () => {
105 | it("sets the owner and stores the provided arguments", async () => {
106 | const { TokenLock, token } = await setupTest()
107 |
108 | const tokenLock = (await upgrades.deployProxy(TokenLock, [
109 | owner.address,
110 | token.address,
111 | now + oneWeek,
112 | 2 * oneWeek,
113 | "Locked TestToken",
114 | "LTT",
115 | ])) as TokenLockT
116 |
117 | expect(await tokenLock.owner()).to.equal(owner.address)
118 | expect(await tokenLock.token()).to.equal(token.address)
119 | expect(await tokenLock.depositDeadline()).to.equal(now + oneWeek)
120 | expect(await tokenLock.lockDuration()).to.equal(2 * oneWeek)
121 | expect(await tokenLock.name()).to.equal("Locked TestToken")
122 | expect(await tokenLock.symbol()).to.equal("LTT")
123 | })
124 | })
125 |
126 | describe("deposit()", () => {
127 | it("reverts if the sender has no sufficient balance", async () => {
128 | const { token, TokenLock } = await setupTest()
129 | const tokenLock = (await upgrades.deployProxy(TokenLock, [
130 | owner.address,
131 | token.address,
132 | now + oneWeek,
133 | 2 * oneWeek,
134 | "Locked TestToken",
135 | "LTT",
136 | ])) as TokenLockT
137 |
138 | await expect(
139 | tokenLock.connect(user).deposit(ONE.mul(2))
140 | ).to.be.revertedWith("ERC20: transfer amount exceeds balance")
141 | })
142 |
143 | it("reverts if the sender has not provided sufficient allowance", async () => {
144 | const { token, TokenLock } = await setupTest()
145 | const tokenLock = (await upgrades.deployProxy(TokenLock, [
146 | owner.address,
147 | token.address,
148 | now + oneWeek,
149 | 2 * oneWeek,
150 | "Locked TestToken",
151 | "LTT",
152 | ])) as TokenLockT
153 |
154 | await token.connect(user).approve(tokenLock.address, ONE.div(2))
155 |
156 | await expect(tokenLock.connect(user).deposit(ONE)).to.be.revertedWith(
157 | "ERC20: transfer amount exceeds allowance"
158 | )
159 | })
160 |
161 | it("reverts if the deposit deadline has passed", async () => {
162 | const { token, TokenLock } = await setupTest()
163 | const tokenLock = (await upgrades.deployProxy(TokenLock, [
164 | owner.address,
165 | token.address,
166 | now - oneWeek,
167 | 2 * oneWeek,
168 | "Locked TestToken",
169 | "LTT",
170 | ])) as TokenLockT
171 |
172 | await token.connect(user).approve(tokenLock.address, ONE)
173 |
174 | await expect(tokenLock.connect(user).deposit(ONE)).to.be.revertedWith(
175 | "DepositPeriodOver()"
176 | )
177 | })
178 |
179 | it("reverts if the token transfer is unsuccessful", async () => {
180 | const { TokenLock } = await setupTest()
181 | const FailingToken = await ethers.getContractFactory(
182 | "TestTokenFailingTransferFrom"
183 | )
184 | const failingToken = await FailingToken.deploy(18)
185 | const tokenLock = (await upgrades.deployProxy(TokenLock, [
186 | owner.address,
187 | failingToken.address,
188 | now + oneWeek,
189 | 2 * oneWeek,
190 | "Locked TestToken",
191 | "LTT",
192 | ])) as TokenLockT
193 |
194 | await failingToken.mint(user.address, ONE)
195 | await failingToken.connect(user).approve(tokenLock.address, ONE)
196 |
197 | await expect(tokenLock.connect(user).deposit(ONE)).to.be.revertedWith(
198 | "TransferFailed()"
199 | )
200 | })
201 |
202 | it("transfers the deposited tokens into the lock contract", async () => {
203 | const { token, TokenLock } = await setupTest()
204 | const tokenLock = (await upgrades.deployProxy(TokenLock, [
205 | owner.address,
206 | token.address,
207 | now + oneWeek,
208 | 2 * oneWeek,
209 | "Locked TestToken",
210 | "LTT",
211 | ])) as TokenLockT
212 |
213 | await token.connect(user).approve(tokenLock.address, ONE)
214 |
215 | await expect(() =>
216 | tokenLock.connect(user).deposit(ONE)
217 | ).to.changeTokenBalances(token, [user, tokenLock], [ONE.mul(-1), ONE])
218 | })
219 |
220 | it("mints lock claim tokens to the sender equal to the deposited amount", async () => {
221 | const { token, TokenLock } = await setupTest()
222 | const tokenLock = (await upgrades.deployProxy(TokenLock, [
223 | owner.address,
224 | token.address,
225 | now + oneWeek,
226 | 2 * oneWeek,
227 | "Locked TestToken",
228 | "LTT",
229 | ])) as TokenLockT
230 |
231 | await token.connect(user).approve(tokenLock.address, ONE)
232 |
233 | await expect(() =>
234 | tokenLock.connect(user).deposit(ONE)
235 | ).to.changeTokenBalance(tokenLock, user, ONE)
236 |
237 | expect(await tokenLock.totalSupply()).to.equal(ONE)
238 | })
239 |
240 | it("emits a Transfer event", async () => {
241 | const { token, TokenLock } = await setupTest()
242 | const tokenLock = (await upgrades.deployProxy(TokenLock, [
243 | owner.address,
244 | token.address,
245 | now + oneWeek,
246 | 2 * oneWeek,
247 | "Locked TestToken",
248 | "LTT",
249 | ])) as TokenLockT
250 |
251 | await token.connect(user).approve(tokenLock.address, ONE)
252 |
253 | await expect(tokenLock.connect(user).deposit(ONE))
254 | .to.emit(tokenLock, "Transfer")
255 | .withArgs(user.address, tokenLock.address, ONE)
256 | })
257 | })
258 |
259 | describe("withdraw", () => {
260 | const setupWithLocked = async (weeksSinceLockEnd: number) => {
261 | const { token, TokenLock } = await setupTest()
262 | const tokenLock = (await upgrades.deployProxy(TokenLock, [
263 | owner.address,
264 | token.address,
265 | now + oneWeek,
266 | 2 * oneWeek,
267 | "Locked TestToken",
268 | "LTT",
269 | ])) as TokenLockT
270 |
271 | await token.connect(user).approve(tokenLock.address, ONE)
272 | await tokenLock.connect(user).deposit(ONE)
273 |
274 | await network.provider.send("evm_setNextBlockTimestamp", [
275 | now + 3 * oneWeek + weeksSinceLockEnd * oneWeek,
276 | ])
277 |
278 | return { tokenLock, token }
279 | }
280 |
281 | it("reverts if the lock period is not over yet", async () => {
282 | const { tokenLock } = await setupWithLocked(-1)
283 | await expect(tokenLock.connect(user).withdraw(ONE)).to.be.revertedWith(
284 | "LockPeriodOngoing()"
285 | )
286 | })
287 |
288 | it("reverts if the claimed amount exceeds the balance", async () => {
289 | const { tokenLock } = await setupWithLocked(1)
290 | await expect(
291 | tokenLock.connect(user).withdraw(ONE.mul(2))
292 | ).to.be.revertedWith("ExceedsBalance()")
293 | })
294 |
295 | it("reverts if the token transfer is unsuccessful", async () => {
296 | const { TokenLock } = await setupTest()
297 | const FailingToken = await ethers.getContractFactory(
298 | "TestTokenFailingTransfer"
299 | )
300 | const failingToken = await FailingToken.deploy(18)
301 | const tokenLock = (await upgrades.deployProxy(TokenLock, [
302 | owner.address,
303 | failingToken.address,
304 | now + oneWeek,
305 | 2 * oneWeek,
306 | "Locked TestToken",
307 | "LTT",
308 | ])) as TokenLockT
309 |
310 | await failingToken.mint(user.address, ONE)
311 | await failingToken.connect(user).approve(tokenLock.address, ONE)
312 | await tokenLock.connect(user).deposit(ONE)
313 |
314 | await network.provider.send("evm_setNextBlockTimestamp", [
315 | now + 4 * oneWeek,
316 | ])
317 |
318 | await expect(tokenLock.connect(user).withdraw(ONE)).to.be.revertedWith(
319 | "TransferFailed()"
320 | )
321 | })
322 |
323 | it("transfers the locked token to the sender", async () => {
324 | const { tokenLock, token } = await setupWithLocked(1)
325 |
326 | await expect(() =>
327 | tokenLock.connect(user).withdraw(ONE)
328 | ).to.changeTokenBalance(token, user, ONE)
329 | })
330 |
331 | it("burns the redeemed lock tokens", async () => {
332 | const { tokenLock } = await setupWithLocked(1)
333 |
334 | await expect(() =>
335 | tokenLock.connect(user).withdraw(ONE)
336 | ).to.changeTokenBalance(tokenLock, user, ONE.mul(-1))
337 | expect(await tokenLock.totalSupply()).to.equal(0)
338 | })
339 |
340 | it("emits a Transfer event", async () => {
341 | const { tokenLock } = await setupWithLocked(1)
342 |
343 | await expect(tokenLock.connect(user).withdraw(ONE))
344 | .to.emit(tokenLock, "Transfer")
345 | .withArgs(tokenLock.address, user.address, ONE)
346 | })
347 |
348 | it("allows withdrawals during the deposit period", async () => {
349 | // 2.5 weeks before the lock end, means 0.5 weeks before deposit deadline
350 | const { tokenLock } = await setupWithLocked(-2.5)
351 |
352 | await expect(tokenLock.connect(user).withdraw(ONE))
353 | .to.emit(tokenLock, "Transfer")
354 | .withArgs(tokenLock.address, user.address, ONE)
355 | })
356 | })
357 |
358 | describe("decimals", () => {
359 | it("has the same value as the token that is locked", async () => {
360 | const { TokenLock, Token } = await setupTest()
361 | const tokenWith17Decimals = await Token.deploy(17)
362 | const tokenLock = (await upgrades.deployProxy(TokenLock, [
363 | owner.address,
364 | tokenWith17Decimals.address,
365 | now + oneWeek,
366 | 2 * oneWeek,
367 | "Locked TestToken",
368 | "LTT",
369 | ])) as TokenLockT
370 |
371 | expect(await tokenLock.decimals()).to.equal(17)
372 | })
373 | })
374 |
375 | describe("balanceOf", () => {
376 | it("returns the correct balance for the given address", async () => {
377 | const { token, TokenLock } = await setupTest()
378 | const tokenLock = (await upgrades.deployProxy(TokenLock, [
379 | owner.address,
380 | token.address,
381 | now + oneWeek,
382 | 2 * oneWeek,
383 | "Locked TestToken",
384 | "LTT",
385 | ])) as TokenLockT
386 |
387 | await token.connect(user).approve(tokenLock.address, ONE)
388 | await tokenLock.connect(user).deposit(ONE)
389 |
390 | expect(await tokenLock.balanceOf(user.address)).to.equal(ONE)
391 | })
392 | })
393 | })
394 |
--------------------------------------------------------------------------------
/packages/contracts/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "declaration": true,
4 | "esModuleInterop": true,
5 | "module": "commonjs",
6 | "moduleResolution": "node",
7 | "noEmit": true,
8 | "resolveJsonModule": true,
9 | "skipLibCheck": true,
10 | "strict": true,
11 | "target": "es2020",
12 | "lib": ["es2016"],
13 | "typeRoots": [
14 | "node_modules/@types",
15 | "typings",
16 | "typechain-types/hardhat.d.ts"
17 | ]
18 | },
19 | "include": ["./src", "./test", "./typechain-types"],
20 | "files": ["./hardhat.config.ts"]
21 | }
22 |
--------------------------------------------------------------------------------
/yarn.lock:
--------------------------------------------------------------------------------
1 | # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
2 | # yarn lockfile v1
3 |
4 |
5 | "husky@7.0.4":
6 | "integrity" "sha512-vbaCKN2QLtP/vD4yvs6iz6hBEo6wkSzs8HpRah1Z6aGmF2KW5PdYuAd7uX5a+OyBZHBhd+TFLqgjUgytQr4RvQ=="
7 | "resolved" "https://registry.npmjs.org/husky/-/husky-7.0.4.tgz"
8 | "version" "7.0.4"
9 |
--------------------------------------------------------------------------------