github.com/gagliardetto/solana-go@v1.11.0/rpc/getEpochSchedule.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  // GetEpochSchedule returns epoch schedule information from this cluster's genesis config.
    22  func (cl *Client) GetEpochSchedule(ctx context.Context) (out *GetEpochScheduleResult, err error) {
    23  	err = cl.rpcClient.CallForInto(ctx, &out, "getEpochSchedule", nil)
    24  	return
    25  }
    26  
    27  type GetEpochScheduleResult struct {
    28  	// The maximum number of slots in each epoch.
    29  	SlotsPerEpoch uint64 `json:"slotsPerEpoch"`
    30  
    31  	// The number of slots before beginning of an epoch to calculate a leader schedule for that epoch.
    32  	LeaderScheduleSlotOffset uint64 `json:"leaderScheduleSlotOffset"`
    33  
    34  	// Whether epochs start short and grow.
    35  	Warmup bool `json:"warmup"`
    36  
    37  	// First normal-length epoch, log2(slotsPerEpoch) - log2(MINIMUM_SLOTS_PER_EPOCH)
    38  	FirstNormalEpoch uint64 `json:"firstNormalEpoch"`
    39  
    40  	// MINIMUM_SLOTS_PER_EPOCH * (2.pow(firstNormalEpoch) - 1)
    41  	FirstNormalSlot uint64 `json:"firstNormalSlot"`
    42  }