Awesome
:warning: SOON TO BE DEPRECATED IN FAVOR OF https://github.com/ArkEcosystem/core/tree/master/packages/crypto - PLEASE SUBMIT PULL REQUESTS TO THE CORE V2 REPOSITORY :warning:*
TSARK
An ARK API wrapper, written in TypeScript to interact with ARK blockchain.
Lead Maintainer: Lúcio Rubens
TSARK is a library client designed to facilitate how you interact with the ARK blockchain.
Why TypeScript
- TypeScript is is a superset of JavaScript which mainly offers optional static typing, classes, and interfaces. The learning curve is not that steep.
- Types are optional, TSARK compiles into ES5 so you can work with both, ECMAScript or TypeScript.
- A better development experience, including auto-complete and fully documented.
Documentation
API documentation is hosted on github pages, and is generated from TypeDoc.
Installation
TSARK is avaliable from npm.
yarn add ark-ts
or
npm i ark-ts --save
Usage
For the best TypeScript experience, you should either use Visual Studio Code, or a plug-in for your favorite text editor.
Basic Examples
Get delegate list from Devnet network.
import { Client, Network, NetworkType } from 'ark-ts';
const devnet = Network.getDefault(NetworkType.Devnet);
const client = new Client(devnet);
client.delegate.list().subscribe((list) => {
console.log(list);
});
Get address from passphrase.
import { PrivateKey } from 'ark-ts/core';
// if no specify a second param, default is mainnet
const key = PrivateKey.fromSeed('my secret passphrase');
console.log(key.getPublicKey().getAddress()); // AaWU6X3pGdtSCK3s9weo9tjth64F3hixgT
For more examples please see documentation or look for tests in each directory.
Running the tests
npm run test
Security
If you discover a security vulnerability within this project, please send an e-mail to security@ark.io. All security vulnerabilities will be promptly addressed.
Contributing
- If you find any bugs, submit an issue or open pull-request, helping us catch and fix them.
- Engage with other users and developers on ARK Slack.
- Join the #development channel on Slack or contact our developer Lúcio (@lorenzo).
- Contribute bounties.
Security
If you discover a security vulnerability within this package, please send an e-mail to security@ark.io. All security vulnerabilities will be promptly addressed.
Credits
This project exists thanks to all the people who contribute.