[DX-5057] add solana key read

framework/.changeset/v0.16.7.md

@@ -0,0 +1 @@
+- Add a method to read Solana keys to `clclient`

framework/clclient/client.go

@@ -897,6 +897,46 @@ func (c *ChainlinkClient) MustReadAptosAccounts() ([]string, error) {
 	return accounts, nil
 }
 
+// ReadSolanaKeys reads all Solana keys from the Chainlink node
+func (c *ChainlinkClient) ReadSolanaKeys() (*SolanaKeys, *resty.Response, error) {
+	solanaKeys := &SolanaKeys{}
+	framework.L.Info().Str(NodeURL, c.Config.URL).Msg("Reading Solana Keys")
+	resp, err := c.APIClient.R().
+		SetResult(solanaKeys).
+		Get("/v2/keys/solana")
+	if err != nil {
+		return nil, nil, err
+	}
+	if len(solanaKeys.Data) == 0 {
+		framework.L.Warn().Str(NodeURL, c.Config.URL).Msg("Found no Solana Keys on the node")
+	}
+	return solanaKeys, resp, nil
+}
+
+// MustReadSolanaKeys reads all Solana keys from the Chainlink node and returns an error if the request is unsuccessful.
+func (c *ChainlinkClient) MustReadSolanaKeys() (*SolanaKeys, *resty.Response, error) {
+	solanaKeys, res, err := c.ReadSolanaKeys()
+	if err != nil {
+		return nil, res, err
+	}
+	return solanaKeys, res, VerifyStatusCodeWithResponse(res, http.StatusOK)
+}
+
+// MustReadSolanaAccounts reads all Solana public keys (used as account addresses) from the Chainlink node.
+func (c *ChainlinkClient) MustReadSolanaAccounts() ([]string, error) {
+	solanaKeys, _, err := c.MustReadSolanaKeys()
+	if err != nil {
+		return nil, err
+	}
+
+	accounts := make([]string, 0, len(solanaKeys.Data))
+	for _, key := range solanaKeys.Data {
+		accounts = append(accounts, key.Attributes.PublicKey)
+	}
+
+	return accounts, nil
+}
+
 // DeleteTxKey deletes an tx key based on the provided ID
 func (c *ChainlinkClient) DeleteTxKey(chain string, id string) (*http.Response, error) {
 	framework.L.Info().Str(NodeURL, c.Config.URL).Str("ID", id).Msg("Deleting Tx Key")

framework/clclient/models.go

@@ -250,6 +250,27 @@ type AptosKeys struct {
 	Data []AptosKeyData `json:"data"`
 }
 
+// SolanaKeyAttributes is the model that represents the created Solana key attributes when read
+type SolanaKeyAttributes struct {
+	PublicKey string `json:"publicKey"`
+}
+
+// SolanaKeyData is the model that represents the created Solana keys when read
+type SolanaKeyData struct {
+	ID         string              `json:"id"`
+	Attributes SolanaKeyAttributes `json:"attributes"`
+}
+
+// SolanaKey is the model that represents the created Solana key when read
+type SolanaKey struct {
+	Data SolanaKeyData `json:"data"`
+}
+
+// SolanaKeys is the model that represents the created Solana keys when read
+type SolanaKeys struct {
+	Data []SolanaKeyData `json:"data"`
+}
+
 // OCRKeys is the model that represents the created OCR keys when read
 type OCRKeys struct {
 	Data []OCRKeyData `json:"data"`