pnpm add aptos
or use the browser bundle
<script src="https://unpkg.com/aptos@latest/dist/index.global.js" />
Then, the SDK can be accessed through
Learn the basics of how to use the SDK by following this tutorial in the Aptos developer site.
./examples folder with ready-made
package.json files to get you going quickly!
If you are using the types in a
commonjs module, like in a Node app, you just have to enable
allowSyntheticDefaultImports in your
tsconfig for types compatibility:
This SDK is composed of two parts, a core client generated from the OpenAPI spec of the API, and a set of wrappers that make it nicer to use, enable certain content types, etc.
To generate the core client from the spec, run:
See the quickstart above.
To develop in a local environment, you need to use the SDK from the main branch.
NOTE SDK from the main branch might not be compatible with the devnet.
Run a local node (run from the root of the repo):
cargo run -p aptos -- node run-local-testnet --with-faucet --faucet-port 8081 --force-restart --assume-yes
Run the SDK tests and make sure they pass. Go to the SDK directory, and setup an env to configure the URLs:
echo 'APTOS_NODE_URL="http://127.0.0.1:8080/v1"' >> .env
echo 'APTOS_FAUCET_URL="http://127.0.0.1:8081"' >> .env
Run the tests:
If you see strange behavior regarding HTTP clients, try running the tests with
Package the SDK and start building:
# In your project directory
pnpm add PATH_TO_LOCAL_SDK_PACKAGE
This project follows semver as closely as possible.
To release a new version of the SDK do the following.
package.jsonaccording to semver.
Generated using TypeDoc