Wallet API

Download OpenAPI specification:Download

Introduction

Wallet API는 개발자들이 Klaytn 계정을 만들어 관리하고, 트랜잭션을 전송할 수 있게 도와줍니다. 생성한 Klaytn 계정의 개인 키를 안전하게 보관할 수 있도록 지갑을 제공하기도 합니다. Wallet API의 엔드포인트를 사용하여 다음 작업을 수행할 수 있습니다.

계정 관리
- Klaytn 계정의 생성과 조회, 그리고 삭제
- Klaytn 계정을 다중서명(Multisig) 계정, 역할 기반 계정으로 업데이트
- 계정 풀에 등록된 모든 계정의 개인 키 관리
- 계정 풀 관리
트랜잭션 생성과 전송
- 기본 트랜잭션
- 수수료 대납 트랜잭션
  - 글로벌 수수료 대납 트랜잭션
  - 사용자 수수료 대납 트랜잭션
- 다중서명 트랜잭션
- RLP 인코딩된 트랜잭션

KAS에서 말하는 기본 트랜잭션은 Klaytn 트랜잭션과 동일하고, 수수료 대납 트랜잭션은 트랜잭션의 대납 주최에 따라 구분됩니다. GroundX의 KAS 계정에서 트랜잭션 수수료를 대납하고 여러분에게 후불 청구하는 방식이라면 글로벌 수수료 대납 트랜잭션, 여러분이 생성한 대납 계정으로 트랜잭션 수수료를 직접 지불하는 방식은 사용자 수수료 대납 트랜잭션입니다. 다중서명 트랜잭션은 트랜잭션을 전송할 때 한 개 이상의 서명이 필요한 트랜잭션입니다. 서명의 임계값(Threshold)을 만족하면 Klaytn에 자동 전송됩니다.

관리자는 KAS 콘솔에서 계정 풀을 생성하거나 조회하는 등의 전반적 풀 관리와 계정 조회 기능을 활용할 수 있습니다.

중요

Wallet API v2에서 지원하지 않는 기능이 있습니다. API를 사용하기 전에 반드시 확인하시기 바랍니다.

[미지원 항목]

Service Chain

외부 관리 키에 대한 계정 관리

RLP 인코딩된 트랜잭션의 다중서명

Caution

Managed Nonce

/v2/tx/* API 이용 시 nonce 값이 0이라면 Wallet API에서 해당 계정에 대한 nonce를 자동 조회하여 트랜잭션 파라미터를 설정합니다.

주의

이 때 부하가 발생하면 요청 순서와 nonce 순서를 보장하기 어렵습니다. 예를 들어, 먼저 실행될 것을 기대하고 요청한 트랜잭션이 예상보다 큰 nonce 값을 가지면 앞 순서의 작은 nonce 값을 기다리면서 지연 실행될 수 있습니다.

순서가 중요할 경우 nonce 값을 직접 설정하세요. 클라이언트가 보낸 값으로 트랜잭션 파라미터를 설정합니다.

Authorization

공통 에러 Unauthorized는 호출하는 API 종류에 상관없이 인증 시스템이 정상적으로 실행되지 않으면 발생합니다.

401: Unauthorized

Code	Message
1010007	The path or method in request is invalid. Check the service API documentation and try again.
1010009	The credential you entered is invalid.

Authentication

basic

KAS는 Basic HTTP Auth를 사용합니다. 모든 요청은 반드시 올바른 Authorization 헤더를 가져야 하며 KAS 사용자는 access key ID를 username으로, secret access key를 password로 사용하여 Basic Auth에 사용할 자격증명을 생성합니다.

참고

KAS 계정의 각 Credential은 모든 KAS 서비스를 사용할 수 있으며, Wallet API로 만든 Klaytn 계정에 대한 모든 권한을 소유하기 때문에, 생성한 Klaytn 계정의 자산(KLAY 등) 이동이나 트랜잭션 실행 권한을 가집니다. KAS/Klaytn 계정 보안을 위해 KAS API 인증 키(Secret Access Key)를 타인과 함부로 공유하지 말고 주의해 관리하십시오.

cURL

  curl --location --request POST 'https://wallet-api.klaytnapi.com/v2/account' \
  -u ${your_accessKeyId}:${your_secretAccessKey} \
  --header 'x-chain-id: 1001' \
  --header 'Content-Type: application/json'

Security Scheme Type	HTTP
HTTP Authorization Scheme	basic