caver-java-ext-kas

caver-java-ext-kas is caver-java's extension library for using KAS(Klaytn API service).

Installation
Getting Started

Installation

maven

<dependency>
  <groupId>xyz.groundx.caver</groupId>
  <artifactId>caver-java-ext-kas</artifactId>
  <version>X.X.X</version>
  <type>pom</type>
</dependency>

<dependency>
  <groupId>xyz.groundx.caver</groupId>
  <artifactId>caver-java-ext-kas</artifactId>
  <version>X.X.X-android</version>
  <type>pom</type>
</dependency>

gradle

implementation 'xyz.groundx.caver:caver-java-ext-kas:X.X.X'

implementation 'xyz.groundx.caver:caver-java-ext-kas:X.X.X-android'

You can find latest caver-java-ext-kas version at release page.

caver-java-ext-kas requires at minimum Java 8+.

Getting Started

Initialize API

For now, you can use Node API, Token History API, Wallet API and Anchor API provided by KAS through this library. To use KAS API, the following items are required.

Access key, secret access key issued by KAS console.
Base URL to use the API provided by KAS.
The Klaytn network chain id to be used.

You can activate KAS API by writing code as below.

initKASAPI() function can initialize all API provided by KAS.

CaverExtKAS caver = new CaverExtKAS();
caver.initKASAPI(chain_id, accessKey, secretAccessKey);

If you want to initialize API each other, you can use initialize***API() instead.

CaverExtKAS caver = new CaverExtKAS();
caver.initNodeAPI(chain ID, accessKey, secretAccessKey);
caver.initWalletAPI(chain ID, accessKey, secretAccessKey);
caver.initTokenHistoryAPI(chain ID, accessKey, secretAccessKey);
caver.initAnchorAPI(chain ID, accessKey, secretAccessKey);

Use Node API

You can now use Node API through com.klaytn.caver.rpc.Klay class in caver-java library. You can send a Node API request to the KAS as shown below and check the results.

public void getBlockNumber() {
    try {
        Quantity response = caver.rpc.klay.getBlockNumber().send();
    } catch(Exception e) {
        // Handle error.
    }

Use Token History API

You can use Token History API through caver-java-ext-kas. You can send a Token History API request to the KAS as shwon below.

public void getFTContractList() {
    try {
        PageableFtContractDetails details = caver.kas.tokenHistory.getFTContractList();
        assertNotNull(details);
    } catch (ApiException e) {
        //Handle error
    }
}

You can find query options required each Token History API in KAS Docs. For defining query options, you can use TokenHistoryQueryOptions class.

TokenHistoryQueryOptions options = new TokenHistoryQueryOptions();
options.setCaFileter(..);
options.setKind(..);
options.setRange(..);
options.setSize(..);
options.setSize(..);
options.setStatus(..);
options.setType(..);

public void getNFTContractList() {
    try {
        TokenHistoryQueryOptions options = new TokenHistoryQueryOptions();
        options.setStatus("processing");
        PageableNftContractDetails details = caver.kas.tokenHistory.getNFTContractList(options);
        assertNotNull(details);
    } catch (ApiException e) {
        //handle error
    }
}

Use Wallet API

You can use Wallet API through caver-java-ext-kas. You can send a Wallet API request to the KAS as shwon below.

public void createAccount() {
    try {
        Account account = caver.kas.wallet.createAccount();
        assertNotNull(account);
    } catch (ApiException e) {
        //handle error
    }
}

You can find query options required each Wallet API in KAS Docs. For defining query options, you can use WalletQueryOptions class.

WalletQueryOptions options = new WalletQueryOptions();
options.setSize();
options.setCursor();
options.setFromTimestamp();
options.setToTimesatamp();

Use Anchor API

You can use Anchor API through caver-java-ext-kas. You can send a Anchor API request to the KAS as shwon below.

public void getOperators() {
    try {
        Operators res = caver.kas.anchor.getOperators();
        assertNotNull(res);
    } catch(ApiException e) {
        //handle error
    }
}

You can find query options required each Anchor API in KAS Docs. For defining query options, you can use AnchorQueryOptions class.

AnchorQueryOptions options = new AnchorQueryOptions();
options.setSize();
options.setCursor();
options.setFromTimestamp();
options.setToTimesatamp();

jimni1222 / caver-java-ext-kas Goto Github PK