github.com/gagliardetto/solana-go@v1.11.0/rpc/getEpochInfo.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  // GetEpochInfo returns information about the current epoch.
    22  func (cl *Client) GetEpochInfo(
    23  	ctx context.Context,
    24  	commitment CommitmentType, // optional
    25  ) (out *GetEpochInfoResult, err error) {
    26  	params := []interface{}{}
    27  	if commitment != "" {
    28  		params = append(params, M{"commitment": commitment})
    29  	}
    30  	err = cl.rpcClient.CallForInto(ctx, &out, "getEpochInfo", params)
    31  	return
    32  }
    33  
    34  type GetEpochInfoResult struct {
    35  	// The current slot.
    36  	AbsoluteSlot uint64 `json:"absoluteSlot"`
    37  
    38  	// The current block height.
    39  	BlockHeight uint64 `json:"blockHeight"`
    40  
    41  	// The current epoch.
    42  	Epoch uint64 `json:"epoch"`
    43  
    44  	// The current slot relative to the start of the current epoch.
    45  	SlotIndex uint64 `json:"slotIndex"`
    46  
    47  	// The number of slots in this epoch.
    48  	SlotsInEpoch uint64 `json:"slotsInEpoch"`
    49  
    50  	TransactionCount *uint64 `json:"transactionCount,omitempty"`
    51  }