Skip to content

Update docs and API refs for modular protocol #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
drewstone wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Update docs and API refs for modular protocol #134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d133778
Update operator docs and API refs for modular protocol
drewstone Dec 21, 2025
44d68d0
docs: align tnt-core links to v2
drewstone Dec 21, 2025
b890e4f
docs: migrate to Tangle EVM
drewstone Dec 21, 2025
1e1156f
docs: document snapshot verification
drewstone Dec 21, 2025
836eb03
docs: clarify operator onboarding flow
drewstone Dec 23, 2025
ad5514c
docs: add sandbox provisioning guide
drewstone Dec 23, 2025
e571159
docs: emphasize systemd sandbox setup
drewstone Dec 23, 2025
09d581c
docs: add sandbox checklist to onboarding
drewstone Dec 23, 2025
a6613df
docs: rename Tangle protocol references
drewstone Dec 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
</div>

<p align="left">
<strong>🚀 Official Documentation of the Tangle Network 🚀 </strong>
<strong>Official Documentation for Tangle</strong>
</p>

<!-- Badges -->
Expand All @@ -14,7 +14,7 @@

❗ **Note:** This is a fork of [Vercel Docs](https://github.com/vercel/turbo/tree/main/docs).

This repository serves as the **documentation** for the **[Tangle Network](https://www.tangle.tools/)** . The docs are written in [MDX](https://mdxjs.com/) format an extension of [markdown](https://www.markdownguide.org/), processed by [Nextra](https://github.com/shuding/nextra/tree/main), and published to Tangle Docs. For support on using Nextra see [https://nextra.site/docs].(https://nextra.site/docs)
This repository serves as the documentation for **[Tangle](https://www.tangle.tools/)**. The docs are written in [MDX](https://mdxjs.com/) (an extension of Markdown), processed by [Nextra](https://github.com/shuding/nextra/tree/main), and published to Tangle Docs. For Nextra help, see https://nextra.site/docs

### Directory structure

Expand Down Expand Up @@ -86,7 +86,7 @@ navigation.

<h2 id="contribute"> Contributing </h2>

Interested in contributing to the Tangle Network Documentation? Thank you so much for your interest! We are always appreciative for contributions from the open-source community!
Interested in contributing to the Tangle documentation? Thank you for your interest — we appreciate contributions from the open-source community.

If you have a contribution in mind, please check out our [Contribution Guide](./.github/CONTRIBUTING.md) for information on how to do so. We are excited for your first contribution! If you have any further questions, please do not hesitate to reach out on our [Tangle Discord channel](https://discord.com/invite/cv8EfJu3Tn)! We would love to get to know you and your work!

Expand Down
333 changes: 112 additions & 221 deletions components/AllocationTable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,240 +1,131 @@
import React, { ReactNode } from "react";
import React from "react";

interface HeaderCellProps {
children: ReactNode;
}

const HeaderCell = ({ children }: HeaderCellProps) => (
<th className="py-2 px-3 bg-gray-100 font-semibold border border-gray-300 dark:bg-gray-700 dark:border-gray-600 whitespace-nowrap">
{children}
</th>
);
type Bucket = {
label: string;
amountTnt: number;
mechanism: string;
claimable: string;
launchLiquidity: string;
};

interface CellProps {
children: ReactNode;
}
const TOTAL_TNT = 109_255_636.919212;

const Cell = ({ children }: CellProps) => (
<td className="py-2 px-3 border border-gray-300 dark:border-gray-600 whitespace-nowrap">
{children}
</td>
);
const BUCKETS: Bucket[] = [
{
label: "Substrate migration claims (SS58)",
amountTnt: 51_244_581.812207,
mechanism: "Merkle + ZK claim (TangleMigration)",
claimable: "Yes",
launchLiquidity: "Default: 10% unlocked / 90% cliff-locked",
},
{
label: "EVM claims (0x...)",
amountTnt: 1_125_776.519168,
mechanism: "Batch distribution",
claimable: "No (sent to recipients)",
launchLiquidity: "As configured for the distribution",
},
{
label: "Treasury carveout (legacy module accounts)",
amountTnt: 41_844_468.761091,
mechanism: "Deploy-time transfer to treasury recipient",
claimable: "No",
launchLiquidity: "Fully liquid at launch",
},
{
label: "Foundation carveout (tangle-foundation)",
amountTnt: 15_040_809.826744,
mechanism: "Deploy-time transfer to foundation recipient",
claimable: "No",
launchLiquidity: "Fully liquid at launch",
},
];

interface RowProps {
children: ReactNode;
isEven: boolean;
}
const TNT_FORMAT = new Intl.NumberFormat("en-US", {
minimumFractionDigits: 6,
maximumFractionDigits: 6,
});

const Row = ({ children, isEven }: RowProps) => (
<tr
className={`border-b ${
isEven ? "bg-gray-100 dark:bg-gray-700" : "dark:bg-gray-800"
}`}
>
{children}
</tr>
);
const PCT_FORMAT = new Intl.NumberFormat("en-US", {
minimumFractionDigits: 2,
maximumFractionDigits: 2,
});

interface SubtotalRowProps {
children: ReactNode;
function formatTnt(value: number): string {
return TNT_FORMAT.format(value);
}

const SubtotalRow = ({ children }: SubtotalRowProps) => (
<tr className="bg-blue-100 font-semibold dark:bg-blue-900 dark:text-blue-300">
{children}
</tr>
);

interface TotalRowProps {
children: ReactNode;
function formatPercent(value: number, total: number): string {
if (total === 0) return "0.00%";
return `${PCT_FORMAT.format((value / total) * 100)}%`;
}

const TotalRow = ({ children }: TotalRowProps) => (
<tr className="bg-green-100 font-semibold dark:bg-green-900 dark:text-green-300">
{children}
</tr>
);

export default function AllocationTable() {
return (
<div className="overflow-x-auto m-5">
<div className="overflow-x-auto my-6">
<table className="w-full border-collapse text-left text-sm text-gray-800 dark:text-gray-300">
<thead>
<TotalRow>
<HeaderCell>Allocation Category</HeaderCell>
<HeaderCell>Entity Name</HeaderCell>
<HeaderCell>Allocated Share (%)</HeaderCell>
<HeaderCell>Vesting Plan</HeaderCell>
<HeaderCell>Cliff (Months)</HeaderCell>
<HeaderCell>Vesting Period (Months)</HeaderCell>
<HeaderCell>Immediate Liquidity (%)</HeaderCell>
<HeaderCell>Initial Liquid Tokens</HeaderCell>
<HeaderCell>Cliff-Release Tokens</HeaderCell>
<HeaderCell>Monthly Vesting Rate</HeaderCell>
<HeaderCell>Total Tokens Allocated</HeaderCell>
</TotalRow>
<tr className="bg-gray-100 font-semibold dark:bg-gray-800">
<th className="py-2 px-3 border border-gray-300 dark:border-gray-700">
Bucket
</th>
<th className="py-2 px-3 border border-gray-300 dark:border-gray-700">
Amount (TNT)
</th>
<th className="py-2 px-3 border border-gray-300 dark:border-gray-700">
% of Total
</th>
<th className="py-2 px-3 border border-gray-300 dark:border-gray-700">
Mechanism
</th>
<th className="py-2 px-3 border border-gray-300 dark:border-gray-700">
Claimable
</th>
<th className="py-2 px-3 border border-gray-300 dark:border-gray-700">
Launch Liquidity
</th>
</tr>
</thead>
<tbody>
<Row isEven={false}>
<Cell>Contributors</Cell>
<Cell>Webb Technologies (Developer)</Cell>
<Cell>28.56500%</Cell>
<Cell>A-Vesting</Cell>
<Cell>12</Cell>
<Cell>48</Cell>
<Cell>0%</Cell>
<Cell>0.00</Cell>
<Cell>7,141,250.00</Cell>
<Cell>595,104.17</Cell>
<Cell>28,565,000.00</Cell>
</Row>
<Row isEven={true}>
<Cell>Contributors</Cell>
<Cell>Investors</Cell>
<Cell>13.64000%</Cell>
<Cell>A-Vesting</Cell>
<Cell>12</Cell>
<Cell>48</Cell>
<Cell>0%</Cell>
<Cell>0.00</Cell>
<Cell>3,410,000.00</Cell>
<Cell>284,166.67</Cell>
<Cell>13,640,000.00</Cell>
</Row>
<Row isEven={false}>
<Cell>Contributors</Cell>
<Cell>Indiv. Contributors</Cell>
<Cell>1.43500%</Cell>
<Cell>A-Vesting</Cell>
<Cell>12</Cell>
<Cell>48</Cell>
<Cell>0%</Cell>
<Cell>0.00</Cell>
<Cell>358,750.00</Cell>
<Cell>29,895.83</Cell>
<Cell>1,435,000.00</Cell>
</Row>
<SubtotalRow>
<Cell col-span={2}>
<strong>Contributors Total</strong>
</Cell>
<Cell>43.64000%</Cell>
<td colSpan={4}></td>
<Cell>0.00</Cell>
<Cell>10,910,000.00</Cell>
<td colSpan={1}></td>
<Cell>43,640,000.00</Cell>
</SubtotalRow>
<Row isEven={true}>
<Cell>Governance-Managed</Cell>
<Cell>On-chain Treasury</Cell>
<Cell>36.36000%</Cell>
<Cell>n/a</Cell>
<Cell>n/a</Cell>
<Cell>n/a</Cell>
<Cell>100%</Cell>
<Cell>36,360,000.00</Cell>
<Cell>n/a</Cell>
<Cell>n/a</Cell>
<Cell>36,360,000.00</Cell>
</Row>
<Row isEven={false}>
<Cell>Governance-Managed</Cell>
<Cell>Foundation</Cell>
<Cell>15.00000%</Cell>
<Cell>A-Vesting</Cell>
<Cell>12</Cell>
<Cell>48</Cell>
<Cell>5%</Cell>
<Cell>750,000.00</Cell>
<Cell>3,562,500.00</Cell>
<Cell>296,875.00</Cell>
<Cell>15,000,000.00</Cell>
</Row>
<SubtotalRow>
<Cell col-span={2}>
<strong>Governance-Managed Total</strong>
</Cell>
<Cell>51.36000%</Cell>
<td colSpan={4}></td>
<Cell>37,110,000.00</Cell>
<Cell>3,562,500.00</Cell>
<td colSpan={1}></td>
<Cell>51,360,000.00</Cell>
</SubtotalRow>
<Row isEven={true}>
<Cell>Airdrop Pool</Cell>
<Cell>Leaderboard Participants</Cell>
<Cell>2.00000%</Cell>
<Cell>B-Vesting</Cell>
<Cell>1</Cell>
<Cell>24</Cell>
<Cell>5%</Cell>
<Cell>100,000.00</Cell>
<Cell>79,166.67</Cell>
<Cell>82,608.70</Cell>
<Cell>2,000,000.00</Cell>
</Row>
<Row isEven={false}>
<Cell>Airdrop Pool</Cell>
<Cell>DOT Validators Snapshot</Cell>
<Cell>1.00000%</Cell>
<Cell>B-Vesting</Cell>
<Cell>1</Cell>
<Cell>24</Cell>
<Cell>5%</Cell>
<Cell>50,000.00</Cell>
<Cell>39,583.33</Cell>
<Cell>41,304.35</Cell>
<Cell>1,000,000.00</Cell>
</Row>
<Row isEven={true}>
<Cell>Airdrop Pool</Cell>
<Cell>EDG Genesis Participants</Cell>
<Cell>1.00000%</Cell>
<Cell>B-Vesting</Cell>
<Cell>1</Cell>
<Cell>24</Cell>
<Cell>5%</Cell>
<Cell>50,000.00</Cell>
<Cell>39,583.33</Cell>
<Cell>41,304.35</Cell>
<Cell>1,000,000.00</Cell>
</Row>
<Row isEven={false}>
<Cell>Airdrop Pool</Cell>
<Cell>EDG 2023 Snapshot</Cell>
<Cell>1.00000%</Cell>
<Cell>B-Vesting</Cell>
<Cell>1</Cell>
<Cell>24</Cell>
<Cell>5%</Cell>
<Cell>50,000.00</Cell>
<Cell>39,583.33</Cell>
<Cell>41,304.35</Cell>
<Cell>1,000,000.00</Cell>
</Row>
<SubtotalRow>
<Cell col-span={2}>
<strong>Airdrop Pools Total</strong>
</Cell>
<Cell>5.00000%</Cell>
<td colSpan={4}></td>
<Cell>250,000.00</Cell>
<Cell>197,916.67</Cell>
<Cell>206,521.74</Cell>
<Cell>5,000,000.00</Cell>
</SubtotalRow>
<TotalRow>
<Cell col-span={2}>
<strong>Total Supply</strong>
</Cell>
<Cell>100.00000%</Cell>
<td colSpan={4}></td>
<Cell>37,360,000.00</Cell>
<td colSpan={2}></td>
<Cell>100,000,000.00</Cell>
</TotalRow>
{BUCKETS.map((b) => (
<tr key={b.label} className="border-b dark:border-gray-700">
<td className="py-2 px-3 border border-gray-300 dark:border-gray-700">
{b.label}
</td>
<td className="py-2 px-3 border border-gray-300 dark:border-gray-700 whitespace-nowrap">
{formatTnt(b.amountTnt)}
</td>
<td className="py-2 px-3 border border-gray-300 dark:border-gray-700 whitespace-nowrap">
{formatPercent(b.amountTnt, TOTAL_TNT)}
</td>
<td className="py-2 px-3 border border-gray-300 dark:border-gray-700">
{b.mechanism}
</td>
<td className="py-2 px-3 border border-gray-300 dark:border-gray-700">
{b.claimable}
</td>
<td className="py-2 px-3 border border-gray-300 dark:border-gray-700">
{b.launchLiquidity}
</td>
</tr>
))}
<tr className="bg-gray-100 font-semibold dark:bg-gray-800">
<td className="py-2 px-3 border border-gray-300 dark:border-gray-700">
Total
</td>
<td className="py-2 px-3 border border-gray-300 dark:border-gray-700 whitespace-nowrap">
{formatTnt(TOTAL_TNT)}
</td>
<td className="py-2 px-3 border border-gray-300 dark:border-gray-700">
100.00%
</td>
<td
className="py-2 px-3 border border-gray-300 dark:border-gray-700"
colSpan={3}
>
Snapshot-distributed TNT (migration + carveouts)
</td>
</tr>
</tbody>
</table>
</div>
Expand Down
Loading
Loading