Skip to content

Commit d95bfcd

Browse files
DiogoSantossDiogoSantoss
authored
add node identity (#22)
1 parent c6c1e4a commit d95bfcd

10 files changed

Lines changed: 290 additions & 1 deletion

File tree

‎api/nodeidentityopts.go‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// Copyright © 2025 Attestant Limited.
2+
// Licensed under the Apache License, Version 2.0 (the "License");
3+
// you may not use this file except in compliance with the License.
4+
// You may obtain a copy of the License at
5+
//
6+
// http://www.apache.org/licenses/LICENSE-2.0
7+
//
8+
// Unless required by applicable law or agreed to in writing, software
9+
// distributed under the License is distributed on an "AS IS" BASIS,
10+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11+
// See the License for the specific language governing permissions and
12+
// limitations under the License.
13+
14+
package api
15+
16+
// NodeIdentityOpts are the options for obtaining the node identity.
17+
type NodeIdentityOpts struct {
18+
Common CommonOpts
19+
}

‎api/v1/identity.go‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
// Copyright © 2025 Attestant Limited.
2+
// Licensed under the Apache License, Version 2.0 (the "License");
3+
// you may not use this file except in compliance with the License.
4+
// You may obtain a copy of the License at
5+
//
6+
// http://www.apache.org/licenses/LICENSE-2.0
7+
//
8+
// Unless required by applicable law or agreed to in writing, software
9+
// distributed under the License is distributed on an "AS IS" BASIS,
10+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11+
// See the License for the specific language governing permissions and
12+
// limitations under the License.
13+
14+
package v1
15+
16+
import (
17+
"encoding/json"
18+
"fmt"
19+
20+
"github.com/pkg/errors"
21+
)
22+
23+
// NodeIdentity contains the node identity information.
24+
type NodeIdentity struct {
25+
PeerID string `json:"peer_id"`
26+
Enr string `json:"enr"`
27+
P2PAddresses []string `json:"p2p_addresses"`
28+
DiscoveryAddresses []string `json:"discovery_addresses"`
29+
Metadata map[string]string `json:"metadata"`
30+
}
31+
32+
type nodeIdentityJSON struct {
33+
PeerID string `json:"peer_id"`
34+
Enr string `json:"enr"`
35+
P2PAddresses []string `json:"p2p_addresses"`
36+
DiscoveryAddresses []string `json:"discovery_addresses"`
37+
Metadata map[string]string `json:"metadata"`
38+
}
39+
40+
// MarshalJSON implements json.Marshaler.
41+
func (n *NodeIdentity) MarshalJSON() ([]byte, error) {
42+
return json.Marshal(&nodeIdentityJSON{
43+
PeerID: n.PeerID,
44+
Enr: n.Enr,
45+
P2PAddresses: n.P2PAddresses,
46+
DiscoveryAddresses: n.DiscoveryAddresses,
47+
Metadata: n.Metadata,
48+
})
49+
}
50+
51+
// UnmarshalJSON implements json.Unmarshaler.
52+
func (n *NodeIdentity) UnmarshalJSON(input []byte) error {
53+
var nodeIdentityJSON nodeIdentityJSON
54+
55+
if err := json.Unmarshal(input, &nodeIdentityJSON); err != nil {
56+
return errors.Wrap(err, "invalid JSON")
57+
}
58+
59+
n.PeerID = nodeIdentityJSON.PeerID
60+
n.Enr = nodeIdentityJSON.Enr
61+
n.P2PAddresses = nodeIdentityJSON.P2PAddresses
62+
n.DiscoveryAddresses = nodeIdentityJSON.DiscoveryAddresses
63+
n.Metadata = nodeIdentityJSON.Metadata
64+
65+
return nil
66+
}
67+
68+
func (n *NodeIdentity) String() string {
69+
data, err := json.Marshal(n)
70+
if err != nil {
71+
return fmt.Sprintf("ERR: %v", err)
72+
}
73+
74+
return string(data)
75+
}

‎auto/service.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ func New(ctx context.Context, params ...Parameter) (consensusclient.Service, err
5353
}
5454

5555
func tryHTTP(ctx context.Context, parameters *parameters) (consensusclient.Service, error) {
56-
httpParameters := make([]http.Parameter, 0)
56+
httpParameters := make([]http.Parameter, 0, 3)
5757
httpParameters = append(httpParameters, http.WithLogLevel(parameters.logLevel))
5858
httpParameters = append(httpParameters, http.WithAddress(parameters.address))
5959
httpParameters = append(httpParameters, http.WithTimeout(parameters.timeout))

‎http/nodeidentity.go‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
// Copyright © 2025 Attestant Limited.
2+
// Licensed under the Apache License, Version 2.0 (the "License");
3+
// you may not use this file except in compliance with the License.
4+
// You may obtain a copy of the License at
5+
//
6+
// http://www.apache.org/licenses/LICENSE-2.0
7+
//
8+
// Unless required by applicable law or agreed to in writing, software
9+
// distributed under the License is distributed on an "AS IS" BASIS,
10+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11+
// See the License for the specific language governing permissions and
12+
// limitations under the License.
13+
14+
package http
15+
16+
import (
17+
"bytes"
18+
"context"
19+
"fmt"
20+
21+
client "github.com/attestantio/go-eth2-client"
22+
"github.com/attestantio/go-eth2-client/api"
23+
apiv1 "github.com/attestantio/go-eth2-client/api/v1"
24+
)
25+
26+
// NodeIdentity provides the identity information of the node.
27+
func (s *Service) NodeIdentity(ctx context.Context,
28+
opts *api.NodeIdentityOpts,
29+
) (
30+
*api.Response[*apiv1.NodeIdentity],
31+
error,
32+
) {
33+
if err := s.assertIsActive(ctx); err != nil {
34+
return nil, err
35+
}
36+
if opts == nil {
37+
return nil, client.ErrNoOptions
38+
}
39+
40+
endpoint := "/eth/v1/node/identity"
41+
httpResponse, err := s.get(ctx, endpoint, "", &opts.Common, false)
42+
if err != nil {
43+
return nil, err
44+
}
45+
46+
if httpResponse.contentType != ContentTypeJSON {
47+
return nil, fmt.Errorf("unexpected content type %v (expected JSON)", httpResponse.contentType)
48+
}
49+
50+
data, metadata, err := decodeJSONResponse(bytes.NewReader(httpResponse.body), &apiv1.NodeIdentity{})
51+
if err != nil {
52+
return nil, err
53+
}
54+
55+
return &api.Response[*apiv1.NodeIdentity]{
56+
Data: data,
57+
Metadata: metadata,
58+
}, nil
59+
}

‎mock/nodeidentity.go‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
// Copyright © 2025 Attestant Limited.
2+
// Licensed under the Apache License, Version 2.0 (the "License");
3+
// you may not use this file except in compliance with the License.
4+
// You may obtain a copy of the License at
5+
//
6+
// http://www.apache.org/licenses/LICENSE-2.0
7+
//
8+
// Unless required by applicable law or agreed to in writing, software
9+
// distributed under the License is distributed on an "AS IS" BASIS,
10+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11+
// See the License for the specific language governing permissions and
12+
// limitations under the License.
13+
14+
package mock
15+
16+
import (
17+
"context"
18+
19+
"github.com/attestantio/go-eth2-client/api"
20+
apiv1 "github.com/attestantio/go-eth2-client/api/v1"
21+
)
22+
23+
// NodeIdentity provides the identity information of the node.
24+
func (s *Service) NodeIdentity(ctx context.Context,
25+
opts *api.NodeIdentityOpts,
26+
) (
27+
*api.Response[*apiv1.NodeIdentity],
28+
error,
29+
) {
30+
if s.NodeIdentityFunc != nil {
31+
return s.NodeIdentityFunc(ctx, opts)
32+
}
33+
34+
return &api.Response[*apiv1.NodeIdentity]{
35+
Data: &apiv1.NodeIdentity{
36+
PeerID: "16Uiu2HAmMockPeerID",
37+
Enr: "enr:-mock-enr-value",
38+
P2PAddresses: []string{"/ip4/127.0.0.1/tcp/9000"},
39+
DiscoveryAddresses: []string{"/ip4/127.0.0.1/udp/9000"},
40+
Metadata: map[string]string{
41+
"seq_number": "1",
42+
"attnets": "0xffffffffffffffff",
43+
},
44+
},
45+
}, nil
46+
}

‎mock/service.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ type Service struct {
6868
ForkFunc func(context.Context, *api.ForkOpts) (*api.Response[*phase0.Fork], error)
6969
ForkScheduleFunc func(context.Context, *api.ForkScheduleOpts) (*api.Response[[]*phase0.Fork], error)
7070
GenesisFunc func(context.Context, *api.GenesisOpts) (*api.Response[*apiv1.Genesis], error)
71+
NodeIdentityFunc func(context.Context, *api.NodeIdentityOpts) (*api.Response[*apiv1.NodeIdentity], error)
7172
NodePeersFunc func(context.Context, *api.NodePeersOpts) (*api.Response[[]*apiv1.Peer], error)
7273
NodePeerCountFunc func(context.Context, *api.NodePeerCountOpts) (*api.Response[*apiv1.PeerCount], error)
7374
NodeSyncingFunc func(context.Context, *api.NodeSyncingOpts) (*api.Response[*apiv1.SyncState], error)

‎multi/nodeidentity.go‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
// Copyright © 2025 Attestant Limited.
2+
// Licensed under the Apache License, Version 2.0 (the "License");
3+
// you may not use this file except in compliance with the License.
4+
// You may obtain a copy of the License at
5+
//
6+
// http://www.apache.org/licenses/LICENSE-2.0
7+
//
8+
// Unless required by applicable law or agreed to in writing, software
9+
// distributed under the License is distributed on an "AS IS" BASIS,
10+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11+
// See the License for the specific language governing permissions and
12+
// limitations under the License.
13+
14+
package multi
15+
16+
import (
17+
"context"
18+
19+
consensusclient "github.com/attestantio/go-eth2-client"
20+
"github.com/attestantio/go-eth2-client/api"
21+
apiv1 "github.com/attestantio/go-eth2-client/api/v1"
22+
)
23+
24+
// NodeIdentity provides the identity information of the node.
25+
func (s *Service) NodeIdentity(ctx context.Context, opts *api.NodeIdentityOpts) (*api.Response[*apiv1.NodeIdentity], error) {
26+
res, err := s.doCall(ctx, func(ctx context.Context, client consensusclient.Service) (any, error) {
27+
nodeIdentity, err := client.(consensusclient.NodeIdentityProvider).NodeIdentity(ctx, opts)
28+
if err != nil {
29+
return nil, err
30+
}
31+
32+
return nodeIdentity, nil
33+
}, nil)
34+
if err != nil {
35+
return nil, err
36+
}
37+
38+
response, isResponse := res.(*api.Response[*apiv1.NodeIdentity])
39+
if !isResponse {
40+
return nil, ErrIncorrectType
41+
}
42+
43+
return response, nil
44+
}

‎service.go‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -527,6 +527,17 @@ type GenesisProvider interface {
527527
)
528528
}
529529

530+
// NodeIdentityProvider is the interface for providing node identity information.
531+
type NodeIdentityProvider interface {
532+
// NodeIdentity provides the identity information of the node.
533+
NodeIdentity(ctx context.Context,
534+
opts *api.NodeIdentityOpts,
535+
) (
536+
*api.Response[*apiv1.NodeIdentity],
537+
error,
538+
)
539+
}
540+
530541
// NodePeersProvider is the interface for providing peer information.
531542
type NodePeersProvider interface {
532543
// NodePeers provides the peers of the node.

‎testclients/erroring.go‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,24 @@ func (s *Erroring) SlotFromStateID(ctx context.Context, stateID string) (phase0.
126126
return next.SlotFromStateID(ctx, stateID)
127127
}
128128

129+
// NodeIdentity provides the identity information of the node.
130+
func (s *Erroring) NodeIdentity(ctx context.Context,
131+
opts *api.NodeIdentityOpts,
132+
) (
133+
*api.Response[*apiv1.NodeIdentity],
134+
error,
135+
) {
136+
if err := s.maybeError(ctx); err != nil {
137+
return nil, err
138+
}
139+
next, isNext := s.next.(consensusclient.NodeIdentityProvider)
140+
if !isNext {
141+
return nil, fmt.Errorf("%s@%s does not support this call", s.next.Name(), s.next.Address())
142+
}
143+
144+
return next.NodeIdentity(ctx, opts)
145+
}
146+
129147
// NodeVersion returns a free-text string with the node version.
130148
func (s *Erroring) NodeVersion(ctx context.Context,
131149
opts *api.NodeVersionOpts,

‎testclients/sleepy.go‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,22 @@ func (s *Sleepy) SlotFromStateID(ctx context.Context, stateID string) (phase0.Sl
119119
return next.SlotFromStateID(ctx, stateID)
120120
}
121121

122+
// NodeIdentity provides the identity information of the node.
123+
func (s *Sleepy) NodeIdentity(ctx context.Context,
124+
opts *api.NodeIdentityOpts,
125+
) (
126+
*api.Response[*apiv1.NodeIdentity],
127+
error,
128+
) {
129+
s.sleep(ctx)
130+
next, isNext := s.next.(consensusclient.NodeIdentityProvider)
131+
if !isNext {
132+
return nil, errors.New("next does not support this call")
133+
}
134+
135+
return next.NodeIdentity(ctx, opts)
136+
}
137+
122138
// NodeVersion returns a free-text string with the node version.
123139
func (s *Sleepy) NodeVersion(ctx context.Context,
124140
opts *api.NodeVersionOpts,

0 commit comments

Comments
 (0)