{"id":13421586,"url":"https://github.com/algorand/js-algorand-sdk","last_synced_at":"2025-05-14T07:08:25.368Z","repository":{"id":37549587,"uuid":"168464345","full_name":"algorand/js-algorand-sdk","owner":"algorand","description":"The official JavaScript SDK for Algorand.","archived":false,"fork":false,"pushed_at":"2025-04-15T23:26:53.000Z","size":11842,"stargazers_count":296,"open_issues_count":39,"forks_count":211,"subscribers_count":22,"default_branch":"main","last_synced_at":"2025-05-01T11:36:21.879Z","etag":null,"topics":["algorand","blockchain","browser","javascript","node","sdk","typescript"],"latest_commit_sha":null,"homepage":"https://algorand.github.io/js-algorand-sdk/","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/algorand.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-01-31T04:44:59.000Z","updated_at":"2025-04-21T06:16:34.000Z","dependencies_parsed_at":"2023-12-19T00:27:52.847Z","dependency_job_id":"11f42b14-ea70-4c0c-9031-be7ecd982920","html_url":"https://github.com/algorand/js-algorand-sdk","commit_stats":{"total_commits":628,"total_committers":73,"mean_commits":8.602739726027398,"dds":0.8646496815286624,"last_synced_commit":"6973ff583b243ddb0632e91f4c0383021430a789"},"previous_names":[],"tags_count":57,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorand%2Fjs-algorand-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorand%2Fjs-algorand-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorand%2Fjs-algorand-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorand%2Fjs-algorand-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/algorand","download_url":"https://codeload.github.com/algorand/js-algorand-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254092776,"owners_count":22013290,"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":["algorand","blockchain","browser","javascript","node","sdk","typescript"],"created_at":"2024-07-30T23:00:25.882Z","updated_at":"2025-05-14T07:08:25.357Z","avatar_url":"https://github.com/algorand.png","language":"TypeScript","funding_links":[],"categories":["Software Development","Development \u0026 Tools","Development Tools","TypeScript","Cryptocurrencies"],"sub_categories":["JavaScript","Language SDKs \u0026 Tools","Languages"],"readme":"# js-algorand-sdk\n\n[![CircleCI](https://dl.circleci.com/status-badge/img/gh/algorand/js-algorand-sdk/tree/develop.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/algorand/js-algorand-sdk/tree/develop) [![npm version](https://badge.fury.io/js/algosdk.svg)](https://www.npmjs.com/package/algosdk)\n\nAlgoSDK is the official JavaScript library for communicating with the Algorand network. It's designed for modern browsers and Node.js.\n\n## New Major Version 3\n\nExisting codebases using v2 of this library will be incompatible with v3. The v3 release introduces breaking changes to the API, and a migration guide is available [here](https://github.com/algorand/js-algorand-sdk/blob/main/v2_TO_v3_MIGRATION_GUIDE.md).\n\n## Installation\n\n### [Node.js](https://nodejs.org/en/download/)\n\n```\n$ npm install algosdk\n```\n\n\u003e This package provides TypeScript types, but you will need [TypeScript](https://www.typescriptlang.org/) version 4.2 or higher to use them properly.\n\n### Browser\n\nInclude a minified browser bundle directly in your HTML like so:\n\n```html\n\u003cscript\n  src=\"https://unpkg.com/algosdk@v3.2.0/dist/browser/algosdk.min.js\"\n  integrity=\"sha384-P3wogHQ1+Zf+KQbCx+X4AXICZ0I9nV2FkJuL/5QJ7xQYv44ctvHyz026hnxuhLDR\"\n  crossorigin=\"anonymous\"\n\u003e\u003c/script\u003e\n```\n\nor\n\n```html\n\u003cscript\n  src=\"https://cdn.jsdelivr.net/npm/algosdk@v3.2.0/dist/browser/algosdk.min.js\"\n  integrity=\"sha384-P3wogHQ1+Zf+KQbCx+X4AXICZ0I9nV2FkJuL/5QJ7xQYv44ctvHyz026hnxuhLDR\"\n  crossorigin=\"anonymous\"\n\u003e\u003c/script\u003e\n```\n\nInformation about hosting the package for yourself, finding the browser bundles of previous versions, and computing the SRI hash is [available here](FAQ.md).\n\n## Quick Start\n\n```javascript\nconst token = 'Your algod API token';\nconst server = 'http://127.0.0.1';\nconst port = 8080;\nconst client = new algosdk.Algodv2(token, server, port);\n\n(async () =\u003e {\n  console.log(await client.status().do());\n})().catch((e) =\u003e {\n  console.log(e);\n});\n```\n\n## Documentation\n\nDocumentation for this SDK is available here: https://algorand.github.io/js-algorand-sdk/. Additional resources are available on https://developer.algorand.org.\n\n## Examples\n\nRunning examples requires access to a running node. Follow the instructions in Algorand's [developer resources](https://developer.algorand.org/docs/run-a-node/setup/install/) to install a node on your computer.\n\n**As portions of the codebase are written in TypeScript, example files cannot be run directly using `node`**. Please refer to the instructions described in the [examples/README.md](examples/README.md) file for more information regarding running the examples.\n\n## SDK Development\n\n### Building\n\nTo build a new version of the library, run:\n\n```bash\nnpm run build\n```\n\n### Generating Documentation\n\nTo generate the documentation website, run:\n\n```bash\nnpm run docs\n```\n\nThe static website will be located in the `docs/` directory.\n\n### Testing\n\nWe have two test suites: mocha tests in this repo, and the Algorand SDK test suite from https://github.com/algorand/algorand-sdk-testing.\n\n#### Node.js\n\nTo run the mocha tests in Node.js, run:\n\n```bash\nnpm test\n```\n\nTo run the SDK test suite in Node.js, run:\n\n```bash\nmake docker-test\n```\n\n#### Browsers\n\nThe test suites can also run in browsers. To do so, set the environment variable `TEST_BROWSER` to\none of our supported browsers. Currently we support testing in `chrome` and `firefox`. When\n`TEST_BROWSER` is set, the mocha and SDK test suites will run in that browser.\n\nFor example, to run mocha tests in Chrome:\n\n```bash\nTEST_BROWSER=chrome npm test\n```\n\nAnd to run SDK tests in Firefox:\n\n```bash\nTEST_BROWSER=firefox make docker-test\n```\n\n### Code Style\n\nThis project enforces a modified version of the [Airbnb code style](https://github.com/airbnb/javascript).\n\nWe've setup linters and formatters to help catch errors and improve the development experience:\n\n- [Prettier](https://prettier.io/) – ensures that code is formatted in a readable way.\n- [ESLint](https://eslint.org/) — checks code for antipatterns as well as formatting.\n\n\u003e If using the Visual Studio Code editor with the [recommended extensions](.vscode/extensions.json), ESLint errors should be highlighted in red and the Prettier extension should format code on every save.\n\n#### Precommit Hook\n\nThe linters and formatters listed above should run automatically on each commit to catch errors early and save CI running time.\n\n## License\n\njs-algorand-sdk is licensed under an MIT license. See the [LICENSE](https://github.com/algorand/js-algorand-sdk/blob/master/LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgorand%2Fjs-algorand-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falgorand%2Fjs-algorand-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgorand%2Fjs-algorand-sdk/lists"}