com.concordium.sdk.cis2

Class Cis2Client

java.lang.Object

com.concordium.sdk.cis2.Cis2Client

public class Cis2Client
extends Object

A client dedicated to the CIS2 specification.

Method Summary

Modifier and Type	Method and Description
Map<BalanceQuery,TokenAmount>	balanceOf(BalanceQuery... queries) Query the balance of token ids and associated AbstractAddress
ClientV2	getClient()
ContractAddress	getContractAddress()
InitName	getContractName()
Iterator<Cis2EventWithMetadata>	getEvents(BlockQuery from, BlockQuery to) Retrieve all events emitted from the CIS2 contract.
Iterator<Cis2EventWithMetadata>	getEventsFor(BlockQuery... queries) Get any events associated emitted from the specified CIS2 contract.
Iterator<Cis2EventWithMetadata>	getEventsForFinalizedTransaction(Hash transactionHash) Get any events associated emitted from the specified CIS2 contract by the supplied transaction hash.
static Cis2Client	newClient(ClientV2 client, ContractAddress address) Construct a new Cis2Client with the provided ClientV2 for the provided ContractAddress
Map<OperatorQuery,Boolean>	operatorOf(OperatorQuery... queries) Query whether one or more owners are operators for one or more addresses.
Map<TokenId,TokenMetadata>	tokenMetadata(TokenId... tokenIds) Query the token metadata for each provided token id
Hash	transfer(AccountAddress sender, TransactionSigner signer, Energy maxEnergyCost, Cis2Transfer... transfers) Perform a CIS2 transfer on the contract.
Hash	updateOperator(AccountAddress sender, TransactionSigner signer, Energy maxEnergyCost, Map<AbstractAddress,Boolean> operatorUpdates) Update the addresses of which the owner (sender of this transaction) operates.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newClient

public static Cis2Client newClient(ClientV2 client,
                                   ContractAddress address)

Construct a new Cis2Client with the provided ClientV2 for the provided ContractAddress

Parameters:

client - client to use

address - the address of the cis 2 contract

Returns:

a cis2 client for interfacing with the provided contract

transfer

public Hash transfer(AccountAddress sender,
                     TransactionSigner signer,
                     Energy maxEnergyCost,
                     Cis2Transfer... transfers)

Perform a CIS2 transfer on the contract.

Parameters:

sender - address of the sender of the transaction.

signer - signer of the transaction.

transfers - the CIS2 transfers.

Returns:

the transaction hash

updateOperator

public Hash updateOperator(AccountAddress sender,
                           TransactionSigner signer,
                           Energy maxEnergyCost,
                           Map<AbstractAddress,Boolean> operatorUpdates)

Update the addresses of which the owner (sender of this transaction) operates.

Parameters:

operatorUpdates - the updates to carry out. The keys of the map correspond to the addresses which the sender (owner) should or should not operate given by the provided boolean.

Returns:

the transaction hash

balanceOf

public Map<BalanceQuery,TokenAmount> balanceOf(BalanceQuery... queries)

Query the balance of token ids and associated AbstractAddress

Parameters:

queries - the token ids and addresses to query

Returns:

the balances together with the queries used

operatorOf

public Map<OperatorQuery,Boolean> operatorOf(OperatorQuery... queries)

Query whether one or more owners are operators for one or more addresses.

Parameters:

queries - the addresses to query.

Returns:

A map where the values indicate whether the specified owner was indeed operator of the supplied address.

tokenMetadata

public Map<TokenId,TokenMetadata> tokenMetadata(TokenId... tokenIds)

Query the token metadata for each provided token id

Parameters:

tokenIds - the token ids to query

Returns:

A map where the values indicate the token metadata responses for each TokenId

getEvents

public Iterator<Cis2EventWithMetadata> getEvents(BlockQuery from,
                                                 BlockQuery to)

Retrieve all events emitted from the CIS2 contract.

Parameters:

from - block to start from

to - block to end from

Returns:

the list of events.

getEventsFor

public Iterator<Cis2EventWithMetadata> getEventsFor(BlockQuery... queries)

Get any events associated emitted from the specified CIS2 contract.

Parameters:

queries - blocks to query

Returns:

the list of events.

getEventsForFinalizedTransaction

public Iterator<Cis2EventWithMetadata> getEventsForFinalizedTransaction(Hash transactionHash)

Get any events associated emitted from the specified CIS2 contract by the supplied transaction hash.

Parameters:

transactionHash - the hash of the transaction to query outcome for.

Returns:

the list of events which originated from the specified transaction hash.

Throws:

IllegalArgumentException - if the transaction was not finalized.

getClient

public ClientV2 getClient()

getContractAddress

public ContractAddress getContractAddress()

getContractName

public InitName getContractName()