io.proximax.sdk.BlockchainRepository Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-xpx-chain-sdk Show documentation
The ProximaX Sirius Chain Java SDK is a Java library for interacting with the Sirius Blockchain.
The newest version!
/*
 * Copyright 2018 NEM
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.proximax.sdk;

import java.math.BigInteger;
import java.util.List;

import io.proximax.sdk.infrastructure.QueryParams;
import io.proximax.sdk.model.blockchain.*;
import io.proximax.sdk.model.transaction.Transaction;
import io.reactivex.Observable;

/**
 * Blockchain interface repository
 *
 * @since 1.0
 */
public interface BlockchainRepository {

    /**
     * Gets a BlockInfo for a given block height.
     *
     * @param height BigInteger
     * @return Observable of {@link BlockInfo}
     */
    Observable getBlockByHeight(BigInteger height);

    /**
     * Gets list of transactions included in a block for a block height
     *
     * @param height BigInteger
     * @return Observable of {@link Transaction} list
     */
    Observable> getBlockTransactions(BigInteger height);

    /**
     * Gets list of transactions included in a block for a block height
     * With pagination.
     *
     * @param height      BigInteger
     * @param queryParams QueryParams
     * @return Observable of {@link Transaction} list
     */
    Observable> getBlockTransactions(BigInteger height, QueryParams queryParams);

    /**
     * Gets current blockchain height.
     *
     * @return Observable of BigInteger
     */
    Observable getBlockchainHeight();

    /**
     * Gets current blockchain score.
     *
     * @return Observable of BigInteger
     */
    Observable getBlockchainScore();

    /**
     * Gets blockchain storage info.
     *
     * @return Observable of {@link BlockchainStorageInfo}
     */
    Observable getBlockchainStorage();
    
    /**
     * retrieve node information
     * 
     * @return the node info
     */
    Observable getNodeInfo();
    
    /**
     * retrieve node time
     * 
     * @return the node time
     */
    Observable getNodeTime();
    
    /**
     * Get current network type.
     *
     * @return network type enum.
     */
    Observable getNetworkType();
    
    /**
     * Get block receipts
     * 
     * @param height height of the block to retrieve receipts
     * @return observable receipts
     */
    Observable getBlockReceipts(BigInteger height);
    
    /**
     * get the merkle path of receipt specified by the block height and hash
     * 
     * @param height height of the block to check
     * @param receiptHash hash of the receipt
     * @return the merkle path
     */
    Observable getReceiptMerklePath(BigInteger height, String receiptHash);
    
    /**
     * get the merkle path of transaction specified by the block height and hash
     * 
     * @param height height of the block to check
     * @param transactionHash hash of the transaction
     * @return the merkle path
     */
    Observable getTransactionMerklePath(BigInteger height, String transactionHash);
    
    /**
     * Gets up to limit number of blocks starting by given block height (i.e. inclusive of the specified height)
     * 
     * @param height block height to start from
     * @param limit limit on number of blocks that get retrieved
     * @return list of block info instances
     */
    Observable> getBlocksByHeightWithLimit(BigInteger height, BlocksLimit limit);
    
    /**
     * retrieve network configuration
     * 
     * @param height the block height at which retrieved configuration was/is valid
     * @return network configuration at give height
     */
    Observable getBlockchainConfiguration(BigInteger height);
    
    /**
     * get information about blockchain upgrade at given height
     * 
     * @param height the height at which the information is requested
     * @return the blockchain upgrade information
     */
    Observable getBlockchainUpgrade(BigInteger height);

}