Client and backend. This class is shared: the same code is compiled into your app and into your server, so everything on this page works in both.
public final class SolanaAddress
- Object
- SolanaAddress
ImplementsComparable<SolanaAddress>
A Solana account address: 32 bytes, written in Base58. An address is either an Ed25519
public key or a program-derived address (PDA), which by construction is not on the curve
and so has no private key.
Nested types
class SolanaAddress.ProgramAddress | A program-derived address with the bump seed that produced it. |
Fields
public static final int LENGTH = 32 | The address length in bytes. |
public static final SolanaAddress SYSTEM_PROGRAM | The System Program, which creates accounts and moves lamports. |
public static final SolanaAddress TOKEN_PROGRAM | The SPL Token program. |
public static final SolanaAddress TOKEN_2022_PROGRAM | The SPL Token-2022 program. |
public static final SolanaAddress ASSOCIATED_TOKEN_PROGRAM | The Associated Token Account program. |
public static final SolanaAddress COMPUTE_BUDGET_PROGRAM | The Compute Budget program. |
public static final SolanaAddress MEMO_PROGRAM | The Memo program. |
Methods
Inherited methods
Field details
LENGTH
public static final int LENGTH = 32The address length in bytes.
SYSTEM_PROGRAM
public static final SolanaAddress SYSTEM_PROGRAMThe System Program, which creates accounts and moves lamports.
TOKEN_PROGRAM
public static final SolanaAddress TOKEN_PROGRAMThe SPL Token program.
TOKEN_2022_PROGRAM
public static final SolanaAddress TOKEN_2022_PROGRAMThe SPL Token-2022 program.
ASSOCIATED_TOKEN_PROGRAM
public static final SolanaAddress ASSOCIATED_TOKEN_PROGRAMThe Associated Token Account program.
COMPUTE_BUDGET_PROGRAM
public static final SolanaAddress COMPUTE_BUDGET_PROGRAMThe Compute Budget program.
MEMO_PROGRAM
public static final SolanaAddress MEMO_PROGRAMThe Memo program.
Method details
fromBytes
public static SolanaAddress fromBytes(byte[] bytes)The address of 32 bytes, an Ed25519 public key or a PDA.
Throws
IllegalArgumentException- unless there are exactly 32 bytes
fromPrivateKey
public static SolanaAddress fromPrivateKey(byte[] seed)The address of an Ed25519 private key (its 32-byte seed).
parse
public static SolanaAddress parse(String base58)Reads a Base58 address.
Throws
IllegalArgumentException- for text that is not Base58 or not 32 bytes
isValid
public static boolean isValid(String base58)Whether text is a Base58 Solana address.
toBytes
public byte[] toBytes()The address bytes, a copy.
isOnCurve
public boolean isOnCurve()Whether the address is on the Ed25519 curve, which is to say it could have a private key.
A program-derived address answers
false.createProgramAddress
public static SolanaAddress createProgramAddress(byte[][] seeds, SolanaAddress programId)createProgramAddress: the address of seeds under a program, with no bump search.Throws
IllegalArgumentException- for more than 16 seeds, a seed over 32 bytes, or seeds whose hash falls on the curve
findProgramAddress
public static SolanaAddress.ProgramAddress findProgramAddress(byte[][] seeds, SolanaAddress programId)findProgramAddress: the canonical PDA, searching the bump seed from 255 down.createWithSeed
public static SolanaAddress createWithSeed(SolanaAddress base, String seed, SolanaAddress owner)createWithSeed: the address SHA-256(base || seed || owner) that the System
Program’s *WithSeed instructions use.Throws
IllegalArgumentException- for a seed over 32 bytes
associatedTokenAddress
public static SolanaAddress associatedTokenAddress(SolanaAddress wallet, SolanaAddress mint)The associated token account of a wallet for a mint under the SPL Token program.
associatedTokenAddress
public static SolanaAddress associatedTokenAddress(SolanaAddress wallet, SolanaAddress mint, SolanaAddress tokenProgram)The associated token account of a wallet for a mint under a given token program, such as
TOKEN_2022_PROGRAM.toString
public String toString()The Base58 form.
equals
public boolean equals(Object o)Indicates whether some other object is “equal to” this one.
The equals method implements an equivalence relation: It is reflexive: for any reference value x, x.equals(x) should return true. It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true. It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true. It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the object is modified. For any non-null reference value x, x.equals(null) should return false.
The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).
hashCode
public int hashCode()Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.
The general contract of hashCode is: Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.
As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)
compareTo
public int compareTo(SolanaAddress o)Orders addresses by their bytes, unsigned.
Parameters
oSolanaAddress- the object to compare to this instance.
Returns
a negative integer if this instance is less than
another;
a positive integer if this instance is greater than
another; 0 if this instance has the same order as
another.Throws
ClassCastException- if
anothercannot be converted into something comparable tothisinstance.