Common

Affinidi TDK common libraries that provides utility functions.

Supported Languages

Package: @affinidi-tdk/common

npm install @affinidi-tdk/common --save

Package: affinidi_tdk_common

pip install affinidi_tdk_common

Package: affinidi-tdk/affinidi-tdk-php

composer require affinidi-tdk/affinidi-tdk-php

Package: pkg:maven/com.affinidi.tdk/common

<dependency>
    <groupId>com.affinidi.tdk</groupId>
    <artifactId>common</artifactId>
    <version><version_number></version>
</dependency>

Check the Maven repository for the latest version of the package.

Classes and Methods

VaultUtils

Provides utility functions for Affinidi Vault requests.

Generates the Affinidi Iota Framework share link to initiate request to Affinidi Vault.

Parameters

request [String]

The signed request token generated from the prepareRequest of the Iota Browser library.

client_id [String]

The client_id from the signed request token.

Module Imports
import { VaultUtils } from '@affinidi-tdk/common'
from affinidi_tdk_common import VaultUtils
require_once 'vendor/autoload.php';

use AffinidiTdk\Common\Helpers\VaultUtils;
import com.affinidi.tdk.common.VaultUtil;
Sample Codes
const vaultShareLink = VaultUtils.buildShareLink(
      request,
      client_id,
    )
vault_share_link = VaultUtils.build_share_link(request, client_id)
$shareLink = VaultUtils::buildShareLink(request, client_id);
String shareLink = VaultUtil.buildShareLink(request, client_id);

Generates the Credential Issuance claim link to claim the credential from the Affinidi Vault.

Parameters

credentialOfferUri [String]

The Credential Offer URI returned from the startIssuance of the Crendential Issuance client.

Module Imports
import { VaultUtils } from '@affinidi-tdk/common'
from affinidi_tdk_common import VaultUtils
require_once 'vendor/autoload.php';

use AffinidiTdk\Common\Helpers\VaultUtils;
import com.affinidi.tdk.common.VaultUtil;
Sample Codes
const vaultClaimLink = VaultUtils.buildClaimLink(
      credentialOfferUri
    )
vault_claim_link = VaultUtils.build_claim_link(credential_offer_uri)
$claimLink = VaultUtils::buildClaimLink(credentialOfferUri);
String claimLink = VaultUtil.buildClaimLink(credentialOfferUri);