Skip to content

account.activate()

[Source]

Activate a created account by sending it XRP from the operator (primary) account, then enabling rippling. This is the any-network counterpart to fund. The account must be signable by this client (e.g., from create).

Signature

account.activate(
  params: AccountActivateParams,
  options?: AccountWriteOptions,
): Promise<SubmissionResult<undefined>>

Parameters

ParameterTypeRequiredDescription
destinationstringYesThe r-address to activate (typically from Account.create).
amountstringNoXRP to send, as a decimal string. Must be non-negative, with at most 6 decimal places (1 drop, XRP's smallest unit). Defaults to the network's base reserve (plus a small buffer).

Options

options is an optional second argument that sets the source account and overrides the fee.

OptionTypeRequiredDescription
fromAccountSelectorNoThe account to act as — an r-address string, or an object { address } or { signer, account? }. Defaults to the primary signer's primary account. (For IOU operations, this is the issuer.)
feeFeeIntentNoFee override — a priority tier and/or a maxFeeDrops cap.
idempotencyKeystringNoA prior submission's idempotencyKey, to retry to the same intent instead of creating a duplicate. Auto-generated when omitted.

Returns

Resolves to a SubmissionResult<undefined> (from the defaultRipple settings change).

Every simpleXRPL write resolves to a SubmissionResult<T> — a union tagged by source, with the backend's raw response preserved verbatim. Its common fields are:

FieldTypeDescription
intentTThe operation-specific output — see the operation's own return fields.
source'xrpld' | 'custody' | 'palisade'Which backend produced the result; discriminates response.
responseTxResponse | custody record | Palisade recordThe backend's raw response, preserved verbatim.
txHashstring (optional)The XRPL transaction hash, once the transaction is on-ledger.
intentIdstring (optional)The custodian intent id, when the path produced one. Hold onto this to resume via client.intent.
idempotencyKeystring (optional)The UUIDv7 this submission carried. Pass it back as a later call's idempotencyKey to retry to the same intent rather than creating a duplicate.

Return fields

Account.activate attaches no intent output; intent is undefined.

Underlying XRPL transactors

Runs as an ordered, multi-step sequence:

  1. Payment — the operator sends XRP to the destination.
  2. AccountSet — the new account enables rippling (defaultRipple).

Example

await client.account.activate({
  destination: 'rNewAccount...',
})