github.com/gagliardetto/solana-go@v1.11.0/rpc/getBlockCommitment.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  // GetBlockCommitment returns commitment for particular block.
    22  func (cl *Client) GetBlockCommitment(
    23  	ctx context.Context,
    24  	block uint64, // block, identified by Slot
    25  ) (out *GetBlockCommitmentResult, err error) {
    26  	params := []interface{}{block}
    27  	err = cl.rpcClient.CallForInto(ctx, &out, "getBlockCommitment", params)
    28  	return
    29  }
    30  
    31  type GetBlockCommitmentResult struct {
    32  	// nil if Unknown block, or array of u64 integers
    33  	// logging the amount of cluster stake in lamports
    34  	// that has voted on the block at each depth from 0 to `MAX_LOCKOUT_HISTORY` + 1
    35  	Commitment []uint64 `json:"commitment"`
    36  
    37  	// Total active stake, in lamports, of the current epoch.
    38  	TotalStake uint64 `json:"totalStake"`
    39  }