From aee4bceffb5e5c1ef3873b26b605a363744bbe08 Mon Sep 17 00:00:00 2001 From: Taha Abbasi Date: Wed, 7 Sep 2022 06:28:08 +0000 Subject: [PATCH 1/4] GitBook: [#22] No subject From 1160e7669d063e01cdef95db26e0e069cc97f9cb Mon Sep 17 00:00:00 2001 From: Taha Abbasi Date: Tue, 25 Oct 2022 20:43:31 +0000 Subject: [PATCH 2/4] GitBook: [#23] No subject --- README.md | 5 ++--- SUMMARY.md | 5 ----- introduction/iron-vest/README.md | 21 ------------------- ...ear-release-with-a-cliff-or-lock-period.md | 6 ------ ...inear-release-with-custom-release-rates.md | 7 ------- .../iron-vest/team-token-administration.md | 5 ----- introduction/iron-vest/time-based-vesting.md | 3 --- introduction/overview/problem-and-solution.md | 7 ++++--- .../overview/the-linear-release-engine.md | 4 ++++ 9 files changed, 10 insertions(+), 53 deletions(-) delete mode 100644 introduction/iron-vest/README.md delete mode 100644 introduction/iron-vest/linear-release-with-a-cliff-or-lock-period.md delete mode 100644 introduction/iron-vest/linear-release-with-custom-release-rates.md delete mode 100644 introduction/iron-vest/team-token-administration.md delete mode 100644 introduction/iron-vest/time-based-vesting.md diff --git a/README.md b/README.md index 51697d7..453a090 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,7 @@ --- description: >- - Vesting done right, powered by Ferrum's Linear Release Engine. A modular - solution that can be used for invested, advisory, team tokens and even staking - or farming rewards. + A powerful engine enabling a per-second release rate of tokens for vesting, + rewards, staking, farming, and so much more. --- # ⚖ Linear Release Engine diff --git a/SUMMARY.md b/SUMMARY.md index 35100c7..2176079 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -7,8 +7,3 @@ * [📝 Overview](introduction/overview.md) * [Problem and Solution](introduction/overview/problem-and-solution.md) * [The Linear Release Engine](introduction/overview/the-linear-release-engine.md) -* [💰 Iron Vest](introduction/iron-vest/README.md) - * [Time-Based Vesting](introduction/iron-vest/time-based-vesting.md) - * [Linear Release with Custom Release Rates](introduction/iron-vest/linear-release-with-custom-release-rates.md) - * [Linear Release with a Cliff or Lock Period](introduction/iron-vest/linear-release-with-a-cliff-or-lock-period.md) - * [Team Token Administration](introduction/iron-vest/team-token-administration.md) diff --git a/introduction/iron-vest/README.md b/introduction/iron-vest/README.md deleted file mode 100644 index b748747..0000000 --- a/introduction/iron-vest/README.md +++ /dev/null @@ -1,21 +0,0 @@ -# 💰 Iron Vest - -### What is Iron Vest? - -Iron Vest is the first implementation powered by the Linear Release Engine. Iron Vest allows you to launch a Vesting Contract and set up custom pools with our without a cliff. Here is a detailed list of features for Iron Vest: - -{% content-ref url="time-based-vesting.md" %} -[time-based-vesting.md](time-based-vesting.md) -{% endcontent-ref %} - -{% content-ref url="linear-release-with-custom-release-rates.md" %} -[linear-release-with-custom-release-rates.md](linear-release-with-custom-release-rates.md) -{% endcontent-ref %} - -{% content-ref url="linear-release-with-a-cliff-or-lock-period.md" %} -[linear-release-with-a-cliff-or-lock-period.md](linear-release-with-a-cliff-or-lock-period.md) -{% endcontent-ref %} - -{% content-ref url="team-token-administration.md" %} -[team-token-administration.md](team-token-administration.md) -{% endcontent-ref %} diff --git a/introduction/iron-vest/linear-release-with-a-cliff-or-lock-period.md b/introduction/iron-vest/linear-release-with-a-cliff-or-lock-period.md deleted file mode 100644 index 32448af..0000000 --- a/introduction/iron-vest/linear-release-with-a-cliff-or-lock-period.md +++ /dev/null @@ -1,6 +0,0 @@ -# Linear Release with a Cliff or Lock Period - -Set a pool with linear release and a cliff or lock period - -1. This setup includes all options of [Linear Release with Custom Release Rates](linear-release-with-custom-release-rates.md) with the addition of cliff or lock period -2. Choose if the cliff period tokens will be released at once upon the arrival of the lock period end date or if they will be released linearly over a period of time by setting `clifVestingDays` and `cliffVestingReleaseRate` diff --git a/introduction/iron-vest/linear-release-with-custom-release-rates.md b/introduction/iron-vest/linear-release-with-custom-release-rates.md deleted file mode 100644 index 16e8a57..0000000 --- a/introduction/iron-vest/linear-release-with-custom-release-rates.md +++ /dev/null @@ -1,7 +0,0 @@ -# Linear Release with Custom Release Rates - -Set a pool with linear release with custom release rates per second. e.g. - -1. Set Vesting Term (Length of Vesting in days) `vestingDays` -2. Set Vesting Release Rate (Rate at which tokens are released to be claimed) `vestingReleaseRate` -3. Upload Vesting Withdrawal Addresses and Amounts for each allocated address diff --git a/introduction/iron-vest/team-token-administration.md b/introduction/iron-vest/team-token-administration.md deleted file mode 100644 index 3c08032..0000000 --- a/introduction/iron-vest/team-token-administration.md +++ /dev/null @@ -1,5 +0,0 @@ -# Team Token Administration - -Set team token vesting with special administrative controls - -1. With team tokens, the inability to stop vesting if a team member leaves the project before meeting their commitments is a serious problem. This causes projects to handle team token vesting manually or lose a significant chunk of the allocated tokens to individuals no longer contributing to the growth of the organization. With administrative controls for team token vesting, the authorized party can update the vesting period through a multi-sig process. diff --git a/introduction/iron-vest/time-based-vesting.md b/introduction/iron-vest/time-based-vesting.md deleted file mode 100644 index bd0f52d..0000000 --- a/introduction/iron-vest/time-based-vesting.md +++ /dev/null @@ -1,3 +0,0 @@ -# Time-Based Vesting - -Set a pool with traditional time-based vesting i.e. 1 month lock, 10% a month for 10 months diff --git a/introduction/overview/problem-and-solution.md b/introduction/overview/problem-and-solution.md index c0f5243..895d917 100644 --- a/introduction/overview/problem-and-solution.md +++ b/introduction/overview/problem-and-solution.md @@ -10,12 +10,13 @@ When you review the currently available solutions, you find one or more of the f 2. Not providing the option for linear release, only giving option for release date based vesting 3. Not providing the option for a cliff or lock period with the linear release option 4. Not providing the option for linear release of the cliff or locked period tokens -5. No ability to administer necessary updates on token categories such as team tokens +5. No ability to administer necessary updates on token categories, such as team tokens +6. No ability to connect linear release to reward contracts such as staking, farming, and more. With our Linear Release Engine, Ferrum has set out to solve each one of these problems and bring more value to the space. ### Our Solution - Linear Release Engine -We built a modular Linear Release Engine to solve the issues identified above and to enable extensibility so the open source community and developers around the world can build their own implementations powered by Ferrum's Linear Release Engine. +We built a modular Linear Release Engine to solve the issues identified above and to enable extensibility so the open-source community and developers around the world can build their own implementations powered by Ferrum's Linear Release Engine. -Linear Release Engine makes it possible to build products like Iron Vest which can solve real-world problems with token release schedules and mitigate the sell pressure caused by staking, farming, and mining rewards or vesting token release dates. +Linear Release Engine makes it possible to build products like Iron Vest, which can solve real-world problems with token release schedules and mitigate the sell pressure caused by staking, farming, and mining rewards or vesting token release dates. diff --git a/introduction/overview/the-linear-release-engine.md b/introduction/overview/the-linear-release-engine.md index bcc8d84..e62e6d2 100644 --- a/introduction/overview/the-linear-release-engine.md +++ b/introduction/overview/the-linear-release-engine.md @@ -3,3 +3,7 @@ ### What is the Linear Release Engine? The Linear Release Engine is a modular implementation that allows you to configure the release of ERC20 assets with limitless built-in customizations. To explain the full power of the Linear Release Engine we have created the Iron Vest product powered by the Linear Release Engine. Let's go over all the features of the Iron Vest. + +{% content-ref url="https://app.gitbook.com/o/4kmBmwCSGs18VyCPwcJE/s/sqX9RCXpejkUPhm0z3wi/" %} +[Iron Vest](https://app.gitbook.com/o/4kmBmwCSGs18VyCPwcJE/s/sqX9RCXpejkUPhm0z3wi/) +{% endcontent-ref %} From 6840baf56a5fc967072c57334a0010dfaabc0323 Mon Sep 17 00:00:00 2001 From: Taha Abbasi Date: Fri, 28 Oct 2022 15:24:39 +0000 Subject: [PATCH 3/4] GitBook: [#24] Ferrum Network - IRONVEST - Audit by Vidma (Oct 24, 2022) --- SUMMARY.md | 1 + introduction/audited-by-vidma.md | 5 +++++ 2 files changed, 6 insertions(+) create mode 100644 introduction/audited-by-vidma.md diff --git a/SUMMARY.md b/SUMMARY.md index 2176079..84fcd39 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -7,3 +7,4 @@ * [📝 Overview](introduction/overview.md) * [Problem and Solution](introduction/overview/problem-and-solution.md) * [The Linear Release Engine](introduction/overview/the-linear-release-engine.md) +* [🔏 Audited by Vidma](introduction/audited-by-vidma.md) diff --git a/introduction/audited-by-vidma.md b/introduction/audited-by-vidma.md new file mode 100644 index 0000000..672ef5b --- /dev/null +++ b/introduction/audited-by-vidma.md @@ -0,0 +1,5 @@ +# 🔏 Audited by Vidma + +{% embed url="https://drive.google.com/file/d/1atppspahsiNsnUP0IbBZCqZ6xot2mEhL/view?usp=sharing" %} +Ferrum Network - IRONVEST - Audit by Vidma (Oct 24, 2022) +{% endembed %} From 11d8b82e3e118c8b51be72a706fc79d3d2e7034c Mon Sep 17 00:00:00 2001 From: Taha Abbasi Date: Fri, 28 Oct 2022 15:26:56 +0000 Subject: [PATCH 4/4] GitBook: [#25] No subject --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 453a090..745ca85 100644 --- a/README.md +++ b/README.md @@ -9,3 +9,7 @@ description: >- At Ferrum, we pride ourselves on creating solutions that add value to the industry by solving critical pain points. We've done this in the past with our staking solutions, bridging solutions, MultiSwap, and more. Now we are bringing the same methodical approach to vesting, staking rewards, and more. The Linear Release Engine helps avoid sell pressure and dump days while giving the community, investors and advisors access to tokens on a per-second basis instead of waiting for months to get access to their tokens. + +{% content-ref url="introduction/audited-by-vidma.md" %} +[audited-by-vidma.md](introduction/audited-by-vidma.md) +{% endcontent-ref %}