데이터 앵커링

이 페이지는 Anchor API로 서비스 체인 데이터를 클레이튼 메인 체인에 앵커링하는 방법을 안내합니다.

튜토리얼에 앞서

  • API 호출에 사용되는 x-chain-id 값은 8217(Cypress) 또는 1001(Baobab)입니다.

  • API 호출에 필요한 필수 파라미터는 각 예시에 설명됩니다.

API 호출 시 사용자가 입력해야 하는 값은 중괄호 1개({})로 표시합니다. 사용자가 입력해야 하는 값은 아래 테이블과 같습니다.

API 인증 키가 있으면 모든 KAS 서비스를 사용할 수 있으며 Wallet API를 호출해 만든 Klaytn 계정에 대한 모든 권한을 소유합니다. 모든 권한에는 Klaytn 계정의 자산(KLAY 등) 이동이나 트랜잭션 전송 및 실행 권한이 포함됩니다. 만약 API 인증 키에 타인이 접근한다면 Klaytn 계정 권한을 탈취당해 원치 않는 트랜잭션이 발생할 수 있습니다.

KAS/Klaytn 계정 보안을 위해 KAS API 인증 키(Secret Access Key)를 타인과 함부로 공유하지 말고 주의해 관리하십시오.

서비스 체인에 관한 자세한 내용은 다음을 확인하십시오. 데이터 앵커링에 관한 자세한 내용은 다음을 확인하십시오.

오퍼레이터 만들기

KAS 콘솔 - Service - Anchor - Operator

KAS 콘솔 - Service - Anchor - Operator 메뉴에서 "생성" 버튼을 클릭합니다. 버튼을 클릭하면 아래와 같이 오퍼레이터를 생성하는 화면이 나타납니다.

데이터 앵커링 트랜잭션 수수료 납부 설정

KAS 콘솔에서 오퍼레이터를 생성하려면 아래와 같이 오퍼레이터가 보낼 데이터 앵커링 트랜잭션 수수료를 어떤 계정이 납부할 것인지 설정해야 합니다.

  • useGlobalFeepayer를 사용하면 KLAY 잔고가 부족해도 데이터 앵커링 트랜잭션을 전송

  • 3개 파라미터가 모두 다 설정되어 있지 않은 경우엔 에러를 반환

  • 1개 이상의 파라미터를 입력했다면 아래 우선 순위를 따라서 데이터 앵커링 트랜잭션 수수료를 대납

앵커링 트랜잭션 실행을 보장하려면 useGlobalFeepayer를 사용하십시오.

feepayer를 사용하려면 먼저 수수료 대납 계정 저장소와 수수료 대납 계정을 만들어야 합니다. feepayer를 사용하려면 수수료 대납 계정 주소(address)와 수수료 대납 계정이 소속된 수수료 대납 계정 저장소 KRN값이 필요합니다.

만약 여러분이 3개 파라미터를 모두 사용하기로 설정했다면, 우선순위가 높은 계정부터 앵커링 트랜잭션 수수료를 납부합니다. feepayer 계정 잔고가 부족하여 트랜잭션 수수료를 납부하기 어렵다면, 그 다음 순위가 오퍼레이터이므로 앵커링 트랜잭션을 전송하는 오퍼레이터가 수수료를 직접 납부합니다.

  • 파라미터 설정별 동작

오퍼레이터 생성 및 확인

파라미터 설정을 마쳤으면 오퍼레이터를 만듭니다.

오퍼레이터 오퍼레이터 목록에서 생성한 오퍼레이터를 확인할 수 있습니다.

이 문서 혹은 KAS에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

또는 모든 오퍼레이터 목록 조회 API를 호출해 조회할 수 있습니다.

오퍼레이터 목록 조회

API 호출

이미 생성된 오퍼레이터 목록과 각 오퍼레이터 설정값을 조회합니다. API 호출 시 REST API 또는 SDKs(caver-js, caver-java extensions)를 사용할 수 있습니다.

쿼리 파라미터

여러분은 커서 방식 페이지네이션을 사용해 API 응답값을 받아올 수 있습니다. 검색 범위를 초단위로 지정할 수 있습니다.

curl --location --request GET "https://anchor-api.klaytnapi.com/v1/operator?&size=100&cursor=J9Ag...VM6z&from-timestamp=1592360291&to-timestamp=15991809920" \
-u {access-key-id}:{secret-access-key} \
--header "x-chain-id: {chain-id}"
  • x-chain-id는 오퍼레이터가 등록된 체인 ID입니다.

API 응답

오퍼레이터 목록 조회 API의 응답은 아래와 같습니다.

{
  "cursor": "",
  "items": [
    {
      "operator": "0x6945B46Add33ABD0576b4D99B4c86Fe28c0Ad026",
      "setting": {
        "useGlobalFeePayer": true,
        "useOperator": true
      }
    },
    {
      "operator": "0x60A4B9342D439ED9D2DbdFf08aB9ceE1eFb73D10",
      "setting": {
        "useGlobalFeePayer": true,
        "useOperator": true
      }
    },
    {
      "operator": "0x002909B4C40a874a5587aa0D15cc847F7E79aD76",
      "setting": {
        "useGlobalFeePayer": true,
        "useOperator": true
      }
    }
  ]
}

이 API에 관한 자세한 내용은 다음을 확인하십시오. 이 문서 혹은 KAS에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

특정 오퍼레이터 정보 조회

아니면 위에서 생성한 오퍼레이터 정보를 이 오퍼레이터의 클레이튼 계정 주소(operator-id)로 조회할 수 있습니다.

API 호출

위에서 오퍼레이터 설정 및 오퍼레이터 계정 잔액을 조회합니다. API 호출 시 REST API 또는 SDKs(caver-js, caver-java extensions)를 사용할 수 있습니다.

curl --location --request GET "https://anchor-api.klaytnapi.com/v1/operator/0x6945B46Add33ABD0576b4D99B4c86Fe28c0Ad026" \
-u {access-key-id}:{secret-access-key} \
--header "x-chain-id: {chain-id}"
  • x-chain-id는 오퍼레이터가 등록된 체인 ID입니다.

API 응답

오퍼레이터 목록 조회 API의 응답은 아래와 같습니다.

{
  "operator": "0x6945B46Add33ABD0576b4D99B4c86Fe28c0Ad026",
  "setting": {
    "useGlobalFeePayer": true,
    "useOperator": true
  }
}

이 API에 관한 자세한 내용은 다음을 확인하십시오. 이 문서 혹은 KAS에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

데이터 앵커링 트랜잭션 전송하기

서비스 체인 데이터를 메인 체인에 앵커링 하려면 데이터 앵커링 API를 호출해야 합니다. 위에서 만든 오퍼레이터의 클레이튼 계정 주소로 데이터 앵커링 트랜잭션을 요청합니다.

페이로드

페이로드(payload)는 "메인 체인에 앵커링 하려는 데이터 자체"입니다. 아래 페이로드값에 입력한 customField1, customField2는 예시값입니다. 페이로드를 사용하시려면 여러분이 메인체인에 앵커링하기 원하는 데이터를 customField1, customField2와 같이 JSON 포맷(key:value)으로 입력하십시오.

id 필드에 문자열을 입력하면 이 문자열로 이 앵커링 트랜잭션의 페이로드 정보를 조회할 수 있습니다.

API 호출

데이터 앵커링 API를 아래와 같이 호출합니다. API 호출 시 REST API 또는 SDKs(caver-js, caver-java extensions)를 사용할 수 있습니다.

curl --location --request POST "https://anchor-api.klaytnapi.com/v1/anchor" \
-u {access-key-id}:{secret-access-key} \
--header "x-chain-id: {chain-id}" \
--header "Content-Type: application/json" \
--data-raw "{
  "operator": "0x6945B46Add33ABD0576b4D99B4c86Fe28c0Ad026",
  "payload": {
    "id": "{$guid}",
    "customField1": "field1",
    "customField2": "field2"
  }
}"

데이터 앵커링에 관한 자세한 내용은 다음을 확인하십시오.

수수료 대납 방식을 사용하려면 API 호출 전에 KAS 콘솔 - Anchor - Operator 메뉴에서 수수료 대납 계정을 설정하십시오. 앵커랭 트랜잭션 전송을 보장하려면 API 호출 전에 UseGlobalFeePayer를 설정하십시오.

API 응답

API 응답으로 데이터 앵커링 성공 여부를 반환합니다.

{
"status": "succeed"
}

이 API에 관한 자세한 내용은 다음을 확인하십시오. 이 문서 혹은 KAS에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오. ㅏ

앵커링 트랜잭션 목록 조회 - 오퍼레이터의 계정 주소로 조회

오퍼레이터 클레이튼 계정 주소로 이 오퍼레이터가 보낸 데이터 앵커링 트랜잭션 목록을 조회합니다.

API 호출

앵커링 트랜잭션 조회 API를 호출합니다. API 호출 시 REST API 또는 SDKs(caver-js, caver-java extensions)를 사용할 수 있습니다.

쿼리 파라미터

여러분은 커서 방식 페이지네이션을 사용해 API 응답값을 받아올 수 있습니다. 검색 범위를 초단위로 지정할 수 있습니다.

curl --location --request GET "https://anchor-api.klaytnapi.com/v1/operator/0x6945B46Add33ABD0576b4D99B4c86Fe28c0Ad026/tx?&size=100&cursor=J9Ag...VM6z&from-timestamp=1592360291&to-timestamp=15991809920" \
-u {access-key-id}:{secret-access-key} \
--header "x-chain-id: {chain-id}" \
--header "Content-Type: application/json" \

API 응답

앵커링 데이터 조회 API의 응답은 아래와 같습니다.

{
  "cursor": "",
  "items": [
    {
      "createdAt": 1599142860,
      "payloadId": "c61cc0d0-5878-450e-bec8-bf73d6184798",
      "transactionHash": "0x5aeb4ddc5d77b9ce977a87461573da00c0aed0ac59962892ecf58ec09296e79d"
    },
    {
      "createdAt": 1599142859,
      "payloadId": "d4f1a11f-4609-40f5-9d59-2313a5799508",
      "transactionHash": "0x70f6f6745ad0b0f4ce5908f40d20a1f44bd34871e0428be782d84f9a53ea2ba0"
    },
    {
      "createdAt": 1599142857,
      "payloadId": "48b59825-82b2-4595-abfb-c465112618cc",
      "transactionHash": "0x3f90cd2e02576fd85572ab76aff49b87b9cf3efb623f34bb8d6354ee1b88869f"
    },
    {
      "createdAt": 1599142841,
      "payloadId": "b315de34-52cb-41c0-9383-3260ceafd3b2",
      "transactionHash": "0x8a73a00f04a1f6e8d8af101487bd35f8dbcce6fcb3ddd95059f42b8f7fbc3345"
    }
  ]
}

이 API에 관한 자세한 내용은 다음을 확인하십시오. 이 문서 혹은 KAS에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오. ㅏ

앵커링 트랜잭션 상세 조회: 오퍼레이터 주소와 트랜잭션 해시로 페이로드 조회

오퍼레이터 주소(오퍼레이터 ID)와 트랜잭션 해시를 사용해 앵커링 트랜잭션 상세 정보를 조회합니다. 페이로드 내용을 조회할 수 있습니다.

API 호출

앵커링 트랜잭션 상세 조회 API를 호출합니다. API 호출 시 REST API 또는 SDKs(caver-js, caver-java extensions)를 사용할 수 있습니다.

curl --location --request GET "https://anchor-api.klaytnapi.com/v1/operator/0x6945B46Add33ABD0576b4D99B4c86Fe28c0Ad026/tx/0xf7db6019fcb9621ed01baf7d27d2f8cfd58b9aa24e5a1e73276ed84e254b54c0" \
-u {access-key-id}:{secret-access-key} \
--header "x-chain-id: {chain-id}"

API 응답

앵커링 트랜잭션 상세 조회 API의 응답은 아래와 같습니다.

{
  "payload": {
    "customField1": "field1",
    "customField2": "field2",
    "id": "c61cc0d0-5878-450e-bec8-bf73d6184798"
  },
  "transactionHash": "0x5aeb4ddc5d77b9ce977a87461573da00c0aed0ac59962892ecf58ec09296e79d"
}

이 API에 관한 자세한 내용은 다음을 확인하십시오. 이 문서 혹은 KAS에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

오퍼레이터 계정 주소와 페이로드 ID로 페이로드 조회

오퍼레이터 클레이튼 계정 주소(오퍼레이터 ID)와 페이로드 ID를 사용해 앵커링 트랜잭션 상세 정보와 페이로드 내용을 조회할 수 있습니다.

API 호출

앵커링 트랜잭션 상세 조회 API를 호출합니다. API 호출 시 REST API 또는 SDKs(caver-js, caver-java extensions)를 사용할 수 있습니다.

curl --location --request GET "https://anchor-api.klaytnapi.com/v1/operator/0x6945B46Add33ABD0576b4D99B4c86Fe28c0Ad026/payload/c61cc0d0-5878-450e-bec8-bf73d6184798" \
-u {access-key-id}:{secret-access-key} \
--header "x-chain-id: {chain-id}"

API 응답

앵커링 트랜잭션의 페이로드 상세 조회 API의 응답은 아래와 같습니다.

{
  "payload": {
    "customField1": "field1",
    "customField2": "field2",
    "id": "c61cc0d0-5878-450e-bec8-bf73d6184798"
  },
  "transactionHash": "0x5aeb4ddc5d77b9ce977a87461573da00c0aed0ac59962892ecf58ec09296e79d"
}

이 API에 관한 자세한 내용은 다음을 확인하십시오. 이 문서 혹은 KAS에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

Last updated