Demos SDKs

To use this package, install it in your project using:

yarn add @kynesyslabs/demosdk

# or

npm -i @kynesyslabs/demosdk
Copy

Installing from local source

To use this package from a local folder, follow these steps:

On the root of this repo, run:

yarn build
Copy

Then, in your project, run:

yarn add file:../path/to/sdks
Copy

Assuming both repos are in the same directory, that would be:

yarn add file:../sdks
Copy

Then you can import stuff from the package normally, eg:

import { Demos } from "@kynesyslabs/demosdk/websdk"
Copy

[!IMPORTANT] Installing this package will replace the NPM version of the package.

Changes to the sdks will not be reflected on your project until you rebuild and reinstall the sdk in your project.

Exporting modules

To export a src/module/index.ts from the package as a module, configure package.json as shown:

"exports": {
    // ...
    "./module": "./build/module/index.js"
}
Copy

This will allow users to use the module exports as follows:

import { ModuleItem, otherModuleItem } from "@kynesyslabs/demosdk/module"
Copy

Publishing on NPM

Publishing to NPM is automated using a Github Workflow. To publish a new version:

1. Increment the package.json version field
2. Commit your changes with a message starting with the word release
3. Push to Github.

For example:

git commit -m "release v1.0.5"
Copy

The commit will trigger a workflow run to build the files and publish a new version on NPM.

Setup pre-push hook

The release pre-push hook will prevent you from pushing a release commit, if the code can't build successfully.

yarn setup:pre-push
Copy

The command will copy the pre-push file from .github/hooks/pre-push to the .git/hooks directory.

[!TIP] This hook is not pushed to Github, so you need to run the command again if you reclone the repository.

Tests

yarn test:multichain           multichain sdks payload generation

yarn test:tx                   sending crosschain pay txs

yarn test:demoswork            demoswork operations

yarn test:native               native pay txs

yarn test:identities           adding xm identities

yarn test:identities:web2      adding web2 identities

yarn test:web2                 using the web2 proxy

yarn test:rubic-service        rubic brigde service
Copy