Skip to content
Merged
Changes from all commits
Commits
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
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,26 @@
[![stability-release-candidate](https://img.shields.io/badge/stability-pre--release-48c9b0.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#release-candidate)
[![Latest Release][release-badge]][release-latest]
[![License][license-badge]][license-url]
[![LOC][loc-badge]][loc-report]

[release-badge]: https://img.shields.io/github/v/tag/provenance-io/object-store.svg?sort=semver
[release-latest]: https://github.com/provenance-io/object-store/releases/latest

[license-badge]: https://img.shields.io/github/license/provenance-io/object-store.svg
[license-url]: https://github.com/provenance-io/object-store/blob/main/LICENSE

[loc-badge]: https://tokei.rs/b1/github/provenance-io/object-store
[loc-report]: https://github.com/provenance-io/object-store

A object storage system with a gRPC interface and strong encryption properties. Currently, only the
[Provenance DIME](https://developer.provenance.io/docs/pb/p8e/overview/encrypted-object-store/dime-encryption-envelope-specification/)
[Provenance DIME](https://developer.provenance.io/docs/pb/p8e/overview/encrypted-object-store/dime-encryption-envelope-specification/)
format is accepted. Supporting material can be found [here](https://developer.provenance.io/docs/pb/p8e/overview/encrypted-object-store/).

This service can be used directly, but the most common case is to use this alongside the [P8e Execution Environment](https://github.com/provenance-io/p8e-scope-sdk)
This service can be used directly, but the most common case is to use this alongside the [P8e Execution Environment](https://github.com/provenance-io/p8e-scope-sdk)
in order to process Provenance scopes and memorialize them on chain.

## Features

- Strong end-to-end encryption.
- Peer-to-peer replication to parties (third party `object-store`s) you want to share data with.
- Capable of publishing traces to Datadog.
- [Additional features](./docs/FEATURES.md)

## Authentication

Expand Down Expand Up @@ -59,12 +56,12 @@ so that items smaller than the threshold specified can have thier bytes stored d

### Running Locally

A postgres connection and data directory is required to run locally. A base set of environment variables can be edited and sourced from `./bin/env`.
A postgres connection and data directory is required to run locally. A base set of environment variables can be edited and sourced from `./bin/env`.

The most common use case for `object-store` is to run it alongside `p8e` in order to write to the [Provenance Blockchain](https://provenance.io). The simplest way to get this
The most common use case for `object-store` is to run it alongside `p8e` in order to write to the [Provenance blockchain](https://provenance.io). The simplest way to get this
up and running is [here](https://github.com/provenance-io/p8e-scope-sdk/tree/main/dev-tools/compose).

### Contributing
It is recommended to have `rust-analyzer` installed and configured for your IDE.
[Install instructions](https://rust-analyzer.github.io/book/installation.html).
[Install instructions](https://rust-analyzer.github.io/book/installation.html).
Basic configuration is included for VS Code.