cloudkit

module
v0.0.0-...-2b6d021 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 7, 2023 License: MPL-2.0

README

Bitcoin CloudKit

EDO

The open source toolkit for building enterprise grade, cloud first, bitcoin infrastructure

Warning

This is alpha/WIP software in active development. Everything subject to change.

This is

Setup

macOS X

install golang (at time of writing 1.19):

brew install golang

Protocol Buffers / GRPC

We try and generate all types using protobuf and in most cases support these with a GRPC service ( though not always)

The goal in defining types with protobuf is to ensure some amount of modularity in building clients, adopting SOME parts of the cloudkit and not others, or cross language/project interoperability.

Protobuf files are to be self contained in /proto and ideally versioned.

Buf

We are currently using buf to generate go types from the proto files and using remote plugins to ensure you don't need to set anything up on your machine.

To generate:

buf mod update buf generate

Directories

Path Synopsis
aws
bitcoind
rpc
cli
clients
lnd
cmd
cli
ws
events
http
keys
ssh
monitoring
rpc
gateway/controlplane/resources/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
store
ws

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL