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

The examples folder in the SDK repository has dozens of code snippets you can customize. These examples are part of the SDK’s CI surface.

Example	Description
`simple_transfer.ts`	Basic APT transfer between two accounts
`simple_orderless_transfer.ts`	Orderless transfer with a replay-protection nonce
`simple_sponsored_transaction.ts`	Fee-payer sponsored transaction
`multi_agent_transfer.ts`	Multi-agent transaction with two signers
`batch_funds.ts`	Batch funding from a single account
`transfer_coin.ts`	Coin API transfer
`your_fungible_asset.ts`	Publish and transfer a fungible asset
`simple_digital_asset.ts`	Digital asset (NFT) flow
`rotate_key.ts`	Authentication key rotation
`keyless.ts`	Keyless account flow
`custom_client.ts`	Custom HTTP client
`external_signing.ts`	Sign with an external signer

To run one of the example scripts:

Clone the repository.

git clone https://github.com/aptos-labs/aptos-ts-sdk.git
cd aptos-ts-sdk

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
```

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.