{"id":18417443,"url":"https://github.com/stellar/js-soroban-client","last_synced_at":"2025-09-29T22:30:58.083Z","repository":{"id":59919782,"uuid":"538477956","full_name":"stellar/js-soroban-client","owner":"stellar","description":"Main Soroban client library for the Javascript language","archived":false,"fork":false,"pushed_at":"2024-07-22T05:17:45.000Z","size":9204,"stargazers_count":22,"open_issues_count":14,"forks_count":17,"subscribers_count":35,"default_branch":"main","last_synced_at":"2025-01-12T11:12:44.455Z","etag":null,"topics":["blockchain","cryptocurrency","horizon","javascript","sdk","soroban","stellar"],"latest_commit_sha":null,"homepage":"https://stellar.github.io/js-soroban-client/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stellar.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-19T11:54:27.000Z","updated_at":"2024-07-21T20:06:17.000Z","dependencies_parsed_at":"2023-10-13T09:26:19.140Z","dependency_job_id":"64f48f66-2333-4c2f-ad1e-be56da68d73d","html_url":"https://github.com/stellar/js-soroban-client","commit_stats":{"total_commits":809,"total_committers":76,"mean_commits":"10.644736842105264","dds":0.7317676143386898,"last_synced_commit":"8a4d6d9f82f82d5f196fcf281f9b76559a9f466e"},"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stellar%2Fjs-soroban-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stellar%2Fjs-soroban-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stellar%2Fjs-soroban-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stellar%2Fjs-soroban-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stellar","download_url":"https://codeload.github.com/stellar/js-soroban-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234669989,"owners_count":18869115,"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":["blockchain","cryptocurrency","horizon","javascript","sdk","soroban","stellar"],"created_at":"2024-11-06T04:09:26.831Z","updated_at":"2025-09-29T22:30:57.649Z","avatar_url":"https://github.com/stellar.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg alt=\"Stellar\" src=\"https://github.com/stellar/.github/raw/master/stellar-logo.png\" width=\"558\" /\u003e\n  \u003cbr/\u003e\n  \u003cstrong\u003eCreating equitable access to the global financial system\u003c/strong\u003e\n  \u003ch1\u003ejs-soroban-client\u003c/h1\u003e\n\u003c/div\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://badge.fury.io/js/soroban-client\"\u003e\u003cimg src=\"https://badge.fury.io/js/soroban-client.svg\" alt=\"npm version\" height=\"18\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/stellar/js-soroban-client/actions/workflows/tests.yml\"\u003e\u003cimg alt=\"Test Status\" src=\"https://github.com/stellar/js-soroban-client/actions/workflows/tests.yml/badge.svg\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://coveralls.io/github/stellar/js-soroban-client?branch=master\"\u003e\u003cimg alt=\"Coverage Status\" src=\"https://coveralls.io/repos/stellar/js-soroban-client/badge.svg?branch=master\u0026service=github\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n# Deprecation Notice\n\n**This repository has been deprecated** in favor of the [`stellar-sdk`](https://github.com/stellar/js-stellar-sdk) package. Please read the [migration guide](https://gist.github.com/Shaptic/5ce4f16d9cce7118f391fbde398c2f30) for how to upgrade to that package. Future changes will only be made there.\n\n----------\n\njs-soroban-client is a JavaScript library for communicating with a\n[Soroban RPC server](https://soroban.stellar.org/api) and building Stellar apps. It provides:\n- a networking layer API for soroban-rpc methods.\n- facilities for building and signing transactions, for communicating with a\n  soroban-rpc instance, and for submitting transactions or querying network\n  state.\n\n\u003cdetails\u003e\n\n### soroban-client vs stellar-base\n\nsoroban-client is a high-level library that serves as client-side API for Horizon.\n[stellar-base](https://github.com/stellar/js-stellar-base) is lower-level\nlibrary for creating Stellar primitive constructs via XDR helpers and wrappers.\n\n**Most people will want soroban-client instead of stellar-base.** You should only\nuse stellar-base if you know what you're doing!\n\nIf you add `soroban-client` to a project, **do not add `stellar-base`!** Mis-matching\nversions could cause weird, hard-to-find bugs. `soroban-client` automatically\ninstalls `stellar-base` and exposes all of its exports in case you need them.\n\n\u003e **Important!** The Node.js version of the `stellar-base` (`soroban-client` dependency) package\n\u003e uses the [`sodium-native`](https://www.npmjs.com/package/sodium-native) package as\n\u003e an [optional dependency](https://docs.npmjs.com/files/package.json#optionaldependencies). `sodium-native` is\n\u003e a low level binding to [libsodium](https://github.com/jedisct1/libsodium),\n\u003e (an implementation of [Ed25519](https://ed25519.cr.yp.to/) signatures).\n\u003e If installation of `sodium-native` fails, or it is unavailable, `stellar-base` (and `soroban-client`) will\n\u003e fallback to using the [`tweetnacl`](https://www.npmjs.com/package/tweetnacl) package implementation.\n\u003e\n\u003e If you are using `soroban-client`/`stellar-base` in a browser you can ignore\n\u003e this. However, for production backend deployments you should be\n\u003e using `sodium-native`. If `sodium-native` is successfully installed and working the\n\u003e `SorobanClient.FastSigning` variable will return `true`.\n\n## Quick start\n\nUsing npm to include js-soroban-client in your own project:\n\n```shell\nnpm install --save soroban-client\n```\n\nAlternatively, you can use cdnjs in a browser:\n\n```html\n\u003cscript src=\"https://cdnjs.cloudflare.com/ajax/libs/soroban-client/{version}/soroban-client.js\"\u003e\u003c/script\u003e\n````\n\n## Install\n\n### To use as a module in a Node.js project\n\n1. Install it using npm:\n\n```shell\nnpm install --save soroban-client\n```\n\n2. require/import it in your JavaScript:\n\n```js\nvar SorobanClient = require('soroban-client');\n```\n\n### To self host for use in the browser\n\n1. Install it using [bower](http://bower.io):\n\n```shell\nbower install soroban-client\n```\n\n2. Include it in the browser:\n\n```html\n\u003cscript src=\"./bower_components/soroban-client/soroban-client.js\"\u003e\u003c/script\u003e\n\u003cscript\u003e\n  console.log(SorobanClient);\n\u003c/script\u003e\n```\n\nIf you don't want to use or install Bower, you can copy built JS files from the\n[bower-js-soroban-client\nrepo](https://github.com/stellar/bower-js-soroban-client).\n\n### To use the [cdnjs](https://cdnjs.com/libraries/soroban-client) hosted script in the browser\n\n1. Instruct the browser to fetch the library from\n   [cdnjs](https://cdnjs.com/libraries/soroban-client), a 3rd party service that\n   hosts js libraries:\n\n```html\n\u003cscript src=\"https://cdnjs.cloudflare.com/ajax/libs/soroban-client/{version}/soroban-client.js\"\u003e\u003c/script\u003e\n\u003cscript\u003e\n  console.log(SorobanClient);\n\u003c/script\u003e\n```\n\nNote that this method relies using a third party to host the JS library. This\nmay not be entirely secure.\n\nMake sure that you are using the latest version number. They can be found on the\n[releases page in Github](https://github.com/stellar/js-soroban-client/releases).\n\n### To develop and test js-soroban-client itself\n\n1. Clone the repo:\n\n```shell\ngit clone https://github.com/stellar/js-soroban-client.git\n```\n\n2. Install dependencies inside js-soroban-client folder:\n\n```shell\ncd js-soroban-client\nyarn install\n```\n\n3. Install Node 16\n\nBecause we support the latest maintenance version of Node, please install and develop on Node 16 so you don't get surprised when your code works locally but breaks in CI.\n\nHere's how to install `nvm` if you haven't: https://github.com/creationix/nvm\n\n```shell\nnvm install\n\n# if you've never installed 16 before you'll want to re-install yarn\nyarn install -g yarn\n```\n\nIf you work on several projects that use different Node versions, you might it\nhelpful to install this automatic version manager:\nhttps://github.com/wbyoung/avn\n\n4. Observe the project's code style\n\nWhile you're making changes, make sure to run the linter-watcher to catch any\n   linting errors (in addition to making sure your text editor supports ESLint)\n\n```shell\nnode_modules/.bin/gulp watch\n````\n\n## Usage\n\nFor information on how to use js-soroban-client, take a look at [the\ndocumentation](https://stellar.github.io/js-soroban-client/), or [the\nexamples](https://github.com/stellar/js-soroban-client/tree/master/docs/reference).\n\n## Testing\n\nTo run all tests:\n\n```shell\ngulp test\n```\n\nTo run a specific set of tests:\n\n```shell\ngulp test:node\ngulp test:browser\n```\n\nTo generate and check the documentation site:\n\n```shell\n# install the `serve` command if you don't have it already\nyarn install -g serve\n\n# generate the docs files\nyarn docs\n\n# get these files working in a browser\ncd jsdoc \u0026\u0026 serve .\n\n# you'll be able to browse the docs at http://localhost:5000\n```\n\n## Documentation\n\nDocumentation for this repo lives in\n[Developers site](https://github.com/stellar/js-soroban-client/blob/master/docs/reference/readme.md).\n\n## Contributing\n\nFor information on how to contribute, please refer to our\n[contribution guide](https://github.com/stellar/js-soroban-client/blob/master/CONTRIBUTING.md).\n\n## Publishing to npm\n\nSee [CONTRIBUTING.md](./CONTRIBUTING.md) for the detailed release process. Once a new release is published and CI passes, a new package will be published to npm by GitHub actions.\n\n## License\n\njs-soroban-client is licensed under an Apache-2.0 license. See the\n[LICENSE](https://github.com/stellar/js-soroban-client/blob/master/LICENSE) file\nfor details.\n\n\u003c/details\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstellar%2Fjs-soroban-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstellar%2Fjs-soroban-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstellar%2Fjs-soroban-client/lists"}