Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 4 additions & 11 deletions deployment/common/view/v2_0/capreg.go
Original file line number Diff line number Diff line change
Expand Up @@ -103,13 +103,6 @@ type unpagniatedCapabilityRegistry interface {
GetDONsSimple(opts *bind.CallOpts) ([]capabilities_registry.CapabilitiesRegistryDONInfo, error)
}

var (
MaxCapabilities = big.NewInt(128)
MaxDONs = big.NewInt(32)
MaxNodes = big.NewInt(256)
MaxNOPs = big.NewInt(128)
)

type ExtendedCapabilityRegistry struct {
*capabilities_registry.CapabilitiesRegistry
}
Expand All @@ -118,22 +111,22 @@ var _ unpagniatedCapabilityRegistry = (*ExtendedCapabilityRegistry)(nil)

// GetCapabilitiesSimple implements unpagniatedCapabilityRegistry
func (e *ExtendedCapabilityRegistry) GetCapabilitiesSimple(opts *bind.CallOpts) ([]capabilities_registry.CapabilitiesRegistryCapabilityInfo, error) {
return e.GetCapabilities(opts, big.NewInt(0), MaxCapabilities)
return pkg.GetCapabilities(opts, e.CapabilitiesRegistry)
}

// GetNodesSimple implements unpagniatedCapabilityRegistry
func (e *ExtendedCapabilityRegistry) GetNodesSimple(opts *bind.CallOpts) ([]capabilities_registry.INodeInfoProviderNodeInfo, error) {
return e.GetNodes(opts, big.NewInt(0), MaxNodes)
return pkg.GetNodes(opts, e.CapabilitiesRegistry)
}

// GetNodeOperatorsSimple implements unpagniatedCapabilityRegistry
func (e *ExtendedCapabilityRegistry) GetNodeOperatorsSimple(opts *bind.CallOpts) ([]capabilities_registry.CapabilitiesRegistryNodeOperatorInfo, error) {
return e.GetNodeOperators(opts, big.NewInt(0), MaxNOPs)
return pkg.GetNodeOperators(opts, e.CapabilitiesRegistry)
}

// GetDONsSimple implements unpagniatedCapabilityRegistry
func (e *ExtendedCapabilityRegistry) GetDONsSimple(opts *bind.CallOpts) ([]capabilities_registry.CapabilitiesRegistryDONInfo, error) {
return e.GetDONs(opts, big.NewInt(0), MaxDONs)
return pkg.GetDONs(opts, e.CapabilitiesRegistry)
}

// GenerateCapabilityRegistryView generates a CapRegView from a CapabilitiesRegistry contract.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,35 +9,56 @@ import (
capabilities_registry_v2 "github.com/smartcontractkit/chainlink-evm/gethwrappers/workflow/generated/capabilities_registry_wrapper_v2"
)

// TODO: we have to support pagination eventually
var (
MaxCapabilities = big.NewInt(128)
MaxDONs = big.NewInt(32)
MaxNodes = big.NewInt(256)
MaxNOPs = big.NewInt(128)
)
// PageSize is the number of entries fetched per CapabilitiesRegistry view call.
const PageSize = 30

// paginate calls fetch with consecutive (start, limit) pages until a page comes back short.
func paginate[T any](fetch func(start, limit *big.Int) ([]T, error)) ([]T, error) {
var all []T
limit := big.NewInt(PageSize)
for start := int64(0); ; start += PageSize {
page, err := fetch(big.NewInt(start), limit)
if err != nil {
return nil, err
}
all = append(all, page...)
if len(page) < PageSize {
return all, nil
}
}
}

func GetCapabilities(opts *bind.CallOpts, capReg *capabilities_registry_v2.CapabilitiesRegistry) ([]capabilities_registry_v2.CapabilitiesRegistryCapabilityInfo, error) {
caps, err := capReg.GetCapabilities(opts, big.NewInt(0), MaxCapabilities)
caps, err := paginate(func(start, limit *big.Int) ([]capabilities_registry_v2.CapabilitiesRegistryCapabilityInfo, error) {
return capReg.GetCapabilities(opts, start, limit)
})
return caps, cldf.DecodeErr(capabilities_registry_v2.CapabilitiesRegistryABI, err)
}

func GetNodeOperators(opts *bind.CallOpts, capReg *capabilities_registry_v2.CapabilitiesRegistry) ([]capabilities_registry_v2.CapabilitiesRegistryNodeOperatorInfo, error) {
nops, err := capReg.GetNodeOperators(opts, big.NewInt(0), MaxNOPs)
nops, err := paginate(func(start, limit *big.Int) ([]capabilities_registry_v2.CapabilitiesRegistryNodeOperatorInfo, error) {
return capReg.GetNodeOperators(opts, start, limit)
})
return nops, cldf.DecodeErr(capabilities_registry_v2.CapabilitiesRegistryABI, err)
}

func GetNodes(opts *bind.CallOpts, capReg *capabilities_registry_v2.CapabilitiesRegistry) ([]capabilities_registry_v2.INodeInfoProviderNodeInfo, error) {
nodes, err := capReg.GetNodes(opts, big.NewInt(0), MaxNodes)
nodes, err := paginate(func(start, limit *big.Int) ([]capabilities_registry_v2.INodeInfoProviderNodeInfo, error) {
return capReg.GetNodes(opts, start, limit)
})
return nodes, cldf.DecodeErr(capabilities_registry_v2.CapabilitiesRegistryABI, err)
}

func GetDONs(opts *bind.CallOpts, capReg *capabilities_registry_v2.CapabilitiesRegistry) ([]capabilities_registry_v2.CapabilitiesRegistryDONInfo, error) {
donsInfo, err := capReg.GetDONs(opts, big.NewInt(0), MaxDONs)
return donsInfo, cldf.DecodeErr(capabilities_registry_v2.CapabilitiesRegistryABI, err)
dons, err := paginate(func(start, limit *big.Int) ([]capabilities_registry_v2.CapabilitiesRegistryDONInfo, error) {
return capReg.GetDONs(opts, start, limit)
})
return dons, cldf.DecodeErr(capabilities_registry_v2.CapabilitiesRegistryABI, err)
}

func GetDONsInFamily(opts *bind.CallOpts, capReg *capabilities_registry_v2.CapabilitiesRegistry, family string) ([]*big.Int, error) {
donsInfo, err := capReg.GetDONsInFamily(opts, family, big.NewInt(0), MaxDONs)
return donsInfo, cldf.DecodeErr(capabilities_registry_v2.CapabilitiesRegistryABI, err)
donIDs, err := paginate(func(start, limit *big.Int) ([]*big.Int, error) {
return capReg.GetDONsInFamily(opts, family, start, limit)
})
return donIDs, cldf.DecodeErr(capabilities_registry_v2.CapabilitiesRegistryABI, err)
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
package pkg

import (
"errors"
"math/big"
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func TestPaginate(t *testing.T) {
fakeContract := func(total int, calls *int) func(start, limit *big.Int) ([]int, error) {
return func(start, limit *big.Int) ([]int, error) {
*calls++
var page []int
for i := start.Int64(); i < int64(total) && i < start.Int64()+limit.Int64(); i++ {
page = append(page, int(i))
}
return page, nil
}
}

for _, tc := range []struct {
total int
wantCalls int
}{
{total: 0, wantCalls: 1},
{total: 1, wantCalls: 1},
{total: PageSize - 1, wantCalls: 1},
{total: PageSize, wantCalls: 2},
{total: PageSize + 1, wantCalls: 2},
{total: 3*PageSize + 7, wantCalls: 4},
} {
calls := 0
got, err := paginate(fakeContract(tc.total, &calls))
require.NoError(t, err)
require.Len(t, got, tc.total)
for i, v := range got {
assert.Equal(t, i, v)
}
assert.Equal(t, tc.wantCalls, calls, "total=%d", tc.total)
}

t.Run("error", func(t *testing.T) {
_, err := paginate(func(start, limit *big.Int) ([]int, error) {
return nil, errors.New("boom")
})
require.ErrorContains(t, err, "boom")
})
}
Loading