@kiltprotocol/dip-sdk

KILT DIP

A cross-chain DID feature that allows KILT DID owners to DID-authorize extrinsics on other parachains and relaychains without bridging their full DID state.

More documentation is coming!

Installation

NPM:

npm install @kiltprotocol/dip-sdk

YARN:

yarn add @kiltprotocol/dip-sdk

End-to-end testing

The end-to-end testing use a Zombienet-based setup with a Kubernetes provider. Hence, a Kubernetes cluster, e.g., minikube must be installed on the machine where the tests are to be executed. For more information on how to set up the machine to spawn Zombienet-based network, please refer to the official Zombienet repository.

Environment configuration

The Zombienet deployment relies on a number of environment variables, which are:

• RELAY_IMAGE: The Docker image for relaychain nodes.
• RELAY_ALICE_RPC: The RPC port for the relay-alice relaychain node.
• PROVIDER_IMAGE: The Docker image for the DIP provider nodes.
• PROVIDER_ALICE_RPC: The RPC port for the provider-alice provider node.
• CONSUMER_IMAGE: The Docker image for the DIP consumer nodes.
• CONSUMER_ALICE_RPC: The RPC port for the consumer-alice consumer node.

A series of default values is sourced from either the tests/dip-provider-template-dip-consumer-template/.env.develop.test or tests/peregrine-dip-consumer-template/.env.develop.test file to spin up either a DIP Template Provider <-> DIP Template Consumer network or a Peregrine <-> DIP Template Consumer network.

Test execution

Test execution requires the following steps:

• Switch to the expected Node version with nvm use.
• Install the repo dependencies with yarn install.
• Set up the environment variables as explained above.
• Spin up the Zombienet network with test:e2e:start-network:peregrine-provider:develop or test:e2e:start-network:dip-template-provider:develop.
• In a new shell session, run the end-to-end tests with yarn test:e2e:peregrine-provider or yarn test:e2e:dip-template-provider.
• [OPTIONAL] Tear down the network by killing the process started at step 4.