github.com/gagliardetto/solana-go@v1.11.0/rpc/getRecentPerformanceSamples.go (about)

     1  // Copyright 2021 github.com/gagliardetto
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package rpc
    16  
    17  import (
    18  	"context"
    19  )
    20  
    21  // GetRecentPerformanceSamples returns a list of recent performance samples,
    22  // in reverse slot order. Performance samples are taken every 60 seconds
    23  // and include the number of transactions and slots that occur in a given time window.
    24  func (cl *Client) GetRecentPerformanceSamples(
    25  	ctx context.Context,
    26  	limit *uint,
    27  ) (out []*GetRecentPerformanceSamplesResult, err error) {
    28  	params := []interface{}{}
    29  	if limit != nil {
    30  		params = append(params, limit)
    31  	}
    32  	err = cl.rpcClient.CallForInto(ctx, &out, "getRecentPerformanceSamples", params)
    33  	return
    34  }
    35  
    36  type GetRecentPerformanceSamplesResult struct {
    37  	// Slot in which sample was taken at.
    38  	Slot uint64 `json:"slot"`
    39  
    40  	// Number of transactions in sample.
    41  	NumTransactions uint64 `json:"numTransactions"`
    42  
    43  	// Number of slots in sample.
    44  	NumSlots uint64 `json:"numSlots"`
    45  
    46  	// Number of seconds in a sample window.
    47  	SamplePeriodSecs uint16 `json:"samplePeriodSecs"`
    48  }