Generated TS client for Aptos Tap
WARNING: This package is deprecated, use @aptos-labs/aptos-faucet-client instead.
Quickstart
yarn add aptos-tap-client
Usage
For Javascript or Typescript usage, check out the [./examples
][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 esModuleInterop
and allowSyntheticDefaultImports
in your tsconfig
for types compatibility:
{
...
"compilerOptions": {
"allowSyntheticDefaultImports": true,
"esModuleInterop": true
...
}
}
Requirements
yarn install
Generating API client
To generate the client from the spec, run:
yarn generate-client
Running tests
Run a tap locally. See the README in the root for information on doing that.
Run the tests:
yarn test
If you see strange behavior regarding HTTP clients, try running the tests with --detectOpenHandles
.
Semantic versioning
This project follows semver as closely as possible.
Release process
To release a new version of the SDK do the following.
- Regenerate the client:
yarn generate-client
- Test:
yarn test
- Bump the version in
package.json
according to semver. - Add an entry in the CHANGELOG for the version. We adhere to Keep a Changelog.
- Once you're confident everything is correct, submit your PR.
- Once the PR is approved and on main, run
yarn checked-publish
manually.