Class MULTIVERSX

Hierarchy (view full)

DefaultChain
- MULTIVERSX
  - xmlocalsdk.MULTIVERSX
  - xmwebsdk.MULTIVERSX

Constructors

constructor

new MULTIVERSX(rpc_url): xmcore.MULTIVERSX
Parameters
- rpc_url: string
Returns xmcore.MULTIVERSX
Overrides DefaultChain.constructor
- Defined in src/multichain/core/multiversx.ts:29

Properties

chainId

chainId: string = ""

connected

connected: boolean = false

name

name: string = ""

provider

provider: INetworkProvider

rpc_url

rpc_url: string = ""

signer

signer: any = null

wallet

wallet: UserSigner | ExtensionProvider

Methods

connect

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

Returns Promise<boolean>
A boolean indicating if the connection was successful
Overrides DefaultChain.connect
- Defined in src/multichain/core/multiversx.ts:43

connectKeyFileWallet

connectKeyFileWallet(keyFile, password): Promise<UserSigner>
Parameters
- keyFile: string
- password: string
Returns Promise<UserSigner>
- Defined in src/multichain/core/multiversx.ts:58

connectWallet

connectWallet(privateKey, options): Promise<UserSigner>
Connects to a wallet using a private key
Parameters
- privateKey: string
  The private key of the wallet
- options: {
  password: string;
  }
  - password: string
Returns Promise<UserSigner>
The wallet object
Overrides DefaultChain.connectWallet
- Defined in src/multichain/core/multiversx.ts:69

disconnect

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

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

getAddress

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

Returns string
Overrides DefaultChain.getAddress
- Defined in src/multichain/core/multiversx.ts:79

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
Overrides DefaultChain.getBalance
- Defined in src/multichain/core/multiversx.ts:87

getEmptyTransaction

getEmptyTransaction(): void
Creates a skeleton transaction

Returns void
Overrides DefaultChain.getEmptyTransaction
- Defined in src/multichain/core/multiversx.ts:234

getNFTs

getNFTs(): Promise<NonFungibleTokenOfAccountOnNetwork[]>
Returns Promise<NonFungibleTokenOfAccountOnNetwork[]>
- Defined in src/multichain/core/multiversx.ts:110

getTokenBalance

getTokenBalance(token_id): Promise<number>
Parameters
- token_id: string
Returns Promise<number>
- Defined in src/multichain/core/multiversx.ts:96

preparePay

preparePay(address, amount): Promise<IPlainTransactionObject>
Alias
Creates a signed transaction to transfer default chain currency
Parameters
- address: string
- amount: string
  The amount to transfer
Returns Promise<IPlainTransactionObject>
The signed transaction

prepareTransfer
Overrides DefaultChain.preparePay
- Defined in src/multichain/core/multiversx.ts:206

preparePays

preparePays(payments): Promise<IPlainTransactionObject[]>
Creates a list of signed transactions to transfer default chain currency
Parameters
- payments: IPayOptions[]
  A list of transfers to prepare
Returns Promise<IPlainTransactionObject[]>
An ordered list of signed transactions
Overrides DefaultChain.preparePays
- Defined in src/multichain/core/multiversx.ts:211

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

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

setRPC

setRPC(rpc_url): void
Parameters
- rpc_url: string
Returns void
- Defined in src/multichain/core/multiversx.ts:38

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

signTransaction

signTransaction(transaction, options): Promise<IPlainTransactionObject>
Signs a single transaction. Calls signTransactions with a single transaction and returns the first element of the result.
Parameters
- transaction: Transaction
- options: EGLDSignTxOptions
Returns Promise<IPlainTransactionObject>
The signed transaction as a plain object
Overrides DefaultChain.signTransaction
- Defined in src/multichain/core/multiversx.ts:143

signTransactions

signTransactions(transactions, options?): Promise<IPlainTransactionObject[]>
Signs multiple transactions
Parameters
- transactions: Transaction[]
- Optionaloptions: EGLDSignTxOptions
Returns Promise<IPlainTransactionObject[]>
The signed transactions as an array of plain objects
Overrides DefaultChain.signTransactions
- Defined in src/multichain/core/multiversx.ts:179

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

`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 MULTIVERSX

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns xmcore.MULTIVERSX

Properties

chainId

connected

name

provider

rpc_url

signer

wallet

Methods

connect

Returns Promise<boolean>

connectKeyFileWallet

Parameters

Returns Promise<UserSigner>

connectWallet

Parameters

password: string

Returns Promise<UserSigner>

disconnect

Returns Promise<boolean>

getAddress

Returns string

getBalance

Parameters

Returns Promise<string>

getEmptyTransaction

Returns void

getNFTs

Returns Promise<NonFungibleTokenOfAccountOnNetwork[]>

getTokenBalance

Parameters

Returns Promise<number>

preparePay

Parameters

Returns Promise<IPlainTransactionObject>

preparePays

Parameters

Returns Promise<IPlainTransactionObject[]>

prepareTransfer

Type Parameters

Parameters

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

prepareTransfers

Type Parameters

Parameters

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

setRpc

Parameters

Returns void

setRPC

Parameters

Returns void

signMessage

Parameters

OptionalprivateKey?: string

Returns Promise<string>

signTransaction

Parameters

Returns Promise<IPlainTransactionObject>

signTransactions

Parameters

Returns Promise<IPlainTransactionObject[]>

verifyMessage

Parameters

Returns Promise<boolean>

Staticcreate

Type Parameters

Parameters

Parameters

Returns T

`Optional`privateKey?: string

`Static`create