4e31b4f231
In previous implementation `client` package provided access to nested response fields as pointers to them. This caused clients to handle nil cases even when the field presence in the response is required. Avoid returning pointers to required fields in response getters. This also reduces reference counter load and allows fields to be decoded directly without additional assignment. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
111 lines
2.7 KiB
Go
111 lines
2.7 KiB
Go
package client
|
|
|
|
import (
|
|
"context"
|
|
|
|
v2accounting "github.com/nspcc-dev/neofs-api-go/v2/accounting"
|
|
"github.com/nspcc-dev/neofs-api-go/v2/refs"
|
|
rpcapi "github.com/nspcc-dev/neofs-api-go/v2/rpc"
|
|
"github.com/nspcc-dev/neofs-api-go/v2/rpc/client"
|
|
"github.com/nspcc-dev/neofs-sdk-go/accounting"
|
|
"github.com/nspcc-dev/neofs-sdk-go/user"
|
|
)
|
|
|
|
// PrmBalanceGet groups parameters of BalanceGet operation.
|
|
type PrmBalanceGet struct {
|
|
prmCommonMeta
|
|
|
|
accountSet bool
|
|
account user.ID
|
|
}
|
|
|
|
// SetAccount sets identifier of the NeoFS account for which the balance is requested.
|
|
// Required parameter.
|
|
func (x *PrmBalanceGet) SetAccount(id user.ID) {
|
|
x.account = id
|
|
x.accountSet = true
|
|
}
|
|
|
|
// ResBalanceGet groups resulting values of BalanceGet operation.
|
|
type ResBalanceGet struct {
|
|
statusRes
|
|
|
|
amount accounting.Decimal
|
|
}
|
|
|
|
// Amount returns current amount of funds on the NeoFS account as decimal number.
|
|
func (x ResBalanceGet) Amount() accounting.Decimal {
|
|
return x.amount
|
|
}
|
|
|
|
// BalanceGet requests current balance of the NeoFS account.
|
|
//
|
|
// Exactly one return value is non-nil. By default, server status is returned in res structure.
|
|
// Any client's internal or transport errors are returned as `error`,
|
|
// If PrmInit.ResolveNeoFSFailures has been called, unsuccessful
|
|
// NeoFS status codes are returned as `error`, otherwise, are included
|
|
// in the returned result structure.
|
|
//
|
|
// Immediately panics if parameters are set incorrectly (see PrmBalanceGet docs).
|
|
// Context is required and must not be nil. It is used for network communication.
|
|
//
|
|
// Return statuses:
|
|
// - global (see Client docs).
|
|
func (c *Client) BalanceGet(ctx context.Context, prm PrmBalanceGet) (*ResBalanceGet, error) {
|
|
switch {
|
|
case ctx == nil:
|
|
panic(panicMsgMissingContext)
|
|
case !prm.accountSet:
|
|
panic("account not set")
|
|
}
|
|
|
|
// form request body
|
|
var accountV2 refs.OwnerID
|
|
prm.account.WriteToV2(&accountV2)
|
|
|
|
var body v2accounting.BalanceRequestBody
|
|
body.SetOwnerID(&accountV2)
|
|
|
|
// form request
|
|
var req v2accounting.BalanceRequest
|
|
|
|
req.SetBody(&body)
|
|
|
|
// init call context
|
|
|
|
var (
|
|
cc contextCall
|
|
res ResBalanceGet
|
|
)
|
|
|
|
c.initCallContext(&cc)
|
|
cc.meta = prm.prmCommonMeta
|
|
cc.req = &req
|
|
cc.statusRes = &res
|
|
cc.call = func() (responseV2, error) {
|
|
return rpcapi.Balance(&c.c, &req, client.WithContext(ctx))
|
|
}
|
|
cc.result = func(r responseV2) {
|
|
resp := r.(*v2accounting.BalanceResponse)
|
|
|
|
const fieldBalance = "balance"
|
|
|
|
bal := resp.GetBody().GetBalance()
|
|
if bal == nil {
|
|
cc.err = newErrMissingResponseField(fieldBalance)
|
|
return
|
|
}
|
|
|
|
cc.err = res.amount.ReadFromV2(*bal)
|
|
if cc.err != nil {
|
|
cc.err = newErrInvalidResponseField(fieldBalance, cc.err)
|
|
}
|
|
}
|
|
|
|
// process call
|
|
if !cc.processCall() {
|
|
return nil, cc.err
|
|
}
|
|
|
|
return &res, nil
|
|
}
|