Skip to content

Commit

Permalink
feat: move join operator docs
Browse files Browse the repository at this point in the history
  • Loading branch information
drewstone committed Dec 19, 2024
1 parent 1138ab0 commit 55f5687
Show file tree
Hide file tree
Showing 22 changed files with 16 additions and 72 deletions.
71 changes: 0 additions & 71 deletions pages/developers/gadget-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,77 +2,6 @@

The Blueprint Gadget SDK is a powerful toolkit designed to streamline the development of offchain components for Actively Validated Services (AVS) and Tangle Blueprints. It provides a comprehensive set of features and tools that make building complex multi-party services faster, easier, and more secure.

## Core Value Propositions

import PrettyListDisplay from '../../components/PrettyListDisplay';

<PrettyListDisplay items={[
{
title: "Accelerated Development",
description: "The SDK dramatically speeds up offchain service development by providing:",
subItems: [
{ title: "Pre-built components for common functionality" },
{ title: "Standardized interfaces and patterns" },
{ title: "Rich documentation and examples" },
{ title: "Battle-tested implementations" }
]
},
{
title: "Rich Feature Set",
description: "Developers have access to a comprehensive suite of tools:",
subItems: [
{ title: "Keystores", description: "Secure key management and cryptographic operations w/ ECDSA, ED25519, BLS381, BN254 key types." },
{ title: "Context System", description: "Structured access to onchain data, API services, and common utilities" },
{ title: "P2P Networking", description: "Built-in networking capabilities for distributed systems" },
{ title: "Event Listeners", description: "React to onchain events across multiple chains, cron-jobs, API calls, and more" },
{ title: "Cryptographic Modules", description: "Advanced cryptographic primitives and protocols" }
]
},
{
title: "Standardized Blueprint Runner",
description: "The SDK includes a standardized `BlueprintRunner` that:",
subItems: [
{ title: "Provides a consistent execution runner" },
{ title: "Makes distribution to operators simple and reliable" },
{ title: "Handles job scheduling and management" },
{ title: "Implements standard monitoring and logging" }
]
},
{
title: "Streamlined Operations",
description: "The SDK simplifies the operational aspects of running services:",
subItems: [
{ title: "Easy deployment workflows" },
{ title: "Built-in monitoring and metrics" },
{ title: "Comprehensive documentation" },
{ title: "Standard operational procedures" }
]
},
{
title: "Network Effects",
description: "As more developers adopt the SDK:",
subItems: [
{ title: "The codebase becomes more battle-tested" },
{ title: "Operators gain confidence in running Blueprint services" },
{ title: "Developers can leverage shared components and libraries" },
{ title: "Improvements benefit the entire ecosystem" },
{ title: "Best practices emerge and evolve" }
]
},
{
title: "Blueprint Templates",
description: "Ready-to-use templates for common use cases:",
subItems: [
{ title: "Obol DVT Blueprint", description: "Distributed validator cluster implementation", href: "https://github.com/tangle-network/obol-dvt-blueprint" },
{ title: "TLS Notary Blueprint", description: "Zero-knowledge TLS proofs", href: "https://github.com/tangle-network/tls-notary-blueprint" },
{ title: "FROST Blueprint", description: "Threshold Schnorr signatures using FROST protocol", href: "https://github.com/tangle-network/frost-blueprint" },
{ title: "Hyperlane Blueprint", description: "Hyperlane bridges as a service", href: "https://github.com/tangle-network/hyperlane-blueprint-template" },
{ title: "LayerZero DVN Blueprint", description: "Decentralized Verifier Network for LayerZero", href: "https://github.com/tangle-network/layerzero-dvn-blueprint" },
{ title: "LayerZero Executor Blueprint", description: "LayerZero Executor implementation", href: "https://github.com/tangle-network/layerzero-executor-blueprint-template" }
]
}
]} />

## Getting Started

import TableOfContentCards from "../../components/TableOfContentCards.tsx"
Expand Down
13 changes: 13 additions & 0 deletions pages/operators/_meta.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
{
"-- introduction": {
"type": "separator",
"title": "Introduction"
},
"introduction": "Get Started",
"node-basics": "Node Basics",
"validator": "Running a Validator",
"monitoring": "Node Monitoring",
"-- Tangle Blueprint Operators": {
"type": "separator",
"title": "Blueprint Operators"
},
"operator": "Running an operator",
"-- Eigenlayer AVS Operators": {
"type": "separator",
"title": "Eigenlayer AVS Operators"
},
"tangle-avs": "Tangle AVS"
}
3 changes: 3 additions & 0 deletions pages/operators/operator/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"join_operator": "Join as an Operator"
}
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 0 additions & 1 deletion pages/restake/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
},
"restake-introduction": "Tangle Restaking",
"incentives": "Incentives",
"join_operator": "Operator Docs",
"how_to_restake": "How to Restake on Tangle",
"restake_developers": "Developer Docs",
"-- liquid staking": {
Expand Down

0 comments on commit 55f5687

Please sign in to comment.