github.com/gagliardetto/solana-go@v1.11.0/rpc/getLargestAccounts.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  	"github.com/gagliardetto/solana-go"
    21  )
    22  
    23  type LargestAccountsFilterType string
    24  
    25  const (
    26  	LargestAccountsFilterCirculating    LargestAccountsFilterType = "circulating"
    27  	LargestAccountsFilterNonCirculating LargestAccountsFilterType = "nonCirculating"
    28  )
    29  
    30  // GetLargestAccounts returns the 20 largest accounts,
    31  // by lamport balance (results may be cached up to two hours).
    32  func (cl *Client) GetLargestAccounts(
    33  	ctx context.Context,
    34  	commitment CommitmentType,
    35  	filter LargestAccountsFilterType, // filter results by account type; currently supported: circulating|nonCirculating
    36  ) (out *GetLargestAccountsResult, err error) {
    37  	params := []interface{}{}
    38  	obj := M{}
    39  	if commitment != "" {
    40  		obj["commitment"] = commitment
    41  	}
    42  	if filter != "" {
    43  		obj["filter"] = filter
    44  	}
    45  	if len(obj) > 0 {
    46  		params = append(params, obj)
    47  	}
    48  	err = cl.rpcClient.CallForInto(ctx, &out, "getLargestAccounts", params)
    49  	return
    50  }
    51  
    52  type GetLargestAccountsResult struct {
    53  	RPCContext
    54  	Value []LargestAccountsResult `json:"value"`
    55  }
    56  
    57  type LargestAccountsResult struct {
    58  	// Address of the account.
    59  	Address solana.PublicKey `json:"address"`
    60  
    61  	// Number of lamports in the account.
    62  	Lamports uint64 `json:"lamports"`
    63  }