open-index/open-npm huggingface dataset:
npm package: @kiltprotocol/dip-sdk
Description: An SDK to help integration of the KILT Decentralized Identity Provider (DIP) protocol using KILT as an Identity Provider.
Latest version: 0.0.1-rc.1

[![](https://user-images.githubusercontent.com/39338561/122415864-8d6a7c00-cf88-11eb-846f-a98a936f88da.png)](https://kilt.io)

![Lint and Test](https://github.com/KILTprotocol/sdk-js/workflows/Lint%20and%20Test/badge.svg)

# 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](https://minikube.sigs.k8s.io/docs/start/) 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](https://github.com/paritytech/zombienet).

### 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:

1. Switch to the expected Node version with `nvm use`.
2. Install the repo dependencies with `yarn install`.
3. Set up the environment variables as explained above.
4. Spin up the Zombienet network with `test:e2e:start-network:peregrine-provider:develop` or `test:e2e:start-network:dip-template-provider:develop`.
5. In a new shell session, run the end-to-end tests with `yarn test:e2e:peregrine-provider` or `yarn test:e2e:dip-template-provider`.
6. [OPTIONAL] Tear down the network by killing the process started at step 4.
npm package: @kiltprotocol/kilt-extension-api
Description: KILT Extension API is a JavaScript/TypeScript library that provides helper functions for interacting with KILT enabled extensions. It facilitates seamless communication between your application and KILT extensions.
Author: KILT
Latest version: 0.1.0-alpha.4

# KILT Extension API

KILT Extension API is a JavaScript/TypeScript library that provides helper functions for interacting with KILT enabled extensions.
It facilitates seamless communication between your application and KILT extensions.

The KILT Extension library documentation is currently under-development.
npm package: @kiltprotocol/prototype-sdk
Description: ![](./KILT_logo.png)
Latest version: 0.11.1
Deprecated: WARNING: This project has been renamed to @kiltprotocol/sdk-js. Install using @kiltprotocol/sdk-js instead.


![](./KILT_logo.png)

# KILT Testnet (Mash-net) SDK

The KILT SDK is a collection of classes and methods that application developers can utilize to interact with the KILT Network. The SDK is provided in Typescript.

Read the [getting started guide](./docs/getting-started.md), or browse the [API documentation](https://kiltprotocol.github.io/prototype-sdk/api).


## How to access

Edit your `~/.npmrc` and insert/add kiltbot's auth token to the registry

e.g. //registry.npmjs.org/:_authToken=8...

Use within your project with `yarn add @kilt/prototype-sdk`

## Development setup

You can use different SDK branches or versions, by linking it into your projects locally.  

Execute `yarn link` in the SDK and copy the command in the output, which should look like this:

```yarn link "@kiltprotocol/prototype-sdk"```

Go into your project folder and execute that second command.

The SDK is now symlinked in your projects `node_modules` folder

Before you see your changes from the SDK, you have to build it, by executing `yarn build`.

### Removing the link
Execute `yarn unlink "@kiltprotocol/prototype-sdk"` in the project folder.

After that execute `yarn install --check-files` to get the version from the registry back.

## Release / Deployment

Deployment is triggered by a push to the master branch as a result to a release build.

To build a release, start the release build job for the SDK in *AWS CodeBuild*. See [here](https://github.com/KILTprotocol/release-build-job/blob/master/README.md#usage) for more info on building releases.

As a result of a release build, a new version of the SDK is published to the NPM registry.

*Note: Don't forget to reference the correct version in the client and services*

## NB

Test coverage does not seem to be fail in all cases, except for testWatch.

## FAQ

### AWS build fails

If the prototype sdk build fails on AWS, please check the error log. Usually it says

```
npm ERR! publish Failed PUT 403
npm ERR! code E403
npm ERR! You cannot publish over the previously published versions: 0.0.3. : @kiltprotocol/prototype-sdk
```

This is on purpose as a new push to master branch triggers a build, but should not automatically and unintended release a new version.

Please update package.json's version in order to publish a new version to the registry by AWS after pushing to master.