Skip to content

Commit 78f120a

Browse files
committed
Document available staking options
1 parent fe0392f commit 78f120a

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

src/coinbase/address/external_address.ts

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ import { Asset } from "../asset";
66
import { StakingOperation } from "../staking_operation";
77
import { StakingRewardFormat } from "../../client";
88
import { StakingReward } from "../staking_reward";
9-
import { BalanceMap } from "../balance_map";
109
import { Balance } from "../balance";
11-
import { FaucetTransaction } from "../faucet_transaction";
1210

1311
/**
1412
* A representation of a blockchain Address, which is a user-controlled account on a Network. Addresses are used to
@@ -24,6 +22,13 @@ export class ExternalAddress extends Address {
2422
* @param assetId - The asset to stake.
2523
* @param mode - The staking mode. Defaults to DEFAULT.
2624
* @param options - Additional options for the stake operation.
25+
* Available options:
26+
* A. Shared ETH Staking: None
27+
* B. Dedicated ETH Staking:
28+
* 1. funding_address (optional): Ethereum address for funding the stake operation. Defaults to the address initiating the stake operation.
29+
* 2. withdrawal_address (optional): Ethereum address for receiving rewards and withdrawal funds. Defaults to the address initiating the stake operation.
30+
* 3. fee_recipient_address (optional): Ethereum address for receiving transaction fees. Defaults to the address initiating the stake operation.
31+
*
2732
* @returns The stake operation.
2833
*/
2934
public async buildStakeOperation(
@@ -43,6 +48,12 @@ export class ExternalAddress extends Address {
4348
* @param assetId - The asset to unstake.
4449
* @param mode - The staking mode. Defaults to DEFAULT.
4550
* @param options - Additional options for the unstake operation.
51+
* Available options:
52+
* A. Shared ETH Staking: None
53+
* B. Dedicated ETH Staking:
54+
* 1. immediate (optional): Set this to "true" to unstake immediately i.e. leverage "Coinbase managed unstake" process . Defaults to "false" i.e. "User managed unstake" process.
55+
* 2. validator_pub_keys (optional): List of validator public keys to unstake. Defaults to validators being picked up on your behalf corresponding to the unstake amount.
56+
*
4657
* @returns The unstake operation.
4758
*/
4859
public async buildUnstakeOperation(

0 commit comments

Comments
 (0)