Class IBC

Extension methods for IBC

Hierarchy (view full)

DefaultChain
- IBC
  - xmlocalsdk.IBC
  - xmwebsdk.IBC

Implements

IBCDefaultChain

Constructors

constructor

new IBC(rpc_url): xmcore.IBC
Parameters
- rpc_url: string
Returns xmcore.IBC
Overrides DefaultChain.constructor
- Defined in src/multichain/core/ibc.ts:39

Properties

address

address: string = ''

chainID

chainID: string = ''

connected

connected: boolean = false

gasPrice

gasPrice: string = ''

multiplier

multiplier: number = 2.0

name

name: string = ""

provider

provider: StargateClient

rpc_url

rpc_url: string = ""

signer

signer: DirectSecp256k1Wallet | DirectSecp256k1HdWallet

wallet

wallet: SigningStargateClient

Methods

connect

connect(rpc_url?): Promise<boolean>
Connects to the RPC provider
Parameters
- Optionalrpc_url: string
Returns Promise<boolean>
A boolean indicating if the connection was successful
Implementation of IBCDefaultChain.connect
Overrides DefaultChain.connect
- Defined in src/multichain/core/ibc.ts:54

connectWallet

connectWallet(privateKey, options, rpc_url?): Promise<SigningStargateClient>
Connects to a wallet using a private key
Parameters
- privateKey: string
  The private key of the wallet
- options: IBCConnectWalletOptions
- Optionalrpc_url: string
Returns Promise<SigningStargateClient>
The wallet object
Implementation of IBCDefaultChain.connectWallet
Overrides DefaultChain.connectWallet
- Defined in src/multichain/core/ibc.ts:71

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 IBCDefaultChain.disconnect
Overrides DefaultChain.disconnect
- Defined in src/multichain/core/ibc.ts:315

getAddress

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

Returns string
Implementation of IBCDefaultChain.getAddress
Overrides DefaultChain.getAddress
- Defined in src/multichain/core/ibc.ts:123

getBalance

getBalance(address, options): Promise<string>
Get the balance of the address
Parameters
- address: string
  The address
- options: IBCGetBalanceOptions
  Specify the denomination of the token
Returns Promise<string>
The balance of the address in the specified denomination
Implementation of IBCDefaultChain.getBalance
Overrides DefaultChain.getBalance
- Defined in src/multichain/core/ibc.ts:133

getEmptyTransaction

getEmptyTransaction(): IBCTransaction
Creates a skeleton transaction

Returns IBCTransaction
Implementation of IBCDefaultChain.getEmptyTransaction
Overrides DefaultChain.getEmptyTransaction
- Defined in src/multichain/core/ibc.ts:140

ibcSend

ibcSend(): Promise<void>
Returns Promise<void>
Implementation of IBCDefaultChain.ibcSend
- Defined in src/multichain/core/ibc.ts:323

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
- options: IBCPreparePayOptions
  Options
Returns Promise<Uint8Array<ArrayBufferLike>>
The signed transaction

prepareTransfer
Implementation of IBCDefaultChain.preparePay
Overrides DefaultChain.preparePay
- Defined in src/multichain/core/ibc.ts:159

preparePays

preparePays(payments, options): Promise<Uint8Array<ArrayBufferLike>[]>
Prepare multiple payments
Parameters
- payments: IPayOptions[]
  An array of payments
- options: IBCPreparePayOptions
  Specifies the denomination of the token
Returns Promise<Uint8Array<ArrayBufferLike>[]>
An array of signed transactions
Implementation of IBCDefaultChain.preparePays
Overrides DefaultChain.preparePays
- Defined in src/multichain/core/ibc.ts:178

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 IBCDefaultChain.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 IBCDefaultChain.prepareTransfers
Inherited from DefaultChain.prepareTransfers
- Defined in src/multichain/core/types/defaultChain.ts:93

setRpc

setRpc(rpc_url): Promise<void>
Sets the RPC URL only. Use await instance.connect() to connect to the rpc provider
Parameters
- rpc_url: string
Returns Promise<void>
Implementation of IBCDefaultChain.setRpc
Overrides DefaultChain.setRpc
- Defined in src/multichain/core/ibc.ts:48

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 IBCDefaultChain.signMessage
Overrides DefaultChain.signMessage
- Defined in src/multichain/core/ibc.ts:207

signTransaction

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

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: IBCTransaction[]
  A list of transactions to sign
- Optionaloptions: IBCSignTxOptions
  Options
Returns Promise<Uint8Array<ArrayBufferLike>[]>
Implementation of IBCDefaultChain.signTransactions
Overrides DefaultChain.signTransactions
- Defined in src/multichain/core/ibc.ts:256

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 IBCDefaultChain.verifyMessage
Overrides DefaultChain.verifyMessage
- Defined in src/multichain/core/ibc.ts:222

`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

Class IBC

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns xmcore.IBC

Properties

address

chainID

connected

gasPrice

multiplier

name

provider

rpc_url

signer

wallet

Methods

connect

Parameters

Returns Promise<boolean>

connectWallet

Parameters

Returns Promise<SigningStargateClient>

disconnect

Returns Promise<boolean>

getAddress

Returns string

getBalance

Parameters

Returns Promise<string>

getEmptyTransaction

Returns IBCTransaction

ibcSend

Returns Promise<void>

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"]>>>

setRpc

Parameters

Returns Promise<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

Parameters

Returns T

Returns Promise<T>

Settings

On This Page

`Optional`privateKey?: string

`Static`create