Skip to content

revamp cct concept docs #2822

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.

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
wants to merge 17 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
102 changes: 102 additions & 0 deletions public/images/ccip/cct/cct-svm-diagrams/burnmint-pool-anatomy.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
102 changes: 102 additions & 0 deletions public/images/ccip/cct/cct-svm-diagrams/lockrelease-pool-anatomy.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
102 changes: 102 additions & 0 deletions public/images/ccip/cct/cct-svm-diagrams/solana_cct_flowchart.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 6 additions & 2 deletions src/components/Tabs/Tabs.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,12 @@ type Props = {
}

export function Tabs({ sharedStore, ...slots }: Props) {
const tabs = Object.entries(slots).filter(isTabSlotEntry)
const panels = Object.entries(slots).filter(isPanelSlotEntry)
const tabs = Object.entries(slots)
.filter(isTabSlotEntry)
.sort(([a], [b]) => a.localeCompare(b))
const panels = Object.entries(slots)
.filter(isPanelSlotEntry)
.sort(([a], [b]) => a.localeCompare(b))

/** Used to focus next and previous tab on arrow key press */
const tabButtonRefs = useRef<Record<TabSlot, HTMLButtonElement | null>>({})
Expand Down
26 changes: 20 additions & 6 deletions src/config/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { SIDEBAR_SECTIONS } from "./sidebarSections.ts"
import evmCcipV150Contents from "./sidebar/ccip/api-reference/evm/v1_5_0.json" with { type: "json" }
import evmCcipV151Contents from "./sidebar/ccip/api-reference/evm/v1_5_1.json" with { type: "json" }
import evmCcipV160Contents from "./sidebar/ccip/api-reference/evm/v1_6_0.json" with { type: "json" }
import svmCcipV160Contents from "./sidebar/ccip/api-reference/svm/v1_6_0.json" with { type: "json" }
import svmCcipV011Contents from "./sidebar/ccip/api-reference/svm/v0_1_1.json" with { type: "json" }
import chainlinkLocalV021Contents from "./sidebar/chainlink-local/api-reference/v0_2_1.json" with { type: "json" }
import chainlinkLocalV022Contents from "./sidebar/chainlink-local/api-reference/v0_2_2.json" with { type: "json" }
import chainlinkLocalV023Contents from "./sidebar/chainlink-local/api-reference/v0_2_3.json" with { type: "json" }
Expand Down Expand Up @@ -1280,6 +1280,10 @@ export const SIDEBAR: Partial<Record<Sections, SectionEntry[]>> = {
title: "SVM",
url: "ccip/concepts/cross-chain-token/svm",
children: [
{
title: "Architecture",
url: "ccip/concepts/cross-chain-token/svm/architecture",
},
{
title: "Tokens",
url: "ccip/concepts/cross-chain-token/svm/tokens",
Expand All @@ -1289,8 +1293,8 @@ export const SIDEBAR: Partial<Record<Sections, SectionEntry[]>> = {
url: "ccip/concepts/cross-chain-token/svm/token-pools",
},
{
title: "Architecture",
url: "ccip/concepts/cross-chain-token/svm/architecture",
title: "Integration Guide",
url: "ccip/concepts/cross-chain-token/svm/integration-guide",
},
{
title: "Registration and Administration",
Expand Down Expand Up @@ -1489,6 +1493,16 @@ export const SIDEBAR: Partial<Record<Sections, SectionEntry[]>> = {
{
title: "Cross-Chain Token (CCT) standard",
url: "ccip/tutorials/svm/cross-chain-tokens",
children: [
{
title: "BurnMint: Direct Mint Authority Transfer",
url: "ccip/tutorials/svm/cross-chain-tokens/direct-mint-authority",
},
{
title: "BurnMint: SPL Token Multisig Tutorial",
url: "ccip/tutorials/svm/cross-chain-tokens/spl-token-multisig-tutorial",
},
],
},
],
},
Expand Down Expand Up @@ -1538,10 +1552,10 @@ export const SIDEBAR: Partial<Record<Sections, SectionEntry[]>> = {
url: "ccip/api-reference/svm",
children: [
{
title: "v1.6.0 (Latest)",
url: "ccip/api-reference/svm/v1.6.0",
title: "v0.1.1 (Latest)",
url: "ccip/api-reference/svm/v0.1.1",
isCollapsible: true,
children: svmCcipV160Contents,
children: svmCcipV011Contents,
},
],
},
Expand Down
34 changes: 34 additions & 0 deletions src/config/sidebar/ccip/api-reference/svm/v0_1_1.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
[
{
"title": "Messages",
"url": "ccip/api-reference/svm/v0.1.1/messages"
},
{
"title": "Router",
"url": "ccip/api-reference/svm/v0.1.1/router"
},
{
"title": "Receiver",
"url": "ccip/api-reference/svm/v0.1.1/receiver"
},
{
"title": "Base Token Pool Library",
"url": "ccip/api-reference/svm/v0.1.1/base-token-pool"
},
{
"title": "BurnMint Token Pool",
"url": "ccip/api-reference/svm/v0.1.1/burn-mint-token-pool"
},
{
"title": "Lock-Release Token Pool",
"url": "ccip/api-reference/svm/v0.1.1/lock-release-token-pool"
},
{
"title": "Errors",
"url": "ccip/api-reference/svm/v0.1.1/errors"
},
{
"title": "Events",
"url": "ccip/api-reference/svm/v0.1.1/events"
}
]
22 changes: 0 additions & 22 deletions src/config/sidebar/ccip/api-reference/svm/v1_6_0.json

This file was deleted.

6 changes: 3 additions & 3 deletions src/config/versions/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ export const VERSIONS = {
},
},
svm: {
LATEST: "v1.6.0",
ALL: ["v1.6.0"] as const,
LATEST: "v0.1.1",
ALL: ["v0.1.1"] as const,
RELEASE_DATES: {
"v1.6.0": "2025-05-19T00:00:00Z", // 19 May 2025
"v0.1.1": "2023-10-04T00:00:00Z", // Placeholder release date – update when known
},
},
// Default for backward compatibility
Expand Down
Loading
Loading