|
1 | 1 | # Tools and libraries for managing digital identity |
2 | 2 |
|
3 | | -This repo contains core components used in the Trinsic SDK |
| 3 | +This repo provides bindings in all popular languages for the core Okapi functionalities: |
4 | 4 |
|
5 | 5 | - Support for working with `did:key` method |
6 | | -- Implementation of DIDComm Messaging protocol for gRPC |
| 6 | +- Security tools for authentication with Oberon |
| 7 | +- Experimental implementation of DIDComm Messaging protocol for gRPC |
7 | 8 | - Linked Data Proofs using non-LD processing signatures, such as `JcsEd25519Signature2020` |
| 9 | +- On the roadmap: BBS+ Signatures |
8 | 10 |
|
9 | 11 | Library is available for use with different languages |
10 | 12 |
|
11 | 13 | [](https://badge.fury.io/nu/okapi.net) |
12 | 14 | [](https://badge.fury.io/js/%40trinsic%2Fokapi) |
13 | 15 | [](https://badge.fury.io/py/trinsic-okapi) |
14 | 16 |
|
| 17 | +## Installation |
| 18 | + |
| 19 | +See the language specific README in each folder of this repo for usage. Additionally, check the [okapi-examples](https://github.com/trinsic-id/okapi-examples) for some quick sample applications. |
| 20 | + |
| 21 | +### Native Libraries |
| 22 | + |
| 23 | +If the bindings in your language require the native libraries to be installed on your system (like Go, Python, Java, etc), |
| 24 | +you can use one of the following methods to install them: |
| 25 | + |
| 26 | +#### Homebrew (MacOS and Linux) |
| 27 | + |
| 28 | +We maintain a Homebrew Tap with bottles for MacOS and Linux. To install run: |
| 29 | + |
| 30 | +``` |
| 31 | +brew install trinsic-id/tap/okapi |
| 32 | +``` |
| 33 | + |
| 34 | +#### `dpkg` for Linux |
| 35 | + |
| 36 | +You can find .deb packages for your platform with [each release](https://github.com/trinsic-id/okapi/releases). These can be installed using `dpkg`. |
| 37 | +Choose the package for your architecture. |
| 38 | +The packages will install the required libraries and header files. |
| 39 | + |
| 40 | +``` |
| 41 | +wget https://github.com/trinsic-id/okapi/releases/download/v1.1.0/okapi_1.1.0_amd64.deb |
| 42 | +
|
| 43 | +dpkg -i okapi_1.1.0_amd64.deb |
| 44 | +``` |
| 45 | + |
| 46 | +#### `win-get` for Windows |
| 47 | + |
| 48 | +TODO |
| 49 | + |
15 | 50 | ## Library and API structure |
16 | 51 |
|
17 | 52 | The main library is built in Rust and exposed to other languages through a C-callable FFI. The function signatures for each method are exposed as byte arrays, that use Protobuf for the main IDL. This allows easy development and maintainance of new methods, with minimal language specific implementation. |
|
0 commit comments