uk.oczadly.karl.jnano.rpc.request.wallet.RequestWalletInfo Maven / Gradle / Ivy

/*
 * Copyright (c) 2020 Karl Oczadly ([email protected])
 * Licensed under the MIT License
 */

package uk.oczadly.karl.jnano.rpc.request.wallet;

import com.google.gson.annotations.Expose;
import com.google.gson.annotations.SerializedName;
import uk.oczadly.karl.jnano.rpc.request.RpcRequest;
import uk.oczadly.karl.jnano.rpc.response.ResponseWalletInfo;

/**
 * This request class is used to retrieve summarized information about all of the accounts within a given wallet.
 * 
Calls the RPC command {@code wallet_info}, and returns a {@link ResponseWalletInfo} data object.
 *
 * @see Official RPC documentation
 */
public class RequestWalletInfo extends RpcRequest {
    
    @Expose @SerializedName("wallet")
    private final String walletId;
    
    
    /**
     * @param walletId the wallet's ID
     */
    public RequestWalletInfo(String walletId) {
        super("wallet_info", ResponseWalletInfo.class);
        this.walletId = walletId;
    }
    
    
    /**
     * @return the wallet's ID
     */
    public String getWalletId() {
        return walletId;
    }
    
}