TypeScript SDK Example Code
For sample code which explains the core concepts of how to use the SDK, see:
Below are additional resources which may be more suited for your individual use case.
Code Snippets
Section titled “Code Snippets”The examples
folder in the SDK repo has dozens of code snippets you can customize to your needs.
How to run examples
Section titled “How to run examples”To run one of the example scripts:
-
Clone the
Terminal window git clone https://github.com/aptos-labs/aptos-ts-sdk.git -
From the top-level of the package, install all dependencies.
Terminal window pnpm install -
Build the package.
Terminal window pnpm build -
Go to the folder of an example you would like to run.
Terminal window cd examples/typescript -
Install local dependencies.
Terminal window pnpm install -
Run the example.
Terminal window pnpm run simple_transfer
Helpful Reference Code
Section titled “Helpful Reference Code”- The SDK’s end-to-end tests - This has the most comprehensive set of code that uses the SDK.
- SDK source code - This has in-line comments explaining what each function does.
- SDK reference docs - These are another way to view the in-line documentation with built-in search.