Skip to content
Branch: develop
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs docs: move docs to gh-pages branch May 22, 2019
src Merge branch 'develop' into docs/getting-started May 13, 2019
.gitignore feat: generate docs Jan 17, 2019
.npmignore build: new build setup Dec 19, 2018
.nvmrc init setup with Demo Nov 22, 2018
.prettierrc style: consisten tslint config with prettier Dec 17, 2018
Dockerfile fix: test execution, add missing COPY statement in Dockerfile Jan 17, 2019
LICENSE feat: added license May 14, 2019
README.md
buildspec-ci.yml fix: disable prettier for generated .js files Feb 14, 2019
buildspec.yml feat: improve logging Feb 14, 2019
jest.config.js fix: move coverage folder Jan 25, 2019
jest.env.js test: added claim tests Jan 17, 2019
npm-create-rc.js fix typings Nov 23, 2018
package.json docs: move .nojekyll file May 14, 2019
prototype-sdk.iml feature: add crypto functions and tests with string instead of UInt8A… Dec 21, 2018
tsconfig.json
tslint.json refactor: no unnecessary classes May 3, 2019
typedoc.js docs: initial doc generation Dec 14, 2018
yarn.lock feat: sort properties before stringify May 13, 2019

README.md

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, or browse the API documentation.

How to use

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 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.

You can’t perform that action at this time.