forked from TrueCloudLab/frostfs-api
53 lines
1.7 KiB
Protocol Buffer
53 lines
1.7 KiB
Protocol Buffer
syntax = "proto3";
|
|
|
|
package accounting;
|
|
|
|
option go_package = "github.com/nspcc-dev/neofs-api-go/accounting";
|
|
option csharp_namespace = "NeoFS.API.Accounting";
|
|
|
|
import "service/meta.proto";
|
|
import "service/verify.proto";
|
|
import "refs/types.proto";
|
|
|
|
// The service provides methods for obtaining information
|
|
// about the account balance in NeoFS system.
|
|
service Accounting {
|
|
// Returns the amount of funds for the requested NeoFS account.
|
|
rpc Balance (BalanceRequest) returns (BalanceResponse);
|
|
}
|
|
|
|
// Message defines the request body of Balance method.
|
|
//
|
|
// To indicate the account for which the balance is requested, its identifier is used.
|
|
//
|
|
// To gain access to the requested information, the request body must be formed according
|
|
// to the requirements from the system specification.
|
|
message BalanceRequest {
|
|
// Carries user identifier in NeoFS system for which the balance is requested.
|
|
refs.OwnerID OwnerID = 1;
|
|
|
|
// Carries request meta information. Header data is used only to regulate message
|
|
// transport and does not affect request execution.
|
|
service.RequestMetaHeader MetaHeader = 98;
|
|
|
|
// Carries request verification information. This header is used to authenticate
|
|
// the nodes of the message route and check the correctness of transmission.
|
|
service.RequestVerificationHeader VerifyHeader = 99;
|
|
}
|
|
|
|
// Decimal represents the decimal numbers.
|
|
message Decimal {
|
|
// Value carries number value.
|
|
int64 Value = 1;
|
|
|
|
// Precision carries value precision.
|
|
uint32 Precision = 2;
|
|
}
|
|
|
|
// Message defines the response body of Balance method.
|
|
//
|
|
// The amount of funds is calculated in decimal numbers.
|
|
message BalanceResponse {
|
|
// Carries the amount of funds on the account.
|
|
Decimal Balance = 1;
|
|
}
|