[Aptos] Typescript SDK를 이용한 토큰 다루기

이 글은 아래 공식 문서를 보고 Aptos의 Typescript SDK를 사용하는 방법을 기록한 글입니다.

Mint NFTs with the SDKs | Aptos Docs

Your First NFT | Aptos Docs

 

이 글을 통해 콜렉션 생성(토큰이 들어가는 곳), 토큰 생성, 토큰 전송(민팅) 방법을 배울 수 있습니다.

 

사전 준비

먼저 예제 코드를 클론받고, 코드를 실행시켜보도록 하겠습니다. vs코드에서 폴더를 만든 뒤 아래 명령어를 실행시켜주세요.

git clone git@github.com:aptos-labs/aptos-core.git

cd aptos-core/ecosystem/typescript/sdk/examples/typescript

pnpm install

pnpm run simple_nft

위 코드의 실행 결과는 아래와 같습니다.

=== Addresses ===
Alice: 0xeef95e86c160fa10a71675c6075f44f8f2c6125f57b4b589424f1fbee385f754
Bob: 0x4dcd7b180c123fdb989d10f71fba6c978bda268c2e3660c169bdb55f67aab776

=== Initial Coin Balances ===
Alice: 100000000
Bob: 100000000

=== Creating Collection and Token ===
Alice's collection: {
    "description": "Alice's simple collection",
    "maximum": "18446744073709551615",
    "mutability_config": {
        "description": false,
        "maximum": false,
        "uri": false
    },
    "name": "Alice's",
    "supply": "1",
    "uri": "<https://alice.com>"
}
Alice's token balance: 1
Alice's token data: {
    "default_properties": {
        "map": {
            "data": []
        }
    },
    "description": "Alice's simple token",
    "largest_property_version": "0",
    "maximum": "18446744073709551615",
    "mutability_config": {
        "description": false,
        "maximum": false,
        "properties": false,
        "royalty": false,
        "uri": false
    },
    "name": "Alice's first token",
    "royalty": {
        "payee_address": "0xeef95e86c160fa10a71675c6075f44f8f2c6125f57b4b589424f1fbee385f754",
        "royalty_points_denominator": "0",
        "royalty_points_numerator": "0"
    },
    "supply": "1",
    "uri": "<https://aptos.dev/img/nyan.jpeg>"
}

=== Transferring the token to Bob ===
Alice's token balance: 0
Bob's token balance: 1

=== Transferring the token back to Alice using MultiAgent ===
Alice's token balance: 1
Bob's token balance: 0

우선 결과로 나온 것들을 종합해보면 아래와 같습니다.

• REST, Faucet Client를 초기화한다.
• Alice, Bob 두 명의 계정을 만든다.(The funding and creation of Alice and Bob's accounts.)
• Collections을 만들고 Alice 의 계정에서 토큰을 사용한다.
• Alice는 Bob에게 토큰을 요청한다
• Bob는 multiagent transaction을 이용해서 bob에게 보낸다.

그리고 pnpm run simple_nft를 통해 코드를 실행했는데 package.json을 보면 아래와 같이 되어있습니다.

ts-node는 타입스크립트 파일을 실행해주는 명령어입니다. 즉 우리는 simple_nft.ts파일을 실행시킨 것입니다. 이제 단계에 따라서 코드를 천천히 보며 이해해보도록 하겠습니다.

 

---

클라이언트 및 계정 생성

토큰을 만들고, 전송하는 작업을 하기 전, SDK를 이용하기 위해 몇 가지 사전 작업을 해보도록 하겠습니다. client를 만들고, 토큰을 생성할 사람(alice), 받을 사람(bob)을 각각 선언할 것입니다. 각 client들은 SDK에 내장되어있는 함수들을 사용할 수 있도록 해줍니다. 

 

API Client는 REST API를 사용할 수 있게 해줍니다. Faucet Client는 devnet Faucet Service를 사용할 수 있게 해줍니다. 그 결과 계정을 생성하고 코인을 넣어줄 수 있게 되는 것입니다. 이후 API Client를 이용해 Token Client를 만듭니다. 이 Token Client는 collection생성, token생성, token전송 등 토큰 관련 작업을 할 수 있게 해줍니다.

// Create API and faucet clients.
  // :!:>section_1a
  const client = new AptosClient(NODE_URL);
  const faucetClient = new FaucetClient(NODE_URL, FAUCET_URL); // <:!:section_1a

  // Create client for working with the token module.
  // :!:>section_1b
  const tokenClient = new TokenClient(client); // <:!:section_1b

  // Create a coin client for checking account balances.
  const coinClient = new CoinClient(client);

 

이제 aptos계정을 2가지 만들어 보도록 하겠습니다. 또 앞서 만든 faucetClient를 통해 코인을 넣어주도록 하겠습니다. faucetClient를 통해 코인을 넣어주기 이전에는 off-chain 계정이라서 토큰을 보내려 해도 찾을 수 없는 계정이라고 나옵니다. 그리고 넣어준 코인은 트랜젝션(토큰을 생성하거나, 보내는 등의 블록체인과 상호작용 하는 작업)을 하는 데에 소비되기 때문에 코인을 넣어주도록 합시다.

const alice = new AptosAccount();
const bob = new AptosAccount(); 

await faucetClient.fundAccount(alice.address(), 100_000_000);
await faucetClient.fundAccount(bob.address(), 100_000_000);

 

콜렉션 및 토큰 생성

이제 콜렉션과 토큰을 생성해주도록 하겠습니다. 앱토스에서는 토큰을 만드려는 사람이 ‘Collection’이라는 것을 가지고 있어야 합니다. 이 Collection에 토큰들을 저장하기 때문입니다. CreateCollection은 다음과 같은 값들을 받습니다.

async createCollection(
  account: AptosAccount,
  name: string,
  description: string,
  uri: string,
  maxAmount?: AnyNumber = MAX_U64_BIG_INT,
  extraArgs?: OptionalTransactionArgs,
): Promise<string> {}

콜렉션을 생성하는 코드는 아래와 같습니다.

const txnHash1 = await tokenClient.createCollection(
    alice,
    collectionName,
    "Alice's simple collection",
    "<https://alice.com>",
  );
  await client.waitForTransaction(txnHash1, { checkSuccess: true });

waitForTransaction은 트랜잭션 해쉬의 값을 받아 상태가 true가 되면 넘어가는 함수입니다.

 

이제는 만든 콜렉션에 토큰을 만들어보도록 하겠습니다. 앱토스에 의하면 토큰을 생성하는 함수는 아래와 같은 인자를 받는다고 되어있습니다.

async createToken(
  account: AptosAccount,
  collectionName: string,
  name: string,
  description: string,
  supply: number,
  uri: string,
  max: AnyNumber = MAX_U64_BIG_INT,
  royalty_payee_address: MaybeHexString = account.address(),
  royalty_points_denominator: number = 0,
  royalty_points_numerator: number = 0,
  property_keys: Array<string> = [],
  property_values: Array<string> = [],
  property_types: Array<string> = [],
  extraArgs?: OptionalTransactionArgs,
): Promise<string> {

공식 예제에서는 최소한의 인자를 주고 아래와 같이 토큰을 생성하고 있습니다.

const txnHash2 =await tokenClient.createToken(
  alice, //account
  collectionName, //collectionName
  tokenName,  //tokenName
  "Alice's simple token", //description
  1, //supply(발행량)
  "<https://aptos.dev/img/nyan.jpeg>", //uri: 사진이미지
);

이제 콜렉션, 토큰, 계정 등이 잘 생성되었는지 확인해보도록 하겠습니다. 아래 코드들은 특정 collection, token의 메타데이터를 가져오는 역할을 합니다.

const collectionData = await tokenClient.getCollectionData(alice.address(), collectionName);
console.log(`Alice's collection: ${JSON.stringify(collectionData, null, 4)}`);

const tokenData = await tokenClient.getTokenData(alice.address(), collectionName, tokenName);
console.log(`Alice's token data: ${JSON.stringify(tokenData, null, 4)}`);

이제 특정 지갑의 토큰 잔고를 읽어오는 코드를 보도록 하겠습니다. 앞서 await faucetClient.fundAccount(alice.address(), 100_000_000); 를 해줬기 때문에 100000000이 출력됩니다.

const aliceBalance1 = await tokenClient.getToken(
  alice.address(),
  collectionName,
  tokenName,
  `${tokenPropertyVersion}`,
);
console.log(`Alice's token balance: ${aliceBalance1["amount"]}`);

 

토큰 전송하기 1 (Offer & Claim)

이제 alice -> bob으로 토큰을 전송해보도록 하겠습니다. 앱토스는 토큰을 받는 사람이 원치 않는 토큰을 받는 상황을 방지하기 위해 offer → claim, 2가지 단계로 토큰을 전달(Transfer)하는 과정을 나눠놓았습니다. 각 코드는 아래와 같이 사용합니다.

const txnHash3 = await tokenClient.offerToken(
  alice,  //전달자
  bob.address(), //수령자 주소
  alice.address(), //토큰 생성자 주소
  collectionName,
  tokenName,
  1, //전달 수량
  tokenPropertyVersion,
);

const txnHash4 = await tokenClient.claimToken(
  bob,  //수령자
  alice.address(), //전달자 주소
  alice.address(), //토큰 생성자 주소
  collectionName,
  tokenName,
  tokenPropertyVersion,
);

 

토큰 전송하기 2 (directTransferToken)

서비스에 따라 위 과정을 나누고 싶지 않을 수 있습니다. 그래서 앱토스 sdk에서는 directTransferToken이라는 함수를 제공합니다. 이 함수를 이용하면 offer, claim을 한번에 처리할 수 있습니다.

let txnHash5 = await tokenClient.directTransferToken(
  bob,   //전달자
  alice, //수령자
  alice.address(), //생성자 주소
  collectionName,
  tokenName,
  1, //전달 수량
  tokenPropertyVersion,
);

 

다만 받는 사람(receiver)의 계정을 aptosAccount형식으로 넘겨줘야 하기 때문에 받는사람의 private key를 알고 있다는 전제하에 위 코드를 실행할 수 있습니다.

 

지금 하는 내용은 공식문서에서 진행하는 예제 코드이기 때문에 사전의 bob = new AptosClient()라고 지정해두었지만(임의의 계정), 실제 Petra wallet 과 상호작용하기 위해서는 해당 wallet의 privateKey, address를 가지고 aptosAccount객체를 만들어야 하기 때문에 수령자의 privateKey를 알고 있어야 합니다.

new AptosClient함수의  호출 형식

offerToken까지만 하면 수령자의 petra wallet에서 수령할 지 거절할 지 선택할 수 있습니다. 서비스 상에서는 offerToken까지만 하고 claim여부는 petra wallet에서 결정하도록 하는 것이 자연스럽게 보입니다.