shgraph.hedera-protobuf-java-api.0.56.2.source-code.crypto_get_stakers.proto Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hedera-protobuf-java-api Show documentation

Hedera Protobuf Java API

There is a newer version: 0.57.1

Show newest version

syntax = "proto3";

package proto;

/*-
 * ‌
 * Hedera Network Services Protobuf
 * 
 * Copyright (C) 2018 - 2021 Hedera Hashgraph, LLC
 * 
 * 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.
 * ‍
 */

option java_package = "com.hederahashgraph.api.proto.java";
// <<>> This comment is special code for setting PBJ Compiler java package
option java_multiple_files = true;

import "basic_types.proto";
import "query_header.proto";
import "response_header.proto";

/**
 * Get all the accounts that are proxy staking to this account. For each of them, give the amount
 * currently staked. This is not yet implemented, but will be in a future version of the API.
 */
message CryptoGetStakersQuery {
    /**
     * Standard info sent from client to node, including the signed payment, and what kind of
     * response is requested (cost, state proof, both, or neither).
     */
    QueryHeader header = 1;

    /**
     * The Account ID for which the records should be retrieved
     */
    AccountID accountID = 2;
}

/**
 * information about a single account that is proxy staking
 */
message ProxyStaker {
    /**
     * The Account ID that is proxy staking
     */
    AccountID accountID = 1;

    /**
     * The number of hbars that are currently proxy staked
     */
    int64 amount = 2;
}

/**
 * all of the accounts proxy staking to a given account, and the amounts proxy staked
 */
message AllProxyStakers {
    /**
     * The Account ID that is being proxy staked to
     */
    AccountID accountID = 1;

    /**
     * Each of the proxy staking accounts, and the amount they are proxy staking
     */
    repeated ProxyStaker proxyStaker = 2;
}

/**
 * Response when the client sends the node CryptoGetStakersQuery
 */
message CryptoGetStakersResponse {
    /**
     * Standard response from node to client, including the requested fields: cost, or state proof,
     * or both, or neither
     */
    ResponseHeader header = 1;

    /**
     * List of accounts proxy staking to this account, and the amount each is currently proxy
     * staking
     */
    AllProxyStakers stakers = 3;
}