Merge branch 'main' into data-store/default-metadata-marshal-json

Author: akuzni2

.changeset/cyan-bars-wink.md

@@ -0,0 +1,5 @@
+---
+"chainlink-deployments-framework": minor
+---
+
+adds solana program close and support for deploying without extended buffers

.github/workflows/pull-request-main.yml

@@ -20,7 +20,7 @@ jobs:
         with:
           only-new-issues: "false"
           golangci-lint-version: v2.0.2
-          # Override the lint args because the detault ones are not compatible with golangci-lint v2
+          # Override the lint args because the default ones are not compatible with golangci-lint v2
           golangci-lint-args: --output.checkstyle.path=golangci-lint-report.xml
 
   ci-lint-misc:

.golangci.yml

@@ -132,7 +132,6 @@ linters:
       - third_party$
       - builtin$
       - examples$
-      - deployment/*
 formatters:
   enable:
     - goimports

CHANGELOG.md

@@ -1,5 +1,29 @@
 # chainlink-deployments-framework
 
+## 0.0.14
+
+### Patch Changes
+
+- [#39](https://github.com/smartcontractkit/chainlink-deployments-framework/pull/39) [`08e4660`](https://github.com/smartcontractkit/chainlink-deployments-framework/commit/08e46605ecb71276b7a35aa94887473da5ee08fb) Thanks [@jkongie](https://github.com/jkongie)! - BREAKING: Operations retry logic is now opt in. Use the `WithRetry` method in your `ExecuteOperation` call to enable retries
+
+## 0.0.13
+
+### Patch Changes
+
+- [#64](https://github.com/smartcontractkit/chainlink-deployments-framework/pull/64) [`f05efd9`](https://github.com/smartcontractkit/chainlink-deployments-framework/commit/f05efd9b0e417da9e6b0fd53372566584ad65520) Thanks [@graham-chainlink](https://github.com/graham-chainlink)! - migrate more helpers for writing changesets
+
+## 0.0.12
+
+### Patch Changes
+
+- [#62](https://github.com/smartcontractkit/chainlink-deployments-framework/pull/62) [`e31e3ea`](https://github.com/smartcontractkit/chainlink-deployments-framework/commit/e31e3eab10cd8cbb10a3ee17ae4202fb7f9f495f) Thanks [@graham-chainlink](https://github.com/graham-chainlink)! - Add more helpers from chainlink/deployment which are useful for writing changesets
+
+## 0.0.11
+
+### Patch Changes
+
+- [#59](https://github.com/smartcontractkit/chainlink-deployments-framework/pull/59) [`5d5a317`](https://github.com/smartcontractkit/chainlink-deployments-framework/commit/5d5a317363b549ac372b9f1c0430ff9566d4314d) Thanks [@graham-chainlink](https://github.com/graham-chainlink)! - better multiclient logging and expose dial attempts and delay as config
+
 ## 0.0.10
 
 ### Patch Changes

README.md

@@ -1 +1,56 @@
-# chainlink-deployments-framework
+<div align="center">
+  <h1>Chainlink Deployments Framework</h1>
+  <a><img src="https://github.com/smartcontractkit/chainlink-deployments-framework/actions/workflows/push-main.yml/badge.svg" /></a>
+  <br/>
+  <br/>
+</div>
+
+
+This repository contains the Chainlink Deployments Framework, a comprehensive set of libraries that enables developers to build, manage, and execute(in future) deployment changesets. 
+The framework includes the Operations API and Datastore API.
+
+## Usage
+
+```bash
+# for writing changesets (migrated from chainlink/deployments
+$ go get github.com/smartcontractkit/chainlink-deployments-framework/deployment
+
+# for operations api
+$ go get github.com/smartcontractkit/chainlink-deployments-framework/operations
+
+# for datastore api
+$ go get github.com/smartcontractkit/chainlink-deployments-framework/datastore
+```
+
+## Development
+
+
+### Installing Dependencies
+
+Install the required tools using [asdf](https://asdf-vm.com/guide/getting-started.html):
+
+```bash
+asdf install
+```
+
+### Linting
+
+```bash
+task lint
+```
+
+### Testing
+
+```bash
+task test
+```
+
+## Contributing
+
+For instructions on how to contribute to `chainlink-deployments-framework` and the release process,
+see [CONTRIBUTING.md](https://github.com/smartcontractkit/chainlink-deployments-framework/blob/main/CONTRIBUTING.md)
+
+## Releasing
+
+For instructions on how to release `chainlink-deployments-framework`,
+see [RELEASE.md](https://github.com/smartcontractkit/chainlink-deployments-framework/blob/main/RELEASE.md)

deployment/address_book.go

@@ -1,6 +1,7 @@
 package deployment
 
 import (
+	"errors"
 	"fmt"
 	"strings"
 	"sync"
@@ -9,7 +10,6 @@ import (
 
 	"github.com/Masterminds/semver/v3"
 	"github.com/ethereum/go-ethereum/common"
-	"github.com/pkg/errors"
 	chainsel "github.com/smartcontractkit/chain-selectors"
 )
 
@@ -39,6 +39,7 @@ func (tv TypeAndVersion) String() string {
 
 	// Use the LabelSet's String method for sorted labels
 	sortedLabels := tv.Labels.String()
+
 	return fmt.Sprintf("%s %s %s",
 		tv.Type,
 		tv.Version.String(),
@@ -64,6 +65,7 @@ func MustTypeAndVersionFromString(s string) TypeAndVersion {
 	if err != nil {
 		panic(err)
 	}
+
 	return tv
 }
 
@@ -82,6 +84,7 @@ func TypeAndVersionFromString(s string) (TypeAndVersion, error) {
 	if len(parts) > 2 {
 		labels = NewLabelSet(parts[2:]...)
 	}
+
 	return TypeAndVersion{
 		Type:    ContractType(parts[0]),
 		Version: *v,
@@ -121,17 +124,17 @@ type AddressBookMap struct {
 func (m *AddressBookMap) save(chainSelector uint64, address string, typeAndVersion TypeAndVersion) error {
 	family, err := chainsel.GetSelectorFamily(chainSelector)
 	if err != nil {
-		return errors.Wrapf(ErrInvalidChainSelector, "chain selector %d", chainSelector)
+		return fmt.Errorf("%w: chain selector %d", ErrInvalidChainSelector, chainSelector)
 	}
 	if family == chainsel.FamilyEVM {
 		if address == "" || address == common.HexToAddress("0x0").Hex() {
-			return errors.Wrap(ErrInvalidAddress, "address cannot be empty")
+			return fmt.Errorf("%w: address cannot be empty", ErrInvalidAddress)
 		}
 		if common.IsHexAddress(address) {
 			// IMPORTANT: WE ALWAYS STANDARDIZE ETHEREUM ADDRESS STRINGS TO EIP55
 			address = common.HexToAddress(address).Hex()
 		} else {
-			return errors.Wrapf(ErrInvalidAddress, "address %s is not a valid Ethereum address, only Ethereum addresses supported for EVM chains", address)
+			return fmt.Errorf("%w: address %s is not a valid Ethereum address, only Ethereum addresses supported for EVM chains", ErrInvalidAddress, address)
 		}
 	}
 
@@ -149,6 +152,7 @@ func (m *AddressBookMap) save(chainSelector uint64, address string, typeAndVersi
 		return fmt.Errorf("address %s already exists for chain %d", address, chainSelector)
 	}
 	m.addressesByChain[chainSelector][address] = typeAndVersion
+
 	return nil
 }
 
@@ -157,6 +161,7 @@ func (m *AddressBookMap) save(chainSelector uint64, address string, typeAndVersi
 func (m *AddressBookMap) Save(chainSelector uint64, address string, typeAndVersion TypeAndVersion) error {
 	m.mtx.Lock()
 	defer m.mtx.Unlock()
+
 	return m.save(chainSelector, address, typeAndVersion)
 }
 
@@ -173,14 +178,14 @@ func (m *AddressBookMap) Addresses() (map[uint64]map[string]TypeAndVersion, erro
 func (m *AddressBookMap) AddressesForChain(chainSelector uint64) (map[string]TypeAndVersion, error) {
 	_, err := chainsel.GetChainIDFromSelector(chainSelector)
 	if err != nil {
-		return nil, errors.Wrapf(ErrInvalidChainSelector, "chain selector %d", chainSelector)
+		return nil, fmt.Errorf("%w: chain selector %d", ErrInvalidChainSelector, chainSelector)
 	}
 
 	m.mtx.RLock()
 	defer m.mtx.RUnlock()
 
 	if _, exists := m.addressesByChain[chainSelector]; !exists {
-		return nil, errors.Wrapf(ErrChainNotFound, "chain selector %d", chainSelector)
+		return nil, fmt.Errorf("%w: chain selector %d", ErrChainNotFound, chainSelector)
 	}
 
 	// maps are mutable and pass via a pointer
@@ -207,6 +212,7 @@ func (m *AddressBookMap) Merge(ab AddressBook) error {
 			}
 		}
 	}
+
 	return nil
 }
 
@@ -246,6 +252,7 @@ func (m *AddressBookMap) cloneAddresses(input map[uint64]map[string]TypeAndVersi
 	for chainSelector, chainAddresses := range input {
 		result[chainSelector] = maps.Clone(chainAddresses)
 	}
+
 	return result
 }
 
@@ -340,6 +347,7 @@ func toTypeAndVersionMap(addrs map[string]TypeAndVersion) map[typeVersionKey][]s
 	for k, v := range addrs {
 		tvkMap[tvKey(v)] = append(tvkMap[tvKey(v)], k)
 	}
+
 	return tvkMap
 }
 

deployment/address_book_labels.go

@@ -14,6 +14,7 @@ func NewLabelSet(labels ...string) LabelSet {
 	for _, lb := range labels {
 		set[lb] = struct{}{}
 	}
+
 	return set
 }
 
@@ -73,6 +74,7 @@ func (ls LabelSet) Equal(other LabelSet) bool {
 			return false
 		}
 	}
+
 	return true
 }
 

deployment/address_book_labels_test.go

@@ -8,11 +8,12 @@ import (
 
 func TestNewLabelSet(t *testing.T) {
 	t.Run("no labels", func(t *testing.T) {
+		t.Parallel()
 		ms := NewLabelSet()
 		assert.Empty(t, ms, "expected empty set")
 	})
-
 	t.Run("some labels", func(t *testing.T) {
+		t.Parallel()
 		ms := NewLabelSet("foo", "bar")
 		assert.Len(t, ms, 2)
 		assert.True(t, ms.Contains("foo"))
@@ -22,6 +23,7 @@ func TestNewLabelSet(t *testing.T) {
 }
 
 func TestLabelSet_Add(t *testing.T) {
+	t.Parallel()
 	ms := NewLabelSet("initial")
 	ms.Add("new")
 
@@ -35,6 +37,7 @@ func TestLabelSet_Add(t *testing.T) {
 }
 
 func TestLabelSet_Remove(t *testing.T) {
+	t.Parallel()
 	ms := NewLabelSet("remove_me", "keep")
 	ms.Remove("remove_me")
 
@@ -48,6 +51,7 @@ func TestLabelSet_Remove(t *testing.T) {
 }
 
 func TestLabelSet_Contains(t *testing.T) {
+	t.Parallel()
 	ms := NewLabelSet("foo", "bar")
 
 	assert.True(t, ms.Contains("foo"))
@@ -56,7 +60,9 @@ func TestLabelSet_Contains(t *testing.T) {
 }
 
 func TestLabelSet_List(t *testing.T) {
+	t.Parallel()
 	t.Run("list with items", func(t *testing.T) {
+		t.Parallel()
 		ms := NewLabelSet("foo", "bar", "baz")
 
 		labels := ms.List()
@@ -68,6 +74,7 @@ func TestLabelSet_List(t *testing.T) {
 	})
 
 	t.Run("empty list", func(t *testing.T) {
+		t.Parallel()
 		ms := NewLabelSet()
 
 		labels := ms.List()
@@ -78,6 +85,7 @@ func TestLabelSet_List(t *testing.T) {
 
 // TestLabelSet_String tests the String() method of the LabelSet type.
 func TestLabelSet_String(t *testing.T) {
+	t.Parallel()
 	tests := []struct {
 		name     string
 		labels   LabelSet
@@ -121,15 +129,16 @@ func TestLabelSet_String(t *testing.T) {
 	}
 
 	for _, tt := range tests {
-		tt := tt
 		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
 			result := tt.labels.String()
 			assert.Equal(t, tt.expected, result, "LabelSet.String() should return the expected sorted string")
 		})
 	}
 }
 
 func TestLabelSet_Equal(t *testing.T) {
+	t.Parallel()
 	tests := []struct {
 		name     string
 		set1     LabelSet
@@ -193,7 +202,6 @@ func TestLabelSet_Equal(t *testing.T) {
 	}
 
 	for _, tt := range tests {
-		tt := tt
 		t.Run(tt.name, func(t *testing.T) {
 			t.Parallel()