v1

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 8, 2024 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Overview

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source
const (
	StakingService_ListProtocols_FullMethodName       = "/coinbase.staking.orchestration.v1.StakingService/ListProtocols"
	StakingService_ListNetworks_FullMethodName        = "/coinbase.staking.orchestration.v1.StakingService/ListNetworks"
	StakingService_ListStakingTargets_FullMethodName  = "/coinbase.staking.orchestration.v1.StakingService/ListStakingTargets"
	StakingService_ListActions_FullMethodName         = "/coinbase.staking.orchestration.v1.StakingService/ListActions"
	StakingService_CreateWorkflow_FullMethodName      = "/coinbase.staking.orchestration.v1.StakingService/CreateWorkflow"
	StakingService_GetWorkflow_FullMethodName         = "/coinbase.staking.orchestration.v1.StakingService/GetWorkflow"
	StakingService_ListWorkflows_FullMethodName       = "/coinbase.staking.orchestration.v1.StakingService/ListWorkflows"
	StakingService_PerformWorkflowStep_FullMethodName = "/coinbase.staking.orchestration.v1.StakingService/PerformWorkflowStep"
	StakingService_ViewStakingContext_FullMethodName  = "/coinbase.staking.orchestration.v1.StakingService/ViewStakingContext"
)

Variables

View Source
var (
	StakeAccount_BalanceState_name = map[int32]string{
		0: "BALANCE_STATE_UNSPECIFIED",
		1: "BALANCE_STATE_INACTIVE",
		2: "BALANCE_STATE_ACTIVATING",
		3: "BALANCE_STATE_ACTIVE",
		4: "BALANCE_STATE_DEACTIVATING",
	}
	StakeAccount_BalanceState_value = map[string]int32{
		"BALANCE_STATE_UNSPECIFIED":  0,
		"BALANCE_STATE_INACTIVE":     1,
		"BALANCE_STATE_ACTIVATING":   2,
		"BALANCE_STATE_ACTIVE":       3,
		"BALANCE_STATE_DEACTIVATING": 4,
	}
)

Enum value maps for StakeAccount_BalanceState.

View Source
var (
	TxStepOutput_State_name = map[int32]string{
		0:  "STATE_UNSPECIFIED",
		1:  "STATE_NOT_CONSTRUCTED",
		2:  "STATE_CONSTRUCTED",
		16: "STATE_PENDING_EXT_BROADCAST",
		4:  "STATE_SIGNED",
		5:  "STATE_BROADCASTING",
		6:  "STATE_CONFIRMING",
		7:  "STATE_CONFIRMED",
		8:  "STATE_FINALIZED",
		9:  "STATE_FAILED",
		10: "STATE_SUCCESS",
	}
	TxStepOutput_State_value = map[string]int32{
		"STATE_UNSPECIFIED":           0,
		"STATE_NOT_CONSTRUCTED":       1,
		"STATE_CONSTRUCTED":           2,
		"STATE_PENDING_EXT_BROADCAST": 16,
		"STATE_SIGNED":                4,
		"STATE_BROADCASTING":          5,
		"STATE_CONFIRMING":            6,
		"STATE_CONFIRMED":             7,
		"STATE_FINALIZED":             8,
		"STATE_FAILED":                9,
		"STATE_SUCCESS":               10,
	}
)

Enum value maps for TxStepOutput_State.

View Source
var (
	WaitStepOutput_WaitUnit_name = map[int32]string{
		0: "WAIT_UNIT_UNSPECIFIED",
		1: "WAIT_UNIT_SECONDS",
		2: "WAIT_UNIT_BLOCKS",
		3: "WAIT_UNIT_EPOCHS",
		4: "WAIT_UNIT_CHECKPOINTS",
	}
	WaitStepOutput_WaitUnit_value = map[string]int32{
		"WAIT_UNIT_UNSPECIFIED": 0,
		"WAIT_UNIT_SECONDS":     1,
		"WAIT_UNIT_BLOCKS":      2,
		"WAIT_UNIT_EPOCHS":      3,
		"WAIT_UNIT_CHECKPOINTS": 4,
	}
)

Enum value maps for WaitStepOutput_WaitUnit.

View Source
var (
	WaitStepOutput_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "STATE_NOT_STARTED",
		2: "STATE_IN_PROGRESS",
		3: "STATE_COMPLETED",
	}
	WaitStepOutput_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"STATE_NOT_STARTED": 1,
		"STATE_IN_PROGRESS": 2,
		"STATE_COMPLETED":   3,
	}
)

Enum value maps for WaitStepOutput_State.

View Source
var (
	Workflow_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "STATE_IN_PROGRESS",
		9: "STATE_WAITING_FOR_EXT_BROADCAST",
		3: "STATE_COMPLETED",
		4: "STATE_FAILED",
	}
	Workflow_State_value = map[string]int32{
		"STATE_UNSPECIFIED":               0,
		"STATE_IN_PROGRESS":               1,
		"STATE_WAITING_FOR_EXT_BROADCAST": 9,
		"STATE_COMPLETED":                 3,
		"STATE_FAILED":                    4,
	}
)

Enum value maps for Workflow_State.

View Source
var File_coinbase_staking_orchestration_v1_action_proto protoreflect.FileDescriptor
View Source
var File_coinbase_staking_orchestration_v1_api_proto protoreflect.FileDescriptor
View Source
var File_coinbase_staking_orchestration_v1_common_proto protoreflect.FileDescriptor
View Source
var File_coinbase_staking_orchestration_v1_ethereum_kiln_proto protoreflect.FileDescriptor
View Source
var File_coinbase_staking_orchestration_v1_network_proto protoreflect.FileDescriptor
View Source
var File_coinbase_staking_orchestration_v1_protocol_proto protoreflect.FileDescriptor
View Source
var File_coinbase_staking_orchestration_v1_solana_proto protoreflect.FileDescriptor
View Source
var File_coinbase_staking_orchestration_v1_staking_context_proto protoreflect.FileDescriptor
View Source
var File_coinbase_staking_orchestration_v1_staking_target_proto protoreflect.FileDescriptor
View Source
var File_coinbase_staking_orchestration_v1_workflow_proto protoreflect.FileDescriptor
View Source
var StakingService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "coinbase.staking.orchestration.v1.StakingService",
	HandlerType: (*StakingServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListProtocols",
			Handler:    _StakingService_ListProtocols_Handler,
		},
		{
			MethodName: "ListNetworks",
			Handler:    _StakingService_ListNetworks_Handler,
		},
		{
			MethodName: "ListStakingTargets",
			Handler:    _StakingService_ListStakingTargets_Handler,
		},
		{
			MethodName: "ListActions",
			Handler:    _StakingService_ListActions_Handler,
		},
		{
			MethodName: "CreateWorkflow",
			Handler:    _StakingService_CreateWorkflow_Handler,
		},
		{
			MethodName: "GetWorkflow",
			Handler:    _StakingService_GetWorkflow_Handler,
		},
		{
			MethodName: "ListWorkflows",
			Handler:    _StakingService_ListWorkflows_Handler,
		},
		{
			MethodName: "PerformWorkflowStep",
			Handler:    _StakingService_PerformWorkflowStep_Handler,
		},
		{
			MethodName: "ViewStakingContext",
			Handler:    _StakingService_ViewStakingContext_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "coinbase/staking/orchestration/v1/api.proto",
}

StakingService_ServiceDesc is the grpc.ServiceDesc for StakingService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterStakingServiceHandler

func RegisterStakingServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterStakingServiceHandler registers the http handlers for service StakingService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterStakingServiceHandlerClient

func RegisterStakingServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client StakingServiceClient) error

RegisterStakingServiceHandlerClient registers the http handlers for service StakingService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "StakingServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "StakingServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "StakingServiceClient" to call the correct interceptors.

func RegisterStakingServiceHandlerFromEndpoint

func RegisterStakingServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterStakingServiceHandlerFromEndpoint is same as RegisterStakingServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterStakingServiceHandlerServer

func RegisterStakingServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server StakingServiceServer) error

RegisterStakingServiceHandlerServer registers the http handlers for service StakingService to "mux". UnaryRPC :call StakingServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterStakingServiceHandlerFromEndpoint instead.

func RegisterStakingServiceServer

func RegisterStakingServiceServer(s grpc.ServiceRegistrar, srv StakingServiceServer)

Types

type Action

type Action struct {

	// The resource name of the Action.
	// Format: protocols/{protocolName}/networks/{networkName}/actions/{actionName}
	// Ex: protocols/ethereum_kiln/networks/holesky/validators/stake
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

An Action resource represents an action you may take on a network (e.g. stake, unstake).

func (*Action) Descriptor deprecated

func (*Action) Descriptor() ([]byte, []int)

Deprecated: Use Action.ProtoReflect.Descriptor instead.

func (*Action) GetName

func (x *Action) GetName() string

func (*Action) ProtoMessage

func (*Action) ProtoMessage()

func (*Action) ProtoReflect

func (x *Action) ProtoReflect() protoreflect.Message

func (*Action) Reset

func (x *Action) Reset()

func (*Action) String

func (x *Action) String() string

type ActionResourceName

type ActionResourceName struct {
	Protocol string
	Network  string
	Action   string
}

func (ActionResourceName) ContainsWildcard

func (n ActionResourceName) ContainsWildcard() bool

func (ActionResourceName) MarshalString

func (n ActionResourceName) MarshalString() (string, error)

func (ActionResourceName) NetworkResourceName

func (n ActionResourceName) NetworkResourceName() NetworkResourceName

func (ActionResourceName) ProtocolResourceName

func (n ActionResourceName) ProtocolResourceName() ProtocolResourceName

func (ActionResourceName) String

func (n ActionResourceName) String() string

func (*ActionResourceName) UnmarshalString

func (n *ActionResourceName) UnmarshalString(name string) error

func (ActionResourceName) Validate

func (n ActionResourceName) Validate() error

type Amount

type Amount struct {

	// The total value of the token.
	Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// The name of the token.
	Currency string `protobuf:"bytes,2,opt,name=currency,proto3" json:"currency,omitempty"`
	// contains filtered or unexported fields
}

The amount of a token you wish to perform an action with.

func (*Amount) Descriptor deprecated

func (*Amount) Descriptor() ([]byte, []int)

Deprecated: Use Amount.ProtoReflect.Descriptor instead.

func (*Amount) GetCurrency

func (x *Amount) GetCurrency() string

func (*Amount) GetValue

func (x *Amount) GetValue() string

func (*Amount) ProtoMessage

func (*Amount) ProtoMessage()

func (*Amount) ProtoReflect

func (x *Amount) ProtoReflect() protoreflect.Message

func (*Amount) Reset

func (x *Amount) Reset()

func (*Amount) String

func (x *Amount) String() string

type Contract

type Contract struct {

	// The resource name of the Contract Address.
	// Format: protocols/{protocolName}/networks/{networkName}/stakingTargets/{contractName}
	// Ex: protocols/ethereum_kiln/networks/holesky/stakingTargets/0xA55416de5DE61A0AC1aa8970a280E04388B1dE4b
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The contract address you may submit actions to.
	Address string `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
	// contains filtered or unexported fields
}

A Contract resource, which represents an active contract for the given protocol network which you can submit an action to.

func (*Contract) Descriptor deprecated

func (*Contract) Descriptor() ([]byte, []int)

Deprecated: Use Contract.ProtoReflect.Descriptor instead.

func (*Contract) GetAddress

func (x *Contract) GetAddress() string

func (*Contract) GetName

func (x *Contract) GetName() string

func (*Contract) ProtoMessage

func (*Contract) ProtoMessage()

func (*Contract) ProtoReflect

func (x *Contract) ProtoReflect() protoreflect.Message

func (*Contract) Reset

func (x *Contract) Reset()

func (*Contract) String

func (x *Contract) String() string

type ContractResourceName

type ContractResourceName struct {
	Protocol string
	Network  string
	Contract string
}

func (ContractResourceName) ContainsWildcard

func (n ContractResourceName) ContainsWildcard() bool

func (ContractResourceName) MarshalString

func (n ContractResourceName) MarshalString() (string, error)

func (ContractResourceName) NetworkResourceName

func (n ContractResourceName) NetworkResourceName() NetworkResourceName

func (ContractResourceName) ProtocolResourceName

func (n ContractResourceName) ProtocolResourceName() ProtocolResourceName

func (ContractResourceName) String

func (n ContractResourceName) String() string

func (*ContractResourceName) UnmarshalString

func (n *ContractResourceName) UnmarshalString(name string) error

func (ContractResourceName) Validate

func (n ContractResourceName) Validate() error

type CreateWorkflowRequest

type CreateWorkflowRequest struct {

	// The resource name of the parent that owns
	// the workflow.
	// Format: projects/{project}
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The workflow to create.
	Workflow *Workflow `protobuf:"bytes,2,opt,name=workflow,proto3" json:"workflow,omitempty"`
	// contains filtered or unexported fields
}

The request message for CreateWorkflow.

func (*CreateWorkflowRequest) Descriptor deprecated

func (*CreateWorkflowRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateWorkflowRequest.ProtoReflect.Descriptor instead.

func (*CreateWorkflowRequest) GetParent

func (x *CreateWorkflowRequest) GetParent() string

func (*CreateWorkflowRequest) GetWorkflow

func (x *CreateWorkflowRequest) GetWorkflow() *Workflow

func (*CreateWorkflowRequest) ProtoMessage

func (*CreateWorkflowRequest) ProtoMessage()

func (*CreateWorkflowRequest) ProtoReflect

func (x *CreateWorkflowRequest) ProtoReflect() protoreflect.Message

func (*CreateWorkflowRequest) Reset

func (x *CreateWorkflowRequest) Reset()

func (*CreateWorkflowRequest) String

func (x *CreateWorkflowRequest) String() string

type EthereumKilnClaimStakeParameters

type EthereumKilnClaimStakeParameters struct {

	// The address you wish to claim stake for.
	StakerAddress string `protobuf:"bytes,1,opt,name=staker_address,json=stakerAddress,proto3" json:"staker_address,omitempty"`
	// The address of the integrator contract
	IntegratorContractAddress string `` /* 138-byte string literal not displayed */
	// contains filtered or unexported fields
}

The parameters required for the claim stake action on Ethereum Kiln.

func (*EthereumKilnClaimStakeParameters) Descriptor deprecated

func (*EthereumKilnClaimStakeParameters) Descriptor() ([]byte, []int)

Deprecated: Use EthereumKilnClaimStakeParameters.ProtoReflect.Descriptor instead.

func (*EthereumKilnClaimStakeParameters) GetIntegratorContractAddress

func (x *EthereumKilnClaimStakeParameters) GetIntegratorContractAddress() string

func (*EthereumKilnClaimStakeParameters) GetStakerAddress

func (x *EthereumKilnClaimStakeParameters) GetStakerAddress() string

func (*EthereumKilnClaimStakeParameters) ProtoMessage

func (*EthereumKilnClaimStakeParameters) ProtoMessage()

func (*EthereumKilnClaimStakeParameters) ProtoReflect

func (*EthereumKilnClaimStakeParameters) Reset

func (*EthereumKilnClaimStakeParameters) String

type EthereumKilnStakeParameters

type EthereumKilnStakeParameters struct {

	// The address you wish to stake from.
	StakerAddress string `protobuf:"bytes,1,opt,name=staker_address,json=stakerAddress,proto3" json:"staker_address,omitempty"`
	// The address of the integrator contract.
	IntegratorContractAddress string `` /* 138-byte string literal not displayed */
	// The amount of Ethereum to stake in wei.
	Amount *Amount `protobuf:"bytes,3,opt,name=amount,proto3" json:"amount,omitempty"`
	// contains filtered or unexported fields
}

The parameters required for the stake action on Ethereum Kiln.

func (*EthereumKilnStakeParameters) Descriptor deprecated

func (*EthereumKilnStakeParameters) Descriptor() ([]byte, []int)

Deprecated: Use EthereumKilnStakeParameters.ProtoReflect.Descriptor instead.

func (*EthereumKilnStakeParameters) GetAmount

func (x *EthereumKilnStakeParameters) GetAmount() *Amount

func (*EthereumKilnStakeParameters) GetIntegratorContractAddress

func (x *EthereumKilnStakeParameters) GetIntegratorContractAddress() string

func (*EthereumKilnStakeParameters) GetStakerAddress

func (x *EthereumKilnStakeParameters) GetStakerAddress() string

func (*EthereumKilnStakeParameters) ProtoMessage

func (*EthereumKilnStakeParameters) ProtoMessage()

func (*EthereumKilnStakeParameters) ProtoReflect

func (*EthereumKilnStakeParameters) Reset

func (x *EthereumKilnStakeParameters) Reset()

func (*EthereumKilnStakeParameters) String

func (x *EthereumKilnStakeParameters) String() string

type EthereumKilnStakingContextDetails

type EthereumKilnStakingContextDetails struct {

	// The Ethereum balance of the address.
	// This can be used to gate the stake action to make sure the requested stake amount
	// is less than ethereum_balance.
	EthereumBalance *Amount `protobuf:"bytes,1,opt,name=ethereum_balance,json=ethereumBalance,proto3" json:"ethereum_balance,omitempty"`
	// The number of integrator shares owned by the address.
	IntegratorShareBalance *Amount `` /* 129-byte string literal not displayed */
	// The total Ethereum you can exchange for your integrator shares.
	// This can be used to gate the unstake action to make sure the requested unstake amount
	// is less than integrator_share_underlying_balance
	IntegratorShareUnderlyingBalance *Amount `` /* 161-byte string literal not displayed */
	// The total amount of Ethereum you can redeem for all non-claimed vPool shares.
	// This along with the condition total_shares_pending_exit == fulfillable_share_count
	// can be used to gate the claim_stake action.
	TotalExitableEth *Amount `protobuf:"bytes,4,opt,name=total_exitable_eth,json=totalExitableEth,proto3" json:"total_exitable_eth,omitempty"`
	// The number of vPool shares are eligible to receive now or at a later point in time.
	TotalSharesPendingExit *Amount `` /* 131-byte string literal not displayed */
	// The number of vPool shares you are able to claim now.
	FulfillableShareCount *Amount `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

The protocol specific details for an Ethereum Kiln staking context.

func (*EthereumKilnStakingContextDetails) Descriptor deprecated

func (*EthereumKilnStakingContextDetails) Descriptor() ([]byte, []int)

Deprecated: Use EthereumKilnStakingContextDetails.ProtoReflect.Descriptor instead.

func (*EthereumKilnStakingContextDetails) GetEthereumBalance

func (x *EthereumKilnStakingContextDetails) GetEthereumBalance() *Amount

func (*EthereumKilnStakingContextDetails) GetFulfillableShareCount

func (x *EthereumKilnStakingContextDetails) GetFulfillableShareCount() *Amount

func (*EthereumKilnStakingContextDetails) GetIntegratorShareBalance

func (x *EthereumKilnStakingContextDetails) GetIntegratorShareBalance() *Amount

func (*EthereumKilnStakingContextDetails) GetIntegratorShareUnderlyingBalance

func (x *EthereumKilnStakingContextDetails) GetIntegratorShareUnderlyingBalance() *Amount

func (*EthereumKilnStakingContextDetails) GetTotalExitableEth

func (x *EthereumKilnStakingContextDetails) GetTotalExitableEth() *Amount

func (*EthereumKilnStakingContextDetails) GetTotalSharesPendingExit

func (x *EthereumKilnStakingContextDetails) GetTotalSharesPendingExit() *Amount

func (*EthereumKilnStakingContextDetails) ProtoMessage

func (*EthereumKilnStakingContextDetails) ProtoMessage()

func (*EthereumKilnStakingContextDetails) ProtoReflect

func (*EthereumKilnStakingContextDetails) Reset

func (*EthereumKilnStakingContextDetails) String

type EthereumKilnStakingContextParameters

type EthereumKilnStakingContextParameters struct {

	// Integrator contract address.
	IntegratorContractAddress string `` /* 138-byte string literal not displayed */
	// contains filtered or unexported fields
}

The protocol specific parameters required for fetching a staking context.

func (*EthereumKilnStakingContextParameters) Descriptor deprecated

func (*EthereumKilnStakingContextParameters) Descriptor() ([]byte, []int)

Deprecated: Use EthereumKilnStakingContextParameters.ProtoReflect.Descriptor instead.

func (*EthereumKilnStakingContextParameters) GetIntegratorContractAddress

func (x *EthereumKilnStakingContextParameters) GetIntegratorContractAddress() string

func (*EthereumKilnStakingContextParameters) ProtoMessage

func (*EthereumKilnStakingContextParameters) ProtoMessage()

func (*EthereumKilnStakingContextParameters) ProtoReflect

func (*EthereumKilnStakingContextParameters) Reset

func (*EthereumKilnStakingContextParameters) String

type EthereumKilnStakingParameters

type EthereumKilnStakingParameters struct {

	// Types that are assignable to Parameters:
	//
	//	*EthereumKilnStakingParameters_StakeParameters
	//	*EthereumKilnStakingParameters_UnstakeParameters
	//	*EthereumKilnStakingParameters_ClaimStakeParameters
	Parameters isEthereumKilnStakingParameters_Parameters `protobuf_oneof:"parameters"`
	// contains filtered or unexported fields
}

The parameters needed for staking on Ethereum via Kiln.

func (*EthereumKilnStakingParameters) Descriptor deprecated

func (*EthereumKilnStakingParameters) Descriptor() ([]byte, []int)

Deprecated: Use EthereumKilnStakingParameters.ProtoReflect.Descriptor instead.

func (*EthereumKilnStakingParameters) GetClaimStakeParameters

func (*EthereumKilnStakingParameters) GetParameters

func (m *EthereumKilnStakingParameters) GetParameters() isEthereumKilnStakingParameters_Parameters

func (*EthereumKilnStakingParameters) GetStakeParameters

func (*EthereumKilnStakingParameters) GetUnstakeParameters

func (*EthereumKilnStakingParameters) ProtoMessage

func (*EthereumKilnStakingParameters) ProtoMessage()

func (*EthereumKilnStakingParameters) ProtoReflect

func (*EthereumKilnStakingParameters) Reset

func (x *EthereumKilnStakingParameters) Reset()

func (*EthereumKilnStakingParameters) String

type EthereumKilnStakingParameters_ClaimStakeParameters

type EthereumKilnStakingParameters_ClaimStakeParameters struct {
	// The parameters for claim stake action on Ethereum Kiln.
	ClaimStakeParameters *EthereumKilnClaimStakeParameters `protobuf:"bytes,4,opt,name=claim_stake_parameters,json=claimStakeParameters,proto3,oneof"`
}

type EthereumKilnStakingParameters_StakeParameters

type EthereumKilnStakingParameters_StakeParameters struct {
	// The parameters for stake action on Ethereum Kiln.
	StakeParameters *EthereumKilnStakeParameters `protobuf:"bytes,1,opt,name=stake_parameters,json=stakeParameters,proto3,oneof"`
}

type EthereumKilnStakingParameters_UnstakeParameters

type EthereumKilnStakingParameters_UnstakeParameters struct {
	// The parameters for unstake action on Ethereum Kiln.
	UnstakeParameters *EthereumKilnUnstakeParameters `protobuf:"bytes,2,opt,name=unstake_parameters,json=unstakeParameters,proto3,oneof"`
}

type EthereumKilnUnstakeParameters

type EthereumKilnUnstakeParameters struct {

	// The address you wish to unstake from.
	StakerAddress string `protobuf:"bytes,1,opt,name=staker_address,json=stakerAddress,proto3" json:"staker_address,omitempty"`
	// The address of the integrator contract.
	IntegratorContractAddress string `` /* 138-byte string literal not displayed */
	// The amount of Ethereum to unstake in wei.
	Amount *Amount `protobuf:"bytes,3,opt,name=amount,proto3" json:"amount,omitempty"`
	// contains filtered or unexported fields
}

The parameters required for the unstake action on Ethereum Kiln.

func (*EthereumKilnUnstakeParameters) Descriptor deprecated

func (*EthereumKilnUnstakeParameters) Descriptor() ([]byte, []int)

Deprecated: Use EthereumKilnUnstakeParameters.ProtoReflect.Descriptor instead.

func (*EthereumKilnUnstakeParameters) GetAmount

func (x *EthereumKilnUnstakeParameters) GetAmount() *Amount

func (*EthereumKilnUnstakeParameters) GetIntegratorContractAddress

func (x *EthereumKilnUnstakeParameters) GetIntegratorContractAddress() string

func (*EthereumKilnUnstakeParameters) GetStakerAddress

func (x *EthereumKilnUnstakeParameters) GetStakerAddress() string

func (*EthereumKilnUnstakeParameters) ProtoMessage

func (*EthereumKilnUnstakeParameters) ProtoMessage()

func (*EthereumKilnUnstakeParameters) ProtoReflect

func (*EthereumKilnUnstakeParameters) Reset

func (x *EthereumKilnUnstakeParameters) Reset()

func (*EthereumKilnUnstakeParameters) String

type GetWorkflowRequest

type GetWorkflowRequest struct {

	// The resource name of the workflow.
	// Format: projects/{project}/workflows/{workflow}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The message for GetWorkflow.

func (*GetWorkflowRequest) Descriptor deprecated

func (*GetWorkflowRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetWorkflowRequest.ProtoReflect.Descriptor instead.

func (*GetWorkflowRequest) GetName

func (x *GetWorkflowRequest) GetName() string

func (*GetWorkflowRequest) ProtoMessage

func (*GetWorkflowRequest) ProtoMessage()

func (*GetWorkflowRequest) ProtoReflect

func (x *GetWorkflowRequest) ProtoReflect() protoreflect.Message

func (*GetWorkflowRequest) Reset

func (x *GetWorkflowRequest) Reset()

func (*GetWorkflowRequest) String

func (x *GetWorkflowRequest) String() string

type ListActionsRequest

type ListActionsRequest struct {

	// The resource name of the parent that owns
	// the collection of actions.
	// Format: protocols/{protocol}/networks/{network}
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// contains filtered or unexported fields
}

The request message for ListActions.

func (*ListActionsRequest) Descriptor deprecated

func (*ListActionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListActionsRequest.ProtoReflect.Descriptor instead.

func (*ListActionsRequest) GetParent

func (x *ListActionsRequest) GetParent() string

func (*ListActionsRequest) ProtoMessage

func (*ListActionsRequest) ProtoMessage()

func (*ListActionsRequest) ProtoReflect

func (x *ListActionsRequest) ProtoReflect() protoreflect.Message

func (*ListActionsRequest) Reset

func (x *ListActionsRequest) Reset()

func (*ListActionsRequest) String

func (x *ListActionsRequest) String() string

type ListActionsResponse

type ListActionsResponse struct {

	// The list of actions.
	Actions []*Action `protobuf:"bytes,1,rep,name=actions,proto3" json:"actions,omitempty"`
	// contains filtered or unexported fields
}

The response message for ListActions.

func (*ListActionsResponse) Descriptor deprecated

func (*ListActionsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListActionsResponse.ProtoReflect.Descriptor instead.

func (*ListActionsResponse) GetActions

func (x *ListActionsResponse) GetActions() []*Action

func (*ListActionsResponse) ProtoMessage

func (*ListActionsResponse) ProtoMessage()

func (*ListActionsResponse) ProtoReflect

func (x *ListActionsResponse) ProtoReflect() protoreflect.Message

func (*ListActionsResponse) Reset

func (x *ListActionsResponse) Reset()

func (*ListActionsResponse) String

func (x *ListActionsResponse) String() string

type ListNetworksRequest

type ListNetworksRequest struct {

	// The resource name of the parent that owns
	// the collection of networks.
	// Format: protocols/{protocol}
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// contains filtered or unexported fields
}

The request message for ListNetworks.

func (*ListNetworksRequest) Descriptor deprecated

func (*ListNetworksRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListNetworksRequest.ProtoReflect.Descriptor instead.

func (*ListNetworksRequest) GetParent

func (x *ListNetworksRequest) GetParent() string

func (*ListNetworksRequest) ProtoMessage

func (*ListNetworksRequest) ProtoMessage()

func (*ListNetworksRequest) ProtoReflect

func (x *ListNetworksRequest) ProtoReflect() protoreflect.Message

func (*ListNetworksRequest) Reset

func (x *ListNetworksRequest) Reset()

func (*ListNetworksRequest) String

func (x *ListNetworksRequest) String() string

type ListNetworksResponse

type ListNetworksResponse struct {

	// The list of networks.
	Networks []*Network `protobuf:"bytes,1,rep,name=networks,proto3" json:"networks,omitempty"`
	// contains filtered or unexported fields
}

The response message for ListNetworks.

func (*ListNetworksResponse) Descriptor deprecated

func (*ListNetworksResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListNetworksResponse.ProtoReflect.Descriptor instead.

func (*ListNetworksResponse) GetNetworks

func (x *ListNetworksResponse) GetNetworks() []*Network

func (*ListNetworksResponse) ProtoMessage

func (*ListNetworksResponse) ProtoMessage()

func (*ListNetworksResponse) ProtoReflect

func (x *ListNetworksResponse) ProtoReflect() protoreflect.Message

func (*ListNetworksResponse) Reset

func (x *ListNetworksResponse) Reset()

func (*ListNetworksResponse) String

func (x *ListNetworksResponse) String() string

type ListProtocolsRequest

type ListProtocolsRequest struct {
	// contains filtered or unexported fields
}

The request message for ListProtocols.

func (*ListProtocolsRequest) Descriptor deprecated

func (*ListProtocolsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListProtocolsRequest.ProtoReflect.Descriptor instead.

func (*ListProtocolsRequest) ProtoMessage

func (*ListProtocolsRequest) ProtoMessage()

func (*ListProtocolsRequest) ProtoReflect

func (x *ListProtocolsRequest) ProtoReflect() protoreflect.Message

func (*ListProtocolsRequest) Reset

func (x *ListProtocolsRequest) Reset()

func (*ListProtocolsRequest) String

func (x *ListProtocolsRequest) String() string

type ListProtocolsResponse

type ListProtocolsResponse struct {

	// The list of protocols.
	Protocols []*Protocol `protobuf:"bytes,1,rep,name=protocols,proto3" json:"protocols,omitempty"`
	// contains filtered or unexported fields
}

The response message for ListProtocols.

func (*ListProtocolsResponse) Descriptor deprecated

func (*ListProtocolsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListProtocolsResponse.ProtoReflect.Descriptor instead.

func (*ListProtocolsResponse) GetProtocols

func (x *ListProtocolsResponse) GetProtocols() []*Protocol

func (*ListProtocolsResponse) ProtoMessage

func (*ListProtocolsResponse) ProtoMessage()

func (*ListProtocolsResponse) ProtoReflect

func (x *ListProtocolsResponse) ProtoReflect() protoreflect.Message

func (*ListProtocolsResponse) Reset

func (x *ListProtocolsResponse) Reset()

func (*ListProtocolsResponse) String

func (x *ListProtocolsResponse) String() string

type ListStakingTargetsRequest

type ListStakingTargetsRequest struct {

	// The resource name of the parent that owns
	// the collection of staking targets.
	// Format: protocols/{protocol}/networks/{network}
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of staking targets to return. The service may
	// return fewer than this value.
	//
	// If unspecified, 100 staking targets will be returned.
	// The maximum value is 1000; values over 1000 will be floored to 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token as part of the response of a previous call.
	// Provide this to retrieve the next page.
	//
	// When paginating, all other parameters must match the previous
	// request to list resources.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The request message for ListStakingTargets.

func (*ListStakingTargetsRequest) Descriptor deprecated

func (*ListStakingTargetsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListStakingTargetsRequest.ProtoReflect.Descriptor instead.

func (*ListStakingTargetsRequest) GetPageSize

func (x *ListStakingTargetsRequest) GetPageSize() int32

func (*ListStakingTargetsRequest) GetPageToken

func (x *ListStakingTargetsRequest) GetPageToken() string

func (*ListStakingTargetsRequest) GetParent

func (x *ListStakingTargetsRequest) GetParent() string

func (*ListStakingTargetsRequest) ProtoMessage

func (*ListStakingTargetsRequest) ProtoMessage()

func (*ListStakingTargetsRequest) ProtoReflect

func (*ListStakingTargetsRequest) Reset

func (x *ListStakingTargetsRequest) Reset()

func (*ListStakingTargetsRequest) String

func (x *ListStakingTargetsRequest) String() string

type ListStakingTargetsResponse

type ListStakingTargetsResponse struct {

	// The list of staking targets.
	StakingTargets []*StakingTarget `protobuf:"bytes,1,rep,name=staking_targets,json=stakingTargets,proto3" json:"staking_targets,omitempty"`
	// A token which can be provided as `page_token` to retrieve the next page.
	// If this field is omitted, there are no additional pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response message for ListStakingTargets.

func (*ListStakingTargetsResponse) Descriptor deprecated

func (*ListStakingTargetsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListStakingTargetsResponse.ProtoReflect.Descriptor instead.

func (*ListStakingTargetsResponse) GetNextPageToken

func (x *ListStakingTargetsResponse) GetNextPageToken() string

func (*ListStakingTargetsResponse) GetStakingTargets

func (x *ListStakingTargetsResponse) GetStakingTargets() []*StakingTarget

func (*ListStakingTargetsResponse) ProtoMessage

func (*ListStakingTargetsResponse) ProtoMessage()

func (*ListStakingTargetsResponse) ProtoReflect

func (*ListStakingTargetsResponse) Reset

func (x *ListStakingTargetsResponse) Reset()

func (*ListStakingTargetsResponse) String

func (x *ListStakingTargetsResponse) String() string

type ListWorkflowsRequest

type ListWorkflowsRequest struct {

	// The resource name of the parent that owns
	// the collection of networks.
	// Format: projects/{project}
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// [AIP-160](https://google.aip.dev/160) filter
	// Supported fields:
	// - string action: "stake", "unstake"
	// - string protocol: "ethereum_kiln"
	// - string network: "holesky", "mainnet"
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	//	The maximum number of workflows to return. The service may
	//
	// return fewer than this value.
	//
	// If unspecified, 100 workflows will be returned.
	// The maximum value is 1000; values over 1000 will be floored to 1000.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token as part of the response of a previous call.
	// Provide this to retrieve the next page.
	//
	// When paginating, all other parameters must match the previous
	// request to list resources.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The message for ListWorkflows.

func (*ListWorkflowsRequest) Descriptor deprecated

func (*ListWorkflowsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListWorkflowsRequest.ProtoReflect.Descriptor instead.

func (*ListWorkflowsRequest) GetFilter

func (x *ListWorkflowsRequest) GetFilter() string

func (*ListWorkflowsRequest) GetPageSize

func (x *ListWorkflowsRequest) GetPageSize() int32

func (*ListWorkflowsRequest) GetPageToken

func (x *ListWorkflowsRequest) GetPageToken() string

func (*ListWorkflowsRequest) GetParent

func (x *ListWorkflowsRequest) GetParent() string

func (*ListWorkflowsRequest) ProtoMessage

func (*ListWorkflowsRequest) ProtoMessage()

func (*ListWorkflowsRequest) ProtoReflect

func (x *ListWorkflowsRequest) ProtoReflect() protoreflect.Message

func (*ListWorkflowsRequest) Reset

func (x *ListWorkflowsRequest) Reset()

func (*ListWorkflowsRequest) String

func (x *ListWorkflowsRequest) String() string

type ListWorkflowsResponse

type ListWorkflowsResponse struct {

	// The list of workflows.
	Workflows []*Workflow `protobuf:"bytes,1,rep,name=workflows,proto3" json:"workflows,omitempty"`
	// A token which can be provided as `page_token` to retrieve the next page.
	// If this field is omitted, there are no additional pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response message for ListWorkflows.

func (*ListWorkflowsResponse) Descriptor deprecated

func (*ListWorkflowsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListWorkflowsResponse.ProtoReflect.Descriptor instead.

func (*ListWorkflowsResponse) GetNextPageToken

func (x *ListWorkflowsResponse) GetNextPageToken() string

func (*ListWorkflowsResponse) GetWorkflows

func (x *ListWorkflowsResponse) GetWorkflows() []*Workflow

func (*ListWorkflowsResponse) ProtoMessage

func (*ListWorkflowsResponse) ProtoMessage()

func (*ListWorkflowsResponse) ProtoReflect

func (x *ListWorkflowsResponse) ProtoReflect() protoreflect.Message

func (*ListWorkflowsResponse) Reset

func (x *ListWorkflowsResponse) Reset()

func (*ListWorkflowsResponse) String

func (x *ListWorkflowsResponse) String() string

type Network

type Network struct {

	// The resource name of the Network.
	// Format: protocols/{protocolName}/networks/{networkName}
	// Ex: protocols/ethereum_kiln/networks/holesky
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

A Network resource represents a blockchain network e.g. mainnet, testnet, etc.

func (*Network) Descriptor deprecated

func (*Network) Descriptor() ([]byte, []int)

Deprecated: Use Network.ProtoReflect.Descriptor instead.

func (*Network) GetName

func (x *Network) GetName() string

func (*Network) ProtoMessage

func (*Network) ProtoMessage()

func (*Network) ProtoReflect

func (x *Network) ProtoReflect() protoreflect.Message

func (*Network) Reset

func (x *Network) Reset()

func (*Network) String

func (x *Network) String() string

type NetworkResourceName

type NetworkResourceName struct {
	Protocol string
	Network  string
}

func (NetworkResourceName) ActionResourceName

func (n NetworkResourceName) ActionResourceName(
	action string,
) ActionResourceName

func (NetworkResourceName) ContainsWildcard

func (n NetworkResourceName) ContainsWildcard() bool

func (NetworkResourceName) ContractResourceName

func (n NetworkResourceName) ContractResourceName(
	contract string,
) ContractResourceName

func (NetworkResourceName) MarshalString

func (n NetworkResourceName) MarshalString() (string, error)

func (NetworkResourceName) ProtocolResourceName

func (n NetworkResourceName) ProtocolResourceName() ProtocolResourceName

func (NetworkResourceName) String

func (n NetworkResourceName) String() string

func (*NetworkResourceName) UnmarshalString

func (n *NetworkResourceName) UnmarshalString(name string) error

func (NetworkResourceName) Validate

func (n NetworkResourceName) Validate() error

func (NetworkResourceName) ValidatorResourceName

func (n NetworkResourceName) ValidatorResourceName(
	validator string,
) ValidatorResourceName

type PerformWorkflowStepRequest

type PerformWorkflowStepRequest struct {

	// The resource name of the workflow.
	// Format: projects/{project}/workflows/{workflow}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The index of the step to be performed.
	Step int32 `protobuf:"varint,2,opt,name=step,proto3" json:"step,omitempty"`
	// Transaction metadata. This is either the signed transaction or transaction hash depending on the workflow's broadcast method.
	Data string `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The request message for PerformWorkflowStep.

func (*PerformWorkflowStepRequest) Descriptor deprecated

func (*PerformWorkflowStepRequest) Descriptor() ([]byte, []int)

Deprecated: Use PerformWorkflowStepRequest.ProtoReflect.Descriptor instead.

func (*PerformWorkflowStepRequest) GetData

func (x *PerformWorkflowStepRequest) GetData() string

func (*PerformWorkflowStepRequest) GetName

func (x *PerformWorkflowStepRequest) GetName() string

func (*PerformWorkflowStepRequest) GetStep

func (x *PerformWorkflowStepRequest) GetStep() int32

func (*PerformWorkflowStepRequest) ProtoMessage

func (*PerformWorkflowStepRequest) ProtoMessage()

func (*PerformWorkflowStepRequest) ProtoReflect

func (*PerformWorkflowStepRequest) Reset

func (x *PerformWorkflowStepRequest) Reset()

func (*PerformWorkflowStepRequest) String

func (x *PerformWorkflowStepRequest) String() string

type PriorityFee

type PriorityFee struct {

	// The maximum number of compute units a transaction is allowed to consume.
	ComputeUnitLimit int64 `protobuf:"varint,1,opt,name=compute_unit_limit,json=computeUnitLimit,proto3" json:"compute_unit_limit,omitempty"`
	// The price to pay per compute unit.
	UnitPrice int64 `protobuf:"varint,2,opt,name=unit_price,json=unitPrice,proto3" json:"unit_price,omitempty"`
	// contains filtered or unexported fields
}

A prioritization fee that can be added to a Solana transaction.

func (*PriorityFee) Descriptor deprecated

func (*PriorityFee) Descriptor() ([]byte, []int)

Deprecated: Use PriorityFee.ProtoReflect.Descriptor instead.

func (*PriorityFee) GetComputeUnitLimit

func (x *PriorityFee) GetComputeUnitLimit() int64

func (*PriorityFee) GetUnitPrice

func (x *PriorityFee) GetUnitPrice() int64

func (*PriorityFee) ProtoMessage

func (*PriorityFee) ProtoMessage()

func (*PriorityFee) ProtoReflect

func (x *PriorityFee) ProtoReflect() protoreflect.Message

func (*PriorityFee) Reset

func (x *PriorityFee) Reset()

func (*PriorityFee) String

func (x *PriorityFee) String() string

type Protocol

type Protocol struct {

	// The resource name of the Protocol.
	// Format: protocols/{protocolName}
	// Ex: protocols/ethereum_kiln
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

A Protocol resource (e.g. ethereum_kiln, solana etc.).

func (*Protocol) Descriptor deprecated

func (*Protocol) Descriptor() ([]byte, []int)

Deprecated: Use Protocol.ProtoReflect.Descriptor instead.

func (*Protocol) GetName

func (x *Protocol) GetName() string

func (*Protocol) ProtoMessage

func (*Protocol) ProtoMessage()

func (*Protocol) ProtoReflect

func (x *Protocol) ProtoReflect() protoreflect.Message

func (*Protocol) Reset

func (x *Protocol) Reset()

func (*Protocol) String

func (x *Protocol) String() string

type ProtocolResourceName

type ProtocolResourceName struct {
	Protocol string
}

func (ProtocolResourceName) ActionResourceName

func (n ProtocolResourceName) ActionResourceName(
	network string,
	action string,
) ActionResourceName

func (ProtocolResourceName) ContainsWildcard

func (n ProtocolResourceName) ContainsWildcard() bool

func (ProtocolResourceName) ContractResourceName

func (n ProtocolResourceName) ContractResourceName(
	network string,
	contract string,
) ContractResourceName

func (ProtocolResourceName) MarshalString

func (n ProtocolResourceName) MarshalString() (string, error)

func (ProtocolResourceName) NetworkResourceName

func (n ProtocolResourceName) NetworkResourceName(
	network string,
) NetworkResourceName

func (ProtocolResourceName) String

func (n ProtocolResourceName) String() string

func (*ProtocolResourceName) UnmarshalString

func (n *ProtocolResourceName) UnmarshalString(name string) error

func (ProtocolResourceName) Validate

func (n ProtocolResourceName) Validate() error

func (ProtocolResourceName) ValidatorResourceName

func (n ProtocolResourceName) ValidatorResourceName(
	network string,
	validator string,
) ValidatorResourceName

type SolanaClaimStakeParameters

type SolanaClaimStakeParameters struct {

	// The address which is the signing authority to claim stake.
	WalletAddress string `protobuf:"bytes,1,opt,name=wallet_address,json=walletAddress,proto3" json:"wallet_address,omitempty"`
	// The address of the stake account to claim stake from.
	StakeAccountAddress string `protobuf:"bytes,2,opt,name=stake_account_address,json=stakeAccountAddress,proto3" json:"stake_account_address,omitempty"`
	// The option to set a priority fee for the transaction.
	PriorityFee *PriorityFee `protobuf:"bytes,3,opt,name=priority_fee,json=priorityFee,proto3" json:"priority_fee,omitempty"`
	// contains filtered or unexported fields
}

The parameters required to perform a claim stake operation on Solana.

func (*SolanaClaimStakeParameters) Descriptor deprecated

func (*SolanaClaimStakeParameters) Descriptor() ([]byte, []int)

Deprecated: Use SolanaClaimStakeParameters.ProtoReflect.Descriptor instead.

func (*SolanaClaimStakeParameters) GetPriorityFee

func (x *SolanaClaimStakeParameters) GetPriorityFee() *PriorityFee

func (*SolanaClaimStakeParameters) GetStakeAccountAddress

func (x *SolanaClaimStakeParameters) GetStakeAccountAddress() string

func (*SolanaClaimStakeParameters) GetWalletAddress

func (x *SolanaClaimStakeParameters) GetWalletAddress() string

func (*SolanaClaimStakeParameters) ProtoMessage

func (*SolanaClaimStakeParameters) ProtoMessage()

func (*SolanaClaimStakeParameters) ProtoReflect

func (*SolanaClaimStakeParameters) Reset

func (x *SolanaClaimStakeParameters) Reset()

func (*SolanaClaimStakeParameters) String

func (x *SolanaClaimStakeParameters) String() string

type SolanaStakeParameters

type SolanaStakeParameters struct {

	// The address where the funds are coming from to stake.
	WalletAddress string `protobuf:"bytes,1,opt,name=wallet_address,json=walletAddress,proto3" json:"wallet_address,omitempty"`
	// The address of the validator.
	ValidatorAddress string `protobuf:"bytes,2,opt,name=validator_address,json=validatorAddress,proto3" json:"validator_address,omitempty"`
	// The amount of Solana to stake in lamports. (1 lamport = 0.000000001 SOL)
	Amount *Amount `protobuf:"bytes,3,opt,name=amount,proto3" json:"amount,omitempty"`
	// The option to set a priority fee for the transaction.
	PriorityFee *PriorityFee `protobuf:"bytes,4,opt,name=priority_fee,json=priorityFee,proto3" json:"priority_fee,omitempty"`
	// contains filtered or unexported fields
}

The parameters required to perform a stake operation on Solana.

func (*SolanaStakeParameters) Descriptor deprecated

func (*SolanaStakeParameters) Descriptor() ([]byte, []int)

Deprecated: Use SolanaStakeParameters.ProtoReflect.Descriptor instead.

func (*SolanaStakeParameters) GetAmount

func (x *SolanaStakeParameters) GetAmount() *Amount

func (*SolanaStakeParameters) GetPriorityFee

func (x *SolanaStakeParameters) GetPriorityFee() *PriorityFee

func (*SolanaStakeParameters) GetValidatorAddress

func (x *SolanaStakeParameters) GetValidatorAddress() string

func (*SolanaStakeParameters) GetWalletAddress

func (x *SolanaStakeParameters) GetWalletAddress() string

func (*SolanaStakeParameters) ProtoMessage

func (*SolanaStakeParameters) ProtoMessage()

func (*SolanaStakeParameters) ProtoReflect

func (x *SolanaStakeParameters) ProtoReflect() protoreflect.Message

func (*SolanaStakeParameters) Reset

func (x *SolanaStakeParameters) Reset()

func (*SolanaStakeParameters) String

func (x *SolanaStakeParameters) String() string

type SolanaStakingContextDetails

type SolanaStakingContextDetails struct {

	// The total balance of the main wallet address (system account).
	// Used to check the balance for any future staking or transaction to send.
	Balance *Amount `protobuf:"bytes,1,opt,name=balance,proto3" json:"balance,omitempty"`
	// The current epoch that the Solana blockchain is in.
	// Used as a frame of reference for future stake activations and deactivations.
	CurrentEpoch int64 `protobuf:"varint,2,opt,name=current_epoch,json=currentEpoch,proto3" json:"current_epoch,omitempty"`
	// How much of the epoch has passed as a percentage.
	// Used to inform how much time is left before a stake is activated or deactivated.
	EpochCompletionPercentage string `` /* 138-byte string literal not displayed */
	// The list of staking accounts that are linked to the main wallet address (system account).
	// Used to check for statuses and balances of all stake accounts related to the main wallet address that
	// they're linked to.
	StakeAccounts []*StakeAccount `protobuf:"bytes,4,rep,name=stake_accounts,json=stakeAccounts,proto3" json:"stake_accounts,omitempty"`
	// contains filtered or unexported fields
}

The protocol specific details for a Solana staking context.

func (*SolanaStakingContextDetails) Descriptor deprecated

func (*SolanaStakingContextDetails) Descriptor() ([]byte, []int)

Deprecated: Use SolanaStakingContextDetails.ProtoReflect.Descriptor instead.

func (*SolanaStakingContextDetails) GetBalance

func (x *SolanaStakingContextDetails) GetBalance() *Amount

func (*SolanaStakingContextDetails) GetCurrentEpoch

func (x *SolanaStakingContextDetails) GetCurrentEpoch() int64

func (*SolanaStakingContextDetails) GetEpochCompletionPercentage

func (x *SolanaStakingContextDetails) GetEpochCompletionPercentage() string

func (*SolanaStakingContextDetails) GetStakeAccounts

func (x *SolanaStakingContextDetails) GetStakeAccounts() []*StakeAccount

func (*SolanaStakingContextDetails) ProtoMessage

func (*SolanaStakingContextDetails) ProtoMessage()

func (*SolanaStakingContextDetails) ProtoReflect

func (*SolanaStakingContextDetails) Reset

func (x *SolanaStakingContextDetails) Reset()

func (*SolanaStakingContextDetails) String

func (x *SolanaStakingContextDetails) String() string

type SolanaStakingContextParameters

type SolanaStakingContextParameters struct {
	// contains filtered or unexported fields
}

The protocol specific parameters required for fetching a staking context.

func (*SolanaStakingContextParameters) Descriptor deprecated

func (*SolanaStakingContextParameters) Descriptor() ([]byte, []int)

Deprecated: Use SolanaStakingContextParameters.ProtoReflect.Descriptor instead.

func (*SolanaStakingContextParameters) ProtoMessage

func (*SolanaStakingContextParameters) ProtoMessage()

func (*SolanaStakingContextParameters) ProtoReflect

func (*SolanaStakingContextParameters) Reset

func (x *SolanaStakingContextParameters) Reset()

func (*SolanaStakingContextParameters) String

type SolanaStakingParameters

type SolanaStakingParameters struct {

	// Types that are assignable to Parameters:
	//
	//	*SolanaStakingParameters_StakeParameters
	//	*SolanaStakingParameters_UnstakeParameters
	//	*SolanaStakingParameters_ClaimStakeParameters
	Parameters isSolanaStakingParameters_Parameters `protobuf_oneof:"parameters"`
	// contains filtered or unexported fields
}

The parameters needed for staking on Solana.

func (*SolanaStakingParameters) Descriptor deprecated

func (*SolanaStakingParameters) Descriptor() ([]byte, []int)

Deprecated: Use SolanaStakingParameters.ProtoReflect.Descriptor instead.

func (*SolanaStakingParameters) GetClaimStakeParameters

func (x *SolanaStakingParameters) GetClaimStakeParameters() *SolanaClaimStakeParameters

func (*SolanaStakingParameters) GetParameters

func (m *SolanaStakingParameters) GetParameters() isSolanaStakingParameters_Parameters

func (*SolanaStakingParameters) GetStakeParameters

func (x *SolanaStakingParameters) GetStakeParameters() *SolanaStakeParameters

func (*SolanaStakingParameters) GetUnstakeParameters

func (x *SolanaStakingParameters) GetUnstakeParameters() *SolanaUnstakeParameters

func (*SolanaStakingParameters) ProtoMessage

func (*SolanaStakingParameters) ProtoMessage()

func (*SolanaStakingParameters) ProtoReflect

func (x *SolanaStakingParameters) ProtoReflect() protoreflect.Message

func (*SolanaStakingParameters) Reset

func (x *SolanaStakingParameters) Reset()

func (*SolanaStakingParameters) String

func (x *SolanaStakingParameters) String() string

type SolanaStakingParameters_ClaimStakeParameters

type SolanaStakingParameters_ClaimStakeParameters struct {
	// The parameters for claim stake action on Solana.
	ClaimStakeParameters *SolanaClaimStakeParameters `protobuf:"bytes,9,opt,name=claim_stake_parameters,json=claimStakeParameters,proto3,oneof"`
}

type SolanaStakingParameters_StakeParameters

type SolanaStakingParameters_StakeParameters struct {
	// The parameters for stake action on Solana.
	StakeParameters *SolanaStakeParameters `protobuf:"bytes,7,opt,name=stake_parameters,json=stakeParameters,proto3,oneof"`
}

type SolanaStakingParameters_UnstakeParameters

type SolanaStakingParameters_UnstakeParameters struct {
	// The parameters for unstake action on Solana.
	UnstakeParameters *SolanaUnstakeParameters `protobuf:"bytes,8,opt,name=unstake_parameters,json=unstakeParameters,proto3,oneof"`
}

type SolanaUnstakeParameters

type SolanaUnstakeParameters struct {

	// The address which is the signing authority to unstake.
	WalletAddress string `protobuf:"bytes,1,opt,name=wallet_address,json=walletAddress,proto3" json:"wallet_address,omitempty"`
	// The address of the stake account to unstake from.
	StakeAccountAddress string `protobuf:"bytes,2,opt,name=stake_account_address,json=stakeAccountAddress,proto3" json:"stake_account_address,omitempty"`
	// The amount of Solana to unstake in lamports. (1 lamport = 0.000000001 SOL)
	Amount *Amount `protobuf:"bytes,3,opt,name=amount,proto3" json:"amount,omitempty"`
	// The option to set a priority fee for the transaction.
	PriorityFee *PriorityFee `protobuf:"bytes,4,opt,name=priority_fee,json=priorityFee,proto3" json:"priority_fee,omitempty"`
	// contains filtered or unexported fields
}

The parameters required to perform a unstake operation on Solana.

func (*SolanaUnstakeParameters) Descriptor deprecated

func (*SolanaUnstakeParameters) Descriptor() ([]byte, []int)

Deprecated: Use SolanaUnstakeParameters.ProtoReflect.Descriptor instead.

func (*SolanaUnstakeParameters) GetAmount

func (x *SolanaUnstakeParameters) GetAmount() *Amount

func (*SolanaUnstakeParameters) GetPriorityFee

func (x *SolanaUnstakeParameters) GetPriorityFee() *PriorityFee

func (*SolanaUnstakeParameters) GetStakeAccountAddress

func (x *SolanaUnstakeParameters) GetStakeAccountAddress() string

func (*SolanaUnstakeParameters) GetWalletAddress

func (x *SolanaUnstakeParameters) GetWalletAddress() string

func (*SolanaUnstakeParameters) ProtoMessage

func (*SolanaUnstakeParameters) ProtoMessage()

func (*SolanaUnstakeParameters) ProtoReflect

func (x *SolanaUnstakeParameters) ProtoReflect() protoreflect.Message

func (*SolanaUnstakeParameters) Reset

func (x *SolanaUnstakeParameters) Reset()

func (*SolanaUnstakeParameters) String

func (x *SolanaUnstakeParameters) String() string

type StakeAccount

type StakeAccount struct {

	// The address of the stake account.
	// Used to hold the staked funds transferred over from the main wallet.
	Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
	// The bonded balance in lamports on the stake account (rent is not included in bonded amount).
	// Used to check the amount that is currently staked.
	BondedStake *Amount `protobuf:"bytes,2,opt,name=bonded_stake,json=bondedStake,proto3" json:"bonded_stake,omitempty"`
	// The rent amount for the stake account in lamports.
	// Used to highlight the amount used as the rent to maintain the address on the Solana blockchain.
	RentReserve *Amount `protobuf:"bytes,3,opt,name=rent_reserve,json=rentReserve,proto3" json:"rent_reserve,omitempty"`
	// The total balance on the address in lamports.
	// Used to check the total balance for the stake account.
	Balance *Amount `protobuf:"bytes,4,opt,name=balance,proto3" json:"balance,omitempty"`
	// The balance state of the stake account.
	// Used to show what state the currently staked funds are in.
	BalanceState StakeAccount_BalanceState `` /* 163-byte string literal not displayed */
	// The validator (vote account) that the stake account is assigned to stake to.
	// Used to show where the staked funds are staked to.
	Validator string `protobuf:"bytes,6,opt,name=validator,proto3" json:"validator,omitempty"`
	// contains filtered or unexported fields
}

The balance information for a stake account.

func (*StakeAccount) Descriptor deprecated

func (*StakeAccount) Descriptor() ([]byte, []int)

Deprecated: Use StakeAccount.ProtoReflect.Descriptor instead.

func (*StakeAccount) GetAddress

func (x *StakeAccount) GetAddress() string

func (*StakeAccount) GetBalance

func (x *StakeAccount) GetBalance() *Amount

func (*StakeAccount) GetBalanceState

func (x *StakeAccount) GetBalanceState() StakeAccount_BalanceState

func (*StakeAccount) GetBondedStake

func (x *StakeAccount) GetBondedStake() *Amount

func (*StakeAccount) GetRentReserve

func (x *StakeAccount) GetRentReserve() *Amount

func (*StakeAccount) GetValidator

func (x *StakeAccount) GetValidator() string

func (*StakeAccount) ProtoMessage

func (*StakeAccount) ProtoMessage()

func (*StakeAccount) ProtoReflect

func (x *StakeAccount) ProtoReflect() protoreflect.Message

func (*StakeAccount) Reset

func (x *StakeAccount) Reset()

func (*StakeAccount) String

func (x *StakeAccount) String() string

type StakeAccount_BalanceState

type StakeAccount_BalanceState int32

Represents the different states a stake account balance can have. Used to check to see if stake is actively earning rewards or ready to be withdrawn.

const (
	// The balance is not known.
	StakeAccount_BALANCE_STATE_UNSPECIFIED StakeAccount_BalanceState = 0
	// The balance is not actively staking.
	StakeAccount_BALANCE_STATE_INACTIVE StakeAccount_BalanceState = 1
	// The balance is in a warm up period and will activate in the next epoch.
	StakeAccount_BALANCE_STATE_ACTIVATING StakeAccount_BalanceState = 2
	// The balance is actively staking and earning rewards.
	StakeAccount_BALANCE_STATE_ACTIVE StakeAccount_BalanceState = 3
	// The balance is in a cool down period and will be deactivated in the next epoch.
	StakeAccount_BALANCE_STATE_DEACTIVATING StakeAccount_BalanceState = 4
)

func (StakeAccount_BalanceState) Descriptor

func (StakeAccount_BalanceState) Enum

func (StakeAccount_BalanceState) EnumDescriptor deprecated

func (StakeAccount_BalanceState) EnumDescriptor() ([]byte, []int)

Deprecated: Use StakeAccount_BalanceState.Descriptor instead.

func (StakeAccount_BalanceState) Number

func (StakeAccount_BalanceState) String

func (x StakeAccount_BalanceState) String() string

func (StakeAccount_BalanceState) Type

type StakingServiceClient

type StakingServiceClient interface {
	// List supported protocols.
	ListProtocols(ctx context.Context, in *ListProtocolsRequest, opts ...grpc.CallOption) (*ListProtocolsResponse, error)
	// List supported staking networks for a given protocol.
	ListNetworks(ctx context.Context, in *ListNetworksRequest, opts ...grpc.CallOption) (*ListNetworksResponse, error)
	// List supported staking targets for a given protocol and network.
	ListStakingTargets(ctx context.Context, in *ListStakingTargetsRequest, opts ...grpc.CallOption) (*ListStakingTargetsResponse, error)
	// List supported actions for a given protocol and network.
	ListActions(ctx context.Context, in *ListActionsRequest, opts ...grpc.CallOption) (*ListActionsResponse, error)
	// Create a workflow to perform an action.
	CreateWorkflow(ctx context.Context, in *CreateWorkflowRequest, opts ...grpc.CallOption) (*Workflow, error)
	// Get the current state of an active workflow.
	GetWorkflow(ctx context.Context, in *GetWorkflowRequest, opts ...grpc.CallOption) (*Workflow, error)
	// List all workflows in a project.
	ListWorkflows(ctx context.Context, in *ListWorkflowsRequest, opts ...grpc.CallOption) (*ListWorkflowsResponse, error)
	// Perform the next step in a workflow.
	PerformWorkflowStep(ctx context.Context, in *PerformWorkflowStepRequest, opts ...grpc.CallOption) (*Workflow, error)
	// View Staking context information given a specific network address.
	ViewStakingContext(ctx context.Context, in *ViewStakingContextRequest, opts ...grpc.CallOption) (*ViewStakingContextResponse, error)
}

StakingServiceClient is the client API for StakingService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type StakingServiceServer

type StakingServiceServer interface {
	// List supported protocols.
	ListProtocols(context.Context, *ListProtocolsRequest) (*ListProtocolsResponse, error)
	// List supported staking networks for a given protocol.
	ListNetworks(context.Context, *ListNetworksRequest) (*ListNetworksResponse, error)
	// List supported staking targets for a given protocol and network.
	ListStakingTargets(context.Context, *ListStakingTargetsRequest) (*ListStakingTargetsResponse, error)
	// List supported actions for a given protocol and network.
	ListActions(context.Context, *ListActionsRequest) (*ListActionsResponse, error)
	// Create a workflow to perform an action.
	CreateWorkflow(context.Context, *CreateWorkflowRequest) (*Workflow, error)
	// Get the current state of an active workflow.
	GetWorkflow(context.Context, *GetWorkflowRequest) (*Workflow, error)
	// List all workflows in a project.
	ListWorkflows(context.Context, *ListWorkflowsRequest) (*ListWorkflowsResponse, error)
	// Perform the next step in a workflow.
	PerformWorkflowStep(context.Context, *PerformWorkflowStepRequest) (*Workflow, error)
	// View Staking context information given a specific network address.
	ViewStakingContext(context.Context, *ViewStakingContextRequest) (*ViewStakingContextResponse, error)
	// contains filtered or unexported methods
}

StakingServiceServer is the server API for StakingService service. All implementations must embed UnimplementedStakingServiceServer for forward compatibility

type StakingTarget

type StakingTarget struct {

	// Types that are assignable to StakingTargets:
	//
	//	*StakingTarget_Validator
	//	*StakingTarget_Contract
	StakingTargets isStakingTarget_StakingTargets `protobuf_oneof:"staking_targets"`
	// contains filtered or unexported fields
}

A Staking Target represents a destination that you perform an action on related to staking.

func (*StakingTarget) Descriptor deprecated

func (*StakingTarget) Descriptor() ([]byte, []int)

Deprecated: Use StakingTarget.ProtoReflect.Descriptor instead.

func (*StakingTarget) GetContract

func (x *StakingTarget) GetContract() *Contract

func (*StakingTarget) GetStakingTargets

func (m *StakingTarget) GetStakingTargets() isStakingTarget_StakingTargets

func (*StakingTarget) GetValidator

func (x *StakingTarget) GetValidator() *Validator

func (*StakingTarget) ProtoMessage

func (*StakingTarget) ProtoMessage()

func (*StakingTarget) ProtoReflect

func (x *StakingTarget) ProtoReflect() protoreflect.Message

func (*StakingTarget) Reset

func (x *StakingTarget) Reset()

func (*StakingTarget) String

func (x *StakingTarget) String() string

type StakingTarget_Contract

type StakingTarget_Contract struct {
	// A contract to send a staking action to.
	Contract *Contract `protobuf:"bytes,2,opt,name=contract,proto3,oneof"`
}

type StakingTarget_Validator

type StakingTarget_Validator struct {
	// A validator to stake to.
	Validator *Validator `protobuf:"bytes,1,opt,name=validator,proto3,oneof"`
}

type TxStepOutput

type TxStepOutput struct {

	// The unsigned transaction which was signed in order to be broadcasted.
	UnsignedTx string `protobuf:"bytes,1,opt,name=unsigned_tx,json=unsignedTx,proto3" json:"unsigned_tx,omitempty"`
	// The signed transaction which was asked to be broadcasted.
	SignedTx string `protobuf:"bytes,2,opt,name=signed_tx,json=signedTx,proto3" json:"signed_tx,omitempty"`
	// The hash of the broadcasted transaction.
	TxHash string `protobuf:"bytes,3,opt,name=tx_hash,json=txHash,proto3" json:"tx_hash,omitempty"`
	// The state of the transaction step.
	State TxStepOutput_State `protobuf:"varint,4,opt,name=state,proto3,enum=coinbase.staking.orchestration.v1.TxStepOutput_State" json:"state,omitempty"`
	// The error message if the transaction step failed.
	ErrorMessage string `protobuf:"bytes,5,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// contains filtered or unexported fields
}

The details of a transaction being constructed and broadcasted to the network.

func (*TxStepOutput) Descriptor deprecated

func (*TxStepOutput) Descriptor() ([]byte, []int)

Deprecated: Use TxStepOutput.ProtoReflect.Descriptor instead.

func (*TxStepOutput) GetErrorMessage

func (x *TxStepOutput) GetErrorMessage() string

func (*TxStepOutput) GetSignedTx

func (x *TxStepOutput) GetSignedTx() string

func (*TxStepOutput) GetState

func (x *TxStepOutput) GetState() TxStepOutput_State

func (*TxStepOutput) GetTxHash

func (x *TxStepOutput) GetTxHash() string

func (*TxStepOutput) GetUnsignedTx

func (x *TxStepOutput) GetUnsignedTx() string

func (*TxStepOutput) ProtoMessage

func (*TxStepOutput) ProtoMessage()

func (*TxStepOutput) ProtoReflect

func (x *TxStepOutput) ProtoReflect() protoreflect.Message

func (*TxStepOutput) Reset

func (x *TxStepOutput) Reset()

func (*TxStepOutput) String

func (x *TxStepOutput) String() string

type TxStepOutput_State

type TxStepOutput_State int32

State defines an enumeration of states for a staking transaction.

const (
	// Unspecified transaction state, this is for backwards compatibility.
	TxStepOutput_STATE_UNSPECIFIED TxStepOutput_State = 0
	// Tx has not yet been constructed in the backend.
	TxStepOutput_STATE_NOT_CONSTRUCTED TxStepOutput_State = 1
	// Tx construction is over in the backend.
	TxStepOutput_STATE_CONSTRUCTED TxStepOutput_State = 2
	// Tx is waiting to be externally broadcasted by the customer.
	TxStepOutput_STATE_PENDING_EXT_BROADCAST TxStepOutput_State = 16
	// Tx has been signed and returned to the backend.
	TxStepOutput_STATE_SIGNED TxStepOutput_State = 4
	// Tx is being broadcasted to the network.
	TxStepOutput_STATE_BROADCASTING TxStepOutput_State = 5
	// Tx is waiting for confirmation.
	TxStepOutput_STATE_CONFIRMING TxStepOutput_State = 6
	// Tx has been confirmed to be included in a block.
	TxStepOutput_STATE_CONFIRMED TxStepOutput_State = 7
	// Tx has been finalized.
	TxStepOutput_STATE_FINALIZED TxStepOutput_State = 8
	// Tx construction or broadcasting failed.
	TxStepOutput_STATE_FAILED TxStepOutput_State = 9
	// Tx has been successfully executed.
	TxStepOutput_STATE_SUCCESS TxStepOutput_State = 10
)

func (TxStepOutput_State) Descriptor

func (TxStepOutput_State) Enum

func (TxStepOutput_State) EnumDescriptor deprecated

func (TxStepOutput_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use TxStepOutput_State.Descriptor instead.

func (TxStepOutput_State) Number

func (TxStepOutput_State) String

func (x TxStepOutput_State) String() string

func (TxStepOutput_State) Type

type UnimplementedStakingServiceServer

type UnimplementedStakingServiceServer struct {
}

UnimplementedStakingServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedStakingServiceServer) CreateWorkflow

func (UnimplementedStakingServiceServer) GetWorkflow

func (UnimplementedStakingServiceServer) ListActions

func (UnimplementedStakingServiceServer) ListNetworks

func (UnimplementedStakingServiceServer) ListProtocols

func (UnimplementedStakingServiceServer) ListStakingTargets

func (UnimplementedStakingServiceServer) ListWorkflows

func (UnimplementedStakingServiceServer) PerformWorkflowStep

func (UnimplementedStakingServiceServer) ViewStakingContext

type UnsafeStakingServiceServer

type UnsafeStakingServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeStakingServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to StakingServiceServer will result in compilation errors.

type Validator

type Validator struct {

	// The resource name of the Validator.
	// Format: protocols/{protocolName}/networks/{networkName}/stakingTargets/{validatorName}
	// Ex: protocols/solana/networks/testnet/stakingTargets/GkqYQysEGmuL6V2AJoNnWZUz2ZBGWhzQXsJiXm2CLKAN
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The public address of the validator.
	Address string `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
	// The rate of commission for the validator
	CommissionRate float32 `protobuf:"fixed32,3,opt,name=commission_rate,json=commissionRate,proto3" json:"commission_rate,omitempty"`
	// contains filtered or unexported fields
}

A Validator resource represents an active validator for the given protocol network.

func (*Validator) Descriptor deprecated

func (*Validator) Descriptor() ([]byte, []int)

Deprecated: Use Validator.ProtoReflect.Descriptor instead.

func (*Validator) GetAddress

func (x *Validator) GetAddress() string

func (*Validator) GetCommissionRate

func (x *Validator) GetCommissionRate() float32

func (*Validator) GetName

func (x *Validator) GetName() string

func (*Validator) ProtoMessage

func (*Validator) ProtoMessage()

func (*Validator) ProtoReflect

func (x *Validator) ProtoReflect() protoreflect.Message

func (*Validator) Reset

func (x *Validator) Reset()

func (*Validator) String

func (x *Validator) String() string

type ValidatorResourceName

type ValidatorResourceName struct {
	Protocol  string
	Network   string
	Validator string
}

func (ValidatorResourceName) ContainsWildcard

func (n ValidatorResourceName) ContainsWildcard() bool

func (ValidatorResourceName) MarshalString

func (n ValidatorResourceName) MarshalString() (string, error)

func (ValidatorResourceName) NetworkResourceName

func (n ValidatorResourceName) NetworkResourceName() NetworkResourceName

func (ValidatorResourceName) ProtocolResourceName

func (n ValidatorResourceName) ProtocolResourceName() ProtocolResourceName

func (ValidatorResourceName) String

func (n ValidatorResourceName) String() string

func (*ValidatorResourceName) UnmarshalString

func (n *ValidatorResourceName) UnmarshalString(name string) error

func (ValidatorResourceName) Validate

func (n ValidatorResourceName) Validate() error

type ViewStakingContextRequest

type ViewStakingContextRequest struct {

	// The address to fetch staking context for.
	Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
	// The network to fetch staking context for.
	Network string `protobuf:"bytes,2,opt,name=network,proto3" json:"network,omitempty"`
	// The protocol specific parameters needed to fetch a staking context.
	//
	// Types that are assignable to StakingContextParameters:
	//
	//	*ViewStakingContextRequest_EthereumKilnStakingContextParameters
	//	*ViewStakingContextRequest_SolanaStakingContextParameters
	StakingContextParameters isViewStakingContextRequest_StakingContextParameters `protobuf_oneof:"staking_context_parameters"`
	// contains filtered or unexported fields
}

The request message for the ViewStakingContext request.

func (*ViewStakingContextRequest) Descriptor deprecated

func (*ViewStakingContextRequest) Descriptor() ([]byte, []int)

Deprecated: Use ViewStakingContextRequest.ProtoReflect.Descriptor instead.

func (*ViewStakingContextRequest) GetAddress

func (x *ViewStakingContextRequest) GetAddress() string

func (*ViewStakingContextRequest) GetEthereumKilnStakingContextParameters

func (x *ViewStakingContextRequest) GetEthereumKilnStakingContextParameters() *EthereumKilnStakingContextParameters

func (*ViewStakingContextRequest) GetNetwork

func (x *ViewStakingContextRequest) GetNetwork() string

func (*ViewStakingContextRequest) GetSolanaStakingContextParameters

func (x *ViewStakingContextRequest) GetSolanaStakingContextParameters() *SolanaStakingContextParameters

func (*ViewStakingContextRequest) GetStakingContextParameters

func (m *ViewStakingContextRequest) GetStakingContextParameters() isViewStakingContextRequest_StakingContextParameters

func (*ViewStakingContextRequest) ProtoMessage

func (*ViewStakingContextRequest) ProtoMessage()

func (*ViewStakingContextRequest) ProtoReflect

func (*ViewStakingContextRequest) Reset

func (x *ViewStakingContextRequest) Reset()

func (*ViewStakingContextRequest) String

func (x *ViewStakingContextRequest) String() string

type ViewStakingContextRequest_EthereumKilnStakingContextParameters

type ViewStakingContextRequest_EthereumKilnStakingContextParameters struct {
	// EthereumKiln staking context parameters.
	EthereumKilnStakingContextParameters *EthereumKilnStakingContextParameters `protobuf:"bytes,3,opt,name=ethereum_kiln_staking_context_parameters,json=ethereumKilnStakingContextParameters,proto3,oneof"`
}

type ViewStakingContextRequest_SolanaStakingContextParameters

type ViewStakingContextRequest_SolanaStakingContextParameters struct {
	// Solana staking context parameters.
	SolanaStakingContextParameters *SolanaStakingContextParameters `protobuf:"bytes,4,opt,name=solana_staking_context_parameters,json=solanaStakingContextParameters,proto3,oneof"`
}

type ViewStakingContextResponse

type ViewStakingContextResponse struct {

	// The address you are getting a staking context for.
	Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
	// The protocol specific details of the staking context.
	//
	// Types that are assignable to StakingContextDetails:
	//
	//	*ViewStakingContextResponse_EthereumKilnStakingContextDetails
	//	*ViewStakingContextResponse_SolanaStakingContextDetails
	StakingContextDetails isViewStakingContextResponse_StakingContextDetails `protobuf_oneof:"staking_context_details"`
	// contains filtered or unexported fields
}

The response message for the ViewStakingContext request.

func (*ViewStakingContextResponse) Descriptor deprecated

func (*ViewStakingContextResponse) Descriptor() ([]byte, []int)

Deprecated: Use ViewStakingContextResponse.ProtoReflect.Descriptor instead.

func (*ViewStakingContextResponse) GetAddress

func (x *ViewStakingContextResponse) GetAddress() string

func (*ViewStakingContextResponse) GetEthereumKilnStakingContextDetails

func (x *ViewStakingContextResponse) GetEthereumKilnStakingContextDetails() *EthereumKilnStakingContextDetails

func (*ViewStakingContextResponse) GetSolanaStakingContextDetails

func (x *ViewStakingContextResponse) GetSolanaStakingContextDetails() *SolanaStakingContextDetails

func (*ViewStakingContextResponse) GetStakingContextDetails

func (m *ViewStakingContextResponse) GetStakingContextDetails() isViewStakingContextResponse_StakingContextDetails

func (*ViewStakingContextResponse) ProtoMessage

func (*ViewStakingContextResponse) ProtoMessage()

func (*ViewStakingContextResponse) ProtoReflect

func (*ViewStakingContextResponse) Reset

func (x *ViewStakingContextResponse) Reset()

func (*ViewStakingContextResponse) String

func (x *ViewStakingContextResponse) String() string

type ViewStakingContextResponse_EthereumKilnStakingContextDetails

type ViewStakingContextResponse_EthereumKilnStakingContextDetails struct {
	// EthereumKiln staking context details.
	EthereumKilnStakingContextDetails *EthereumKilnStakingContextDetails `protobuf:"bytes,2,opt,name=ethereum_kiln_staking_context_details,json=ethereumKilnStakingContextDetails,proto3,oneof"`
}

type ViewStakingContextResponse_SolanaStakingContextDetails

type ViewStakingContextResponse_SolanaStakingContextDetails struct {
	// Solana staking context details.
	SolanaStakingContextDetails *SolanaStakingContextDetails `protobuf:"bytes,3,opt,name=solana_staking_context_details,json=solanaStakingContextDetails,proto3,oneof"`
}

type WaitStepOutput

type WaitStepOutput struct {

	// The beginning of wait period.
	Start int64 `protobuf:"varint,1,opt,name=start,proto3" json:"start,omitempty"`
	// The current wait progress.
	Current int64 `protobuf:"varint,2,opt,name=current,proto3" json:"current,omitempty"`
	// The target wait end point.
	Target int64 `protobuf:"varint,3,opt,name=target,proto3" json:"target,omitempty"`
	// The wait unit (like checkpoint, block, epoch etc).
	Unit WaitStepOutput_WaitUnit `protobuf:"varint,4,opt,name=unit,proto3,enum=coinbase.staking.orchestration.v1.WaitStepOutput_WaitUnit" json:"unit,omitempty"`
	// The state of the wait step.
	State WaitStepOutput_State `protobuf:"varint,5,opt,name=state,proto3,enum=coinbase.staking.orchestration.v1.WaitStepOutput_State" json:"state,omitempty"`
	// contains filtered or unexported fields
}

The output details of a step where we wait for some kind of on-chain activity to finish like reaching a certain checkpoint, epoch or block.

func (*WaitStepOutput) Descriptor deprecated

func (*WaitStepOutput) Descriptor() ([]byte, []int)

Deprecated: Use WaitStepOutput.ProtoReflect.Descriptor instead.

func (*WaitStepOutput) GetCurrent

func (x *WaitStepOutput) GetCurrent() int64

func (*WaitStepOutput) GetStart

func (x *WaitStepOutput) GetStart() int64

func (*WaitStepOutput) GetState

func (x *WaitStepOutput) GetState() WaitStepOutput_State

func (*WaitStepOutput) GetTarget

func (x *WaitStepOutput) GetTarget() int64

func (*WaitStepOutput) GetUnit

func (*WaitStepOutput) ProtoMessage

func (*WaitStepOutput) ProtoMessage()

func (*WaitStepOutput) ProtoReflect

func (x *WaitStepOutput) ProtoReflect() protoreflect.Message

func (*WaitStepOutput) Reset

func (x *WaitStepOutput) Reset()

func (*WaitStepOutput) String

func (x *WaitStepOutput) String() string

type WaitStepOutput_State

type WaitStepOutput_State int32

WaitStepState defines an enumeration of states for a wait step.

const (
	// Unspecified wait step state.
	WaitStepOutput_STATE_UNSPECIFIED WaitStepOutput_State = 0
	// Wait step has not started.
	WaitStepOutput_STATE_NOT_STARTED WaitStepOutput_State = 1
	// Wait step is in-progress.
	WaitStepOutput_STATE_IN_PROGRESS WaitStepOutput_State = 2
	// Wait step completed.
	WaitStepOutput_STATE_COMPLETED WaitStepOutput_State = 3
)

func (WaitStepOutput_State) Descriptor

func (WaitStepOutput_State) Enum

func (WaitStepOutput_State) EnumDescriptor deprecated

func (WaitStepOutput_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use WaitStepOutput_State.Descriptor instead.

func (WaitStepOutput_State) Number

func (WaitStepOutput_State) String

func (x WaitStepOutput_State) String() string

func (WaitStepOutput_State) Type

type WaitStepOutput_WaitUnit

type WaitStepOutput_WaitUnit int32

The unit of wait time.

const (
	// Unspecified wait time.
	WaitStepOutput_WAIT_UNIT_UNSPECIFIED WaitStepOutput_WaitUnit = 0
	// Wait time measured in seconds.
	WaitStepOutput_WAIT_UNIT_SECONDS WaitStepOutput_WaitUnit = 1
	// Wait time measured in blocks.
	WaitStepOutput_WAIT_UNIT_BLOCKS WaitStepOutput_WaitUnit = 2
	// Wait time measured in epochs.
	WaitStepOutput_WAIT_UNIT_EPOCHS WaitStepOutput_WaitUnit = 3
	// Wait time measured in checkpoints.
	WaitStepOutput_WAIT_UNIT_CHECKPOINTS WaitStepOutput_WaitUnit = 4
)

func (WaitStepOutput_WaitUnit) Descriptor

func (WaitStepOutput_WaitUnit) Enum

func (WaitStepOutput_WaitUnit) EnumDescriptor deprecated

func (WaitStepOutput_WaitUnit) EnumDescriptor() ([]byte, []int)

Deprecated: Use WaitStepOutput_WaitUnit.Descriptor instead.

func (WaitStepOutput_WaitUnit) Number

func (WaitStepOutput_WaitUnit) String

func (x WaitStepOutput_WaitUnit) String() string

func (WaitStepOutput_WaitUnit) Type

type Workflow

type Workflow struct {

	// The resource name of the workflow.
	// Format: projects/{projectUUID}/workflows/{workflowUUID}
	// Ex: projects/ 123e4567-e89b-12d3-a456-426614174000/workflows/123e4567-e89b-12d3-a456-426614174000
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The resource name of the action being
	// performed.
	// Format: protocols/{protocol}/networks/{network}/actions/{action}
	Action string `protobuf:"bytes,2,opt,name=action,proto3" json:"action,omitempty"`
	// The parameters of the action to take.
	//
	// Types that are assignable to StakingParameters:
	//
	//	*Workflow_SolanaStakingParameters
	//	*Workflow_EthereumKilnStakingParameters
	StakingParameters isWorkflow_StakingParameters `protobuf_oneof:"staking_parameters"`
	// The current state of the workflow.
	State Workflow_State `protobuf:"varint,4,opt,name=state,proto3,enum=coinbase.staking.orchestration.v1.Workflow_State" json:"state,omitempty"`
	// The index of the current step.
	CurrentStepId int32 `protobuf:"varint,5,opt,name=current_step_id,json=currentStepId,proto3" json:"current_step_id,omitempty"`
	// The list of steps for this workflow.
	Steps []*WorkflowStep `protobuf:"bytes,6,rep,name=steps,proto3" json:"steps,omitempty"`
	// The timestamp the workflow was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The timestamp the workflow was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The timestamp the workflow completed.
	CompleteTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=complete_time,json=completeTime,proto3" json:"complete_time,omitempty"`
	// contains filtered or unexported fields
}

A Workflow resource.

func (*Workflow) Descriptor deprecated

func (*Workflow) Descriptor() ([]byte, []int)

Deprecated: Use Workflow.ProtoReflect.Descriptor instead.

func (*Workflow) GetAction

func (x *Workflow) GetAction() string

func (*Workflow) GetCompleteTime

func (x *Workflow) GetCompleteTime() *timestamppb.Timestamp

func (*Workflow) GetCreateTime

func (x *Workflow) GetCreateTime() *timestamppb.Timestamp

func (*Workflow) GetCurrentStepId

func (x *Workflow) GetCurrentStepId() int32

func (*Workflow) GetEthereumKilnStakingParameters

func (x *Workflow) GetEthereumKilnStakingParameters() *EthereumKilnStakingParameters

func (*Workflow) GetName

func (x *Workflow) GetName() string

func (*Workflow) GetSolanaStakingParameters

func (x *Workflow) GetSolanaStakingParameters() *SolanaStakingParameters

func (*Workflow) GetStakingParameters

func (m *Workflow) GetStakingParameters() isWorkflow_StakingParameters

func (*Workflow) GetState

func (x *Workflow) GetState() Workflow_State

func (*Workflow) GetSteps

func (x *Workflow) GetSteps() []*WorkflowStep

func (*Workflow) GetUpdateTime

func (x *Workflow) GetUpdateTime() *timestamppb.Timestamp

func (*Workflow) ProtoMessage

func (*Workflow) ProtoMessage()

func (*Workflow) ProtoReflect

func (x *Workflow) ProtoReflect() protoreflect.Message

func (*Workflow) Reset

func (x *Workflow) Reset()

func (*Workflow) String

func (x *Workflow) String() string

type WorkflowResourceName

type WorkflowResourceName struct {
	Project  string
	Workflow string
}

func (WorkflowResourceName) ContainsWildcard

func (n WorkflowResourceName) ContainsWildcard() bool

func (WorkflowResourceName) MarshalString

func (n WorkflowResourceName) MarshalString() (string, error)

func (WorkflowResourceName) String

func (n WorkflowResourceName) String() string

func (*WorkflowResourceName) UnmarshalString

func (n *WorkflowResourceName) UnmarshalString(name string) error

func (WorkflowResourceName) Validate

func (n WorkflowResourceName) Validate() error

type WorkflowStep

type WorkflowStep struct {

	// The human readable name of the step.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The output of the current step. It can be of tx or wait type.
	//
	// Types that are assignable to Output:
	//
	//	*WorkflowStep_TxStepOutput
	//	*WorkflowStep_WaitStepOutput
	Output isWorkflowStep_Output `protobuf_oneof:"output"`
	// contains filtered or unexported fields
}

The information for a step in the workflow.

func (*WorkflowStep) Descriptor deprecated

func (*WorkflowStep) Descriptor() ([]byte, []int)

Deprecated: Use WorkflowStep.ProtoReflect.Descriptor instead.

func (*WorkflowStep) GetName

func (x *WorkflowStep) GetName() string

func (*WorkflowStep) GetOutput

func (m *WorkflowStep) GetOutput() isWorkflowStep_Output

func (*WorkflowStep) GetTxStepOutput

func (x *WorkflowStep) GetTxStepOutput() *TxStepOutput

func (*WorkflowStep) GetWaitStepOutput

func (x *WorkflowStep) GetWaitStepOutput() *WaitStepOutput

func (*WorkflowStep) ProtoMessage

func (*WorkflowStep) ProtoMessage()

func (*WorkflowStep) ProtoReflect

func (x *WorkflowStep) ProtoReflect() protoreflect.Message

func (*WorkflowStep) Reset

func (x *WorkflowStep) Reset()

func (*WorkflowStep) String

func (x *WorkflowStep) String() string

type WorkflowStep_TxStepOutput

type WorkflowStep_TxStepOutput struct {
	// The tx step output (e.g. transaction metadata such as unsigned tx, signed tx etc).
	TxStepOutput *TxStepOutput `protobuf:"bytes,2,opt,name=tx_step_output,json=txStepOutput,proto3,oneof"`
}

type WorkflowStep_WaitStepOutput

type WorkflowStep_WaitStepOutput struct {
	// The waiting details for any kind like how many checkpoints away for unbonding etc.
	WaitStepOutput *WaitStepOutput `protobuf:"bytes,3,opt,name=wait_step_output,json=waitStepOutput,proto3,oneof"`
}

type Workflow_EthereumKilnStakingParameters

type Workflow_EthereumKilnStakingParameters struct {
	// EthereumKiln staking parameters.
	EthereumKilnStakingParameters *EthereumKilnStakingParameters `protobuf:"bytes,10,opt,name=ethereum_kiln_staking_parameters,json=ethereumKilnStakingParameters,proto3,oneof"`
}

type Workflow_SolanaStakingParameters

type Workflow_SolanaStakingParameters struct {
	// Solana staking parameters.
	SolanaStakingParameters *SolanaStakingParameters `protobuf:"bytes,9,opt,name=solana_staking_parameters,json=solanaStakingParameters,proto3,oneof"`
}

type Workflow_State

type Workflow_State int32

The state of a workflow

const (
	// Unspecified workflow state, this is for backwards compatibility.
	Workflow_STATE_UNSPECIFIED Workflow_State = 0
	// In Progress represents a workflow that is currently in progress.
	Workflow_STATE_IN_PROGRESS Workflow_State = 1
	// Waiting for external broadcast represents the workflow is waiting for the customer to broadcast a tx and return its corresponding tx hash.
	Workflow_STATE_WAITING_FOR_EXT_BROADCAST Workflow_State = 9
	// Completed represents the workflow has completed.
	Workflow_STATE_COMPLETED Workflow_State = 3
	// Failed represents the workflow has failed.
	Workflow_STATE_FAILED Workflow_State = 4
)

func (Workflow_State) Descriptor

func (Workflow_State) Enum

func (x Workflow_State) Enum() *Workflow_State

func (Workflow_State) EnumDescriptor deprecated

func (Workflow_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Workflow_State.Descriptor instead.

func (Workflow_State) Number

func (Workflow_State) String

func (x Workflow_State) String() string

func (Workflow_State) Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL