Documentation

Overview

    Package grpc_client is the interface for uses gRPC methods.

    Example
    Output:
    
    

    Index

    Examples

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    func ConvertStructToEvent

    func ConvertStructToEvent(str *_struct.Struct) (api.Event, error)

      ConvertStructToEvent returns Event model

      Example
      Output:
      
      

      Types

      type Client

      type Client struct {
      	// contains filtered or unexported fields
      }

        Client gRPC

        func New

        func New(address string, _ ...string) (*Client, error)

          New returns gRPC Client

          func (*Client) Address

          func (c *Client) Address(address string, optionalHeight ...uint64) (*api_pb.AddressResponse, error)

            Address returns coins list, balance and transaction count of an address.

            func (*Client) AddressExtended

            func (c *Client) AddressExtended(address string, delegated bool, optionalHeight ...uint64) (*api_pb.AddressResponse, error)

              AddressExtended returns coins list with balance, delegated and transaction count of an address.

              func (*Client) Addresses

              func (c *Client) Addresses(addresses []string, optionalHeight ...uint64) (*api_pb.AddressesResponse, error)

                Addresses returns list of addresses.

                func (*Client) AddressesExtended

                func (c *Client) AddressesExtended(addresses []string, delegated bool, optionalHeight ...uint64) (*api_pb.AddressesResponse, error)

                  AddressesExtended returns list of addresses with bipValue and delegated.

                  func (*Client) Block

                  func (c *Client) Block(height uint64) (*api_pb.BlockResponse, error)

                    Block returns block data at given height.

                    func (*Client) BlockExtended

                    func (c *Client) BlockExtended(height uint64, failedTxs bool, fieldsBlock ...string) (*api_pb.BlockResponse, error)

                      BlockExtended returns block data at given height by filtered data.

                      func (*Client) Blocks

                      func (c *Client) Blocks(from, to uint64, failedTxs bool, fieldsBlock ...string) (*api_pb.BlocksResponse, error)

                        Blocks ...

                        func (*Client) Candidate

                        func (c *Client) Candidate(publicKey string, optionalHeight ...uint64) (*api_pb.CandidateResponse, error)

                          Candidate returns candidate’s info by provided public_key.

                          func (*Client) CandidateExtended

                          func (c *Client) CandidateExtended(publicKey string, notShowStakes bool, optionalHeight ...uint64) (*api_pb.CandidateResponse, error)

                            CandidateExtended returns candidate’s info by provided public_key.

                            func (*Client) Candidates

                            func (c *Client) Candidates(includeStakes bool, optionalHeight ...uint64) (*api_pb.CandidatesResponse, error)

                              Candidates returns list of candidates.

                              func (*Client) CandidatesExtended

                              func (c *Client) CandidatesExtended(includeStakes, notShowStakes bool, status string, optionalHeight ...uint64) (*api_pb.CandidatesResponse, error)

                                CandidatesExtended returns list of candidates.

                                func (*Client) CheckVersion

                                func (c *Client) CheckVersion(version string, isTestnet bool) error

                                  CheckVersion compares the prefix in the version name and checks the testnet mode

                                  func (*Client) CoinID

                                  func (c *Client) CoinID(symbol string, optionalHeight ...uint64) (uint64, error)

                                    CoinID returns ID of coin symbol.

                                    func (*Client) CoinInfo

                                    func (c *Client) CoinInfo(symbol string, optionalHeight ...uint64) (*api_pb.CoinInfoResponse, error)

                                      CoinInfo returns information about coin symbol.

                                      func (*Client) CoinInfoByID

                                      func (c *Client) CoinInfoByID(id uint64, optionalHeight ...uint64) (*api_pb.CoinInfoResponse, error)

                                        CoinInfoByID returns information about coin ID.

                                        func (*Client) CommissionVotes

                                        func (c *Client) CommissionVotes(target uint64, optionalHeight ...uint64) (*api_pb.CommissionVotesResponse, error)

                                          CommissionVotes returns ...

                                          func (*Client) ErrorBody

                                          func (c *Client) ErrorBody(err error) (int, *api_pb.ErrorBody, error)

                                            ErrorBody returns error as API model

                                            func (*Client) EstimateCoinIDBuy

                                            func (c *Client) EstimateCoinIDBuy(coinToSell, coinToBuy uint64, valueToBuy string, coinCommission uint64, optionalHeight ...uint64) (*api_pb.EstimateCoinBuyResponse, error)

                                              EstimateCoinIDBuy returns estimate of buy coin transaction.

                                              func (*Client) EstimateCoinIDBuyExtended

                                              func (c *Client) EstimateCoinIDBuyExtended(coinToSell, coinToBuy uint64, valueToBuy string, coinCommission uint64, swapFrom string, route []uint64, optionalHeight ...uint64) (*api_pb.EstimateCoinBuyResponse, error)

                                                EstimateCoinIDBuyExtended returns estimate of buy coin transaction with choice of the exchange source.

                                                func (*Client) EstimateCoinIDSell

                                                func (c *Client) EstimateCoinIDSell(coinToBuy, coinToSell uint64, valueToSell string, coinCommission uint64, optionalHeight ...uint64) (*api_pb.EstimateCoinSellResponse, error)

                                                  EstimateCoinIDSell returns estimate of sell coin transaction.

                                                  func (*Client) EstimateCoinIDSellAll

                                                  func (c *Client) EstimateCoinIDSellAll(coinToBuy, coinToSell uint64, gasPrice uint64, valueToSell string, optionalHeight ...uint64) (*api_pb.EstimateCoinSellAllResponse, error)

                                                    EstimateCoinIDSellAll returns estimate of sell all coin transaction.

                                                    func (*Client) EstimateCoinIDSellAllExtended

                                                    func (c *Client) EstimateCoinIDSellAllExtended(coinToBuy, coinToSell uint64, gasPrice uint64, valueToSell string, swapFrom string, route []uint64, optionalHeight ...uint64) (*api_pb.EstimateCoinSellAllResponse, error)

                                                      EstimateCoinIDSellAllExtended returns estimate of sell all coin transaction with choice of the exchange source.

                                                      func (*Client) EstimateCoinIDSellExtended

                                                      func (c *Client) EstimateCoinIDSellExtended(coinToBuy, coinToSell uint64, valueToSell string, coinCommission uint64, swapFrom string, route []uint64, optionalHeight ...uint64) (*api_pb.EstimateCoinSellResponse, error)

                                                        EstimateCoinIDSellExtended returns estimate of sell coin transaction with choice of the exchange source.

                                                        func (*Client) EstimateCoinSymbolBuy

                                                        func (c *Client) EstimateCoinSymbolBuy(coinToSell, coinToBuy string, valueToBuy string, coinCommission string, optionalHeight ...uint64) (*api_pb.EstimateCoinBuyResponse, error)

                                                          EstimateCoinSymbolBuy returns estimate of buy coin transaction.

                                                          func (*Client) EstimateCoinSymbolBuyExtended

                                                          func (c *Client) EstimateCoinSymbolBuyExtended(coinToSell, coinToBuy string, valueToBuy string, coinCommission string, swapFrom string, route []uint64, optionalHeight ...uint64) (*api_pb.EstimateCoinBuyResponse, error)

                                                            EstimateCoinSymbolBuyExtended returns estimate of buy coin transaction with choice of the exchange source.

                                                            func (*Client) EstimateCoinSymbolSell

                                                            func (c *Client) EstimateCoinSymbolSell(coinToBuy, coinToSell string, valueToSell string, coinCommission string, optionalHeight ...uint64) (*api_pb.EstimateCoinSellResponse, error)

                                                              EstimateCoinSymbolSell returns estimate of sell coin transaction.

                                                              func (*Client) EstimateCoinSymbolSellAll

                                                              func (c *Client) EstimateCoinSymbolSellAll(coinToBuy, coinToSell string, gasPrice uint64, valueToSell string, optionalHeight ...uint64) (*api_pb.EstimateCoinSellAllResponse, error)

                                                                EstimateCoinSymbolSellAll returns estimate of sell all coin transaction.

                                                                func (*Client) EstimateCoinSymbolSellAllExtended

                                                                func (c *Client) EstimateCoinSymbolSellAllExtended(coinToBuy, coinToSell string, gasPrice uint64, valueToSell string, swapFrom string, route []uint64, optionalHeight ...uint64) (*api_pb.EstimateCoinSellAllResponse, error)

                                                                  EstimateCoinSymbolSellAllExtended returns estimate of sell all coin transaction with choice of the exchange source.

                                                                  func (*Client) EstimateCoinSymbolSellExtended

                                                                  func (c *Client) EstimateCoinSymbolSellExtended(coinToBuy, coinToSell string, valueToSell string, coinCommission string, swapFrom string, route []uint64, optionalHeight ...uint64) (*api_pb.EstimateCoinSellResponse, error)

                                                                    EstimateCoinSymbolSellExtended returns estimate of sell coin transaction with choice of the exchange source.

                                                                    func (*Client) EstimateTxCommission

                                                                    func (c *Client) EstimateTxCommission(tx string, optionalHeight ...uint64) (*api_pb.EstimateTxCommissionResponse, error)

                                                                      EstimateTxCommission returns estimate of encoding transaction with choice of the exchange source.

                                                                      func (*Client) Events

                                                                      func (c *Client) Events(height uint64, search ...string) (*api_pb.EventsResponse, error)

                                                                        Events returns events at given height.

                                                                        func (*Client) Frozen

                                                                        func (c *Client) Frozen(address string, coinID *uint64, optionalHeight ...uint64) (*api_pb.FrozenResponse, error)

                                                                          Frozen returns frozen balance.

                                                                          func (*Client) GRPCClient

                                                                          func (c *Client) GRPCClient() api_pb.ApiServiceClient

                                                                            GRPCClient returns gRPC client api_pb.ApiServiceClient

                                                                            func (*Client) Genesis

                                                                            func (c *Client) Genesis() (*api_pb.GenesisResponse, error)

                                                                              Genesis returns genesis file.

                                                                              func (*Client) HTTPError

                                                                              func (c *Client) HTTPError(statusError error) (statusCode int, json string, err error)

                                                                                HTTPError returns error as JSON API

                                                                                func (*Client) Halts

                                                                                func (c *Client) Halts(height uint64) (*api_pb.HaltsResponse, error)

                                                                                  Halts returns the candidate votes for stopping the network at block.

                                                                                  func (*Client) Marshal

                                                                                  func (c *Client) Marshal(m proto.Message) (json string, err error)

                                                                                    Marshal returns model in JSON format

                                                                                    func (*Client) MaxGasPrice

                                                                                    func (c *Client) MaxGasPrice(optionalHeight ...uint64) (*api_pb.MaxGasPriceResponse, error)

                                                                                      MaxGasPrice returns current max gas.

                                                                                      func (*Client) MinGasPrice

                                                                                      func (c *Client) MinGasPrice() (*api_pb.MinGasPriceResponse, error)

                                                                                        MinGasPrice returns current min gas price.

                                                                                        func (*Client) MissedBlocks

                                                                                        func (c *Client) MissedBlocks(publicKey string, optionalHeight ...uint64) (*api_pb.MissedBlocksResponse, error)

                                                                                          MissedBlocks returns missed blocks by validator public key.

                                                                                          func (*Client) NetInfo

                                                                                          func (c *Client) NetInfo() (*api_pb.NetInfoResponse, error)

                                                                                            NetInfo returns network info

                                                                                            func (*Client) Nonce

                                                                                            func (c *Client) Nonce(address string) (uint64, error)

                                                                                              Nonce returns next transaction number (nonce) of an address.

                                                                                              func (*Client) PriceCommission

                                                                                              func (c *Client) PriceCommission(optionalHeight ...uint64) (*api_pb.PriceCommissionResponse, error)

                                                                                                PriceCommission returns ...

                                                                                                func (*Client) SendTransaction

                                                                                                func (c *Client) SendTransaction(tx string) (*api_pb.SendTransactionResponse, error)

                                                                                                  SendTransaction returns the result of sending signed tx. To ensure that transaction was successfully committed to the blockchain, you need to find the transaction by the hash and ensure that the status code equals to 0.

                                                                                                  func (*Client) Status

                                                                                                  func (c *Client) Status() (*api_pb.StatusResponse, error)

                                                                                                    Status returns node status including pubkey, latest block.

                                                                                                    func (*Client) Subscribe

                                                                                                    func (c *Client) Subscribe(query string) (api_pb.ApiService_SubscribeClient, error)

                                                                                                      Subscribe returns a subscription for events by query.

                                                                                                      func (*Client) SwapPool

                                                                                                      func (c *Client) SwapPool(coin0, coin1 uint64, optionalHeight ...uint64) (*api_pb.SwapPoolResponse, error)

                                                                                                        SwapPool returns total supply and reserves.

                                                                                                        func (*Client) SwapPoolProvider

                                                                                                        func (c *Client) SwapPoolProvider(coin0, coin1 uint64, provider string, optionalHeight ...uint64) (*api_pb.SwapPoolResponse, error)

                                                                                                          SwapPoolProvider returns reserves and liquidity balance of provider.

                                                                                                          func (*Client) Transaction

                                                                                                          func (c *Client) Transaction(hash string) (*api_pb.TransactionResponse, error)

                                                                                                            Transaction returns transaction info.

                                                                                                            func (*Client) Transactions

                                                                                                            func (c *Client) Transactions(query string, page, perPage int) (*api_pb.TransactionsResponse, error)

                                                                                                              Transactions returns transactions by query.

                                                                                                              func (*Client) UnconfirmedTxs

                                                                                                              func (c *Client) UnconfirmedTxs(limit ...uint64) (*api_pb.UnconfirmedTxsResponse, error)

                                                                                                                UnconfirmedTxs returns unconfirmed transactions.

                                                                                                                func (*Client) UpdateVotes

                                                                                                                func (c *Client) UpdateVotes(target uint64, optionalHeight ...uint64) (*api_pb.UpdateVotesResponse, error)

                                                                                                                  UpdateVotes returns ...

                                                                                                                  func (*Client) Validators

                                                                                                                  func (c *Client) Validators(optionalHeight ...uint64) (*api_pb.ValidatorsResponse, error)

                                                                                                                    Validators returns list of active validators.

                                                                                                                    func (*Client) VersionNetwork

                                                                                                                    func (c *Client) VersionNetwork() (*api_pb.VersionNetworkResponse, error)

                                                                                                                      VersionNetwork returns ...

                                                                                                                      func (*Client) WaitList

                                                                                                                      func (c *Client) WaitList(publicKey, address string, optionalHeight ...uint64) (*api_pb.WaitListResponse, error)

                                                                                                                        WaitList returns the list of address stakes in waitlist.

                                                                                                                        func (*Client) WithCallOption

                                                                                                                        func (c *Client) WithCallOption(opts ...grpc.CallOption) *Client

                                                                                                                          WithCallOption returns new Client with additional grpc.CallOption

                                                                                                                          func (*Client) WithContextFunc

                                                                                                                          func (c *Client) WithContextFunc(contextFunc func(context.Context) func() context.Context) *Client

                                                                                                                            WithContextFunc returns new Client with new context Example:

                                                                                                                            timeout := func(c context.Context) func() context.Context {
                                                                                                                            	return func() context.Context {
                                                                                                                            		ctx, _ := context.WithTimeout(c, 10*time.Second)
                                                                                                                            		return ctx
                                                                                                                            	}
                                                                                                                            }