io.proximax.sdk.TransactionRepository 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.util.List;

import io.proximax.sdk.model.transaction.CosignatureSignedTransaction;
import io.proximax.sdk.model.transaction.SignedTransaction;
import io.proximax.sdk.model.transaction.Transaction;
import io.proximax.sdk.model.transaction.TransactionAnnounceResponse;
import io.proximax.sdk.model.transaction.TransactionStatus;
import io.reactivex.Observable;

/**
 * Transaction interface repository.
 *
 * @since 1.0
 */
public interface TransactionRepository {

    /**
     * Gets a transaction for a given hash.
     *
     * @param transactionHash String
     * @return Observable of Transaction
     */
    Observable getTransaction(String transactionHash);

    /**
     * Gets an list of transactions for different transaction hashes.
     *
     * @param transactionHashes List of String
     * @return Observable of Transaction list
     */
    Observable> getTransactions(List transactionHashes);

    /**
     * Gets a transaction status for a transaction hash.
     *
     * @param transactionHash String
     * @return Observable of TransactionStatus
     */
    Observable getTransactionStatus(String transactionHash);

    /**
     * Gets an list of transaction status for different transaction hashes.
     *
     * @param transactionHashes List of String
     * @return Observable of TransactionStatus list
     */
    Observable> getTransactionStatuses(List transactionHashes);

    /**
     * Send a signed transaction.
     *
     * @param signedTransaction SignedTransaction
     * @return Observable of TransactionAnnounceResponse
     */
    Observable announce(SignedTransaction signedTransaction);

    /**
     * Send a signed transaction with missing signatures.
     *
     * @param signedTransaction SignedTransaction
     * @return Observable of TransactionAnnounceResponse
     */
    Observable announceAggregateBonded(SignedTransaction signedTransaction);

    /**
     * Send a co-signature signed transaction of an already announced transaction.
     *
     * @param cosignatureSignedTransaction CosignatureSignedTransaction
     * @return Observable of TransactionAnnounceResponse
     */
    Observable announceAggregateBondedCosignature(CosignatureSignedTransaction cosignatureSignedTransaction);
}