Add common options.

CHANGELOG.md

@@ -1,3 +1,7 @@
+dev:
+  - standardise names of options
+  - add common options (currently just timeout) to options structs
+
 0.19.4:
   - revert SubmitProposal() to use v1 of the API
 

api/aggregateattestationopts.go

@@ -17,6 +17,8 @@ import "github.com/attestantio/go-eth2-client/spec/phase0"
 
 // AggregateAttestationOpts are the options for obtaining aggregate attestations.
 type AggregateAttestationOpts struct {
+	Common CommonOpts
+
 	// Slot is the slot for which the data is obtained.
 	Slot phase0.Slot
 	// AttestationDataRoot is the root for which the data is obtained.

api/attestationdataopts.go

@@ -17,6 +17,8 @@ import "github.com/attestantio/go-eth2-client/spec/phase0"
 
 // AttestationDataOpts are the options for obtaining attestation data.
 type AttestationDataOpts struct {
+	Common CommonOpts
+
 	// Slot is the slot for which the data is obtained.
 	Slot phase0.Slot
 	// CommitteeIndex is the committee index for which the data is obtained.

api/attestationpoolopts.go

@@ -17,6 +17,8 @@ import "github.com/attestantio/go-eth2-client/spec/phase0"
 
 // AttestationPoolOpts are the options for obtaining the attestation pool.
 type AttestationPoolOpts struct {
+	Common CommonOpts
+
 	// Slot is the slot for which the data is obtained.
 	Slot phase0.Slot
 }

api/attesterdutiesopts.go

@@ -17,6 +17,8 @@ import "github.com/attestantio/go-eth2-client/spec/phase0"
 
 // AttesterDutiesOpts are the options for obtaining proposer duties.
 type AttesterDutiesOpts struct {
+	Common CommonOpts
+
 	// Epoch is the epoch for which the data is obtained.
 	Epoch phase0.Epoch
 	// Indices is a list of validators for which to obtain the duties.

api/beaconblockheaderopts.go

@@ -15,6 +15,8 @@ package api
 
 // BeaconBlockHeaderOpts are the options for obtaining beacon block headers.
 type BeaconBlockHeaderOpts struct {
+	Common CommonOpts
+
 	// Block is the ID of the block which the data is obtained.
 	Block string
 }

api/beaconblockrootopts.go

@@ -15,6 +15,8 @@ package api
 
 // BeaconBlockRootOpts are the options for obtaining the beacon block root.
 type BeaconBlockRootOpts struct {
+	Common CommonOpts
+
 	// Block is the ID of the block which the data is obtained.
 	Block string
 }

api/beaconcommitteesopts.go

@@ -17,6 +17,8 @@ import "github.com/attestantio/go-eth2-client/spec/phase0"
 
 // BeaconCommitteesOpts are the options for obtaining proposer duties.
 type BeaconCommitteesOpts struct {
+	Common CommonOpts
+
 	// State is the state at which the data is obtained.
 	// It can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
 	State string

api/beaconstateopts.go

@@ -15,6 +15,8 @@ package api
 
 // BeaconStateOpts are the options for obtaining the beacon state.
 type BeaconStateOpts struct {
+	Common CommonOpts
+
 	// State is the state at which the data is obtained.
 	// It can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
 	State string

api/beaconstaterandaoopts.go

@@ -15,6 +15,8 @@ package api
 
 // BeaconStateRandaoOpts are the options for obtaining the beacon state RANDAO.
 type BeaconStateRandaoOpts struct {
+	Common CommonOpts
+
 	// State is the state at which the data is obtained.
 	// It can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
 	State string

api/beaconstaterootopts.go

@@ -15,6 +15,8 @@ package api
 
 // BeaconStateRootOpts are the options for obtaining the beacon state root.
 type BeaconStateRootOpts struct {
+	Common CommonOpts
+
 	// State is the state at which the data is obtained.
 	// It can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
 	State string

api/blindedproposalopts.go

@@ -17,6 +17,8 @@ import "github.com/attestantio/go-eth2-client/spec/phase0"
 
 // BlindedProposalOpts are the options for obtaining blinded proposals.
 type BlindedProposalOpts struct {
+	Common CommonOpts
+
 	// Slot is the slot for which the proposal should be fetched.
 	Slot phase0.Slot
 	// RandaoReveal is the RANDAO reveal for the proposal.

api/blobsidecarsopts.go

@@ -15,6 +15,8 @@ package api
 
 // BlobSidecarsOpts are the options for obtaining blob sidecars.
 type BlobSidecarsOpts struct {
+	Common CommonOpts
+
 	// Block is the ID of the block for which the data is obtained.
 	Block string
 }

api/commonopts.go

@@ -0,0 +1,23 @@
+// Copyright © 2023 Attestant Limited.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package api
+
+import "time"
+
+// CommonOpts are options common for all calls.
+type CommonOpts struct {
+	// Timeout is a specific timeout for this call.
+	// If 0 then the default timeout is used.
+	Timeout time.Duration
+}

api/depositcontractopts.go

@@ -0,0 +1,19 @@
+// Copyright © 2023 Attestant Limited.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package api
+
+// DepositContractOpts are the options for obtaining the deposit contract.
+type DepositContractOpts struct {
+	Common CommonOpts
+}

api/finalityopts.go

@@ -15,6 +15,8 @@ package api
 
 // FinalityOpts are the options for obtaining finality checkpoints.
 type FinalityOpts struct {
+	Common CommonOpts
+
 	// State is the state at which the data is obtained.
 	// It can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
 	State string

api/forkchoiceopts.go

@@ -0,0 +1,19 @@
+// Copyright © 2023 Attestant Limited.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package api
+
+// ForkChoiceOpts are the options for obtaining the fork choice.
+type ForkChoiceOpts struct {
+	Common CommonOpts
+}

api/forkopts.go

@@ -15,6 +15,8 @@ package api
 
 // ForkOpts are the options for obtaining the fork.
 type ForkOpts struct {
+	Common CommonOpts
+
 	// State is the state at which the data is obtained.
 	// It can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
 	State string

api/forkscheduleopts.go

@@ -0,0 +1,19 @@
+// Copyright © 2023 Attestant Limited.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package api
+
+// ForkScheduleOpts are the options for obtaining the fork schedule.
+type ForkScheduleOpts struct {
+	Common CommonOpts
+}

api/genesisopts.go

@@ -0,0 +1,19 @@
+// Copyright © 2023 Attestant Limited.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package api
+
+// GenesisOpts are the options for obtaining genesis information.
+type GenesisOpts struct {
+	Common CommonOpts
+}

api/peeropts.go → api/nodepeersopts.go

@@ -13,8 +13,10 @@
 
 package api
 
-// PeerOpts are the options for client side peer filtering.
-type PeerOpts struct {
+// NodePeersOpts are the options for client side peer filtering.
+type NodePeersOpts struct {
+	Common CommonOpts
+
 	// State of the connection (disconnected, connecting, connected, disconnecting)
 	State []string
 	// Direction of the connection (inbound, outbound)

api/nodesyncingopts.go

@@ -0,0 +1,19 @@
+// Copyright © 2023 Attestant Limited.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package api
+
+// NodeSyncingOpts are the options for obtaining node sync information.
+type NodeSyncingOpts struct {
+	Common CommonOpts
+}

api/nodeversionopts.go

@@ -0,0 +1,19 @@
+// Copyright © 2023 Attestant Limited.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package api
+
+// NodeVersionOpts are the options for obtaining the node version.
+type NodeVersionOpts struct {
+	Common CommonOpts
+}

api/proposalopts.go

@@ -17,6 +17,8 @@ import "github.com/attestantio/go-eth2-client/spec/phase0"
 
 // ProposalOpts are the options for obtaining proposals.
 type ProposalOpts struct {
+	Common CommonOpts
+
 	// Slot is the slot for which the proposal should be fetched.
 	Slot phase0.Slot
 	// RandaoReveal is the RANDAO reveal for the proposal.

api/proposerdutiesopts.go

@@ -17,6 +17,8 @@ import "github.com/attestantio/go-eth2-client/spec/phase0"
 
 // ProposerDutiesOpts are the options for obtaining proposer duties.
 type ProposerDutiesOpts struct {
+	Common CommonOpts
+
 	// Epoch is the epoch for which the data is obtained.
 	Epoch phase0.Epoch
 	// Indices is a list of validators to restrict the returned values.  If no indices are supplied then no filter will be applied.

api/signedbeaconblockopts.go

@@ -15,6 +15,8 @@ package api
 
 // SignedBeaconBlockOpts are the options for obtaining signed beacon blocks.
 type SignedBeaconBlockOpts struct {
+	Common CommonOpts
+
 	// Block is the ID of the block which the data is obtained.
 	Block string
 }

api/specopts.go

@@ -0,0 +1,19 @@
+// Copyright © 2023 Attestant Limited.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package api
+
+// SpecOpts are the options for obtaining the chain specification.
+type SpecOpts struct {
+	Common CommonOpts
+}

api/synccommitteecontributionopts.go

@@ -17,6 +17,8 @@ import "github.com/attestantio/go-eth2-client/spec/phase0"
 
 // SyncCommitteeContributionOpts are the options for obtaining sync committee contributions.
 type SyncCommitteeContributionOpts struct {
+	Common CommonOpts
+
 	// Slot is the slot for which the data is obtained.
 	Slot phase0.Slot
 	// SubcommitteeIndex is the index of the sync subcommittee for which the data is obtained.

api/synccommitteedutiesopts.go

@@ -17,6 +17,8 @@ import "github.com/attestantio/go-eth2-client/spec/phase0"
 
 // SyncCommitteeDutiesOpts are the options for obtaining sync committee duties.
 type SyncCommitteeDutiesOpts struct {
+	Common CommonOpts
+
 	// Epoch is the epoch for which the data is obtained.
 	Epoch phase0.Epoch
 	// Indices is a list of validators for which to obtain the duties.

api/synccommitteeopts.go

@@ -17,6 +17,8 @@ import "github.com/attestantio/go-eth2-client/spec/phase0"
 
 // SyncCommitteeOpts are the options for obtaining sync committees.
 type SyncCommitteeOpts struct {
+	Common CommonOpts
+
 	// State is the state at which the data is obtained.
 	// It can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
 	State string

api/validatorbalancesopts.go

@@ -17,6 +17,8 @@ import "github.com/attestantio/go-eth2-client/spec/phase0"
 
 // ValidatorBalancesOpts are the options for obtaining validator balances.
 type ValidatorBalancesOpts struct {
+	Common CommonOpts
+
 	// State is the state at which the data is obtained.
 	// It can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
 	State string

api/validatorsopts.go

@@ -17,6 +17,8 @@ import "github.com/attestantio/go-eth2-client/spec/phase0"
 
 // ValidatorsOpts are the options for obtaining validators.
 type ValidatorsOpts struct {
+	Common CommonOpts
+
 	// State is the state at which the data is obtained.
 	// It can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
 	State string