# XChainClaim | xrpl
Documentation for xrpl

# Interface XChainClaim

The XChainClaim transaction completes a cross-chain transfer of value. It allows a user to claim the value on the destination chain - the equivalent of the value locked on the source chain.

#### Hierarchy

- BaseTransaction
  - XChainClaim

- Defined in packages/xrpl/src/models/transactions/XChainClaim.ts:23

#####
Index

### Properties

Account
AccountTxnID?
Amount
Destination
DestinationTag?
Fee?
Flags?
LastLedgerSequence?
Memos?
NetworkID?
Sequence?
Signers?
SigningPubKey?
SourceTag?
TicketSequence?
TransactionType
TxnSignature?
XChainBridge
XChainClaimID

## Properties

### Account

Account: string

The unique address of the transaction sender.

Inherited from BaseTransaction.Account

- Defined in packages/xrpl/src/models/transactions/common.ts:225

### `Optional` AccountTxnID

AccountTxnID?: string

Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

Inherited from BaseTransaction.AccountTxnID

- Defined in packages/xrpl/src/models/transactions/common.ts:249

### Amount

Amount: Amount

The amount to claim on the destination chain. This must match the amount attested to on the attestations associated with this XChainClaimID.

- Defined in packages/xrpl/src/models/transactions/XChainClaim.ts:54

### Destination

Destination: string

The destination account on the destination chain. It must exist or the transaction will fail. However, if the transaction fails in this case, the sequence number and collected signatures won't be destroyed, and the transaction can be rerun with a different destination.

- Defined in packages/xrpl/src/models/transactions/XChainClaim.ts:43

### `Optional` DestinationTag

DestinationTag?: number

An integer destination tag.

- Defined in packages/xrpl/src/models/transactions/XChainClaim.ts:48

### `Optional` Fee

Fee?: string

Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

Inherited from BaseTransaction.Fee

- Defined in packages/xrpl/src/models/transactions/common.ts:236

### `Optional` Flags

Flags?: number | GlobalFlags

Set of bit-flags for this transaction.

Inherited from BaseTransaction.Flags

- Defined in packages/xrpl/src/models/transactions/common.ts:251

### `Optional` LastLedgerSequence

LastLedgerSequence?: number

Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

Inherited from BaseTransaction.LastLedgerSequence

- Defined in packages/xrpl/src/models/transactions/common.ts:257

### `Optional` Memos

Memos?: Memo []

Additional arbitrary information used to identify this transaction.

Inherited from BaseTransaction.Memos

- Defined in packages/xrpl/src/models/transactions/common.ts:261

### `Optional` NetworkID

NetworkID?: number

The network id of the transaction.

Inherited from BaseTransaction.NetworkID

- Defined in packages/xrpl/src/models/transactions/common.ts:293

### `Optional` Sequence

Sequence?: number

The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

Inherited from BaseTransaction.Sequence

- Defined in packages/xrpl/src/models/transactions/common.ts:243

### `Optional` Signers

Signers?: Signer []

Array of objects that represent a multi-signature which authorizes this transaction.

Inherited from BaseTransaction.Signers

- Defined in packages/xrpl/src/models/transactions/common.ts:266

### `Optional` SigningPubKey

SigningPubKey?: string

Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

Inherited from BaseTransaction.SigningPubKey

- Defined in packages/xrpl/src/models/transactions/common.ts:279

### `Optional` SourceTag

SourceTag?: number

Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

Inherited from BaseTransaction.SourceTag

- Defined in packages/xrpl/src/models/transactions/common.ts:273

### `Optional` TicketSequence

TicketSequence?: number

The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

Inherited from BaseTransaction.TicketSequence

- Defined in packages/xrpl/src/models/transactions/common.ts:284

### TransactionType

TransactionType: "XChainClaim"

The type of transaction. Valid types include: `Payment`, `OfferCreate`, `TrustSet`, and many others.

Overrides BaseTransaction.TransactionType

- Defined in packages/xrpl/src/models/transactions/XChainClaim.ts:24

### `Optional` TxnSignature

TxnSignature?: string

The signature that verifies this transaction as originating from the account it says it is from.

Inherited from BaseTransaction.TxnSignature

- Defined in packages/xrpl/src/models/transactions/common.ts:289

### XChainBridge

XChainBridge: XChainBridge

The bridge to use for the transfer.

- Defined in packages/xrpl/src/models/transactions/XChainClaim.ts:29

### XChainClaimID

XChainClaimID: string | number

The unique integer ID for the cross-chain transfer that was referenced in the corresponding XChainCommit transaction.

- Defined in packages/xrpl/src/models/transactions/XChainClaim.ts:35

Generated using TypeDoc