ocean

module
v0.2.8 Latest Latest
Warning

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

Go to latest
Published: Feb 26, 2024 License: MIT

README

Ocean

This repo contains the protobuf files of the Ocean wallet interface.
Any Ocean wallet implementation must stick with the services and RPCs defined by the protos.
This also includes a single-key Ocean wallet that can be served by running the binary or as a dockerized solution.

We use Buf as package manager for the protos, you should import them from the registry and compile the stubs for your preferred prorgramming language with buf CLI.

Build

Build ocean binaries:

# build oceand
$ make build

# build ocean CLI
$ make build-cli

Build docker image:

$ docker build -t ghcr.io/vulpemventures/oceand:latest .

Local run

# run oceand with regtest configuration
$ make run

# in another tab, check the status of the daemon with the CLI
$ alias ocean=$(pwd)/build/ocean-cli-<os>-<arch>
$ ocean config init --no-tls
$ ocean wallet status
# check all available commands with help message
$ ocean --help

Test

# run unit and compose tests:
$ make test

Release

Precompiled binaries are published with each release.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Jump to

Keyboard shortcuts

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