Endless SDK
npm install endless-sdk> _NOTE:_
> This is the legacy TypeScript SDK, aka the npm package endless. For a more robust SDK and better support, we recommend upgrading to the new TypeScript SDK @endless-labs/ts-sdk. Take a look at the documentation and the migration guide.
[![Discord][discord-image]][discord-url]
[![NPM Package Version][npm-image-version]][npm-url]
[![NPM Package Downloads][npm-image-downloads]][npm-url]
The Endless TypeScript SDK provides a convenient way to interact with the Endless blockchain using TypeScript. It offers a set of utility functions, classes, and types to simplify the integration process and enhance developer productivity.
##### For use in Node.js or a web application
``ts`
pnpm install endless
You can also use your preferred npm client, such as yarn or npm.
##### For use in a browser
`ts`
Then, the SDK can be accessed through window.endlessSDK.
- The Endless documentation site provides step-by-step instructions, code snippets, and best practices to use this library.
- You can view the generated Type Doc for the latest release of the SDK.
- For in-depth examples, check out the examples folder with ready-made package.json files to get you going quickly!
Setup an .env file to configure the URLs.
From the root of this package, run:
`ts`
rm .env
echo 'ENDLESS_NODE_URL="http://localhost:8080/v1"' >> .env
echo 'ENDLESS_FAUCET_URL="http://localhost:8081"' >> .env
To run the full SDK tests, From the root of this package, run:
`ts`
pnpm test
> If you see strange behavior regarding HTTP clients, try running the tests with --detectOpenHandles.
To test a single file in the SDK, From the root of this package, run:
`ts`
npx jest --
To use the local build in a local project:
`ts`
// run from the root of this package
pnpm build
// run on your local project
pnpm add PATH_TO_LOCAL_SDK_PACKAGE
To develop in a local environment, you need to use the SDK from the main branch.
Run a local node (run from the root of the repo):
`ts``
cargo run -p endless -- node run-local-testnet --force-restart --assume-yes
If you found a bug or would like to request a feature, please file an issue. If, based on the discussion on an issue you would like to offer a code change, please make a pull request. If neither of these describes what you would like to contribute, checkout out the contributing guide.
[npm-image-version]: https://img.shields.io/npm/v/endless.svg
[npm-image-downloads]: https://img.shields.io/npm/dm/endless.svg
[npm-url]: https://npmjs.org/package/endless
[discord-image]: https://img.shields.io/discord/945856774056083548?label=Discord&logo=discord&style=flat~~~~
[discord-url]: https://discord.gg/endlessnetwork
"openapi-typescript-codegen": "https://github.com/aptos-labs/openapi-typescript-codegen/releases/download/v0.24.0-p1/openapi-typescript-codegen-v0.24.0-p1.tgz",