Skip to content

Commit

Permalink
bump version (v0.2.0)
Browse files Browse the repository at this point in the history
  • Loading branch information
sarvalabs-manish committed Dec 15, 2024
1 parent 2ce0626 commit e7d9169
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,19 @@
[![pulls count](https://img.shields.io/github/issues-pr/sarvalabs/go-moi-identifiers?style=for-the-badge&color=brightgreen)][pullslink]

# MOI Identifiers
**go-moi-identifiers** is a package that contains implementations for all primitive identifiers
used in the MOI Protocol such as the `Address`, `LogicID` and `AssetID` standards. The `KramaID`
primitive will also be implemented soon.

### Specifications & Implementations
| Identifier | Specification | Implemented |
|:----------:|:-------------------------------------------------------------------------------------------------------:|:-----------:|
| `Address` | _pending_ | Yes |
| `AssetID` | [Asset ID Spec](https://sarvalabs.notion.site/Asset-ID-Standard-e4fcd9151e7d4e7eb2447f1d8edf4672?pvs=4) | Yes |
| `LogicID` | [Logic ID Spec](https://sarvalabs.notion.site/Logic-ID-Standard-174a2cc6e3dc42e4bbf4dd708af0cd03?pvs=4) | Yes |
| `KramaID` | _pending_ | No |
**go-moi-identifiers** is a package that contains implementations for all account identifiers
used in the MOI Protocol such as the `AssetID`, `LogicID` and `ParticipantID` identifiers.
The full specification for MOI Identifier can be found at [SPECIFICATION.md](./SPECIFICATION.md).

The root type `Identifier` is simple 32-byte array that can be used to represent any of the identifiers.
Each of the specific identifiers can be converted to and from the `Identifier` type with validations.

The package contains the functionality to access flags, metadata, variant ID and account ID from the identifier.
It also contains validation for multiple versions of each identifier kind and generator functions for each kind.

The package is designed to be used in the MOI Protocol and can be used in any other project that requires
the use of MOI identifiers. It has 100% test coverage and is well documented. Refer to the contributing
guidelines below to contribute to the project or report issues.

## Install
Install the latest [release](https://github.com/sarvalabs/go-moi-engineio/releases) using the following command
Expand All @@ -37,7 +39,7 @@ for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as below, without any additional terms or conditions.

## License
© 2023 Sarva Labs Inc. & MOI Protocol Developers.
© 2024 Sarva Labs Inc. & MOI Protocol Developers.

This project is licensed under either of
- [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0) ([`LICENSE-APACHE`](LICENSE-APACHE))
Expand Down

0 comments on commit e7d9169

Please sign in to comment.