BaseSubstrateToolbox
BaseSubstrateToolbox(
__namedParameters):object
Defined in: packages/toolboxes/src/substrate/substrate.ts:206
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”ApiPromise
gasAsset
Section titled “gasAsset”AssetValue
network
Section titled “network”signer?
Section titled “signer?”Signer | IKeyringPair
Returns
Section titled “Returns”object
api:
ApiPromise
broadcast()
Section titled “broadcast()”broadcast: (
tx,callback?) =>Promise<string| () =>void>
Parameters
Section titled “Parameters”SubmittableExtrinsic<"promise">
callback?
Section titled “callback?”(result) => void | Promise<void>
Returns
Section titled “Returns”Promise<string | () => void>
convertAddress()
Section titled “convertAddress()”convertAddress: (
address,newPrefix) =>string
Parameters
Section titled “Parameters”address
Section titled “address”string
newPrefix
Section titled “newPrefix”number
Returns
Section titled “Returns”string
createKeyring()
Section titled “createKeyring()”createKeyring: (
phrase) =>Promise<KeyringPair>
Parameters
Section titled “Parameters”phrase
Section titled “phrase”string
Returns
Section titled “Returns”Promise<KeyringPair>
createTransaction()
Section titled “createTransaction()”createTransaction: (
params) =>undefined|SubmittableExtrinsic<"promise",ISubmittableResult>
Parameters
Section titled “Parameters”params
Section titled “params”GenericCreateTransactionParams
Returns
Section titled “Returns”undefined | SubmittableExtrinsic<"promise", ISubmittableResult>
decodeAddress()
Section titled “decodeAddress()”decodeAddress: (
address,networkPrefix?) =>Uint8Array<ArrayBufferLike>
Parameters
Section titled “Parameters”address
Section titled “address”string
networkPrefix?
Section titled “networkPrefix?”number
Returns
Section titled “Returns”Uint8Array<ArrayBufferLike>
encodeAddress()
Section titled “encodeAddress()”encodeAddress: (
address,encoding,networkPrefix?) =>string
Parameters
Section titled “Parameters”address
Section titled “address”Uint8Array
encoding
Section titled “encoding”"hex" | "ss58"
networkPrefix?
Section titled “networkPrefix?”number
Returns
Section titled “Returns”string
estimateTransactionFee()
Section titled “estimateTransactionFee()”estimateTransactionFee: (
params) =>Promise<undefined|AssetValue>
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<undefined | AssetValue>
gasAsset
Section titled “gasAsset”gasAsset:
AssetValue
getAddress()
Section titled “getAddress()”getAddress: (
keyring?) =>undefined|string
Parameters
Section titled “Parameters”keyring?
Section titled “keyring?”Signer | IKeyringPair
Returns
Section titled “Returns”undefined | string
getBalance()
Section titled “getBalance()”getBalance: (
address,scamFilter) =>Promise<AssetValue[]>
Parameters
Section titled “Parameters”address
Section titled “address”string
scamFilter
Section titled “scamFilter”boolean = true
Returns
Section titled “Returns”Promise<AssetValue[]>
network
Section titled “network”network:
SubstrateNetwork
sign()
Section titled “sign()”sign: (
tx) =>Promise<SubmittableExtrinsic<"promise",ISubmittableResult>>
Parameters
Section titled “Parameters”SubmittableExtrinsic<"promise">
Returns
Section titled “Returns”Promise<SubmittableExtrinsic<"promise", ISubmittableResult>>
signAndBroadcast()
Section titled “signAndBroadcast()”signAndBroadcast: (
__namedParameters) =>string|Promise<string> |Promise<() =>void>
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”address?
Section titled “address?”string
callback?
Section titled “callback?”(result) => void | Promise<void>
SubmittableExtrinsic<"promise">
Returns
Section titled “Returns”string | Promise<string> | Promise<() => void>
transfer()
Section titled “transfer()”transfer: (
params) =>Promise<undefined|string>
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<undefined | string>
validateAddress()
Section titled “validateAddress()”validateAddress: (
address) =>boolean
Parameters
Section titled “Parameters”address
Section titled “address”string
Returns
Section titled “Returns”boolean