From 3ff129668dface0ebc041ccc9b5ce54a8f882439 Mon Sep 17 00:00:00 2001 From: kediyalua Date: Sun, 11 Oct 2026 08:42:47 +0800 Subject: [PATCH] chore: fix some comments to improve readability Signed-off-by: kediyalua --- bindings/dao/proposals.go | 2 +- bindings/dao/protocol/proposal.go | 2 +- bindings/dao/protocol/verify.go | 4 ++-- bindings/dao/security/proposals.go | 2 +- bindings/dao/security/security.go | 2 +- bindings/dao/trustednode/dao.go | 2 +- bindings/dao/trustednode/proposals.go | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/bindings/dao/proposals.go b/bindings/dao/proposals.go index 4764434c8..a34482f5f 100644 --- a/bindings/dao/proposals.go +++ b/bindings/dao/proposals.go @@ -450,7 +450,7 @@ func GetProposalCount(rp *rocketpool.RocketPool, opts *bind.CallOpts) (uint64, e return (*proposalCount).Uint64(), nil } -// Proposal details +// GetProposalDAO returns the DAO name associated with a proposal. func GetProposalDAO(rp *rocketpool.RocketPool, proposalId uint64, opts *bind.CallOpts) (string, error) { rocketDAOProposal, err := getRocketDAOProposal(rp, opts) if err != nil { diff --git a/bindings/dao/protocol/proposal.go b/bindings/dao/protocol/proposal.go index accb8430b..052f06cb6 100644 --- a/bindings/dao/protocol/proposal.go +++ b/bindings/dao/protocol/proposal.go @@ -651,7 +651,7 @@ func EstimateFinalizeGas(rp *rocketpool.RocketPool, proposalId uint64, opts *bin return rocketDAOProtocolProposal.GetTransactionGasInfo(opts, "finalise", big.NewInt(int64(proposalId))) } -// Finalizes a vetoed proposal by burning the proposer's bond +// Finalize burns the proposer's bond for a vetoed proposal. func Finalize(rp *rocketpool.RocketPool, proposalId uint64, opts *bind.TransactOpts) (common.Hash, error) { rocketDAOProtocolProposal, err := getRocketDAOProtocolProposal(rp, nil) if err != nil { diff --git a/bindings/dao/protocol/verify.go b/bindings/dao/protocol/verify.go index 22a7f3a44..119d34339 100755 --- a/bindings/dao/protocol/verify.go +++ b/bindings/dao/protocol/verify.go @@ -103,7 +103,7 @@ func EstimateCreateChallengeGas(rp *rocketpool.RocketPool, proposalId uint64, in return rocketDAOProtocolVerifier.GetTransactionGasInfo(opts, "createChallenge", big.NewInt(int64(proposalId)), big.NewInt((int64(index))), node, witness) } -// Challenge a proposal at a specific tree node index, providing a Merkle proof of the node as well +// CreateChallenge challenges a proposal at a tree node index with a Merkle proof for that node. func CreateChallenge(rp *rocketpool.RocketPool, proposalId uint64, index uint64, node types.VotingTreeNode, witness []types.VotingTreeNode, opts *bind.TransactOpts) (common.Hash, error) { rocketDAOProtocolVerifier, err := getRocketDAOProtocolVerifier(rp, nil) if err != nil { @@ -506,7 +506,7 @@ func EstimateDefeatProposalGas(rp *rocketpool.RocketPool, proposalId uint64, ind return rocketDAOProtocolVerifier.GetTransactionGasInfo(opts, "defeatProposal", big.NewInt(int64(proposalId)), big.NewInt(int64(index))) } -// Defeat a proposal if it fails to respond to a challenge within the challenge window, providing the node index that wasn't responded to +// DefeatProposal defeats a proposal that failed to respond to a challenge within the challenge window. func DefeatProposal(rp *rocketpool.RocketPool, proposalId uint64, index uint64, opts *bind.TransactOpts) (common.Hash, error) { rocketDAOProtocolVerifier, err := getRocketDAOProtocolVerifier(rp, nil) if err != nil { diff --git a/bindings/dao/security/proposals.go b/bindings/dao/security/proposals.go index 1d6905c06..28da95ac4 100644 --- a/bindings/dao/security/proposals.go +++ b/bindings/dao/security/proposals.go @@ -123,7 +123,7 @@ func EstimateCancelProposalGas(rp *rocketpool.RocketPool, proposalId uint64, opt return rocketDAOSecurityProposals.GetTransactionGasInfo(opts, "cancel", big.NewInt(int64(proposalId))) } -// Cancel a submitted proposal +// CancelProposal cancels a submitted security DAO proposal. func CancelProposal(rp *rocketpool.RocketPool, proposalId uint64, opts *bind.TransactOpts) (common.Hash, error) { rocketDAOSecurityProposals, err := getRocketDAOSecurityProposals(rp, nil) if err != nil { diff --git a/bindings/dao/security/security.go b/bindings/dao/security/security.go index 6cfada614..acc756043 100644 --- a/bindings/dao/security/security.go +++ b/bindings/dao/security/security.go @@ -186,7 +186,7 @@ func GetMemberAt(rp *rocketpool.RocketPool, index uint64, opts *bind.CallOpts) ( return *memberAddress, nil } -// Member details +// GetMemberExists reports whether the address is a security DAO member. func GetMemberExists(rp *rocketpool.RocketPool, memberAddress common.Address, opts *bind.CallOpts) (bool, error) { rocketDAOSecurity, err := getRocketDAOSecurity(rp, opts) if err != nil { diff --git a/bindings/dao/trustednode/dao.go b/bindings/dao/trustednode/dao.go index 4009418dc..6d135b735 100644 --- a/bindings/dao/trustednode/dao.go +++ b/bindings/dao/trustednode/dao.go @@ -218,7 +218,7 @@ func GetMemberAt(rp *rocketpool.RocketPool, index uint64, opts *bind.CallOpts) ( return *memberAddress, nil } -// Member details +// GetMemberExists reports whether the address is a trusted node DAO member. func GetMemberExists(rp *rocketpool.RocketPool, memberAddress common.Address, opts *bind.CallOpts) (bool, error) { rocketDAONodeTrusted, err := getRocketDAONodeTrusted(rp, opts) if err != nil { diff --git a/bindings/dao/trustednode/proposals.go b/bindings/dao/trustednode/proposals.go index 379af3454..b594c49a3 100644 --- a/bindings/dao/trustednode/proposals.go +++ b/bindings/dao/trustednode/proposals.go @@ -244,7 +244,7 @@ func EstimateCancelProposalGas(rp *rocketpool.RocketPool, proposalId uint64, opt return rocketDAONodeTrustedProposals.GetTransactionGasInfo(opts, "cancel", big.NewInt(int64(proposalId))) } -// Cancel a submitted proposal +// CancelProposal cancels a submitted trusted node DAO proposal. func CancelProposal(rp *rocketpool.RocketPool, proposalId uint64, opts *bind.TransactOpts) (common.Hash, error) { rocketDAONodeTrustedProposals, err := getRocketDAONodeTrustedProposals(rp, nil) if err != nil {