Aptos TypeScript SDK
注記
このドキュメントは、新しい TypeScript SDK@aptos-labs/ts-sdk用です。レガシー SDK(別名aptos
)のドキュメントはこちら
新しいTypeScript SDKへの移行は移行ガイド確認して下さい。
概要
Aptos TypeScript SDKは、aptos-ts-sdk GitHubリポジトリでソース コードが完全にサポートされています。Aptos TypeScript SDK は、TypeScript を使用して Aptos ブロックチェーンと対話する便利な方法を提供します。統合プロセスを簡素化し、開発者の生産性を向上させるための一連のユーティリティ関数、クラス、および型を提供します。
- 開発者エクスペリエンス 厳密に型指定された API とインターフェイス、オートコンプリート、包括的なドキュメント。
- 安定性 テスト一式は、Aptosフルノードおよびインデクサーに備えてローカルネットワークで実行されます。
- トランザクション ビルダー 直感的で簡素化されたトランザクションビルダーフロー
- シリアル化/逆シリアル化のサポート 完全にネストされたシリアル化/逆シリアル化のサポートと、Moveタイプを簡単にシリアル化および逆シリアル化するための Moveサブクラス
インストール
- pnpm
- npm
- yarn
- bun
pnpm i @aptos-labs/ts-sdk
npm i @aptos-labs/ts-sdk
yarn add @aptos-labs/ts-sdk
bun i @aptos-labs/ts-sdk
クイックスタート
アプトスのセットアップ
const aptos = new Aptos(); // デフォルトはdevnet
// カスタム構成の場合
const aptosConfig = new AptosConfig({ network: Network.TESTNET });
const aptos = new Aptos(aptosConfig);
チェーンからデータを取得する
const ledgerInfo = await aptos.getLedgerInfo();
const modules = await aptos.getAccountModules({ accountAddress: "0x123" });
const tokens = await aptos.getAccountOwnedTokens({ accountAddress: "0x123" });
APTコイン送金トランザクション
const transaction = await aptos.transferCoinTransaction({
sender: alice,
recipient: bob.accountAddress,
amount: 100,
});
const pendingTransaction = await aptos.signAndSubmitTransaction({
signer: alice,
transaction,
});
トランザクションを構築して提出する
// 新しいアカウントキーペアを一つ生成する。
const alice: Account = Account.generate();
// チェーン上にアカウントを作成する。
await aptos.fundAccount({
accountAddress: alice.accountAddress,
amount: 100000000,
});
// アリスからボブへAPTコインを送金するトランザクションを送信する。
const bobAddress = "0xb0b";
const transaction = await aptos.transaction.build.simple({
sender: alice.accountAddress,
data: {
function: "0x1::aptos_account::transfer_coins",
typeArguments: ["0x1::aptos_coin::AptosCoin"],
functionArguments: [bobAddress, 100],
},
});
// 署名と送信を別々に使う。
const senderAuthenticator = aptos.transaction.sign({
signer: alice,
transaction,
});
const pendingTransaction = await aptos.transaction.submit.simple({
transaction,
senderAuthenticator,
});
// signAndSubmitを組み合わせて使う
const pendingTransaction = await aptos.signAndSubmitTransaction({
signer: alice,
transaction,
});