0.1.50 • Published 5 months ago

endless-sdk v0.1.50

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
5 months ago

SDK for Endless Node API

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 NPM Package Version NPM Package Downloads

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.

Installation

For use in Node.js or a web application
pnpm install endless

You can also use your preferred npm client, such as yarn or npm.

For use in a browser
<script src="https://unpkg.com/endless@latest/dist/index.global.js" />

Then, the SDK can be accessed through window.endlessSDK.

Documentation and examples

  • 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!

Development environment setup

Setup an .env file to configure the URLs. From the root of this package, run:

rm .env
echo 'ENDLESS_NODE_URL="http://localhost:8080/v1"' >> .env
echo 'ENDLESS_FAUCET_URL="http://localhost:8081"' >> .env

Testing

To run the full SDK tests, From the root of this package, run:

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:

npx jest -- <path/to/file.test.ts>

To use the local build in a local project:

// run from the root of this package
pnpm build
// run on your local project
pnpm add PATH_TO_LOCAL_SDK_PACKAGE

Working with local node

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):

cargo run -p endless -- node run-local-testnet --force-restart --assume-yes

Contributing

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.

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",

0.1.50

5 months ago

0.1.49

5 months ago

0.1.30

7 months ago

0.1.31

7 months ago

0.1.32

7 months ago

0.1.29

8 months ago

0.1.28

8 months ago

0.1.27

8 months ago

0.1.22

9 months ago

0.1.23

9 months ago

0.1.24

9 months ago

0.1.20

9 months ago

0.1.21

9 months ago

0.1.18

12 months ago

0.1.17

12 months ago

0.1.15

12 months ago

0.1.13

12 months ago

0.1.12

12 months ago

0.1.11

12 months ago

0.1.10

12 months ago

0.1.8

12 months ago

0.1.7

1 year ago

0.1.6

1 year ago

0.1.5

1 year ago

0.1.4

1 year ago

0.1.3

1 year ago

0.1.2

1 year ago

0.1.1

1 year ago