stellar-sdk/com.soneso.stellar.sdk/MuxedContract

MuxedContract

class MuxedContract

A contract with an optional 64-bit multiplexing id (CAP-0084, protocol 30 and higher).

A muxed contract address pairs a contract with an id the way a muxed account address pairs an account with one. It consists of two parts:

The contract id, which starts with the letter "C"
An optional multiplexing id, a 64-bit unsigned integer

When the multiplexing id is set, the address starts with "W" instead of "C". The Stellar Asset Contract accepts a muxed contract address as the recipient of a transfer; it is never an authorization target.

Usage

val muxed = MuxedContract("CA3D5KRYM6CB7OWQ6TWYRR3Z4T7GNZLKERYNZGGA5SOAOPIFY6YQGAXE", 123456UL)
println(muxed.address) // WA3D5KRYM6CB7OWQ6TWYRR3Z4T7GNZLKERYNZGGA5SOAOPIFY6YQGAAAAAAAAAPCIA6IG

val parsed = MuxedContract("WA3D5KRYM6CB7OWQ6TWYRR3Z4T7GNZLKERYNZGGA5SOAOPIFY6YQGAAAAAAAAAPCIA6IG")
println(parsed.contractId) // CA3D5KRY...
println(parsed.id)         // 123456

See also

Constructors

constructor(contractId: String, id: ULong)

Creates a muxed contract from a contract id and a multiplexing id.

constructor(address: String)

Creates a muxed contract from a contract address (C...), which leaves id null, or a muxed contract address (W...).

Types

object Companion

Properties

val address: String

The address of this muxed contract: the muxed contract address (W...) if the multiplexing id is set, or the contract address (C...) if it is not.

val contractId: String

The contract id. It starts with the letter "C".

val id: ULong?

The optional multiplexing id, a 64-bit unsigned integer. Null for a plain contract address.

Functions

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

fun toAddress(): Address

Converts this muxed contract to an Address of type Address.AddressType.MUXED_CONTRACT if the multiplexing id is set, or Address.AddressType.CONTRACT if it is not.

fun toSCAddress(): SCAddressXdr

Converts this muxed contract to its XDR address: the muxed contract arm if the multiplexing id is set, or the contract arm if it is not.

open override fun toString(): String