AlgoSDK is the official JavaScript library for communicating with the Algorand network. It's designed for modern browsers and Node.js.
$ npm install algosdk
This package provides TypeScript types, but you will need TypeScript version 4.2 or higher to use them properly.
For errors in Webpack 5 or Vite projects, you will need to install extra dependencies.
Include a minified browser bundle directly in your HTML like so:
<script
src="https://unpkg.com/algosdk@v1.17.0/dist/browser/algosdk.min.js"
integrity="sha384-a9B05lyY5P6hDuZRdqWCEOD7xn/qAY8gc4B5/SJwy+t8GcUlwpzJ25qHcYwxi1NX"
crossorigin="anonymous"
></script>
or
<script
src="https://cdn.jsdelivr.net/npm/algosdk@v1.17.0/dist/browser/algosdk.min.js"
integrity="sha384-a9B05lyY5P6hDuZRdqWCEOD7xn/qAY8gc4B5/SJwy+t8GcUlwpzJ25qHcYwxi1NX"
crossorigin="anonymous"
></script>
Information about hosting the package for yourself, finding the browser bundles of previous versions, and computing the SRI hash is available here.
const token = 'Your algod API token';
const server = 'http://127.0.0.1';
const port = 8080;
const client = new algosdk.Algodv2(token, server, port);
(async () => {
console.log(await client.status().do());
})().catch((e) => {
console.log(e);
});
Documentation for this SDK is available here: https://algorand.github.io/js-algorand-sdk/. Additional resources are available on https://developer.algorand.org.
Running examples requires access to a running node. Follow the instructions in Algorand's developer resources to install a node on your computer.
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 file for more information regarding running the examples.
To build a new version of the library, run:
npm run build
To generate the documentation website, run:
npm run docs
The static website will be located in the docs/ directory.
We have two test suites: mocha tests in this repo, and the Algorand SDK test suite from https://github.com/algorand/algorand-sdk-testing.
To run the mocha tests in Node.js, run:
npm test
To run the SDK test suite in Node.js, run:
make docker-test
The test suites can also run in browsers. To do so, set the environment variable TEST_BROWSER to
one of our supported browsers. Currently we support testing in chrome and firefox. When
TEST_BROWSER is set, the mocha and SDK test suites will run in that browser.
For example, to run mocha tests in Chrome:
TEST_BROWSER=chrome npm test
And to run SDK tests in Firefox:
TEST_BROWSER=firefox make docker-test
This project enforces a modified version of the Airbnb code style.
We've setup linters and formatters to help catch errors and improve the development experience:
If using the Visual Studio Code editor with the recommended extensions, ESLint errors should be highlighted in red and the Prettier extension should format code on every save.
The linters and formatters listed above should run automatically on each commit to catch errors early and save CI running time.
js-algorand-sdk is licensed under an MIT license. See the LICENSE file for details.
v1.17.0
FAQs
The official JavaScript SDK for Algorand
The npm package algosdk receives a total of 42,454 weekly downloads. As such, algosdk popularity was classified as popular.
We found that algosdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.