Skip to content

Commit

Permalink
Add docs for block number
Browse files Browse the repository at this point in the history
  • Loading branch information
damiramirez committed Feb 3, 2025
1 parent 1be8184 commit 4846de3
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions chainio/clients/elcontracts/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,8 @@ type RemovePendingAdminRequest struct {
WaitForReceipt bool
}

// OperatorAVSSplitRequest is used to request the split of an operator for a specific AVS
// OperatorAVSSplitRequest is used to request the split of an operator for a specific AVS.
// If `BlockNumber` is nil, the latest block will be used
type OperatorAVSSplitRequest struct {
BlockNumber *big.Int
OperatorAddress common.Address
Expand All @@ -94,13 +95,15 @@ type SplitResponse struct {
Split uint16
}

// OperatorRequest is used to represent the address of an operator
// OperatorRequest is used to represent the address of an operator.
// If `BlockNumber` is nil, the latest block will be used
type OperatorRequest struct {
BlockNumber *big.Int
OperatorAddress common.Address
}

// OperatorStrategyRequest is used to represent the address of an operator and a strategy
// OperatorStrategyRequest is used to represent the address of an operator and a strategy.
// If `BlockNumber` is nil, the latest block will be used
type OperatorStrategyRequest struct {
BlockNumber *big.Int
OperatorAddress common.Address
Expand All @@ -112,6 +115,8 @@ type AllocatableResponse struct {
Allocatable uint64
}

// OperatorStrategiesRequest is used to represent the addresses of an operator and strategies.
// If `BlockNumber` is nil, the latest block will be used
type OperatorStrategiesRequest struct {
BlockNumber *big.Int
OperatorAddress common.Address
Expand All @@ -133,7 +138,8 @@ type OperatorSharesResponse struct {
Shares []*big.Int
}

// OperatorsStrategiesRequest represents the addresses of operators and strategies
// OperatorsStrategiesRequest represents the addresses of operators and strategies.
// If `BlockNumber` is nil, the latest block will be used
type OperatorsStrategiesRequest struct {
BlockNumber *big.Int
OperatorAddresses []common.Address
Expand Down

0 comments on commit 4846de3

Please sign in to comment.