Package org.xrpl.xrpl4j.model.client.channels

Interface ChannelVerifyRequestParams

All Superinterfaces:

XrplRequestParams

All Known Implementing Classes:

ImmutableChannelVerifyRequestParams

@Immutable
public interface ChannelVerifyRequestParams
extends XrplRequestParams

Request parameters for the "channel_verify" rippled API method.

Method Summary

Modifier and Type	Method	Description
XrpCurrencyAmount	amount()	The amount of XRP, in drops, the provided signature() authorizes.
static ImmutableChannelVerifyRequestParams.Builder	builder()	Construct a builder for this class.
Hash256	channelId()	The Channel ID of the channel that provides the XRP.
String	publicKey()	The public key of the channel and the key pair that was used to create the signature(), in hexadecimal or the XRP Ledger's base58 format.
String	signature()	The signature to verify, in hexadecimal.

Method Details

builder

static ImmutableChannelVerifyRequestParams.Builder builder()

Construct a builder for this class.

Returns:

An ImmutableChannelVerifyRequestParams.Builder.

amount

XrpCurrencyAmount amount()

The amount of XRP, in drops, the provided signature() authorizes.

Returns:

the xrp currency amount

channelId

Hash256 channelId()

The Channel ID of the channel that provides the XRP.

Returns:

the hash 256

publicKey

String publicKey()

The public key of the channel and the key pair that was used to create the signature(), in hexadecimal or the XRP Ledger's base58 format.

Returns:

A String containing the public key.

signature

String signature()

The signature to verify, in hexadecimal.

Returns:

A String containing the signature.