Merge pull request #7 from coinbase/main-1701903076

v0.2.0 Release

Author: drohit-cb

.gitignore

@@ -25,7 +25,7 @@
 vendor/
 
 # Cloud API key
-.coinbase_cloud_api_key_*.json
+.coinbase_cloud_api_key*.json
 
 # Example binary
 staking-client-*

README.md

@@ -46,17 +46,25 @@ To test that your API Key gives you access as expected to the Staking APIs:
 ### Create an Ethereum Kiln workflow
 To test creating an Ethereum Kiln workflow perform the following:
 
-1. Run `go run examples/ethereum_kiln/example.go`
-2. To proceed with the entire example.go, you will need to set the following variables in the example.go file and run the code again:
+1. Open `examples/ethereum_kiln/example.go` and set the following variables:
    * `projectID` - this is the project ID of your Coinbase Cloud project
    * `privateKey` - this is the private key of the address with this you want to perform staking actions
    * `stakerAddress` - this is the address with which you want to perform staking actions
+   * `integratorContractAddress` - this is the integrator contract address to which you want to stake. This is typically procured by engaging with the Coinbase Cloud sales team.
+2. Run `go run examples/ethereum_kiln/example.go`
 
 ### Create a Polygon workflow
 To test creating a Polygon workflow perform the following:
 
-1. Run `go run examples/polygon/example.go`
-2. To proceed with the entire example.go, you will need to set the following variables in the example.go file and run the code again:
+1. Open `examples/polygon/example.go` and set the following variables:
    * `projectID` - this is the project ID of your Coinbase Cloud project
    * `privateKey` - this is the private key of the address with this you want to perform staking actions
    * `delegatorAddress` - this is the address with which you want to perform staking actions
+2. Run `go run examples/polygon/example.go`
+
+### Listing workflows
+To test listing workflows within a project, perform the following:
+
+1. Open `examples/example_list_workflows.go` and set the following variables:
+   * `projectID` - this is the project ID of your Coinbase Cloud project
+2. Run `go run examples/example_list_workflows.go`

client/v1alpha1/create_workflow.go

@@ -13,61 +13,61 @@ import (
 	stakingpb "github.com/coinbase/staking-client-library-go/gen/go/coinbase/staking/v1alpha1"
 )
 
-// ValidatorIterator is an interface for iterating through the response to ListValidators.
-type ValidatorIterator interface {
+// StakingTargetIterator is an interface for iterating through the response to ListStakingTargets.
+type StakingTargetIterator interface {
 	// PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
 	PageInfo() *iterator.PageInfo
 
 	// Next returns the next result. Its second return value is iterator.Done if there are no more
 	// results. Once Next returns Done, all subsequent calls will return Done.
-	Next() (*stakingpb.Validator, error)
+	Next() (*stakingpb.StakingTarget, error)
 
 	// Response is the raw response for the current page.
 	// Calling Next() or InternalFetch() updates this value.
-	Response() *stakingpb.ListValidatorsResponse
+	Response() *stakingpb.ListStakingTargetsResponse
 }
 
-// ValidatorIteratorImpl is an implementation of ValidatorIterator that unwraps correctly.
-type ValidatorIteratorImpl struct {
-	iter *innerClient.ValidatorIterator
+// StakingTargetIteratorImpl is an implementation of StakingTargetIterator that unwraps correctly.
+type StakingTargetIteratorImpl struct {
+	iter *innerClient.StakingTargetIterator
 }
 
 // PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
-func (n *ValidatorIteratorImpl) PageInfo() *iterator.PageInfo {
+func (n *StakingTargetIteratorImpl) PageInfo() *iterator.PageInfo {
 	return n.iter.PageInfo()
 }
 
 // Next returns the next result. Its second return value is iterator.Done if there are no more
 // results. Once Next returns Done, all subsequent calls will return Done.
-func (n *ValidatorIteratorImpl) Next() (*stakingpb.Validator, error) {
-	validator, err := n.iter.Next()
+func (n *StakingTargetIteratorImpl) Next() (*stakingpb.StakingTarget, error) {
+	stakingTarget, err := n.iter.Next()
 	if errors.Is(err, iterator.Done) || err == nil {
-		return validator, err
+		return stakingTarget, err
 	}
 
-	return validator, stakingerrors.FromError(err)
+	return stakingTarget, stakingerrors.FromError(err)
 }
 
 // Response is the raw response for the current page.
 // Calling Next() or InternalFetch() updates this value.
-func (n *ValidatorIteratorImpl) Response() *stakingpb.ListValidatorsResponse {
+func (n *StakingTargetIteratorImpl) Response() *stakingpb.ListStakingTargetsResponse {
 	if n.iter.Response == nil {
 		return nil
 	}
 
-	response, ok := n.iter.Response.(*stakingpb.ListValidatorsResponse)
+	response, ok := n.iter.Response.(*stakingpb.ListStakingTargetsResponse)
 	if !ok {
 		return nil
 	}
 
 	return response
 }
 
-// ListValidators lists the Validators supported by Staking API.
-func (s *StakingServiceClient) ListValidators(
+// ListStakingTargets lists the StakingTargets supported by Staking API.
+func (s *StakingServiceClient) ListStakingTargets(
 	ctx context.Context,
-	req *stakingpb.ListValidatorsRequest,
+	req *stakingpb.ListStakingTargetsRequest,
 	opts ...gax.CallOption,
-) ValidatorIterator {
-	return &ValidatorIteratorImpl{iter: s.client.ListValidators(ctx, req, opts...)}
+) StakingTargetIterator {
+	return &StakingTargetIteratorImpl{iter: s.client.ListStakingTargets(ctx, req, opts...)}
 }

client/v1alpha1/get_workflow.go

@@ -2,10 +2,14 @@ package v1alpha1
 
 import (
 	"context"
+	"errors"
 
 	"github.com/googleapis/gax-go/v2"
 
+	"google.golang.org/api/iterator"
+
 	stakingerrors "github.com/coinbase/staking-client-library-go/client/errors"
+	innerClient "github.com/coinbase/staking-client-library-go/gen/client/coinbase/staking/v1alpha1"
 	stakingpb "github.com/coinbase/staking-client-library-go/gen/go/coinbase/staking/v1alpha1"
 )
 
@@ -43,6 +47,65 @@ func (s *StakingServiceClient) GetWorkflow(
 	return wf, sae
 }
 
+// WorkflowIterator is an interface for iterating through the response to ListWorkflows.
+type WorkflowIterator interface {
+	// PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
+	PageInfo() *iterator.PageInfo
+
+	// Next returns the next result. Its second return value is iterator.Done if there are no more
+	// results. Once Next returns Done, all subsequent calls will return Done.
+	Next() (*stakingpb.Workflow, error)
+
+	// Response is the raw response for the current page.
+	// Calling Next() or InternalFetch() updates this value.
+	Response() *stakingpb.ListWorkflowsResponse
+}
+
+// WorkflowIteratorImpl is an implementation of WorkflowIterator that unwraps correctly.
+type WorkflowIteratorImpl struct {
+	iter *innerClient.WorkflowIterator
+}
+
+// PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
+func (n *WorkflowIteratorImpl) PageInfo() *iterator.PageInfo {
+	return n.iter.PageInfo()
+}
+
+// Next returns the next result. Its second return value is iterator.Done if there are no more
+// results. Once Next returns Done, all subsequent calls will return Done.
+func (n *WorkflowIteratorImpl) Next() (*stakingpb.Workflow, error) {
+	workflow, err := n.iter.Next()
+	if errors.Is(err, iterator.Done) || err == nil {
+		return workflow, err
+	}
+
+	return workflow, stakingerrors.FromError(err)
+}
+
+// Response is the raw response for the current page.
+// Calling Next() or InternalFetch() updates this value.
+func (n *WorkflowIteratorImpl) Response() *stakingpb.ListWorkflowsResponse {
+	if n.iter.Response == nil {
+		return nil
+	}
+
+	response, ok := n.iter.Response.(*stakingpb.ListWorkflowsResponse)
+	if !ok {
+		return nil
+	}
+
+	return response
+}
+
+// ListWorkflows lists the Workflows supported by Staking API.
+func (s *StakingServiceClient) ListWorkflows(
+	ctx context.Context,
+	req *stakingpb.ListWorkflowsRequest,
+	opts ...gax.CallOption,
+) WorkflowIterator {
+	return &WorkflowIteratorImpl{iter: s.client.ListWorkflows(ctx, req, opts...)}
+}
+
 // PerformWorkflowStep helps update workflow move to the next state by returning the signed tx back.
 func (s *StakingServiceClient) PerformWorkflowStep(
 	ctx context.Context,