Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update deps & Add README and LICENSE #20

Merged
merged 2 commits into from
Sep 19, 2022
Merged

Update deps & Add README and LICENSE #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f8f3a3
Update deps
altafan Sep 19, 2022
7c621f0
Add license and readme
altafan Sep 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Vulpem Ventures

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
58 changes: 58 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,59 @@
# 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-<os>-<arch>
$ 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.
4 changes: 2 additions & 2 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ require (
github.com/stretchr/testify v1.7.2
github.com/timshannon/badgerhold/v4 v4.0.2
github.com/vulpemventures/go-bip39 v1.0.2
github.com/vulpemventures/go-elements v0.4.0-rc.2
github.com/vulpemventures/neutrino-elements v0.1.2
github.com/vulpemventures/go-elements v0.4.0
github.com/vulpemventures/neutrino-elements v0.1.3
golang.org/x/crypto v0.0.0-20220525230936-793ad666bf5e
golang.org/x/net v0.0.0-20220520000938-2e3eb7b945c2
google.golang.org/grpc v1.46.2
Expand Down
9 changes: 4 additions & 5 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1251,13 +1251,12 @@ github.com/vulpemventures/fastsha256 v0.0.0-20160815193821-637e65642941 h1:CTcw8
github.com/vulpemventures/fastsha256 v0.0.0-20160815193821-637e65642941/go.mod h1:GXBJykxW2kUcktGdsgyay7uwwWvkljASfljNcT0mbh8=
github.com/vulpemventures/go-bip39 v1.0.2 h1:+BgKOVo04okKf1wA4Fhv8ccvql+qFyzVUdVJKkb48r0=
github.com/vulpemventures/go-bip39 v1.0.2/go.mod h1:mjFmuv9D6BtANI6iscMmbHhmBOwjMCFfny3mxHnuDrk=
github.com/vulpemventures/go-elements v0.4.0-rc.1/go.mod h1:S7wy2QnrC2ElCZOscYMU2PYnnXRmuBQYfLMQGMVBqMg=
github.com/vulpemventures/go-elements v0.4.0-rc.2 h1:tvSOOTxoBL9wf+Bq/JhGrwW2ervCS/3E5ocZYYnQ228=
github.com/vulpemventures/go-elements v0.4.0-rc.2/go.mod h1:S7wy2QnrC2ElCZOscYMU2PYnnXRmuBQYfLMQGMVBqMg=
github.com/vulpemventures/go-elements v0.4.0 h1:oTuXIAyvJTMq8ccWwKfDiILJa9la+DPYeqX+rH/dgWc=
github.com/vulpemventures/go-elements v0.4.0/go.mod h1:S7wy2QnrC2ElCZOscYMU2PYnnXRmuBQYfLMQGMVBqMg=
github.com/vulpemventures/go-secp256k1-zkp v1.1.5 h1:oG1kO8ibVQ1wOvYcnFyuI+2YqnEZluXdRwkOPJlHBQM=
github.com/vulpemventures/go-secp256k1-zkp v1.1.5/go.mod h1:zo7CpgkuPgoe7fAV+inyxsI9IhGmcoFgyD8nqZaPSOM=
github.com/vulpemventures/neutrino-elements v0.1.2 h1:wld/NZC+7eRMcjvXJwJqBcOBgVOmMbotEquELl4g0Lc=
github.com/vulpemventures/neutrino-elements v0.1.2/go.mod h1:dqh8defBuAmGCwQ89ru2EjQSmibEj+IoMe+lJaDlNKQ=
github.com/vulpemventures/neutrino-elements v0.1.3 h1:rzg6G1oL2fWodOZ716SOs71JuqttPCjjmig7TrlHrxM=
github.com/vulpemventures/neutrino-elements v0.1.3/go.mod h1:pSl1A515bPEw9PxnyVwxyTpXH5GZNMMBacOCs7Ioyds=
github.com/willf/bitset v1.1.11-0.20200630133818-d5bec3311243/go.mod h1:RjeCKbqT1RxIR/KWY6phxZiaY1IyutSBfGjNPySAYV4=
github.com/willf/bitset v1.1.11/go.mod h1:83CECat5yLh5zVOf4P1ErAgKA5UDvKtgyUABdr3+MjI=
github.com/xanzy/go-gitlab v0.15.0/go.mod h1:8zdQa/ri1dfn8eS3Ir1SyfvOKlw7WBJ8DVThkpGiXrs=
Expand Down