Class SOLANA

Hierarchy (view full)

DefaultChain
- SOLANA
  - xmlocalsdk.SOLANA
  - xmwebsdk.SOLANA

Implements

SolanaDefaultChain

Constructors

constructor

new SOLANA(rpc_url): xmcore.SOLANA
Parameters
- rpc_url: string
Returns xmcore.SOLANA
Overrides DefaultChain.constructor
- Defined in src/multichain/core/solana.ts:64

Properties

connected

connected: boolean = false

name

name: string = ""

provider

provider: Connection

rpc_url

rpc_url: string = ""

signer

signer: any = null

wallet

wallet: Keypair

Methods

connect

connect(): Promise<boolean>
Connects to the RPC provider

Returns Promise<boolean>
A boolean indicating if the connection was successful
Implementation of SolanaDefaultChain.connect
Overrides DefaultChain.connect
- Defined in src/multichain/core/solana.ts:76

connectWallet

connectWallet(privateKey): Promise<Keypair>
Connects to a wallet using a private key
Parameters
- privateKey: string
  The private key of the wallet
Returns Promise<Keypair>
The wallet object
Implementation of SolanaDefaultChain.connectWallet
Overrides DefaultChain.connectWallet
- Defined in src/multichain/core/solana.ts:102

createWallet

createWallet(): Promise<{
    address: string;
    keypair: Keypair;
    secretKey: string;
}>
Returns Promise<{
    address: string;
    keypair: Keypair;
    secretKey: string;
}>
- Defined in src/multichain/core/solana.ts:92

disconnect

disconnect(): Promise<boolean>
Disconnects from the RPC provider and the wallet

Returns Promise<boolean>
A boolean indicating if the disconnection was successful
Implementation of SolanaDefaultChain.disconnect
Inherited from DefaultChain.disconnect
- Defined in src/multichain/core/types/defaultChain.ts:110

fetchAccount

fetchAccount(address, options): Promise<DecodeStruct<IdlTypeDefTyStruct, DecodedHelper<IdlTypeDef[], EmptyDefined>>>
Fetch the deserialized account from the network
Parameters
- address: Address
  The program address
- options: SolanaReadAccountDataOptions
  Options
Returns Promise<DecodeStruct<IdlTypeDefTyStruct, DecodedHelper<IdlTypeDef[], EmptyDefined>>>
The account data
Implementation of SolanaDefaultChain.fetchAccount
- Defined in src/multichain/core/solana.ts:253

getAddress

getAddress(): string
Returns the address of the connected wallet

Returns string
Implementation of SolanaDefaultChain.getAddress
Overrides DefaultChain.getAddress
- Defined in src/multichain/core/solana.ts:189

getBalance

getBalance(address): Promise<string>
Gets the balance of a wallet
Parameters
- address: string
  The wallet address
Returns Promise<string>
The balance of the wallet as a string
Implementation of SolanaDefaultChain.getBalance
Overrides DefaultChain.getBalance
- Defined in src/multichain/core/solana.ts:108

getEmptyTransaction

getEmptyTransaction(): VersionedTransaction
Creates a skeleton transaction

Returns VersionedTransaction
Implementation of SolanaDefaultChain.getEmptyTransaction
Overrides DefaultChain.getEmptyTransaction
- Defined in src/multichain/core/solana.ts:194

getProgramIdl

getProgramIdl(programId): Promise<Idl>
Fetch the IDL from the network
Parameters
- programId: Address
  The program address
Returns Promise<Idl>
The IDL of the program
Implementation of SolanaDefaultChain.getProgramIdl
- Defined in src/multichain/core/solana.ts:244

preparePay

preparePay(receiver, amount, options?): Promise<Uint8Array<ArrayBufferLike>>
Alias
Creates a signed transaction to transfer default chain currency
Parameters
- receiver: string
  The receiver's address
- amount: string
  The amount to transfer
- Optionaloptions: SignTxOptions
  Options
Returns Promise<Uint8Array<ArrayBufferLike>>
The signed transaction

prepareTransfer
Implementation of SolanaDefaultChain.preparePay
Overrides DefaultChain.preparePay
- Defined in src/multichain/core/solana.ts:204

preparePays

preparePays(payments, options?): Promise<Uint8Array<ArrayBufferLike>[]>
Creates a list of signed transactions to transfer default chain currency
Parameters
- payments: IPayOptions[]
  A list of transfers to prepare
- Optionaloptions: SignTxOptions
  Options
Returns Promise<Uint8Array<ArrayBufferLike>[]>
An ordered list of signed transactions
Implementation of SolanaDefaultChain.preparePays
Overrides DefaultChain.preparePays
- Defined in src/multichain/core/solana.ts:216

prepareTransfer

prepareTransfer<T, Options>(this, receiver, amount, options?): Promise<Awaited<ReturnType<T["preparePays"]>>[number]>
Creates a signed transaction to transfer default chain currency
Type Parameters
- T extends DefaultChain
- Options extends {}
Parameters
- this: T
- receiver: string
  The receiver's address
- amount: string
  The amount to transfer
- Optionaloptions: Options
  Options
Returns Promise<Awaited<ReturnType<T["preparePays"]>>[number]>
The signed transaction
Implementation of SolanaDefaultChain.prepareTransfer
Inherited from DefaultChain.prepareTransfer
- Defined in src/multichain/core/types/defaultChain.ts:75

prepareTransfers

prepareTransfers<T, Options>(this, payments, options?): Promise<Awaited<ReturnType<T["preparePays"]>>>
Creatthis.provider = new JsonRpcProvider(this.rpc_url)es a list of signed transactions to transfer default chain currency
Type Parameters
- T extends DefaultChain
- Options extends {}
Parameters
- this: T
- payments: IPayOptions[]
  A list of transfers to prepare
- Optionaloptions: Options
  Options
Returns Promise<Awaited<ReturnType<T["preparePays"]>>>
An ordered list of signed transactions
Implementation of SolanaDefaultChain.prepareTransfers
Inherited from DefaultChain.prepareTransfers
- Defined in src/multichain/core/types/defaultChain.ts:93

runAnchorProgram

runAnchorProgram(programId, params): Promise<Buffer<ArrayBufferLike>>
Parameters
- programId: string
- params: SolanarunProgramParams
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/multichain/core/solana.ts:282

runRawProgram

runRawProgram(programId, params): Promise<Buffer<ArrayBufferLike>>
Parameters
- programId: Address
- params: SolanaRunRawProgramParams
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/multichain/core/solana.ts:320

setRpc

setRpc(rpc_url): void
Sets the RPC URL only. Use await instance.connect() to connect to the rpc provider
Parameters
- rpc_url: string
Returns void
Implementation of SolanaDefaultChain.setRpc
Overrides DefaultChain.setRpc
- Defined in src/multichain/core/solana.ts:69

signMessage

signMessage(message, options?): Promise<string>
Signs a message using the connected wallet
Parameters
- message: string
  The message to sign
- Optionaloptions: {
  privateKey?: string;
  }
  Options
  - OptionalprivateKey?: string
Returns Promise<string>
The signed message
Implementation of SolanaDefaultChain.signMessage
Overrides DefaultChain.signMessage
- Defined in src/multichain/core/solana.ts:115

signTransaction

signTransaction(tx, options?): Promise<Uint8Array<ArrayBufferLike>>
Signs a transaction using the connected wallet
Parameters
- tx: VersionedTransaction
  The transaction to sign
- Optionaloptions: SignTxOptions
  Options
Returns Promise<Uint8Array<ArrayBufferLike>>
The signed transaction
Implementation of SolanaDefaultChain.signTransaction
Overrides DefaultChain.signTransaction
- Defined in src/multichain/core/solana.ts:155

signTransactions

signTransactions(transactions, options?): Promise<Uint8Array<ArrayBufferLike>[]>
Signs a list of transactions using the connected wallet. The transaction nonce is incremented for each transaction in order of appearance.
Parameters
- transactions: VersionedTransaction[]
  A list of transactions to sign
- Optionaloptions: SignTxOptions
  Options
Returns Promise<Uint8Array<ArrayBufferLike>[]>
Implementation of SolanaDefaultChain.signTransactions
Overrides DefaultChain.signTransactions
- Defined in src/multichain/core/solana.ts:167

verifyMessage

verifyMessage(message, signature, publicKey): Promise<boolean>
Verifies a message using the connected wallet
Parameters
- message: string
  The message to verify
- signature: string
  The signature to verify
- publicKey: string
Returns Promise<boolean>
A boolean indicating if the message was verified
Implementation of SolanaDefaultChain.verifyMessage
Overrides DefaultChain.verifyMessage
- Defined in src/multichain/core/solana.ts:137

`Static`create

create<T>(this, rpc_url?): Promise<T>
Creates a new instance of this sdk
Type Parameters
- T extends DefaultChain
Parameters
- this: (new (rpc_url: string) => T)
  - - new (rpc_url): T
    - Parameters
      rpc_url: string
      Returns T
- rpc_url: string = ""
  The RPC URL
Returns Promise<T>
The sdk instance connected to the RPC provider
Inherited from DefaultChain.create
- Defined in src/multichain/core/types/defaultChain.ts:43

`Static`createInstance

createInstance(rpc_url): xmcore.SOLANA
Parameters
- rpc_url: string
Returns xmcore.SOLANA
- Defined in src/multichain/core/solana.ts:373

`Static`getInstance

getInstance(): boolean | xmcore.SOLANA
Returns boolean | xmcore.SOLANA
- Defined in src/multichain/core/solana.ts:366

Class SOLANA

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns xmcore.SOLANA

Properties

connected

name

provider

rpc_url

signer

wallet

Methods

connect

Returns Promise<boolean>

connectWallet

Parameters

Returns Promise<Keypair>

createWallet

Returns Promise<{ address: string; keypair: Keypair; secretKey: string; }>

disconnect

Returns Promise<boolean>

fetchAccount

Parameters

Returns Promise<DecodeStruct<IdlTypeDefTyStruct, DecodedHelper<IdlTypeDef[], EmptyDefined>>>

getAddress

Returns string

getBalance

Parameters

Returns Promise<string>

getEmptyTransaction

Returns VersionedTransaction

getProgramIdl

Parameters

Returns Promise<Idl>

preparePay

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

preparePays

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>[]>

prepareTransfer

Type Parameters

Parameters

Returns Promise<Awaited<ReturnType<T["preparePays"]>>[number]>

prepareTransfers

Type Parameters

Parameters

Returns Promise<Awaited<ReturnType<T["preparePays"]>>>

runAnchorProgram

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

runRawProgram

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

setRpc

Parameters

Returns void

signMessage

Parameters

OptionalprivateKey?: string

Returns Promise<string>

signTransaction

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

signTransactions

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>[]>

verifyMessage

Parameters

Returns Promise<boolean>

Staticcreate

Type Parameters

Parameters

Returns Promise<{
address: string;
keypair: Keypair;
secretKey: string;
}>

`Optional`privateKey?: string

`Static`create

`Static`createInstance

`Static`getInstance