Aptos Indexer API를 한 번도 사용해보신 적이 없으신가요? 걱정하지 마세요! 이 가이드를 읽고 차근차근 진행하면 Aptos Indexer API를 어떻게 사용하는지, 그리고 어디에서 활용할 수 있는지 자연스럽게 배울 수 있습니다.
이 가이드는 다음 세 가지 주요 단계로 진행됩니다.
- Nodit 사용을 위한 환경 설정하기
- Indexer API 사용해보기
- Dapp에서 Indexer API 활용해보기
1. Setting up Nodit Console
첫 번째 챕터에서는 Aptos Indexer API를 사용하기 위해 Nodit 콘솔 환경을 설정합니다. Nodit 콘솔을 이용하면 Aptos 네트워크에 연결하고, API 키를 발급받아 다양한 데이터를 손쉽게 조회할 수 있습니다. 환경 설정 단계에서는 Nodit 회원가입부터 Aptos 노드 연결, API Key 발급까지의 과정을 진행합니다.
1.1. Sign-up for Nodit
가장 먼저 회원가입을 진행해볼까요?
아래 링크를 클릭하여 회원가입 페이지로 이동합니다. 구글 계정으로 간편하게 가입하거나, 이메일 계정을 직접 입력하여 가입하실 수 있습니다.
1.2. Connect to Aptos Networks
회원가입 후, 첫 로그인 시 온보딩 과정을 통해 프로젝트를 생성하고 프로젝트에 필요한 노드를 연결할 수 있습니다. 이 가이드에서는 Aptos Indexer API를 사용할 예정입니다. 따라서 반드시 Aptos Maninnet과 Testnet을 선택하고, Go to Nodit 버튼을 클릭해주세요.
온보딩 과정을 성공적으로 완료했다면, 방금 선택한 노드들이 연결된 새로운 프로젝트가 생성됩니다.
아래 그림처럼 프로젝트 Overview 페이지에서 Connected Nodes에 Aptos Mainnet과 Testnet 카드가 있다면 성공적으로 연결이 완료된 것입니다.
온보딩 화면에서 Aptos를 선택하지 못했나요?
온보딩 화면에서 Aptos를 선택하지 못했더라도 걱정하지마세요! 노드 대시보드 페이지에서 원하는 체인의 노드를 추가로 연결하거나 연결 해제할 수 있습니다.
노드 관리에 대한 더 자세한 내용은 아래 문서 링크를 확인하세요.
1.3. Get Indexer API Endpoint
API Endpoint는 Indexer API 호출의 목적지 URL로, 내 프로젝트에 연결된 노드별로 할당됩니다. API Endpoint 주소는 프로젝트 Overview 페이지 또는 Nodes 페이지에서 조회할 수 있습니다. Indexer API를 호출할 대상 네트워크(Aptos Mainnet 혹은 Aptos Testnet)의 ‘Indexer API Endpoint’ 버튼을 클릭한 후 값을 복사하여 안전하게 보관 후 사용하세요. 이때 Indexer API Endpoint에는 API Key가 포함되어 있기 때문에 외부에 노출이 되지 않도록 주의해야 합니다.
이제 Nodit을 사용할 모든 준비가 완료됐어요! 본격적으로 Indexer API를 사용해볼까요?
2. Exploring Aptos Indexer API
이번 챕터에서는 Aptos Indexer API로 데이터를 조회하는 방법을 배웁니다. 그리고 간단한 쿼리문을 작성해보고 실제 데이터를 조회할 예정입니다. 만약 어떤 쿼리문을 작성할지 모르겠다면, Nodit에서 제공하고 있는 Query Templates을 활용해보세요!
▶ Link to Query Templates (Coin)
▶ Link to Query Templates (NFT)
이 세션에서는 특정 계정이 가지고 있는 Fungible Asset의 리스트를 조회해볼 예정입니다. 아래의 쿼리문을 복사하여 아래 과정에서 활용해보세요.
query FA_Balances {
current_fungible_asset_balances(
limit: 10
offset: 0
where: {
owner_address: {
# You can change the below address
_eq: "0x0000000000000000000000000000000000000000000000000000000000000001"
}
}
)
{
owner_address
amount
asset_type
token_standard
metadata {
asset_type
creator_address
decimals
name
symbol
token_standard
maximum_v2
supply_v2
}
}
}
▶️ Link to Query template of “Get Fungible Asset Balances by Account”
2.1. Try out in Nodit Docs
Aptos Indexer API를 통해 데이터를 조회하기 위해서는 먼저 쿼리문을 작성해야 합니다. 만약 Aptos Indexer API에서 어떤 스키마를 제공하는지, 그리고 쿼리문을 어떻게 작성하는지 모른다면 Nodit 공식 문서를 활용해보세요! 아래 링크를 클릭하면 Aptos Indexer API를 자유롭게 테스트할 수 있는 페이지로 연결됩니다.
▶ Link to Aptos Indexer API in Nodit Docs
이 페이지의 중간 부분에는 쿼리문 작성 및 호출과 응답을 확인해 볼 수 있습니다. 우측 부분에는 Aptos Indexer API에서 제공하는 스키마와 필드를 표시하고 있으며, 여기서 원하는 스키마와 필드를 클릭하면 자동으로 쿼리문이 작성됩니다. 이제 위에서 제공된 쿼리문을 복사하여 붙여넣고, "Try it" 버튼을 눌러서 응답을 확인해보세요!
현재 Nodit Docs 페이지에서는 Aptos Mainnet 환경만 지원합니다. Testnet 데이터를 위와 같은 방법으로 조회하고자 하는 경우 Hasura Cloud와 같은 3rd party 서비스를 사용할 수 있습니다.
2.2. Try out using Hasura Cloud
Hasura는 연결된 데이터베이스에 대해 실시간 쿼리 및 구독 기능을 제공하는 오픈 소스 엔진입니다. Hasura를 사용하면 Indexer API를 쉽게 테스트할 수 있습니다.
아래 링크를 클릭하여 Hasura Cloud에 접속합니다.
챕터 1에서 복사한 Indexer API Endpoint를 입력하여 연결합니다.
Nodit 문서와 동일하게 이 페이지의 중간 부분에는 쿼리문 작성 및 호출과 응답을 확인해 볼 수 있으며, 좌측 부분에는 스키마와 필드를 표시하고 있습니다.
이제 위에서 제공된 쿼리문을 복사하여 붙여넣고, 실행 버튼(▶️ 모양)을 눌러서 응답을 확인해보세요!
축하합니다!🎉🎉 이제 여러분은 Aptos Indexer API를 이용하여 성공적으로 데이터를 조회할 수 있게 되었어요. 이 가이드의 내용을 활용해서 각자의 프로젝트에 맞게 쿼리문을 작성하고 Aptos Indexer API를 적용해보세요. 프로젝트를 구현하는데 수월해질거에요!😃