Skip to content

Latest commit

 

History

History
538 lines (469 loc) · 11.7 KB

Klaytn SDK.md

File metadata and controls

538 lines (469 loc) · 11.7 KB
Raw

클레이튼 V3 REST API 문서

클레이튼 개발자 문서 바로가기 함수 호출에 필요한 매개변수 또는 반환되는 데이터에 대해서는 REST API 개발자 문서를 참고해 주시길 바랍니다.

클라이언트 생성 (테스트넷)

<?php
use BlockSDK;

$blockSDK = new BlockSDK("YOU_TOKEN");
$klayClient = $blockSDK->createKlaytn();

//or

$klayClient = BlockSDK::createKlaytn("YOU_TOKEN");

클라이언트 생성 (메인넷)

엔드 포인트를 지정해주지 않는경우 테스트넷으로 기본 설정되어 호출 됩니다 메인넷은 아래 예시와 같이 클라이언트 생성시 두번째 매개변수를 메인넷으로 지정해 주시길 바랍니다.

<?php
use BlockSDK;

$blockSDK = new BlockSDK("YOU_TOKEN","https://mainnet-api.blocksdk.com");
$klayClient = $blockSDK->createKlaytn();

//or

$klayClient = BlockSDK::createKlaytn("YOU_TOKEN","https://mainnet-api.blocksdk.com");

규약

모든 URL,Query,Body 매개변수는 모든 함수는 첫번쨰 인수를 Array 형 으로 key = 매개변수명 value = 매개변수값 형태로 호출하실수 있습니다.

<?php
$nfts = $klayClient->GetSingleNfts([
    "contract_address" => "0xf5de760f2e916647fd766b4ad9e85ff943ce3a2b",
    "includeMetadata" => true,
    "offset" => 0,
    "limit" => 10
]);

블록체인 정보

GET /v3/klay/info

$result = $klayClient->GetBlockChainInfo();

블록 정보

GET /v3/klay/block/<block>

$result = $klayClient->GetBlock([
    'block' => "blockNumber 또는 blockHash"
]);

주소 목록

GET /v3/klay/address

$result = $klayClient->GetAddresses([
    'offset' => 0,
    'limit' => 10
]);

주소 정보

GET /v3/klay/address/<address>/info

$result = $klayClient->GetAddressInfo([
    'address' => "주소",
    'offset' => 0,
    'limit' => 10
]);

주소 생성

POST /v3/klay/address

$result = $klayClient->CreateAddress([
    'name' => "test"
]);

주소 잔액

GET /v3/klay/address/<address>/balance

$result = $klayClient->GetAddressBalance([
    'address' => "주소"
]);

주소 거래 전송

POST /v3/klay/address/<from_address>/send

$result = $klayClient->Send([
    'from_address' => "주소",
    'to' => "주소",
    'amount' => "보낼 양",
    'private_key' => "보내는 주소 키"
]);

거래 전송

POST /v3/klay/transaction/send

$result = $klayClient->SendTransaction([
    'hex' => "서명된 트랜잭션 hex"
]);

거래 조회

GET /v3/klay/transaction/<tx_hash>

$result = $klayClient->GetTransaction([
    'tx_hash' => "트랜잭션 해쉬"
]);

ERC20 토큰 정보

GET /v3/klay/token/<contract_address>/info

$result = $klayClient->GetTokenInfo([
    'contract_address' => "ERC20 토큰 컨트렉트 주소"
]);

ERC20 토큰 잔액

GET /v3/klay/token/<contract_address>/<from_address>/balance

$result = $klayClient->GetTokenBalance([
    'contract_address' => "ERC20 토큰 컨트렉트 주소",
    'from_address' => "잔액을 조회할 주소"
]);

ERC20 토큰 전송

POST /v3/klay/token/<contract_address>/<from_address>/transfer

$result = $klayClient->SendToken([
    'contract_address' => "ERC20 토큰 컨트렉트 주소",
    'from_address' => "토큰을 전송할 주소",
    'to' => "주소",
    'amount' => "보낼 양",
    'private_key' => "보내는 주소 키"
]);

ERC20 특정 주소 거래 조회

GET /v3/klay/token/<from_address>/transactions

$result = $klayClient->GetTokenTxs([
    'from_address' => "거래 내역을 조회할 주소",
    'offset' => 0,
    'limit' => 10
]);

ERC20 특정 컨트렉트 거래 조회

GET /v3/klay/token/<contract_address>/<from_address>/transactions

$result = $klayClient->GetTokenContractTxs([
    'contract_address' => "ERC20 토큰 컨트렉트 주소",
    'from_address' => "거래 내역을 조회할 주소",
    'offset' => 0,
    'limit' => 10
]);

ERC20 소유내역 조회

GET /v3/klay/token/<from_address>/all-balance

$result = $klayClient->GetTokenAllBalance([
    'from_address' => "토큰 목록을 조회할 주소",
    'offset' => 0,
    'limit' => 10
]);

ERC721(NFT) 특정 컨트렉트 NFT 목록

GET /v3/klay/single-nft/<contract_address>/nfts

$result = $klayClient->GetSingleNfts([
    'contract_address' => "목록을 조회할 주소",
    'offset' => 0,
    'limit' => 10
]);

ERC721(NFT) 특정 월렛 소유중인 NFT 조회

GET /v3/klay/single-nft/<owner_address>/owner-nfts

$result = $klayClient->GetSingleOwnerNfts([
    'owner_address' => "목록을 조회할 주소",
    'offset' => 0,
    'limit' => 10
]);

ERC721(NFT) 특정 월렛 생성한 NFT 조회

GET /v3/klay/single-nft/<creator_address>/creator-nfts

$result = $klayClient->GetSingleCreatorNfts([
    'creator_address' => "목록을 조회할 주소",
    'offset' => 0,
    'limit' => 10
]);

ERC721(NFT) 특정 월렛 NFT 거래 조회

GET /v3/klay/single-nft/<from_address>/transactions

$result = $klayClient->GetSingleTxs([
    'from_address' => "토큰 목록을 조회할 주소",
    'offset' => 0,
    'limit' => 10
]);

ERC721(NFT) 특정 컨트렉트,월렛 의 소유중인 NFT 조회

GET /v3/klay/single-nft/<contract_address>/<owner_address>/owner-nfts

$result = $klayClient->GetSingleNftOwnerNfts([
    'contract_address' => "목록을 조회할 주소",
    'owner_address' => "월렛 주소",
    'offset' => 0,
    'limit' => 10
]);

ERC721(NFT) 특정 컨트렉트,월렛의 생성한 NFT 조회

GET /v3/klay/single-nft/<contract_address>/<creator_address>/creator-nfts

$result = $klayClient->GetSingleNftCreatorNfts([
    'contract_address' => "NFT 컨트렉트 주소",
    'creator_address' => "토큰 목록을 조회할 주소",
    'offset' => 0,
    'limit' => 10
]);

ERC721(NFT) 특정 컨트렉트,월렛의 NFT 거래 조회

GET /v3/klay/single-nft/<contract_address>/<from_address>/from-transactions

$result = $klayClient->GetSingleNftTxs([
    'contract_address' => "NFT 컨트렉트 주소",
    'from_address' => "목록을 조회할 주소",
    'offset' => 0,
    'limit' => 10
]);

ERC721(NFT) 특정 NFT 거래내역 조회

GET /v3/klay/single-nft/<contract_address>/<token_id>/nft-transactions

$result = $klayClient->GetSingleNftTokenTxs([
    'contract_address' =>  "NFT 컨트렉트 주소",
    'token_id' =>  "NFT 토큰 ID",
    'offset' => 0,
    'limit' => 10
]);

ERC721(NFT) 특정 NFT 정보 조회

GET /v3/klay/single-nft/<contract_address>/<token_id>/info

$result = $klayClient->GetSingleNftInfo([
    'contract_address' => "NFT 컨트렉트 주소",
    'token_id' =>  "NFT 토큰 ID",
    'offset' => 0,
    'limit' => 10
]);

ERC1155(NFT) 특정 컨트렉트 NFT 목록 조회

GET /v3/klay/multi-nft/<contract_address>/nfts

$result = $klayClient->GetMultiNfts([
    'contract_address' =>"NFT 컨트렉트 주소",
    'offset' => 0,
    'limit' => 10
]);

ERC1155(NFT) 특정 월렛 소유하고 있는 NFT 목록 조회

GET /v3/klay/multi-nft/<owner_address>/owner-nfts

$result = $klayClient->GetMultiOwnerNfts([
    'owner_address' => "목록을 조회할 주소",
    'offset' => 0,
    'limit' => 10
]);

ERC1155(NFT) 특정 월렛 생성한 NFT 목록 조회

GET /v3/klay/multi-nft/<creator_address>/creator-nfts

$result = $klayClient->GetMultiCreatorNfts([
    'creator_address' => "목록을 조회할 주소",
    'offset' => 0,
    'limit' => 10
]);

ERC1155(NFT) 특정 월렛 NFT 거래 내역 조회

GET /v3/klay/multi-nft/<from_address>/transactions

$result = $klayClient->GetMultiTxs([
    'from_address' => "목록을 조회할 주소",
    'offset' => 0,
    'limit' => 10
]);

ERC1155(NFT) 특정 컨트렉트,월렛이 소유한 NFT 목록 조회

GET /v3/klay/multi-nft/<contract_address>/<owner_address>/owner-nfts

$result = $klayClient->GetMultiNftOwnerNfts([
    'contract_address' => "NFT 컨트렉트 주소",
    'owner_address' => "목록을 조회할 주소",
    'offset' => 0,
    'limit' => 10
]);

ERC1155(NFT) 특정 컨트렉트,월렛이 생성한 NFT 목록 조회

GET /v3/klay/multi-nft/<contract_address>/<creator_address>/creator-nfts

$result = $klayClient->GetMultiNftCreatorNfts([
    'contract_address' => "NFT 컨트렉트 주소",
    'creator_address' => "목록을 조회할 주소",
    'offset' => 0,
    'limit' => 10
]);

ERC1155(NFT) 특정 컨트렉트,월렛의 NFT 거래 내역 조회

GET /v3/klay/multi-nft/<contract_address>/<from_address>/from-transactions

$result = $klayClient->GetMultiNftTxs([
    'contract_address' => "NFT 컨트렉트 주소",
    'from_address' => "목록을 조회할 주소",
    'offset' => 0,
    'limit' => 10
]);

ERC1155(NFT) 특정 NFT 정보&소유자 조회

GET /v3/klay/multi-nft/<contract_address>/<token_id>/info

$result = $klayClient->GetMultiNftInfo([
    'contract_address' => "NFT 컨트렉트 주소",
    'token_id' =>  "NFT 토큰 ID",
    'offset' => 0,
    'limit' => 10
]);

ERC1155(NFT) 특정 NFT 거래내역 조회

GET /v3/klay/multi-nft/<contract_address>/<token_id>/nft-transactions

$result = $klayClient->GetMultiNftTokenTxs([
    'contract_address' => "NFT 컨트렉트 주소",
    'token_id' =>  "NFT 토큰 ID",
    'offset' => 0,
    'limit' => 10
]);

스마트 계약 함수호출(읽기)

POST /v3/klay/contract/<contract_address>/read

$result = $klayClient->ReadContract([
    'contract_address' => "컨트렉트 주소",
    'method' => "ownerOf",
    'return_type' => "address",
    'parameter_type' => ["uint256"],
    'parameter_data' => [1]
]);

스마트 계약 함수호출(쓰기)

POST /v3/klay/contract/<contract_address>/write

$result = $klayClient->WriteContract([
    'contract_address' => "컨트렉트 주소",
    'from' => "트랜잭션을 생성할 주소",
    'private_key' => "from 의 프라이빗키",
    'method' => "transfer",
    'parameter_type' => ["uint256"],
    'parameter_data' => [1]
]);

NFT 마켓 ERC721 경매 진행중인 NFT 목록

GET /v3/klay/single-nft/<contract_address>/auction-nfts

$result = $klayClient->GetSingleNftAuctionNfts([
    'contract_address' => "NFT 컨트렉트 주소",
    'offset' => 0,
    'limit' => 10
]);

NFT 마켓 ERC721 특정 월렛 판매 등록한 NFT 목록

GET /v3/klay/single-nft/<contract_address>/<seller_address>/sale-nfts

$result = $klayClient->GetSingleNftSellerNfts([
    'contract_address' => "NFT 컨트렉트 주소",
    'seller_address' => "토큰 목록을 조회할 주소",
    'offset' => 0,
    'limit' => 10
]);

NFT 마켓 ERC721 특정 NFT 입찰 거래 내역

GET /v3/klay/single-nft/<contract_address>/<token_id>/nft-bids

$result = $klayClient->GetSingleNftTokenBids([
    'contract_address' => "NFT 컨트렉트 주소",
    'token_id' =>  "NFT 토큰 ID",
    'offset' => 0,
    'limit' => 10
]);

NFT 마켓 ERC1155 특정 월렛 판매 등록한 NFT 목록

GET /v3/klay/multi-nft/<contract_address>/<seller_address>/seller-nfts

$result = $klayClient->GetMultiNftSellerNfts([
    'contract_address' => "NFT 컨트렉트 주소",
    'seller_address' => "토큰 목록을 조회할 주소",
    'offset' => 0,
    'limit' => 10
]);