Kaia Safe APIキット

APIキットは、Safe Transaction APIと安全にやり取りするためのキットです。このキットの中核は、有効な署名者が Safe の他の署名者に取引を提案・共有したり、署名を収集するサービスに署名を送信したり、Safe に関する情報（取引履歴、保留中の取引、有効なモジュールやガードなど）を取得したりできるようにすることである。

クイックスタート

このガイドを読み終える頃には、同サービスに取引を提案し、実行のためにオーナーの署名を得ることができるようになるだろう。

前提条件

Node.js と npm
複数の署名者がいる金庫

環境設定

ステップ1：プロジェクト・ディレクトリを作成する。

このコマンドをコピーしてターミナルに貼り付け、プロジェクトフォルダを作成する。


mkdir kaiasafe-api-kit
cd kaiasafe-api-kit

ステップ2： npmプロジェクトを初期化する。

このコマンドをターミナルにコピー＆ペーストして、package.jsonファイルを作成する。


npm init -y

ステップ3：依存関係をインストールする。

API-Kitの使用方法は、以下のインストールコマンドを実行するだけです：

npm
yarn


npm install @safe-global/api-kit @safe-global/protocol-3 @safe-global/safe-core-sdk-types


yarn add @safe-global/api-kit @safe-global/protocol-kit @safe-global/safe-core-sdk-types

ステップ4：依存関係をインポートする。

app.jsという名前のファイルを作成する。このインタラクションのためのコード・スニペットはすべてここにある。

これらの必要なインポートをコピーして、app.jsファイルの先頭に貼り付ける。


import SafeApiKit from '@safe-global/api-kit'
import Safe from '@safe-global/protocol-kit'
import { 
  OperationType
} from '@safe-global/safe-core-sdk-types'

ステップ5：セットアップの設定

API-Kitがどのように機能するかを効率的に説明するために、2人以上の署名者を持つSafeアカウントのセットアップを使用する。

以下をコピーして、app.jsファイルのimport文の下に貼り付ける：


// https://chainlist.org/?search=kaia&testnets=true
const RPC_URL = 'https://public-en-kairos.node.kaia.io'
const SAFE_ADDRESS = "<REPLACE WITH SAFE PUBLIC ADDRESS HERE>";  // 2 Owner Safe Address Ex: 0x123.... SAFE SHOULD 
const OWNER_1_ADDRESS = "<REPLACE WITH OWNER 1 PUBLIC KEY HERE>"; // ONLY OWNER 1 and SAFE ADDRESS Need to have some test KAIA balance
const OWNER_1_PRIVATE_KEY = "<REPLACE WITH OWNER 1 PRIVATE KEY HERE>";
const OWNER_2_PRIVATE_KEY = "<REPLACE WITH OWNER 2 PRIVATE KEY HERE>"; // OWNER 2 need not have any test KAIA
const TO_ADDRESS = OWNER_1_ADDRESS; // Receiver address of sample transaction who receives 1 wei

APIキットを使用する

ステップ1：APIキットの初期化

APIキットを初期化するには、APIキットのインスタンスを作成する必要がある。

Safe Transaction Service](https://docs.safe.global/core-api/transaction-service-overview) がサポートされているチェーンでは、chainId プロパティを指定するだけで十分です。


const apiKit = new SafeApiKit.default({
  chainId: 1001n,
  txServiceUrl: 'https://docs-safe.kaia.io/txs-baobab/api'
})

上で見たように、オプションのtxServiceUrlプロパティを使用してカスタムサービスを含めました。

ステップ2：プロトコルキットの初期化

トランザクションと署名を処理するには、プロバイダ、署名者、safeAddressを指定して、Protocol Kit（開発者がTypeScriptインタフェースを使用してSafe Smart Accountsとやり取りできるようにするためのキット）のインスタンスを作成する必要がある。


const protocolKitOwner1 = await Safe.default.init({
  provider: RPC_URL,
  signer: OWNER_1_PRIVATE_KEY,
  safeAddress: SAFE_ADDRESS
})

ステップ3：サービスにトランザクションを提案する

API Kitの中核機能の1つは、有効な署名者が他の署名者とトランザクションを共有できるようにすることである。しかし、その前に、セーフサイナーの誰かが取引のプロポーザルを作成し、プロセスを開始する必要がある。この取引は、他の所有者がアクセスできるようにするためにサービスに送信され、他の所有者も同様に承認を与え、取引に署名することができる。しかし、その前に、セーフサイナーの誰かが取引のプロポーザルを作成し、プロセスを開始する必要がある。この取引は、他の所有者がアクセスできるようにするためにサービスに送信され、他の所有者も同様に承認を与え、取引に署名することができる。


const safeTransactionData = {
  to: TO_ADDRESS,
  value: '1', // 1 wei
  data: '0x',
  operation: OperationType.Call
}
const safeTransaction = await protocolKitOwner1.createTransaction({
  transactions: [safeTransactionData]
})
const safeTxHash = await protocolKitOwner1.getTransactionHash(safeTransaction)
const signature = await protocolKitOwner1.signHash(safeTxHash)
// 2. Propose transaction to the service
try {
  await apiKit.proposeTransaction({
    safeAddress: SAFE_ADDRESS,
    safeTransactionData: safeTransaction.data,
    safeTxHash,
    senderAddress: OWNER_1_ADDRESS,
    senderSignature: signature.data
  })
} catch(err) {
  console.log(err)
}

ステップ4：保留中のトランザクションを取得する

APIキットは、状況に応じて保留中のトランザクションを取得するためのさまざまな方法を提供してくれる。このガイドでは、セーフトランザクションハッシュと以下に示すその他の利用可能なメソッドを使用してトランザクションを取得する：


const transaction = await apiKit.getTransaction(safeTxHash)
// const transactions = await service.getPendingTransactions()
// const transactions = await service.getIncomingTransactions()
// const transactions = await service.getMultisigTransactions()
// const transactions = await service.getModuleTransactions()
// const transactions = await service.getAllTransactions()

ステップ5：取引の確認

次に行うことは、プロトコルキットを使用してトランザクションに署名し、confirmTransaction メソッドを使用して署名を Safe Transaction Service に提出することである。


const protocolKitOwner2 = await Safe.default.init({
  provider: RPC_URL,
  signer: OWNER_2_PRIVATE_KEY,
  safeAddress: SAFE_ADDRESS
})
const signature2 = await protocolKitOwner2.signHash(safeTxHash)
// Confirm the Safe transaction
const signatureResponse = await apiKit.confirmTransaction(
  safeTxHash,
  signature2.data
)

ステップ6：トランザクションの実行

これで Safe トランザクションを実行する準備ができた。これで Safe トランザクションを実行する準備ができた。これは、Safe Wallet Webインターフェース、Protocol Kit、Safe CLI、または利用可能なその他のツールを使用して行うことができます。

この最後のステップでは、Protocol Kitを使って安全なトランザクションを実行した。


const safeTxn = await apiKit.getTransaction(safeTxHash);
const executeTxReponse = await protocolKitOwner1.executeTransaction(safeTxn)
const receipt = await executeTxReponse.transactionResponse?.wait();
console.log('Transaction executed:');
console.log(`https://kairos.kaiascan.io/tx/${hash}`)

最後に、app.jsの完全なコードは次のようになるはずだ：


import SafeApiKit from '@safe-global/api-kit'
import Safe from '@safe-global/protocol-kit'
import { 
  OperationType
} from '@safe-global/safe-core-sdk-types'
// https://chainlist.org/?search=kaia&testnets=true
const RPC_URL = 'https://public-en-kairos.node.kaia.io'
const SAFE_ADDRESS = "<REPLACE WITH SAFE PUBLIC ADDRESS HERE>";  // 2 Owner Safe Address Ex: 0x123.... SAFE SHOULD 
const OWNER_1_ADDRESS = "<REPLACE WITH OWNER 1 PUBLIC KEY HERE>"; // ONLY OWNER 1 and SAFE ADDRESS Need to have some test KAIA balance
const OWNER_1_PRIVATE_KEY = "<REPLACE WITH OWNER 1 PRIVATE KEY HERE>";
const OWNER_2_PRIVATE_KEY = "<REPLACE WITH OWNER 2 PRIVATE KEY HERE>"; // OWNER 2 need not have any test KAIA
const TO_ADDRESS = OWNER_1_ADDRESS; // Receiver address of sample transaction who receives 1 wei
const apiKit = new SafeApiKit.default({
  chainId: 1001n,
  txServiceUrl: 'https://docs-safe.kaia.io/txs-baobab/api'
})
const protocolKitOwner1 = await Safe.default.init({
  provider: RPC_URL,
  signer: OWNER_1_PRIVATE_KEY,
  safeAddress: SAFE_ADDRESS
})
// 1. Create transaction
const safeTransactionData = {
  to: TO_ADDRESS,
  value: '1', // 1 wei
  data: '0x',
  operation: OperationType.Call
}
const safeTransaction = await protocolKitOwner1.createTransaction({
  transactions: [safeTransactionData]
})
const safeTxHash = await protocolKitOwner1.getTransactionHash(safeTransaction)
const signature = await protocolKitOwner1.signHash(safeTxHash)
// 2. Propose transaction to the service
try {
  await apiKit.proposeTransaction({
    safeAddress: SAFE_ADDRESS,
    safeTransactionData: safeTransaction.data,
    safeTxHash,
    senderAddress: OWNER_1_ADDRESS,
    senderSignature: signature.data
  })
} catch(err) {
  console.log(err)
}
console.log("Transaction hash is "+safeTxHash)
const transaction = await apiKit.getTransaction(safeTxHash)
// const transactions = await service.getPendingTransactions()
// const transactions = await service.getIncomingTransactions()
// const transactions = await service.getMultisigTransactions()
// const transactions = await service.getModuleTransactions()
// const transactions = await service.getAllTransactions()
// 3. Confirmation from Owner 2
const protocolKitOwner2 = await Safe.default.init({
  provider: RPC_URL,
  signer: OWNER_2_PRIVATE_KEY,
  safeAddress: SAFE_ADDRESS
})
const signature2 = await protocolKitOwner2.signHash(safeTxHash)
// Confirm the Safe transaction
const signatureResponse = await apiKit.confirmTransaction(
  safeTxHash,
  signature2.data
)
console.log(signatureResponse)
// 4. Execute transaction
const safeTxn = await apiKit.getTransaction(safeTxHash);
const executeTxReponse = await protocolKitOwner1.executeTransaction(safeTxn)
const receipt = await executeTxReponse.transactionResponse?.wait();
console.log('Transaction executed:');
console.log(`https://kairos.kaiascan.io/tx/${hash}`)

APIキットは、状況に応じて保留中のトランザクションを取得するためのさまざまな方法を提供してくれる。

クイックスタート​

前提条件​

環境設定​

ステップ1：プロジェクト・ディレクトリを作成する。​

ステップ2： npmプロジェクトを初期化する。​

ステップ3：依存関係をインストールする。​

ステップ4：依存関係をインポートする。​

ステップ5：セットアップの設定​

APIキットを使用する​

ステップ1：APIキットの初期化​

ステップ2：プロトコルキットの初期化​

ステップ3：サービスにトランザクションを提案する​

ステップ4：保留中のトランザクションを取得する​

ステップ5：取引の確認​

ステップ6：トランザクションの実行​