https://github.com/vulpemventures/ocean
:ocean: Elements/Liquid wallet daemon
https://github.com/vulpemventures/ocean
Last synced: 12 months ago
JSON representation
:ocean: Elements/Liquid wallet daemon
- Host: GitHub
- URL: https://github.com/vulpemventures/ocean
- Owner: vulpemventures
- License: mit
- Created: 2021-12-22T09:18:01.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-05T12:16:37.000Z (almost 2 years ago)
- Last Synced: 2025-06-30T15:57:02.489Z (12 months ago)
- Language: Go
- Homepage:
- Size: 829 KB
- Stars: 6
- Watchers: 4
- Forks: 10
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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](https://buf.build/vulpemventures/ocean) and compile the stubs for your preferred prorgramming language with buf CLI.
## Build
Build ocean binaries:
```bash
# build oceand
$ make build
# build ocean CLI
$ make build-cli
```
Build docker image:
```bash
$ docker build -t ghcr.io/vulpemventures/oceand:latest .
```
## Local run
```bash
# 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--
$ ocean config init --no-tls
$ ocean wallet status
# check all available commands with help message
$ ocean --help
```
## Test
```bash
# run unit and compose tests:
$ make test
```
## Release
Precompiled binaries are published with each [release](https://github.com/vulpemventures/ocean/releases).
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the
[tags on this repository](https://github.com/vulpemventures/ocean/tags).
## License
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.