feat: expose pending claimable balance

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Coinbase Go SDK Changelog
 
+## [0.0.18] - 2025-02-10
+
+### Added
+
+- Add `GetPendingClaimableBalance` function to help users get the pending claimable balance for a given address.
+
 ## [0.0.17] - 2025-02-06
 
 ### Added

pkg/auth/transport.go

@@ -36,7 +36,7 @@ func (t *transport) RoundTrip(req *http.Request) (*http.Response, error) {
 		"Correlation-Context",
 		fmt.Sprintf(
 			"%s,%s",
-			fmt.Sprintf("%s=%s", "sdk_version", "0.0.17"),
+			fmt.Sprintf("%s=%s", "sdk_version", "0.0.18"),
 			fmt.Sprintf("%s=%s", "sdk_language", "go"),
 		),
 	)

pkg/coinbase/staking_context_balances.go

@@ -9,9 +9,10 @@ import (
 
 // StakingContextBalance represents the active stakeable balances for a given address and asset.
 type StakingContextBalance struct {
-	StakeableBalance   *Balance
-	UnstakeableBalance *Balance
-	ClaimableBalance   *Balance
+	StakeableBalance        *Balance
+	UnstakeableBalance      *Balance
+	PendingClaimableBalance *Balance
+	ClaimableBalance        *Balance
 }
 
 // StakingBalanceOption allows for the passing of custom options to the staking balance
@@ -37,6 +38,15 @@ func (c *Client) GetUnstakeableBalance(ctx context.Context, assetId string, addr
 	return sb.UnstakeableBalance, nil
 }
 
+func (c *Client) GetPendingClaimableBalance(ctx context.Context, assetId string, address *Address, o ...StakingBalanceOption) (*Balance, error) {
+	sb, err := c.fetchStakingBalances(ctx, assetId, address, o...)
+	if err != nil {
+		return nil, err
+	}
+
+	return sb.PendingClaimableBalance, nil
+}
+
 // GetClaimableBalance returns the claimable balance.
 func (c *Client) GetClaimableBalance(ctx context.Context, assetId string, address *Address, o ...StakingBalanceOption) (*Balance, error) {
 	sb, err := c.fetchStakingBalances(ctx, assetId, address, o...)
@@ -92,14 +102,20 @@ func newStakingBalancesFromModel(context *client.StakingContext) (*StakingContex
 		return nil, err
 	}
 
+	pendingClaimableBalance, err := newBalanceFromModel(&context.Context.PendingClaimableBalance)
+	if err != nil {
+		return nil, err
+	}
+
 	claimableBalance, err := newBalanceFromModel(&context.Context.ClaimableBalance)
 	if err != nil {
 		return nil, err
 	}
 
 	return &StakingContextBalance{
-		StakeableBalance:   stakeableBalance,
-		UnstakeableBalance: unstakeableBalance,
-		ClaimableBalance:   claimableBalance,
+		StakeableBalance:        stakeableBalance,
+		UnstakeableBalance:      unstakeableBalance,
+		PendingClaimableBalance: pendingClaimableBalance,
+		ClaimableBalance:        claimableBalance,
 	}, nil
 }