This is the official DNA TypeScript SDK - a comprehensive library for developing with the DNA blockchain in both TypeScript and JavaScript. It currently supports management of wallets, digital identities and digital assets - as well as the deployment and invocation of smart contracts.
npm install 'dna-ts-sdk' --save
or
yarn add 'dna-ts-sdk'
git clone 'https://github.com/DNAProject/DNA-ts-SDK.git'
Then install the dependencies with:
npm install
or
yarn
Compile the project with the:
npm run build:dev // or npm run build:prod
or
yarn run build:dev // or yarn run build:prod
This will create a compiled version of the SDK in the lib directory.
To run the tests in the test directory, use:
npm run test
or
yarn run test
Using import to include the modules from 'DNA-ts-sdk':
import {Wallet} from 'DNA-ts-sdk';
var wallet = Wallet.create('test');
Using require to include the modules from 'DNA-ts-sdk':
var DNA = require('DNA-ts-sdk');
var wallet = DNA.Wallet.create('test');
To use in the browser you must use the compiled version (as listed above).
The browser.js file is located in the lib directory.
Include it into the project with a <script> tag:
<script src="./lib/browser.js"></script>
Everything will be available under the DNA variable, just like in the require example above.
var wallet = DNA.Wallet.create('test');
Contributors are welcome to the DNA-ts-sdk. Before beginning, please take a look at our contributing guidelines. You can open an issue by clicking here.
The DNA TypeScript SDK is availabl under the LGPL-3.0 License.