8000 GitHub - bolajahmad/fiber-watchtower-sdk: Fiber Watchtower Protocol (FWP): A standardized application-to-watchtower protocol, reference server, and SDK that enables interoperable standalone watchtower implementations while remaining fully compatible with Fiber's embedded WatchtowerActor. · GitHub
[go: up one dir, main page]

Skip to content

About

Fiber Watchtower Protocol (FWP): A standardized application-to-watchtower protocol, reference server, and SDK that enables interoperable standalone watchtower implementations while remaining fully compatible with Fiber's embedded WatchtowerActor.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

1 Commit

Folders and files

Repository files navigation

Fiber Watchtower SDK

A standardized Rust SDK and protocol for integrating any Fiber application with any Fiber watchtower implementation.

Mission

The SDK provides an integration interface—not a watchtower implementation itself. It serves as the reference implementation of the Fiber Watchtower Protocol (FWP).

Non-goals

We are NOT building:

  • ❌ A watchtower
  • ❌ A Fiber node
  • ❌ A CKB node
  • ❌ Monitoring logic
  • ❌ Penalty logic
  • ❌ Gossip logic

These belong to Fiber.

What We Are Building

  • ✅ Protocol specification
  • ✅ Rust SDK
  • ✅ Adapters (Fiber, Mock)
  • ✅ Mock backend for testing
  • ✅ Examples and CLI
  • ✅ Integration tests

Project Structure

fiber-watchtower-sdk/
├── crates/
│   ├── protocol/      # Core protocol types
│   ├── types/         # Shared types
│   ├── transport/     # Transport abstraction
│   ├── server/        # Service traits
│   ├── client/        # Public SDK
│   ├── adapter-fiber/ # Fiber RPC adapter
│   ├── adapter-mock/  # In-memory mock
│   └── cli/           # CLI tool
├── examples/          # Runnable examples
├── docs/              # Documentation
└── tests/             # Integration & E2E tests

Quick Start

Building

cargo build

Running Tests

cargo test

Running Examples

# Wallet example
cargo run --example wallet

# Merchant example
cargo run --example merchant

# Mock server (interactive demo)
cargo run --example mock-server

# Subscriber
cargo run --example subscriber

CLI

watchtower register
watchtower login
watchtower watch
watchtower events
watchtower status

Documentation

Development

Using just

Common tasks:

just test       # Run tests
just fmt        # Format code
just lint       # Run clippy
just demo       # Run mock-server example

Tooling

Required components:

cargo install cargo-nextest
cargo install cargo-watch
cargo install cargo-deny
cargo install cargo-audit
cargo install bacon
cargo install just

License

MIT

About

Fiber Watchtower Protocol (FWP): A standardized application-to-watchtower protocol, reference server, and SDK that enables interoperable standalone watchtower implementations while remaining fully compatible with Fiber's embedded WatchtowerActor.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

0