{"id":13695982,"url":"https://github.com/ArkEcosystemArchive/ark-ts","last_synced_at":"2025-05-03T13:34:07.593Z","repository":{"id":55850336,"uuid":"95448957","full_name":"ArkEcosystemArchive/ark-ts","owner":"ArkEcosystemArchive","description":"An ARK API wrapper, written in TypeScript to interact with ARK blockchain.","archived":true,"fork":false,"pushed_at":"2020-12-11T07:19:49.000Z","size":841,"stargazers_count":15,"open_issues_count":0,"forks_count":28,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-29T08:24:57.693Z","etag":null,"topics":["ark","blockchain","cryptocurrency"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ArkEcosystemArchive.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null}},"created_at":"2017-06-26T13:24:38.000Z","updated_at":"2023-07-27T12:02:27.000Z","dependencies_parsed_at":"2022-08-15T07:50:50.307Z","dependency_job_id":null,"html_url":"https://github.com/ArkEcosystemArchive/ark-ts","commit_stats":null,"previous_names":["arkecosystem/ark-ts"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArkEcosystemArchive%2Fark-ts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArkEcosystemArchive%2Fark-ts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArkEcosystemArchive%2Fark-ts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArkEcosystemArchive%2Fark-ts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ArkEcosystemArchive","download_url":"https://codeload.github.com/ArkEcosystemArchive/ark-ts/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224364483,"owners_count":17299080,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ark","blockchain","cryptocurrency"],"created_at":"2024-08-02T18:00:35.301Z","updated_at":"2024-11-12T23:31:29.005Z","avatar_url":"https://github.com/ArkEcosystemArchive.png","language":"TypeScript","funding_links":[],"categories":["Libraries"],"sub_categories":[],"readme":"**: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:***\n\n![TSARK Logo](https://i.imgur.com/AyhlVoZ.png)\n\n# TSARK\n\n\u003e An ARK API wrapper, written in TypeScript to interact with ARK blockchain.\n\n[![npm](https://img.shields.io/npm/dt/ark-ts.svg)]()\n[![npm](https://img.shields.io/npm/v/ark-ts.svg)]()\n[![license](https://img.shields.io/github/license/arkecosystem/ark-ts.svg)]()\n\n\u003e Lead Maintainer: [Lúcio Rubens](https://github.com/luciorubeens)\n\nTSARK is a library client designed to facilitate how you interact with the ARK blockchain.\n\n## Why TypeScript\n\n  * TypeScript is is a superset of JavaScript which mainly offers optional static typing, classes, and interfaces. The learning curve is not that steep.\n  * Types are optional, TSARK compiles into ES5 so you can work with both, ECMAScript or TypeScript.\n  * A better development experience, including auto-complete and fully documented.\n\n## Documentation\n\n\u003e [API documentation](https://arkecosystem.github.io/ark-ts/) is hosted on github pages, and is generated from [TypeDoc](https://github.com/TypeStrong/typedoc).\n\n## Installation\n\nTSARK is avaliable from `npm`.\n\n```bash\nyarn add ark-ts\n```\n\nor\n\n```bash\nnpm i ark-ts --save\n```\n\n## Usage\n\nFor the best TypeScript experience, you should either use [Visual Studio Code](http://code.visualstudio.com/), or a [plug-in for your favorite text editor](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Editor-Support).\n\n### Basic Examples\n\n\u003e Get delegate list from Devnet network.\n\n```js\nimport { Client, Network, NetworkType } from 'ark-ts';\n\nconst devnet = Network.getDefault(NetworkType.Devnet);\nconst client = new Client(devnet);\n\nclient.delegate.list().subscribe((list) =\u003e {\n  console.log(list);\n});\n```\n\n\u003e Get address from passphrase.\n\n```js\nimport { PrivateKey } from 'ark-ts/core';\n\n// if no specify a second param, default is mainnet\nconst key = PrivateKey.fromSeed('my secret passphrase');\nconsole.log(key.getPublicKey().getAddress()); // AaWU6X3pGdtSCK3s9weo9tjth64F3hixgT\n```\n\nFor more examples please see documentation or look for tests in each directory.\n\n## Running the tests\n\n```bash\nnpm run test\n```\n\n## Security\n\nIf you discover a security vulnerability within this project, please send an e-mail to security@ark.io. All security vulnerabilities will be promptly addressed.\n\n## Contributing\n\n  * If you find any bugs, submit an [issue](../../issues) or open [pull-request](../../pulls), helping us catch and fix them.\n  * Engage with other users and developers on [ARK Slack](https://ark.io/slack/).\n  * Join the #development channel on Slack or contact our developer Lúcio (@lorenzo).\n  * [Contribute bounties](./CONTRIBUTING.md).\n\n## Security\n\nIf you discover a security vulnerability within this package, please send an e-mail to security@ark.io. All security vulnerabilities will be promptly addressed.\n\n## Credits\n\nThis project exists thanks to all the people who [contribute](../../contributors).\n\n## License\n\n[MIT](LICENSE) © [ARK Ecosystem](https://ark.io)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FArkEcosystemArchive%2Fark-ts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FArkEcosystemArchive%2Fark-ts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FArkEcosystemArchive%2Fark-ts/lists"}