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

docs: updated readme for Java #483

Merged
merged 2 commits into from
Jan 20, 2025
Merged

docs: updated readme for Java #483

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
40d9f78
docs: update readme
affrncsp Jan 20, 2025
60ac22b
docs: added vault-data-manager-client to the
affrncsp Jan 20, 2025
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
27 changes: 14 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,22 @@ The Affinidi TDK offers the following modules and support to programming languag



| | TypeScript | Python | Dart | PHP |
|----------- |-----------------------|-----------------------|----------------------|---------------------|
| | TypeScript | Python | Dart | PHP | Java |
|----------- |-----------------------|-----------------------|----------------------|---------------------|---------------------|
|**Packages** | | | |
|[auth-provider](packages/auth-provider/) | 🟢 | 🟢 | 🔴 | [🟢 Link](https://github.com/affinidi/affinidi-tdk-php/tree/main/src/AuthProvider) |
|[common](packages/common/) | 🟢 | 🟢 | 🔴 | [🟢 Link](https://github.com/affinidi/affinidi-tdk-php/tree/main/src/Common) |
|**Packages** | | | |
|credential-issuance-client | [🟢 Link](clients/typescript/credential-issuance-client/) | [🟢 Link](clients/python/credential_issuance_client/) | [🟡 Link](clients/dart/credential_issuance_client/) | [🟢 Link](https://github.com/affinidi/affinidi-tdk-php/tree/main/src/Clients/CredentialIssuanceClient) |
|credential-verification-client | [🟢 Link](clients/typescript/credential-verification-client/) | [🟢 Link](clients/python/credential_verification_client/) | [🟡 Link](clients/dart/credential_verification_client/) | [🟢 Link](https://github.com/affinidi/affinidi-tdk-php/tree/main/src/Clients/CredentialVerificationClient) |
|iam-client | [🟢 Link](clients/typescript/iam-client/) | [🟢 Link](clients/python/iam_client/) | [🟡 Link](clients/dart/iam_client/) | [🟢 Link](https://github.com/affinidi/affinidi-tdk-php/tree/main/src/Clients/IamClient) |
|iota-client | [🟢 Link](clients/typescript/iota-client/) | [🟢 Link](clients/python/iota_client/) | [🟡 Link](clients/dart/iota_client/) | [🟢 Link](https://github.com/affinidi/affinidi-tdk-php/tree/main/src/Clients/IotaClient) |
|login-configuration-client | [🟢 Link](clients/typescript/login-configuration-client/) | [🟢 Link](clients/python/login_configuration_client/) | [🟡 Link](clients/dart/login_configuration_client/) | [🟢 Link](https://github.com/affinidi/affinidi-tdk-php/tree/main/src/Clients/LoginConfigurationClient) |
|wallets-client | [🟢 Link](clients/typescript/wallets-client/) | [🟢 Link](clients/python/wallets_client/) | [🟡 Link](clients/dart/wallets_client/) | [🟢 Link](https://github.com/affinidi/affinidi-tdk-php/tree/main/src/Clients/WalletsClient) |
|[auth-provider](packages/auth-provider/) | 🟢 | 🟢 | 🔴 | [🟢](https://github.com/affinidi/affinidi-tdk-php/tree/main/src/AuthProvider) | 🟢 |
|[common](packages/common/) | 🟢 | 🟢 | 🔴 | [🟢](https://github.com/affinidi/affinidi-tdk-php/tree/main/src/Common) | 🟢 |
|**Clients** | | | |
|credential-issuance-client | [🟢 Link](clients/typescript/credential-issuance-client/) | [🟢 Link](clients/python/credential_issuance_client/) | [🟡 Link](clients/dart/credential_issuance_client/) | [🟢 Link](https://github.com/affinidi/affinidi-tdk-php/tree/main/src/Clients/CredentialIssuanceClient) | [🟢 Link](clients/java/credential.issuance.client/) |
|credential-verification-client | [🟢 Link](clients/typescript/credential-verification-client/) | [🟢 Link](clients/python/credential_verification_client/) | [🟡 Link](clients/dart/credential_verification_client/) | [🟢 Link](https://github.com/affinidi/affinidi-tdk-php/tree/main/src/Clients/CredentialVerificationClient) | [🟢 Link](clients/java/credential.verification.client/) |
|iam-client | [🟢 Link](clients/typescript/iam-client/) | [🟢 Link](clients/python/iam_client/) | [🟡 Link](clients/dart/iam_client/) | [🟢 Link](https://github.com/affinidi/affinidi-tdk-php/tree/main/src/Clients/IamClient) | [🟢 Link](clients/java/iam.client/) |
|iota-client | [🟢 Link](clients/typescript/iota-client/) | [🟢 Link](clients/python/iota_client/) | [🟡 Link](clients/dart/iota_client/) | [🟢 Link](https://github.com/affinidi/affinidi-tdk-php/tree/main/src/Clients/IotaClient) | [🟢 Link](clients/java/iota.client/) |
|login-configuration-client | [🟢 Link](clients/typescript/login-configuration-client/) | [🟢 Link](clients/python/login_configuration_client/) | [🟡 Link](clients/dart/login_configuration_client/) | [🟢 Link](https://github.com/affinidi/affinidi-tdk-php/tree/main/src/Clients/LoginConfigurationClient) | [🟢 Link](clients/java/login.configuration.client/) |
|vault-data-manager-client | [🟢 Link](clients/typescript/vault-data-manager-client/) | [🟢 Link](clients/python/vault_data_manager_client/) | [🟡 Link](clients/dart/vault_data_manager_client/) | [🟢 Link](https://github.com/affinidi/affinidi-tdk-php/tree/main/src/Clients/VaultDataManagerClient) | [🟢 Link](clients/java/vault.data.manager.client/) |
|wallets-client | [🟢 Link](clients/typescript/wallets-client/) | [🟢 Link](clients/python/wallets_client/) | [🟡 Link](clients/dart/wallets_client/) | [🟢 Link](https://github.com/affinidi/affinidi-tdk-php/tree/main/src/Clients/WalletsClient) | [🟢 Link](clients/java/wallets.client/) |
|**Libraries** | | | |
|[iota-browser](libs/iota-browser/) | 🟢 | 🔴 | 🔴 | 🔴 |
|[iota-core](libs/iota-core/) | 🟢 | 🟢 | 🔴 | 🔴 |
|[iota-browser](libs/iota-browser/) | 🟢 | 🔴 | 🔴 | 🔴 | 🔴 |
|[iota-core](libs/iota-core/) | 🟢 | 🟢 | 🔴 | 🔴 | 🟢 |

<br />
🟢 Supported <br />
Expand Down
3 changes: 0 additions & 3 deletions packages/java/auth.provider/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# Mandatory value required to derive the environment
AFFINIDI_TDK_ENVIRONMENT=

# Optional values needed to generate auth token. These values can also be directly passsed to the AuthProvider build fuunction
PROJECT_ID=
KEY_ID=
Expand Down
26 changes: 4 additions & 22 deletions packages/java/auth.provider/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# auth.provider

AuthProvider package

- API version: 1.0.0
AuthProvider package enables you to generate the required access token like Project Scoped Token to authenticate and access Affinidi Trust Network services.

For more information, please visit [https://github.com/affinidi/affinidi-tdk](https://github.com/affinidi/affinidi-tdk)

Expand Down Expand Up @@ -47,17 +45,11 @@ At first generate the JAR by executing:
mvn clean package
```

## Getting Started

Configure .env file at your project base with the following values (Refer .env.example)
## Usage

AFFINIDI_TDK_ENVIRONMENT= (local,dev or prod)
Sample usage to generate Project Scoped Token to call Affinidi TDK clients.

PROJECT_ID=
KEY_ID=
TOKEN_ID=
PASSPHRASE=
PRIVATE_KEY=
> You can store the required parameters like the Token details into an environment file.

```java

Expand Down Expand Up @@ -96,13 +88,3 @@ public class AuthProviderConsumer {
}

```

## Documentation for API Endpoints


## Recommendation


## Author

info@affinidi.com
Loading