Class XrplAddressCodec
Inheritance
System.Object
XrplAddressCodec
Assembly: Xrpl.AddressCodec.dll
Syntax
public class XrplAddressCodec : object
Fields
|
Improve this Doc
View Source
Alphabet
Declaration
public const string Alphabet = null
Field Value
Type |
Description |
System.String |
|
Methods
|
Improve this Doc
View Source
ClassicAddressToXAddress(String, Nullable<Int32>, Boolean)
Returns the X-Address representation of the data.
Declaration
public static string ClassicAddressToXAddress(string classicAddress, int? tag, bool isTest)
Parameters
Type |
Name |
Description |
System.String |
classicAddress |
|
System.Nullable<System.Int32> |
tag |
|
System.Boolean |
isTest |
|
Returns
Type |
Description |
System.String |
The X-Address representation of the data.
|
|
Improve this Doc
View Source
DecodeXAddress(String)
Declaration
public static XrplAddressCodec.CodecAccountID DecodeXAddress(string xAddress)
Parameters
Type |
Name |
Description |
System.String |
xAddress |
|
Returns
|
Improve this Doc
View Source
EncodeXAddress(Byte[], Nullable<Int32>, Boolean)
Encode account ID, tag, and network ID to X-address
Declaration
public static string EncodeXAddress(byte[] accountId, int? tag, bool isTest)
Parameters
Type |
Name |
Description |
System.Byte[] |
accountId |
|
System.Nullable<System.Int32> |
tag |
|
System.Boolean |
isTest |
|
Returns
Type |
Description |
System.String |
|
Exceptions
|
Improve this Doc
View Source
IsTestAddress(Byte[])
Returns whether a decoded X-Address is a test address.
Declaration
public static bool IsTestAddress(byte[] buf)
Parameters
Type |
Name |
Description |
System.Byte[] |
buf |
|
Returns
Type |
Description |
System.Boolean |
Whether a decoded X-Address is a test address.
|
|
Improve this Doc
View Source
IsValidXAddress(String)
Returns whether xAddress
is a valid X-Address.
Declaration
public static bool IsValidXAddress(string xAddress)
Parameters
Type |
Name |
Description |
System.String |
xAddress |
|
Returns
Type |
Description |
System.Boolean |
Whether xAddress is a valid X-Address.
|
|
Improve this Doc
View Source
TagFromBuffer(Byte[])
Returns the destination tag extracted from the suffix of the X-Address.
Declaration
public static int? TagFromBuffer(byte[] buf)
Parameters
Type |
Name |
Description |
System.Byte[] |
buf |
|
Returns
Type |
Description |
System.Nullable<System.Int32> |
The destination tag extracted from the suffix of the X-Address.
|
|
Improve this Doc
View Source
XAddressToClassicAddress(String)
Returns a tuple containing the classic address, tag, and whether the address
is on a test network for an X-Address.
Declaration
public static XrplAddressCodec.CodecAddress XAddressToClassicAddress(string xAddress)
Parameters
Type |
Name |
Description |
System.String |
xAddress |
|
Returns
Type |
Description |
XrplAddressCodec.CodecAddress |
A dict containing: classicAddress: the base58 classic address, tag: the destination tag, isTest: whether the address is on the test network (or main)
|