hiero-did-sdk-python 0.1.3__tar.gz

hiero_did_sdk_python-0.1.3/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

hiero_did_sdk_python-0.1.3/PKG-INFO

@@ -0,0 +1,305 @@
+Metadata-Version: 2.1
+Name: hiero-did-sdk-python
+Version: 0.1.3
+Summary: The repository contains the Python SDK for managing DID Documents and Anoncreds Verifiable Credentials registry using Hedera Consensus Service.
+Home-page: https://github.com/hiero-ledger/hiero-did-sdk-python
+Author: Alexander Shenshin
+Author-email: alexander.shenshin@dsr-corporation.com
+Requires-Python: >=3.12,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: aiohttp (>=3.10.9,<4.0.0)
+Requires-Dist: aiohttp_retry (>=2.9.0,<3.0.0)
+Requires-Dist: base58 (>=2.1.1,<3.0.0)
+Requires-Dist: did-resolver (==0.0.3)
+Requires-Dist: hiero_sdk_python (==0.1.6)
+Requires-Dist: zstandard (>=0.23.0,<0.24.0)
+Project-URL: Documentation, https://hiero-ledger.github.io/hiero-did-sdk-python/
+Project-URL: Repository, https://github.com/hiero-ledger/hiero-did-sdk-python
+Description-Content-Type: text/markdown
+
+# Hiero DID SDK Python
+
+[![Release](https://img.shields.io/github/v/release/hiero-ledger/hiero-did-sdk-python)](https://github.com/hiero-ledger/hiero-did-sdk-python/releases)
+[![Build status](https://img.shields.io/github/actions/workflow/status/hiero-ledger/hiero-did-sdk-python/main.yml?branch=main)](https://github.com/hiero-ledger/hiero-did-sdk-python/actions/workflows/main.yml?query=branch%3Amain)
+[![codecov](https://codecov.io/gh/hiero-ledger/hiero-did-sdk-python/branch/main/graph/badge.svg)](https://codecov.io/gh/hiero-ledger/hiero-did-sdk-python)
+[![Commit activity](https://img.shields.io/github/commit-activity/m/hiero-ledger/hiero-did-sdk-python)](https://github.com/hiero-ledger/hiero-did-sdk-python/commits/main)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/hiero-ledger/hiero-did-sdk-python/badge)](https://scorecard.dev/viewer/?uri=github.com/hiero-ledger/hiero-did-sdk-python)
+[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/10697/badge)](https://bestpractices.coreinfrastructure.org/projects/10697)
+[![License](https://img.shields.io/github/license/hiero-ledger/hiero-did-sdk-python)](https://github.com/hiero-ledger/hiero-did-sdk-python/blob/main/LICENSE)
+
+This repository contains the Python SDK that enables developers to manage Decentralized Identifiers (DIDs) and AnonCreds Verifiable Credentials on the Hedera network using the Hedera Consensus Service.
+
+This library is using [Hiero Python SDK](https://github.com/hiero-ledger/hiero-sdk-python).
+
+# Table of contents
+
+1. [Overview](#overview)
+2. [Documentation](#documentation)
+3. [Getting started](#getting-started)
+4. [Configuration](#configuration)
+5. [Contributing](CONTRIBUTING.md)
+
+## Overview
+
+Decentralized identity ecosystems are built upon decentralized identifiers (DIDs) and verifiable credentials (VCs) standards, providing necessary functionality to publish and resolve DID documents and issue/verify credentials (claims).
+
+Data model of such ecosystems rely on [Verifiable Data Registries (VDRs)](https://w3c.github.io/vc-data-model/#dfn-verifiable-data-registries), commonly represented by decentralized ledgers.
+
+[Hiero](https://hiero.org/), as an open-source Decentralized Ledger Technology (DLT), is a great VDR option providing high-performance and low costs of operations.
+Hedera, while being built on Hiero, is a large and trusted network that will be a great choice for solutions searching for high-reliability.
+
+In particular, Hedera and other Hiero-based networks can be used as VDR for [Hedera DID Method](https://github.com/hashgraph/did-method/blob/master/hedera-did-method-specification.md) and [AnonCreds Verifiable Credentials](https://github.com/hyperledger/anoncreds-spec) by leveraging Hedera Consensus Service (HCS).
+
+This SDK is designed to simplify:
+
+- Creation and management of Hedera DID documents
+- Creation and management of AnonCreds resources
+- Adoption of Hiero-based VDRs for AnonCreds use cases
+- Empowering new and existing Python-based agent implementations with high-performance and low operational costs provided by Hiero
+
+## Documentation
+
+### Dev and API
+
+You can find dev documentation on [GH pages](https://hiero-ledger.github.io/hiero-did-sdk-python/).
+
+If you're planning to contribute to the project, please also check [contribution guidelines](CONTRIBUTING.md).
+
+### Design
+
+SDK design documentation can be found in corresponding [repo folder](docs/design).
+
+## Dev environment
+
+The project uses Makefile for dev scripts. You can view available commands by running:
+
+```bash
+make help
+```
+
+Core commands are listed below:
+
+#### Install dependencies and tools
+
+```bash
+make install
+```
+
+#### Run code quality checks
+
+```bash
+make check
+```
+
+#### Run tests
+
+```bash
+make test
+```
+
+#### Build artifacts
+
+```bash
+make build
+```
+
+## Getting started
+
+### Prerequisites
+
+- Python 3.12+
+- [Poetry](https://python-poetry.org/) (at least 1.8.4)
+- NodeJS and npm (used by pre-commit hooks)
+- Tools for Makefile support (Windows only)
+  - Can be installed with [chocolatey](https://chocolatey.org/): `choco install make`
+
+### Install package
+
+```bash
+pip install hiero-did-sdk-python
+```
+
+### Example usage
+
+Here you can find basic SDK usage examples.
+
+For more complex examples, please refer to SDK integration tests:
+
+- [Hedera DID](https://github.com/hiero-ledger/hiero-did-sdk-python/blob/main/tests/integration/test_hedera_did.py)
+- [AnonCreds registry](https://github.com/hiero-ledger/hiero-did-sdk-python/blob/main/tests/integration/test_hedera_anoncreds_registry.py)
+
+#### Create Hedera Client (for testnet)
+
+```python
+from hiero_sdk_python import Client, Network, AccountId, PrivateKey
+
+client = Client(
+    network=Network("testnet")
+)
+
+client.set_operator(AccountId.from_string("OPERATOR_ID"), private_key=PrivateKey.from_string("OPERATOR_KEY"))
+```
+
+#### Register new Hedera DID on testnet network and add DID service
+
+```python
+from hiero_did_sdk_python import HederaDid
+
+did = HederaDid(client=client, private_key_der="private_key_der")
+
+await did.register()
+
+await did.add_or_update_service(
+    id_=f"{did.identifier}#service-1", service_type="LinkedDomains", service_endpoint="https://example.com/vcs"
+)
+```
+
+#### Resolve existing Hedera DID
+
+```python
+from hiero_did_sdk_python import HederaDidResolver
+
+resolver = HederaDidResolver(client)
+
+resolution_result = await resolver.resolve(
+    "did:hedera:testnet:zvAQyPeUecGck2EsxcsihxhAB6jZurFrBbj2gC7CNkS5o_0.0.5063027")
+```
+
+#### Create AnonCreds credential schema and credential definition
+
+```python
+from hiero_did_sdk_python import HederaAnonCredsRegistry, AnonCredsSchema, AnonCredsCredDef, CredDefValue, CredDefValuePrimary
+
+issuer_did = "did:hedera:testnet:zvAQyPeUecGck2EsxcsihxhAB6jZurFrBbj2gC7CNkS5o_0.0.5063027"
+registry = HederaAnonCredsRegistry(client)
+
+schema = AnonCredsSchema(
+    name="schema-name",
+    issuer_id=issuer_did,
+    attr_names=["name", "age"],
+    version="1"
+)
+
+schema_registration_result = await registry.register_schema(schema, issuer_did, "OPERATOR_KEY_DER")
+
+cred_def = AnonCredsCredDef(
+    schema_id=schema_registration_result.schema_state.schema_id,
+    issuer_id=issuer_did,
+    value=CredDefValue(primary=CredDefValuePrimary(...)),
+    tag="cred-def-tag"
+)
+
+cred_def_registration_result = await registry.register_cred_def(cred_def, issuer_did, "OPERATOR_KEY_DER")
+```
+
+## Configuration
+
+At the moment, SDK comes with following configuration capabilities:
+
+- Hedera Client configuration
+- Cache implementation (optional)
+- Logger configuration (optional)
+
+### Hedera Client configuration
+
+Configuration consists from two parts:
+
+- Network configuration
+  - Basic configuration is lightweight and consists from selection of specific network ("mainnet", "testnet", "
+    previewnet"), complex parts are handled by Hedera Python SDK
+  - Custom configuration can be provided, if necessary
+- Hedera operator (account) configuration
+  - Essentially, account "credentials" that will be used for Hedera network integration and paying fees
+  - Needs to be provided explicitly and can be changed for specific Hedera Client instance via provider class
+
+#### Examples
+
+Create client for Testnet and set operator config:
+
+```python
+from hiero_sdk_python import Client, Network, AccountId, PrivateKey
+
+client = Client(
+    network=Network("testnet")
+)
+
+client.set_operator(AccountId.from_string("OPERATOR_ID"), private_key=PrivateKey.from_string("OPERATOR_KEY"))
+```
+
+Create client provider with custom network config:
+
+```python
+from hiero_sdk_python import Client, Network, AccountId, PrivateKey
+
+TESTNET_NODES = [
+    ("0.testnet.hedera.com:50211", AccountId(0, 0, 3)),
+    ("1.testnet.hedera.com:50211", AccountId(0, 0, 4))
+]
+
+client = Client(
+    network=Network(network="testnet", nodes=TESTNET_NODES, mirror_address="hcs.testnet.mirrornode.hedera.com:5600"),
+)
+client.set_operator(AccountId.from_string("OPERATOR_ID"), private_key=PrivateKey.from_string("OPERATOR_KEY"))
+```
+
+### Cache implementation
+
+SDK utilizes cache to optimize read operations and provides an option to customize cache implementation (individually
+for each resolver instance).
+
+By default, [in-memory cache implementation](https://github.com/hiero-ledger/hiero-did-sdk-python/blob/main/hiero_did_sdk_python/utils/cache.py#L112) is used.
+
+You can create custom cache implementation by inheriting [Cache base class](https://github.com/hiero-ledger/hiero-did-sdk-python/blob/main/hiero_did_sdk_python/utils/cache.py#L25).
+Custom cache instance needs to be provided in resolver constructor arguments.
+
+Classes that accept custom cache implementation:
+
+- [HederaDidResolver](https://github.com/hiero-ledger/hiero-did-sdk-python/blob/main/hiero_did_sdk_python/did/hedera_did_resolver.py)
+- [HederaAnonCredsRegistry](https://github.com/hiero-ledger/hiero-did-sdk-python/blob/main/hiero_did_sdk_python/anoncreds/hedera_anoncreds_registry.py)
+
+#### Example
+
+```python
+from hiero_did_sdk_python import Cache, HederaDidResolver
+
+class CustomCache(Cache):
+  ...
+
+custom_cache_instance = CustomCache[str, object]()
+
+resolver = HederaDidResolver(client, custom_cache_instance)
+```
+
+### Logger configuration
+
+Logger configuration supports following properties that can be set with environment variables:
+
+- Log level
+  - Env variable name: `HEDERA_DID_SDK_LOG_LEVEL`
+  - Currently supported values: "DEBUG", "INFO", "WARN", "ERROR"
+- Log format (in string representation)
+  - Env variable name: `HEDERA_DID_SDK_LOG_FORMAT`
+  - For log format pattern reference, please see Python docs:
+    - [Formatter objects](https://docs.python.org/3/library/logging.html#formatter-objects)
+    - [Log record attributes](https://docs.python.org/3/library/logging.html#logrecord-attributes)
+
+## Contributing to this Project
+
+Whether you’re fixing bugs, enhancing features, or improving documentation, your contributions are important — let’s build something great together!
+
+For instructions on how to contribute to this repo, please
+review the [Contributing Guide for the Hiero DID SDK](CONTRIBUTING.md).
+
+More instructions for contribution can be found in the
+[Global Contributing Guide](https://github.com/hiero-ledger/.github/blob/main/CONTRIBUTING.md).
+
+## Code of Conduct
+
+Hiero uses the Linux Foundation Decentralised Trust [Code of Conduct](https://www.lfdecentralizedtrust.org/code-of-conduct).
+
+## License
+
+[Apache License 2.0](LICENSE)
+