From e0499b6fc87f1815a279ef50be3d74763c507126 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 14 Nov 2023 13:35:01 +0000 Subject: [PATCH] chore(changeset): Bump version & Update docs --- docs/enums/AssetType.html | 4 ++-- docs/enums/SubstrateExplorer.html | 4 ++-- docs/enums/SubstrateWalletPlatform.html | 4 ++-- docs/enums/UseInkathonErrorCode.html | 4 ++-- docs/functions/accountArraysAreEqual.html | 2 +- docs/functions/accountsAreEqual.html | 2 +- docs/functions/checkIfBalanceSufficient.html | 2 +- docs/functions/contractCallDryRun.html | 2 +- docs/functions/contractQuery.html | 2 +- docs/functions/contractTx.html | 2 +- docs/functions/decodeOutput.html | 2 +- docs/functions/deployContract.html | 2 +- docs/functions/enableWallet.html | 2 +- docs/functions/formatBalance.html | 2 +- docs/functions/getAbiMessage.html | 2 +- docs/functions/getBalance.html | 2 +- docs/functions/getDeployment.html | 2 +- docs/functions/getDeploymentContract.html | 2 +- docs/functions/getExtrinsicErrorMessage.html | 2 +- docs/functions/getGasLimit.html | 2 +- docs/functions/getMaxGasLimit.html | 2 +- docs/functions/getNightlyConnectAdapter.html | 2 +- docs/functions/getPSP22Balances.html | 2 +- docs/functions/getSubstrateChain.html | 2 +- docs/functions/getSubstrateWallet.html | 2 +- docs/functions/initPolkadotJs.html | 2 +- docs/functions/isWalletInstalled.html | 2 +- docs/functions/parsePSP22Balance.html | 2 +- docs/functions/registerDeployment.html | 2 +- docs/functions/registerDeployments.html | 2 +- docs/functions/transferBalance.html | 2 +- docs/functions/transferFullBalance.html | 2 +- docs/functions/unwrapResultOrDefault.html | 2 +- docs/functions/unwrapResultOrError.html | 2 +- docs/functions/useBalance.html | 2 +- docs/functions/useContract.html | 2 +- docs/functions/useInkathon.html | 2 +- docs/functions/usePSP22Balances.html | 2 +- docs/functions/useRegisteredContract.html | 2 +- docs/functions/watchBalance.html | 2 +- docs/functions/watchPSP22Balances.html | 2 +- docs/interfaces/ChainAsset.html | 4 ++-- docs/interfaces/SubstrateChain.html | 4 ++-- docs/interfaces/SubstrateDeployment.html | 4 ++-- docs/interfaces/SubstrateWallet.html | 4 ++-- docs/interfaces/UseInkathonError.html | 4 ++-- docs/interfaces/UseInkathonProviderProps.html | 4 ++-- docs/types/BalanceData.html | 2 +- docs/types/BalanceFormatterOptions.html | 2 +- docs/types/ContractTxResult.html | 2 +- docs/types/ExstrinsicThrowErrorMessage.html | 2 +- docs/types/PSP22BalanceData.html | 2 +- docs/types/PolkadotBalanceFormatterOptions.html | 2 +- docs/types/TokenData.html | 2 +- docs/types/TransferBalanceResult.html | 2 +- docs/types/UseInkathonProviderContextType.html | 2 +- docs/variables/PSP22_TOKEN_BALANCE_SUBSCRIPTION_INTERVAL.html | 2 +- docs/variables/agungTestnet.html | 2 +- docs/variables/alephzero.html | 2 +- docs/variables/alephzeroSigner.html | 2 +- docs/variables/alephzeroTestnet.html | 2 +- docs/variables/allSubstrateChains.html | 2 +- docs/variables/allSubstrateWallets.html | 2 +- docs/variables/amplitude.html | 2 +- docs/variables/amplitudeTestnet.html | 2 +- docs/variables/astar.html | 2 +- docs/variables/bitCountryAlphaTestnet.html | 2 +- docs/variables/development.html | 2 +- docs/variables/khala.html | 2 +- docs/variables/nightly.html | 2 +- docs/variables/nightlyConnect.html | 2 +- docs/variables/nova.html | 2 +- docs/variables/pendulum.html | 2 +- docs/variables/phala.html | 2 +- docs/variables/phalaPOC5Testnet.html | 2 +- docs/variables/polkadotjs.html | 2 +- docs/variables/psp22Abi.html | 2 +- docs/variables/rococo.html | 2 +- docs/variables/shibuya.html | 2 +- docs/variables/shiden.html | 2 +- docs/variables/subwallet.html | 2 +- docs/variables/t0rnTestnet.html | 2 +- docs/variables/talisman.html | 2 +- 83 files changed, 93 insertions(+), 93 deletions(-) diff --git a/docs/enums/AssetType.html b/docs/enums/AssetType.html index 98d81f4..d187c95 100644 --- a/docs/enums/AssetType.html +++ b/docs/enums/AssetType.html @@ -1,3 +1,3 @@ -AssetType | @scio-labs/use-inkathon

Enumeration Members

PSP22 +AssetType | @scio-labs/use-inkathon

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

PSP22: "PSP22"
PSP34: "PSP34"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/SubstrateExplorer.html b/docs/enums/SubstrateExplorer.html index 3106e78..398a014 100644 --- a/docs/enums/SubstrateExplorer.html +++ b/docs/enums/SubstrateExplorer.html @@ -1,3 +1,3 @@ -SubstrateExplorer | @scio-labs/use-inkathon

Enumeration SubstrateExplorer

Enumeration Members

PolkadotJs +SubstrateExplorer | @scio-labs/use-inkathon

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

PolkadotJs: "polkadotjs"
Subscan: "subscan"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/SubstrateWalletPlatform.html b/docs/enums/SubstrateWalletPlatform.html index de8fbb0..8480df1 100644 --- a/docs/enums/SubstrateWalletPlatform.html +++ b/docs/enums/SubstrateWalletPlatform.html @@ -1,4 +1,4 @@ -SubstrateWalletPlatform | @scio-labs/use-inkathon

Enumeration SubstrateWalletPlatform

Enumeration Members

Android +SubstrateWalletPlatform | @scio-labs/use-inkathon

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

Android: "android"
Browser: "browser"
iOS: "ios"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/UseInkathonErrorCode.html b/docs/enums/UseInkathonErrorCode.html index 1cb9c66..0874a11 100644 --- a/docs/enums/UseInkathonErrorCode.html +++ b/docs/enums/UseInkathonErrorCode.html @@ -1,4 +1,4 @@ -UseInkathonErrorCode | @scio-labs/use-inkathon

Enumeration UseInkathonErrorCode

Enumeration Members

InitializationError +UseInkathonErrorCode | @scio-labs/use-inkathon

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

InitializationError: 0
NoAccountInjected: 2
NoSubstrateExtensionDetected: 1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/accountArraysAreEqual.html b/docs/functions/accountArraysAreEqual.html index 3c9b9a9..3fcd8b9 100644 --- a/docs/functions/accountArraysAreEqual.html +++ b/docs/functions/accountArraysAreEqual.html @@ -1,3 +1,3 @@ accountArraysAreEqual | @scio-labs/use-inkathon

Function accountArraysAreEqual

  • Returns true if both given arrays of injected accounts contain the same objects with the same addresses in the same order.

    -

    Parameters

    • a1: InjectedAccount[]
    • a2: InjectedAccount[]

    Returns boolean

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/accountsAreEqual.html b/docs/functions/accountsAreEqual.html index 20adee9..90db5fa 100644 --- a/docs/functions/accountsAreEqual.html +++ b/docs/functions/accountsAreEqual.html @@ -1,2 +1,2 @@ accountsAreEqual | @scio-labs/use-inkathon
  • Returns true if both given injected accounts have the same address.

    -

    Parameters

    • Optional a1: InjectedAccount
    • Optional a2: InjectedAccount

    Returns boolean

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/checkIfBalanceSufficient.html b/docs/functions/checkIfBalanceSufficient.html index 34f55c2..c76853b 100644 --- a/docs/functions/checkIfBalanceSufficient.html +++ b/docs/functions/checkIfBalanceSufficient.html @@ -1,3 +1,3 @@ checkIfBalanceSufficient | @scio-labs/use-inkathon

Function checkIfBalanceSufficient

  • Fetches the balance of the given address and returns a boolean whether this is zero or below an optionally passed minimum value.

    -

    Parameters

    • api: ApiPromise
    • account: string | IKeyringPair
    • Optional minBalance: string | number | bigint | BN

    Returns Promise<boolean>

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<boolean>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/contractCallDryRun.html b/docs/functions/contractCallDryRun.html index 292b5b9..dd1c2ef 100644 --- a/docs/functions/contractCallDryRun.html +++ b/docs/functions/contractCallDryRun.html @@ -1,3 +1,3 @@ contractCallDryRun | @scio-labs/use-inkathon
  • Performs a dry run for the given contract method and arguments. Is used within contractQuery & contractTx for gas estimation.

    -

    Parameters

    • api: ApiPromise
    • account: string | IKeyringPair
    • contract: ContractPromise
    • method: string
    • options: ContractOptions = ...
    • args: unknown[] = ...

    Returns Promise<ContractCallOutcome>

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<ContractCallOutcome>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/contractQuery.html b/docs/functions/contractQuery.html index a2b9860..c305883 100644 --- a/docs/functions/contractQuery.html +++ b/docs/functions/contractQuery.html @@ -1,2 +1,2 @@ contractQuery | @scio-labs/use-inkathon
  • Calls a given non-mutating contract method (query) with maximum possible gas limit.

    -

    Parameters

    • api: ApiPromise
    • address: string
    • contract: ContractPromise
    • method: string
    • options: ContractOptions = ...
    • args: unknown[] = ...

    Returns Promise<ContractCallOutcome>

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<ContractCallOutcome>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/contractTx.html b/docs/functions/contractTx.html index de4cd71..9b106ae 100644 --- a/docs/functions/contractTx.html +++ b/docs/functions/contractTx.html @@ -1 +1 @@ -contractTx | @scio-labs/use-inkathon
  • Parameters

    • api: ApiPromise
    • account: string | IKeyringPair
    • contract: ContractPromise
    • method: string
    • options: ContractOptions = ...
    • args: unknown[] = ...
    • Optional statusCb: ((result) => void | Promise<void>)
        • (result): void | Promise<void>
        • Parameters

          • result: ISubmittableResult

          Returns void | Promise<void>

    Returns Promise<ContractTxResult>

Generated using TypeDoc

\ No newline at end of file +contractTx | @scio-labs/use-inkathon
  • Parameters

    • api: ApiPromise
    • account: string | IKeyringPair
    • contract: ContractPromise
    • method: string
    • options: ContractOptions = ...
    • args: unknown[] = ...
    • Optional statusCb: ((result) => void | Promise<void>)
        • (result): void | Promise<void>
        • Parameters

          • result: ISubmittableResult

          Returns void | Promise<void>

    Returns Promise<ContractTxResult>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/decodeOutput.html b/docs/functions/decodeOutput.html index 7b87560..c7caaf7 100644 --- a/docs/functions/decodeOutput.html +++ b/docs/functions/decodeOutput.html @@ -1,4 +1,4 @@ decodeOutput | @scio-labs/use-inkathon
  • Decodes & unwraps outputs and errors of a given result, contract, and method. Parsed error message can be found in decodedOutput if isError is true. SOURCE: https://github.com/paritytech/contracts-ui (GPL-3.0-only)

    -

    Parameters

    • __namedParameters: Pick<ContractExecResult, "result" | "debugMessage">
    • contract: ContractPromise
    • method: string

    Returns {
        decodedOutput: string;
        isError: boolean;
        output: any;
    }

    • decodedOutput: string
    • isError: boolean
    • output: any

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns {
    decodedOutput: string;
    isError: boolean;
    output: any;
}

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/deployContract.html b/docs/functions/deployContract.html index 25c2c87..3fdc788 100644 --- a/docs/functions/deployContract.html +++ b/docs/functions/deployContract.html @@ -1,2 +1,2 @@ deployContract | @scio-labs/use-inkathon
  • Uploads & instantiates a contract on-chain.

    -

    Parameters

    • api: ApiPromise
    • account: string | IKeyringPair
    • abi: any
    • wasm: string | Uint8Array | Buffer
    • constructorMethod: string = 'new'
    • args: unknown[] = ...
    • options: ContractOptions = ...

    Returns Promise<{
        address: string;
        block: SignedBlock;
        blockNumber: number;
        hash: string;
    }>

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<{
    address: string;
    block: SignedBlock;
    blockNumber: number;
    hash: string;
}>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/enableWallet.html b/docs/functions/enableWallet.html index 1b1fc87..de478dc 100644 --- a/docs/functions/enableWallet.html +++ b/docs/functions/enableWallet.html @@ -1,2 +1,2 @@ enableWallet | @scio-labs/use-inkathon
  • Enables the given wallet (if existent) and returns the injected extension.

    -

    Parameters

    Returns Promise<undefined | InjectedExtension>

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<undefined | InjectedExtension>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/formatBalance.html b/docs/functions/formatBalance.html index c9ba67b..880e6aa 100644 --- a/docs/functions/formatBalance.html +++ b/docs/functions/formatBalance.html @@ -1,2 +1,2 @@ formatBalance | @scio-labs/use-inkathon

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/getAbiMessage.html b/docs/functions/getAbiMessage.html index abf8973..e2bb0ee 100644 --- a/docs/functions/getAbiMessage.html +++ b/docs/functions/getAbiMessage.html @@ -1,2 +1,2 @@ getAbiMessage | @scio-labs/use-inkathon
  • Returns the ABI message for the given method name within the given contract.

    -

    Parameters

    • contract: ContractPromise
    • method: string

    Returns AbiMessage

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns AbiMessage

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/getBalance.html b/docs/functions/getBalance.html index 4c66429..1ad146c 100644 --- a/docs/functions/getBalance.html +++ b/docs/functions/getBalance.html @@ -1,2 +1,2 @@ getBalance | @scio-labs/use-inkathon

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<BalanceData>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/getDeployment.html b/docs/functions/getDeployment.html index d642dbf..59e0ae8 100644 --- a/docs/functions/getDeployment.html +++ b/docs/functions/getDeployment.html @@ -1,3 +1,3 @@ getDeployment | @scio-labs/use-inkathon

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns undefined | SubstrateDeployment

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/getDeploymentContract.html b/docs/functions/getDeploymentContract.html index 681ba9f..1ca4c72 100644 --- a/docs/functions/getDeploymentContract.html +++ b/docs/functions/getDeploymentContract.html @@ -1,3 +1,3 @@ getDeploymentContract | @scio-labs/use-inkathon

Function getDeploymentContract

  • Takes the first matching deployment from the given deployments array with an equal contractId and networkId and creates a ContractPromise.

    -

    Parameters

    Returns undefined | ContractPromise

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns undefined | ContractPromise

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/getExtrinsicErrorMessage.html b/docs/functions/getExtrinsicErrorMessage.html index 28cd695..4162d07 100644 --- a/docs/functions/getExtrinsicErrorMessage.html +++ b/docs/functions/getExtrinsicErrorMessage.html @@ -1 +1 @@ -getExtrinsicErrorMessage | @scio-labs/use-inkathon

Function getExtrinsicErrorMessage

Generated using TypeDoc

\ No newline at end of file +getExtrinsicErrorMessage | @scio-labs/use-inkathon

Function getExtrinsicErrorMessage

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/getGasLimit.html b/docs/functions/getGasLimit.html index 80db254..0d5cf16 100644 --- a/docs/functions/getGasLimit.html +++ b/docs/functions/getGasLimit.html @@ -1,2 +1,2 @@ getGasLimit | @scio-labs/use-inkathon
  • Helper function that returns Weights V2 gasLimit object.

    -

    Parameters

    • api: ApiPromise
    • _refTime: string | BN
    • _proofSize: string | BN

    Returns WeightV2

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns WeightV2

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/getMaxGasLimit.html b/docs/functions/getMaxGasLimit.html index 1ec64f6..ff78be8 100644 --- a/docs/functions/getMaxGasLimit.html +++ b/docs/functions/getMaxGasLimit.html @@ -1,4 +1,4 @@ getMaxGasLimit | @scio-labs/use-inkathon
  • Helper function that returns the maximum gas limit Weights V2 object for an extrinsic based on the api chain constants. NOTE: It's reduced by a given factor (defaults to 80%) to avoid storage exhaust.

    -

    Parameters

    • api: ApiPromise
    • reductionFactor: number = 0.8

    Returns WeightV2

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns WeightV2

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/getNightlyConnectAdapter.html b/docs/functions/getNightlyConnectAdapter.html index d90f882..3dc045a 100644 --- a/docs/functions/getNightlyConnectAdapter.html +++ b/docs/functions/getNightlyConnectAdapter.html @@ -1 +1 @@ -getNightlyConnectAdapter | @scio-labs/use-inkathon

Function getNightlyConnectAdapter

  • Parameters

    • Optional appName: string
    • Optional appIcon: string
    • Optional appOrigin: string
    • persisted: boolean = true

    Returns Promise<any>

Generated using TypeDoc

\ No newline at end of file +getNightlyConnectAdapter | @scio-labs/use-inkathon

Function getNightlyConnectAdapter

  • Parameters

    • Optional appName: string
    • Optional appIcon: string
    • Optional appOrigin: string
    • persisted: boolean = true

    Returns Promise<any>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/getPSP22Balances.html b/docs/functions/getPSP22Balances.html index 7764b7a..05894cf 100644 --- a/docs/functions/getPSP22Balances.html +++ b/docs/functions/getPSP22Balances.html @@ -1,2 +1,2 @@ getPSP22Balances | @scio-labs/use-inkathon

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<PSP22BalanceData[]>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/getSubstrateChain.html b/docs/functions/getSubstrateChain.html index ce07cf9..c81c264 100644 --- a/docs/functions/getSubstrateChain.html +++ b/docs/functions/getSubstrateChain.html @@ -1,2 +1,2 @@ getSubstrateChain | @scio-labs/use-inkathon

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns undefined | SubstrateChain

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/getSubstrateWallet.html b/docs/functions/getSubstrateWallet.html index 0514aa2..6aed200 100644 --- a/docs/functions/getSubstrateWallet.html +++ b/docs/functions/getSubstrateWallet.html @@ -1,2 +1,2 @@ getSubstrateWallet | @scio-labs/use-inkathon

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns undefined | SubstrateWallet

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/initPolkadotJs.html b/docs/functions/initPolkadotJs.html index 23daef3..c901c1a 100644 --- a/docs/functions/initPolkadotJs.html +++ b/docs/functions/initPolkadotJs.html @@ -1,2 +1,2 @@ initPolkadotJs | @scio-labs/use-inkathon
  • Helper to initialize polkadot.js API with given chain and options.

    -

    Parameters

    Returns Promise<{
        api: ApiPromise;
        provider: WsProvider | HttpProvider;
    }>

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<{
    api: ApiPromise;
    provider: WsProvider | HttpProvider;
}>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/isWalletInstalled.html b/docs/functions/isWalletInstalled.html index 07e73fb..1958422 100644 --- a/docs/functions/isWalletInstalled.html +++ b/docs/functions/isWalletInstalled.html @@ -1 +1 @@ -isWalletInstalled | @scio-labs/use-inkathon

Generated using TypeDoc

\ No newline at end of file +isWalletInstalled | @scio-labs/use-inkathon

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/parsePSP22Balance.html b/docs/functions/parsePSP22Balance.html index cd91850..f9e9b8a 100644 --- a/docs/functions/parsePSP22Balance.html +++ b/docs/functions/parsePSP22Balance.html @@ -1,2 +1,2 @@ parsePSP22Balance | @scio-labs/use-inkathon

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/registerDeployment.html b/docs/functions/registerDeployment.html index e15cb94..dbf4f88 100644 --- a/docs/functions/registerDeployment.html +++ b/docs/functions/registerDeployment.html @@ -1,4 +1,4 @@ registerDeployment | @scio-labs/use-inkathon
  • Registering the given deployment with the given setDeployments dispatcher. The registry is kept unique, so if there is already one deployment with equal contractId and networkId it will be replaced.

    -

    Parameters

    Returns void

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/registerDeployments.html b/docs/functions/registerDeployments.html index 9ef5ae3..16fd4f0 100644 --- a/docs/functions/registerDeployments.html +++ b/docs/functions/registerDeployments.html @@ -1,2 +1,2 @@ registerDeployments | @scio-labs/use-inkathon

Function registerDeployments

  • Registers all given deployments via registerDeployment after awaiting the promise.

    -

    Parameters

    Returns Promise<void>

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<void>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/transferBalance.html b/docs/functions/transferBalance.html index 3cf724e..c4c4e60 100644 --- a/docs/functions/transferBalance.html +++ b/docs/functions/transferBalance.html @@ -1,2 +1,2 @@ transferBalance | @scio-labs/use-inkathon
  • Transfers a given amount of tokens from one account to another.

    -

    Parameters

    • api: ApiPromise
    • fromAccount: string | IKeyringPair
    • toAddress: string | AccountId
    • amount: string | number | bigint | BN
    • Optional allowDeath: boolean
    • Optional statusCb: ((result) => void | Promise<void>)
        • (result): void | Promise<void>
        • Parameters

          • result: ISubmittableResult

          Returns void | Promise<void>

    Returns Promise<TransferBalanceResult>

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<TransferBalanceResult>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/transferFullBalance.html b/docs/functions/transferFullBalance.html index 1eeb76d..b563683 100644 --- a/docs/functions/transferFullBalance.html +++ b/docs/functions/transferFullBalance.html @@ -1,2 +1,2 @@ transferFullBalance | @scio-labs/use-inkathon

Function transferFullBalance

  • Transfers all available tokens from one account to another.

    -

    Parameters

    • api: ApiPromise
    • fromAccount: string | IKeyringPair
    • toAddress: string | AccountId
    • Optional keepAlive: boolean
    • Optional statusCb: ((result) => void | Promise<void>)
        • (result): void | Promise<void>
        • Parameters

          • result: ISubmittableResult

          Returns void | Promise<void>

    Returns Promise<TransferBalanceResult>

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<TransferBalanceResult>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/unwrapResultOrDefault.html b/docs/functions/unwrapResultOrDefault.html index 3f2a7cc..2398957 100644 --- a/docs/functions/unwrapResultOrDefault.html +++ b/docs/functions/unwrapResultOrDefault.html @@ -1,2 +1,2 @@ unwrapResultOrDefault | @scio-labs/use-inkathon

Function unwrapResultOrDefault

  • Unwraps a Weights V2 result type or returns the given default if there is no 'ok' value.

    -

    Type Parameters

    • T = any

    Parameters

    • outcome: Pick<ContractCallOutcome, "result" | "output">
    • defaultValue: T

    Returns T

Generated using TypeDoc

\ No newline at end of file +

Type Parameters

Parameters

Returns T

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/unwrapResultOrError.html b/docs/functions/unwrapResultOrError.html index 9dc087b..1840054 100644 --- a/docs/functions/unwrapResultOrError.html +++ b/docs/functions/unwrapResultOrError.html @@ -1,2 +1,2 @@ unwrapResultOrError | @scio-labs/use-inkathon

Function unwrapResultOrError

  • Unwraps a Weights V2 result type or errors if there is no 'ok' value.

    -

    Type Parameters

    • T = any

    Parameters

    • outcome: Pick<ContractCallOutcome, "result" | "output">

    Returns T

Generated using TypeDoc

\ No newline at end of file +

Type Parameters

Parameters

Returns T

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/useBalance.html b/docs/functions/useBalance.html index 34d2d7c..a7ed643 100644 --- a/docs/functions/useBalance.html +++ b/docs/functions/useBalance.html @@ -1,2 +1,2 @@ useBalance | @scio-labs/use-inkathon

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns BalanceData

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/useContract.html b/docs/functions/useContract.html index b461535..e20246e 100644 --- a/docs/functions/useContract.html +++ b/docs/functions/useContract.html @@ -1,3 +1,3 @@ useContract | @scio-labs/use-inkathon
  • React Hook that returns a ContractPromise object configured with the active api & chain as well as the given abi and address.

    -

    Parameters

    • Optional abi: string | Record<string, unknown> | Abi
    • Optional address: string | AccountId

    Returns {
        address: undefined | string | AccountId;
        contract: undefined | ContractPromise;
    }

    • address: undefined | string | AccountId
    • contract: undefined | ContractPromise

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns {
    address: undefined | string | AccountId;
    contract: undefined | ContractPromise;
}

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/useInkathon.html b/docs/functions/useInkathon.html index 3364d7f..6a37d8c 100644 --- a/docs/functions/useInkathon.html +++ b/docs/functions/useInkathon.html @@ -1,2 +1,2 @@ useInkathon | @scio-labs/use-inkathon

Generated using TypeDoc

\ No newline at end of file +

Returns UseInkathonProviderContextType

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/usePSP22Balances.html b/docs/functions/usePSP22Balances.html index 180c8fb..0c4bb28 100644 --- a/docs/functions/usePSP22Balances.html +++ b/docs/functions/usePSP22Balances.html @@ -1,2 +1,2 @@ usePSP22Balances | @scio-labs/use-inkathon

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns PSP22BalanceData[]

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/useRegisteredContract.html b/docs/functions/useRegisteredContract.html index 71f344f..24a73e3 100644 --- a/docs/functions/useRegisteredContract.html +++ b/docs/functions/useRegisteredContract.html @@ -1,4 +1,4 @@ useRegisteredContract | @scio-labs/use-inkathon

Function useRegisteredContract

  • React Hook that returns a ContractPromise object configured with the active api & chain as well as the given deployment contract id which is looked up from the deployments registry.

    -

    Parameters

    • contractId: string
    • Optional networkId: string

    Returns {
        address: undefined | string | AccountId;
        contract: undefined | ContractPromise;
    }

    • address: undefined | string | AccountId
    • contract: undefined | ContractPromise

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns {
    address: undefined | string | AccountId;
    contract: undefined | ContractPromise;
}

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/watchBalance.html b/docs/functions/watchBalance.html index 837e027..5b14603 100644 --- a/docs/functions/watchBalance.html +++ b/docs/functions/watchBalance.html @@ -1,3 +1,3 @@ watchBalance | @scio-labs/use-inkathon
  • Watches the native token balance of the given address and returns it in a callback. The returned void function can be used to unsubscribe.

    -

    Parameters

    • api: ApiPromise
    • address: undefined | string | AccountId
    • callback: ((data) => void)
    • Optional formatterOptions: BalanceFormatterOptions

    Returns Promise<null | VoidFunction>

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<null | VoidFunction>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/watchPSP22Balances.html b/docs/functions/watchPSP22Balances.html index 005d577..97b1837 100644 --- a/docs/functions/watchPSP22Balances.html +++ b/docs/functions/watchPSP22Balances.html @@ -1,3 +1,3 @@ watchPSP22Balances | @scio-labs/use-inkathon
  • Watches the PSP-22 token balances of the given address and returns it in a callback. The returned void function can be used to unsubscribe.

    -

    Parameters

    Returns null | VoidFunction

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns null | VoidFunction

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/ChainAsset.html b/docs/interfaces/ChainAsset.html index 185c4ff..efc3ea9 100644 --- a/docs/interfaces/ChainAsset.html +++ b/docs/interfaces/ChainAsset.html @@ -1,4 +1,4 @@ -ChainAsset | @scio-labs/use-inkathon

Hierarchy

  • ChainAsset

Properties

assetType +ChainAsset | @scio-labs/use-inkathon

Generated using TypeDoc

\ No newline at end of file +

Properties

assetType: AssetType
decimals: number
iconPath: string
metadata: null | Record<any, any>
name: string
originChain: string
slug: string
symbol: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/SubstrateChain.html b/docs/interfaces/SubstrateChain.html index c5649b4..294f6f1 100644 --- a/docs/interfaces/SubstrateChain.html +++ b/docs/interfaces/SubstrateChain.html @@ -1,9 +1,9 @@ SubstrateChain | @scio-labs/use-inkathon

Substrate Chain Type

-

Hierarchy

  • SubstrateChain

Properties

Hierarchy

  • SubstrateChain

Properties

explorerUrls?: Partial<Record<SubstrateExplorer, string>>
faucetUrls?: string[]
name: string
network: string
rpcUrls: [string, ...string[]]
ss58Prefix?: number
testnet?: boolean

Generated using TypeDoc

\ No newline at end of file +

Properties

explorerUrls?: Partial<Record<SubstrateExplorer, string>>
faucetUrls?: string[]
name: string
network: string
rpcUrls: [string, ...string[]]
ss58Prefix?: number
testnet?: boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/SubstrateDeployment.html b/docs/interfaces/SubstrateDeployment.html index af4c3dd..983f48e 100644 --- a/docs/interfaces/SubstrateDeployment.html +++ b/docs/interfaces/SubstrateDeployment.html @@ -1,5 +1,5 @@ -SubstrateDeployment | @scio-labs/use-inkathon

Interface SubstrateDeployment

Hierarchy

  • SubstrateDeployment

Properties

abi +SubstrateDeployment | @scio-labs/use-inkathon

Generated using TypeDoc

\ No newline at end of file +

Properties

abi: string | Record<string, unknown> | Abi
address: string | AccountId
contractId: string
networkId: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/SubstrateWallet.html b/docs/interfaces/SubstrateWallet.html index c25f1e8..5822d94 100644 --- a/docs/interfaces/SubstrateWallet.html +++ b/docs/interfaces/SubstrateWallet.html @@ -1,6 +1,6 @@ -SubstrateWallet | @scio-labs/use-inkathon

Hierarchy

  • SubstrateWallet

Properties

id +SubstrateWallet | @scio-labs/use-inkathon

Hierarchy

  • SubstrateWallet

Properties

id: string
logoUrls: [string, ...string[]]
name: string
urls: {
    androidApp?: string;
    chromeExtension?: string;
    firefoxExtension?: string;
    iosApp?: string;
    website: string;
}

Type declaration

  • Optional androidApp?: string
  • Optional chromeExtension?: string
  • Optional firefoxExtension?: string
  • Optional iosApp?: string
  • website: string

Generated using TypeDoc

\ No newline at end of file +

Properties

id: string
logoUrls: [string, ...string[]]
name: string
urls: {
    androidApp?: string;
    chromeExtension?: string;
    firefoxExtension?: string;
    iosApp?: string;
    website: string;
}

Type declaration

  • Optional androidApp?: string
  • Optional chromeExtension?: string
  • Optional firefoxExtension?: string
  • Optional iosApp?: string
  • website: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/UseInkathonError.html b/docs/interfaces/UseInkathonError.html index 113b487..5466c04 100644 --- a/docs/interfaces/UseInkathonError.html +++ b/docs/interfaces/UseInkathonError.html @@ -1,3 +1,3 @@ -UseInkathonError | @scio-labs/use-inkathon

Interface UseInkathonError

Hierarchy

  • UseInkathonError

Properties

code +UseInkathonError | @scio-labs/use-inkathon

Generated using TypeDoc

\ No newline at end of file +

Properties

message: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/UseInkathonProviderProps.html b/docs/interfaces/UseInkathonProviderProps.html index 6990c5f..4ce2e28 100644 --- a/docs/interfaces/UseInkathonProviderProps.html +++ b/docs/interfaces/UseInkathonProviderProps.html @@ -1,9 +1,9 @@ UseInkathonProviderProps | @scio-labs/use-inkathon

Interface UseInkathonProviderProps

Main provider that needs to be wrapped around the app (see README) to use useInkathon and other hooks anywhere.

-

Hierarchy

  • PropsWithChildren
    • UseInkathonProviderProps

Properties

Hierarchy

  • PropsWithChildren
    • UseInkathonProviderProps

Properties

apiOptions?: ApiOptions
appName: string
children?: ReactNode
connectOnInit?: boolean
defaultChain: string | SubstrateChain
deployments?: Promise<SubstrateDeployment[]>

Generated using TypeDoc

\ No newline at end of file +

Properties

apiOptions?: ApiOptions
appName: string
children?: ReactNode
connectOnInit?: boolean
defaultChain: string | SubstrateChain
deployments?: Promise<SubstrateDeployment[]>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/BalanceData.html b/docs/types/BalanceData.html index f1ae8ff..2b19a01 100644 --- a/docs/types/BalanceData.html +++ b/docs/types/BalanceData.html @@ -1 +1 @@ -BalanceData | @scio-labs/use-inkathon
BalanceData: {
    balance?: BN;
    balanceFormatted?: string;
    freeBalance?: BN;
    freeBalanceFormatted?: string;
    reducibleBalance?: BN;
    reducibleBalanceFormatted?: string;
    reservedBalance?: BN;
    reservedBalanceFormatted?: string;
    tokenDecimals: number;
    tokenSymbol: string;
}

Type declaration

  • Optional balance?: BN
  • Optional balanceFormatted?: string
  • Optional freeBalance?: BN
  • Optional freeBalanceFormatted?: string
  • Optional reducibleBalance?: BN
  • Optional reducibleBalanceFormatted?: string
  • Optional reservedBalance?: BN
  • Optional reservedBalanceFormatted?: string
  • tokenDecimals: number
  • tokenSymbol: string

Generated using TypeDoc

\ No newline at end of file +BalanceData | @scio-labs/use-inkathon
BalanceData: {
    balance?: BN;
    balanceFormatted?: string;
    freeBalance?: BN;
    freeBalanceFormatted?: string;
    reducibleBalance?: BN;
    reducibleBalanceFormatted?: string;
    reservedBalance?: BN;
    reservedBalanceFormatted?: string;
    tokenDecimals: number;
    tokenSymbol: string;
}

Type declaration

  • Optional balance?: BN
  • Optional balanceFormatted?: string
  • Optional freeBalance?: BN
  • Optional freeBalanceFormatted?: string
  • Optional reducibleBalance?: BN
  • Optional reducibleBalanceFormatted?: string
  • Optional reservedBalance?: BN
  • Optional reservedBalanceFormatted?: string
  • tokenDecimals: number
  • tokenSymbol: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/BalanceFormatterOptions.html b/docs/types/BalanceFormatterOptions.html index d7c6897..b3f4a9d 100644 --- a/docs/types/BalanceFormatterOptions.html +++ b/docs/types/BalanceFormatterOptions.html @@ -1 +1 @@ -BalanceFormatterOptions | @scio-labs/use-inkathon

Type alias BalanceFormatterOptions

BalanceFormatterOptions: Omit<PolkadotBalanceFormatterOptions, "forceUnit" | "withZero"> & {
    fixedDecimals?: number;
    forceUnit?: string | false;
    removeTrailingZeros?: boolean;
}

Type declaration

  • Optional fixedDecimals?: number
  • Optional forceUnit?: string | false
  • Optional removeTrailingZeros?: boolean

Generated using TypeDoc

\ No newline at end of file +BalanceFormatterOptions | @scio-labs/use-inkathon

Type alias BalanceFormatterOptions

BalanceFormatterOptions: Omit<PolkadotBalanceFormatterOptions, "forceUnit" | "withZero"> & {
    fixedDecimals?: number;
    forceUnit?: string | false;
    removeTrailingZeros?: boolean;
}

Type declaration

  • Optional fixedDecimals?: number
  • Optional forceUnit?: string | false
  • Optional removeTrailingZeros?: boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/ContractTxResult.html b/docs/types/ContractTxResult.html index 27c5b8e..3c49e4a 100644 --- a/docs/types/ContractTxResult.html +++ b/docs/types/ContractTxResult.html @@ -1,3 +1,3 @@ ContractTxResult | @scio-labs/use-inkathon

Type alias ContractTxResult

ContractTxResult: {
    blockHash?: string;
    dryResult: ContractCallOutcome;
    errorEvent?: EventRecord;
    errorMessage?: ReturnType<typeof getExtrinsicErrorMessage> | "ExtrinsicFailed";
    extrinsicHash?: string;
    extrinsicIndex?: number;
    result?: ISubmittableResult;
    successEvent?: EventRecord;
}

Calls a given mutating contract method (tx) and wraps it in a promise. Before, a dry run is performed to determine the required gas & potential errors.

-

Type declaration

  • Optional blockHash?: string
  • dryResult: ContractCallOutcome
  • Optional errorEvent?: EventRecord
  • Optional errorMessage?: ReturnType<typeof getExtrinsicErrorMessage> | "ExtrinsicFailed"
  • Optional extrinsicHash?: string
  • Optional extrinsicIndex?: number
  • Optional result?: ISubmittableResult
  • Optional successEvent?: EventRecord

Generated using TypeDoc

\ No newline at end of file +

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/ExstrinsicThrowErrorMessage.html b/docs/types/ExstrinsicThrowErrorMessage.html index 22a5954..2066f1f 100644 --- a/docs/types/ExstrinsicThrowErrorMessage.html +++ b/docs/types/ExstrinsicThrowErrorMessage.html @@ -1,2 +1,2 @@ ExstrinsicThrowErrorMessage | @scio-labs/use-inkathon

Type alias ExstrinsicThrowErrorMessage

ExstrinsicThrowErrorMessage: "UserCancelled" | "TokenBelowMinimum" | "Error"

Decodes the error message from an extrinsic's error event.

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/PSP22BalanceData.html b/docs/types/PSP22BalanceData.html index 8f58394..49d3c58 100644 --- a/docs/types/PSP22BalanceData.html +++ b/docs/types/PSP22BalanceData.html @@ -1 +1 @@ -PSP22BalanceData | @scio-labs/use-inkathon

Type alias PSP22BalanceData

PSP22BalanceData: {
    balance?: BN;
    balanceFormatted?: string;
    iconPath: string;
    tokenDecimals: number;
    tokenSlug: string;
    tokenSymbol: string;
}

Type declaration

  • Optional balance?: BN
  • Optional balanceFormatted?: string
  • iconPath: string
  • tokenDecimals: number
  • tokenSlug: string
  • tokenSymbol: string

Generated using TypeDoc

\ No newline at end of file +PSP22BalanceData | @scio-labs/use-inkathon

Type alias PSP22BalanceData

PSP22BalanceData: {
    balance?: BN;
    balanceFormatted?: string;
    iconPath: string;
    tokenDecimals: number;
    tokenSlug: string;
    tokenSymbol: string;
}

Type declaration

  • Optional balance?: BN
  • Optional balanceFormatted?: string
  • iconPath: string
  • tokenDecimals: number
  • tokenSlug: string
  • tokenSymbol: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/PolkadotBalanceFormatterOptions.html b/docs/types/PolkadotBalanceFormatterOptions.html index 21e195a..32f7da8 100644 --- a/docs/types/PolkadotBalanceFormatterOptions.html +++ b/docs/types/PolkadotBalanceFormatterOptions.html @@ -1 +1 @@ -PolkadotBalanceFormatterOptions | @scio-labs/use-inkathon

Type alias PolkadotBalanceFormatterOptions

PolkadotBalanceFormatterOptions: NonNullable<Parameters<typeof polkadotFormatBalance>["1"]>

Generated using TypeDoc

\ No newline at end of file +PolkadotBalanceFormatterOptions | @scio-labs/use-inkathon

Type alias PolkadotBalanceFormatterOptions

PolkadotBalanceFormatterOptions: NonNullable<Parameters<typeof polkadotFormatBalance>["1"]>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/TokenData.html b/docs/types/TokenData.html index 514fdb0..e6fd6a4 100644 --- a/docs/types/TokenData.html +++ b/docs/types/TokenData.html @@ -1 +1 @@ -TokenData | @scio-labs/use-inkathon
TokenData: {
    tokenDecimals: number;
    tokenSymbol: string;
}

Type declaration

  • tokenDecimals: number
  • tokenSymbol: string

Generated using TypeDoc

\ No newline at end of file +TokenData | @scio-labs/use-inkathon
TokenData: {
    tokenDecimals: number;
    tokenSymbol: string;
}

Type declaration

  • tokenDecimals: number
  • tokenSymbol: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/TransferBalanceResult.html b/docs/types/TransferBalanceResult.html index 8596036..71401e2 100644 --- a/docs/types/TransferBalanceResult.html +++ b/docs/types/TransferBalanceResult.html @@ -1 +1 @@ -TransferBalanceResult | @scio-labs/use-inkathon

Type alias TransferBalanceResult

TransferBalanceResult: {
    errorEvent?: EventRecord;
    errorMessage?: ExstrinsicThrowErrorMessage | "ExtrinsicFailed";
    result?: ISubmittableResult;
}

Type declaration

  • Optional errorEvent?: EventRecord
  • Optional errorMessage?: ExstrinsicThrowErrorMessage | "ExtrinsicFailed"
  • Optional result?: ISubmittableResult

Generated using TypeDoc

\ No newline at end of file +TransferBalanceResult | @scio-labs/use-inkathon

Type alias TransferBalanceResult

TransferBalanceResult: {
    errorEvent?: EventRecord;
    errorMessage?: ExstrinsicThrowErrorMessage | "ExtrinsicFailed";
    result?: ISubmittableResult;
}

Type declaration

  • Optional errorEvent?: EventRecord
  • Optional errorMessage?: ExstrinsicThrowErrorMessage | "ExtrinsicFailed"
  • Optional result?: ISubmittableResult

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/UseInkathonProviderContextType.html b/docs/types/UseInkathonProviderContextType.html index bead303..f052c1e 100644 --- a/docs/types/UseInkathonProviderContextType.html +++ b/docs/types/UseInkathonProviderContextType.html @@ -1 +1 @@ -UseInkathonProviderContextType | @scio-labs/use-inkathon

Type alias UseInkathonProviderContextType

UseInkathonProviderContextType: {
    accounts?: InjectedAccount[];
    activeAccount?: InjectedAccount;
    activeChain?: SubstrateChain;
    activeExtension?: InjectedExtension;
    activeSigner?: Signer;
    api?: ApiPromise;
    connect?: ((chain?, wallet?, lastActiveAccountAddress?) => Promise<void>);
    deployments?: SubstrateDeployment[];
    disconnect?: (() => void);
    error?: UseInkathonError;
    isConnected?: boolean;
    isConnecting?: boolean;
    isInitialized?: boolean;
    isInitializing?: boolean;
    lastActiveAccount?: InjectedAccount;
    provider?: WsProvider | HttpProvider;
    setActiveAccount?: Dispatch<SetStateAction<InjectedAccount | undefined>>;
    switchActiveChain?: ((chain) => Promise<void>);
}

Type declaration

  • Optional accounts?: InjectedAccount[]
  • Optional activeAccount?: InjectedAccount
  • Optional activeChain?: SubstrateChain
  • Optional activeExtension?: InjectedExtension
  • Optional activeSigner?: Signer
  • Optional api?: ApiPromise
  • Optional connect?: ((chain?, wallet?, lastActiveAccountAddress?) => Promise<void>)
      • (chain?, wallet?, lastActiveAccountAddress?): Promise<void>
      • Parameters

        Returns Promise<void>

  • Optional deployments?: SubstrateDeployment[]
  • Optional disconnect?: (() => void)
      • (): void
      • Returns void

  • Optional error?: UseInkathonError
  • Optional isConnected?: boolean
  • Optional isConnecting?: boolean
  • Optional isInitialized?: boolean
  • Optional isInitializing?: boolean
  • Optional lastActiveAccount?: InjectedAccount
  • Optional provider?: WsProvider | HttpProvider
  • Optional setActiveAccount?: Dispatch<SetStateAction<InjectedAccount | undefined>>
  • Optional switchActiveChain?: ((chain) => Promise<void>)
      • (chain): Promise<void>
      • Parameters

        Returns Promise<void>

Generated using TypeDoc

\ No newline at end of file +UseInkathonProviderContextType | @scio-labs/use-inkathon

Type alias UseInkathonProviderContextType

UseInkathonProviderContextType: {
    accounts?: InjectedAccount[];
    activeAccount?: InjectedAccount;
    activeChain?: SubstrateChain;
    activeExtension?: InjectedExtension;
    activeSigner?: Signer;
    api?: ApiPromise;
    connect?: ((chain?, wallet?, lastActiveAccountAddress?) => Promise<void>);
    deployments?: SubstrateDeployment[];
    disconnect?: (() => void);
    error?: UseInkathonError;
    isConnected?: boolean;
    isConnecting?: boolean;
    isInitialized?: boolean;
    isInitializing?: boolean;
    lastActiveAccount?: InjectedAccount;
    provider?: WsProvider | HttpProvider;
    setActiveAccount?: Dispatch<SetStateAction<InjectedAccount | undefined>>;
    switchActiveChain?: ((chain) => Promise<void>);
}

Type declaration

  • Optional accounts?: InjectedAccount[]
  • Optional activeAccount?: InjectedAccount
  • Optional activeChain?: SubstrateChain
  • Optional activeExtension?: InjectedExtension
  • Optional activeSigner?: Signer
  • Optional api?: ApiPromise
  • Optional connect?: ((chain?, wallet?, lastActiveAccountAddress?) => Promise<void>)
      • (chain?, wallet?, lastActiveAccountAddress?): Promise<void>
      • Parameters

        Returns Promise<void>

  • Optional deployments?: SubstrateDeployment[]
  • Optional disconnect?: (() => void)
      • (): void
      • Returns void

  • Optional error?: UseInkathonError
  • Optional isConnected?: boolean
  • Optional isConnecting?: boolean
  • Optional isInitialized?: boolean
  • Optional isInitializing?: boolean
  • Optional lastActiveAccount?: InjectedAccount
  • Optional provider?: WsProvider | HttpProvider
  • Optional setActiveAccount?: Dispatch<SetStateAction<InjectedAccount | undefined>>
  • Optional switchActiveChain?: ((chain) => Promise<void>)
      • (chain): Promise<void>
      • Parameters

        Returns Promise<void>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/PSP22_TOKEN_BALANCE_SUBSCRIPTION_INTERVAL.html b/docs/variables/PSP22_TOKEN_BALANCE_SUBSCRIPTION_INTERVAL.html index 81a7d4d..5b4ce83 100644 --- a/docs/variables/PSP22_TOKEN_BALANCE_SUBSCRIPTION_INTERVAL.html +++ b/docs/variables/PSP22_TOKEN_BALANCE_SUBSCRIPTION_INTERVAL.html @@ -1,2 +1,2 @@ PSP22_TOKEN_BALANCE_SUBSCRIPTION_INTERVAL | @scio-labs/use-inkathon

Variable PSP22_TOKEN_BALANCE_SUBSCRIPTION_INTERVALConst

PSP22_TOKEN_BALANCE_SUBSCRIPTION_INTERVAL: 60000 = 60000

Default refresh interval for the PSP-22 token balances.

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/agungTestnet.html b/docs/variables/agungTestnet.html index bcc1438..d591880 100644 --- a/docs/variables/agungTestnet.html +++ b/docs/variables/agungTestnet.html @@ -1 +1 @@ -agungTestnet | @scio-labs/use-inkathon

Variable agungTestnetConst

agungTestnet: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file +agungTestnet | @scio-labs/use-inkathon

Variable agungTestnetConst

agungTestnet: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/alephzero.html b/docs/variables/alephzero.html index 8a06e60..1037b96 100644 --- a/docs/variables/alephzero.html +++ b/docs/variables/alephzero.html @@ -1,2 +1,2 @@ alephzero | @scio-labs/use-inkathon

Variable alephzeroConst

alephzero: SubstrateChain = ...

Live Mainnet Networks

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/alephzeroSigner.html b/docs/variables/alephzeroSigner.html index 8542377..89163ad 100644 --- a/docs/variables/alephzeroSigner.html +++ b/docs/variables/alephzeroSigner.html @@ -1 +1 @@ -alephzeroSigner | @scio-labs/use-inkathon

Variable alephzeroSignerConst

alephzeroSigner: SubstrateWallet = ...

Generated using TypeDoc

\ No newline at end of file +alephzeroSigner | @scio-labs/use-inkathon

Variable alephzeroSignerConst

alephzeroSigner: SubstrateWallet = ...

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/alephzeroTestnet.html b/docs/variables/alephzeroTestnet.html index 449f794..3516a1b 100644 --- a/docs/variables/alephzeroTestnet.html +++ b/docs/variables/alephzeroTestnet.html @@ -1,2 +1,2 @@ alephzeroTestnet | @scio-labs/use-inkathon

Variable alephzeroTestnetConst

alephzeroTestnet: SubstrateChain = ...

Live Testnets

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/allSubstrateChains.html b/docs/variables/allSubstrateChains.html index cd57fac..2732938 100644 --- a/docs/variables/allSubstrateChains.html +++ b/docs/variables/allSubstrateChains.html @@ -1,2 +1,2 @@ allSubstrateChains | @scio-labs/use-inkathon

Variable allSubstrateChainsConst

allSubstrateChains: SubstrateChain[] = ...

Exporting all chains separately

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/allSubstrateWallets.html b/docs/variables/allSubstrateWallets.html index 93e22f0..e2c8722 100644 --- a/docs/variables/allSubstrateWallets.html +++ b/docs/variables/allSubstrateWallets.html @@ -1,2 +1,2 @@ allSubstrateWallets | @scio-labs/use-inkathon

Variable allSubstrateWalletsConst

allSubstrateWallets: SubstrateWallet[] = ...

Exporting all wallets separately

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/amplitude.html b/docs/variables/amplitude.html index d7de89a..7d52c90 100644 --- a/docs/variables/amplitude.html +++ b/docs/variables/amplitude.html @@ -1 +1 @@ -amplitude | @scio-labs/use-inkathon

Variable amplitudeConst

amplitude: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file +amplitude | @scio-labs/use-inkathon

Variable amplitudeConst

amplitude: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/amplitudeTestnet.html b/docs/variables/amplitudeTestnet.html index c97b0e2..1a90938 100644 --- a/docs/variables/amplitudeTestnet.html +++ b/docs/variables/amplitudeTestnet.html @@ -1 +1 @@ -amplitudeTestnet | @scio-labs/use-inkathon

Variable amplitudeTestnetConst

amplitudeTestnet: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file +amplitudeTestnet | @scio-labs/use-inkathon

Variable amplitudeTestnetConst

amplitudeTestnet: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/astar.html b/docs/variables/astar.html index 3e416b3..ed5b821 100644 --- a/docs/variables/astar.html +++ b/docs/variables/astar.html @@ -1 +1 @@ -astar | @scio-labs/use-inkathon

Variable astarConst

astar: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file +astar | @scio-labs/use-inkathon

Variable astarConst

astar: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/bitCountryAlphaTestnet.html b/docs/variables/bitCountryAlphaTestnet.html index 4fc878c..2d735cb 100644 --- a/docs/variables/bitCountryAlphaTestnet.html +++ b/docs/variables/bitCountryAlphaTestnet.html @@ -1 +1 @@ -bitCountryAlphaTestnet | @scio-labs/use-inkathon

Variable bitCountryAlphaTestnetConst

bitCountryAlphaTestnet: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file +bitCountryAlphaTestnet | @scio-labs/use-inkathon

Variable bitCountryAlphaTestnetConst

bitCountryAlphaTestnet: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/development.html b/docs/variables/development.html index 0ed3eee..0351bd0 100644 --- a/docs/variables/development.html +++ b/docs/variables/development.html @@ -1,2 +1,2 @@ development | @scio-labs/use-inkathon

Variable developmentConst

development: SubstrateChain = ...

Local Development Network

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/khala.html b/docs/variables/khala.html index c6bffc7..7814bb9 100644 --- a/docs/variables/khala.html +++ b/docs/variables/khala.html @@ -1 +1 @@ -khala | @scio-labs/use-inkathon

Variable khalaConst

khala: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file +khala | @scio-labs/use-inkathon

Variable khalaConst

khala: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/nightly.html b/docs/variables/nightly.html index 24b398e..6b2633b 100644 --- a/docs/variables/nightly.html +++ b/docs/variables/nightly.html @@ -1 +1 @@ -nightly | @scio-labs/use-inkathon

Variable nightlyConst

nightly: SubstrateWallet = ...

Generated using TypeDoc

\ No newline at end of file +nightly | @scio-labs/use-inkathon

Variable nightlyConst

nightly: SubstrateWallet = ...

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/nightlyConnect.html b/docs/variables/nightlyConnect.html index 4150071..98dd5b5 100644 --- a/docs/variables/nightlyConnect.html +++ b/docs/variables/nightlyConnect.html @@ -1 +1 @@ -nightlyConnect | @scio-labs/use-inkathon

Variable nightlyConnectConst

nightlyConnect: SubstrateWallet = ...

Generated using TypeDoc

\ No newline at end of file +nightlyConnect | @scio-labs/use-inkathon

Variable nightlyConnectConst

nightlyConnect: SubstrateWallet = ...

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/nova.html b/docs/variables/nova.html index 564836f..8f5f5e4 100644 --- a/docs/variables/nova.html +++ b/docs/variables/nova.html @@ -1 +1 @@ -nova | @scio-labs/use-inkathon

Variable novaConst

nova: SubstrateWallet = ...

Generated using TypeDoc

\ No newline at end of file +nova | @scio-labs/use-inkathon

Variable novaConst

nova: SubstrateWallet = ...

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/pendulum.html b/docs/variables/pendulum.html index a9a7a08..84cfa89 100644 --- a/docs/variables/pendulum.html +++ b/docs/variables/pendulum.html @@ -1 +1 @@ -pendulum | @scio-labs/use-inkathon

Variable pendulumConst

pendulum: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file +pendulum | @scio-labs/use-inkathon

Variable pendulumConst

pendulum: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/phala.html b/docs/variables/phala.html index a96faf3..aa0e5f3 100644 --- a/docs/variables/phala.html +++ b/docs/variables/phala.html @@ -1 +1 @@ -phala | @scio-labs/use-inkathon

Variable phalaConst

phala: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file +phala | @scio-labs/use-inkathon

Variable phalaConst

phala: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/phalaPOC5Testnet.html b/docs/variables/phalaPOC5Testnet.html index 3b077c3..4cdf153 100644 --- a/docs/variables/phalaPOC5Testnet.html +++ b/docs/variables/phalaPOC5Testnet.html @@ -1 +1 @@ -phalaPOC5Testnet | @scio-labs/use-inkathon

Variable phalaPOC5TestnetConst

phalaPOC5Testnet: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file +phalaPOC5Testnet | @scio-labs/use-inkathon

Variable phalaPOC5TestnetConst

phalaPOC5Testnet: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/polkadotjs.html b/docs/variables/polkadotjs.html index e9a4aeb..bb796c0 100644 --- a/docs/variables/polkadotjs.html +++ b/docs/variables/polkadotjs.html @@ -1,2 +1,2 @@ polkadotjs | @scio-labs/use-inkathon

Variable polkadotjsConst

polkadotjs: SubstrateWallet = ...

Defined Substrate Wallet Constants

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/psp22Abi.html b/docs/variables/psp22Abi.html index 804c50b..5fd2761 100644 --- a/docs/variables/psp22Abi.html +++ b/docs/variables/psp22Abi.html @@ -1 +1 @@ -psp22Abi | @scio-labs/use-inkathon

Variable psp22AbiConst

psp22Abi: Record<string, any> = ...

Generated using TypeDoc

\ No newline at end of file +psp22Abi | @scio-labs/use-inkathon

Variable psp22AbiConst

psp22Abi: Record<string, any> = ...

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/rococo.html b/docs/variables/rococo.html index 92931b7..9bd007f 100644 --- a/docs/variables/rococo.html +++ b/docs/variables/rococo.html @@ -1 +1 @@ -rococo | @scio-labs/use-inkathon

Variable rococoConst

rococo: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file +rococo | @scio-labs/use-inkathon

Variable rococoConst

rococo: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/shibuya.html b/docs/variables/shibuya.html index 5431d45..fea6bae 100644 --- a/docs/variables/shibuya.html +++ b/docs/variables/shibuya.html @@ -1 +1 @@ -shibuya | @scio-labs/use-inkathon

Variable shibuyaConst

shibuya: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file +shibuya | @scio-labs/use-inkathon

Variable shibuyaConst

shibuya: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/shiden.html b/docs/variables/shiden.html index 6fd6752..8761349 100644 --- a/docs/variables/shiden.html +++ b/docs/variables/shiden.html @@ -1,2 +1,2 @@ shiden | @scio-labs/use-inkathon

Variable shidenConst

shiden: SubstrateChain = ...

Live Canary Networks

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/subwallet.html b/docs/variables/subwallet.html index f9911cd..36312e5 100644 --- a/docs/variables/subwallet.html +++ b/docs/variables/subwallet.html @@ -1 +1 @@ -subwallet | @scio-labs/use-inkathon

Variable subwalletConst

subwallet: SubstrateWallet = ...

Generated using TypeDoc

\ No newline at end of file +subwallet | @scio-labs/use-inkathon

Variable subwalletConst

subwallet: SubstrateWallet = ...

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/t0rnTestnet.html b/docs/variables/t0rnTestnet.html index 550988b..c0ed01b 100644 --- a/docs/variables/t0rnTestnet.html +++ b/docs/variables/t0rnTestnet.html @@ -1 +1 @@ -t0rnTestnet | @scio-labs/use-inkathon

Variable t0rnTestnetConst

t0rnTestnet: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file +t0rnTestnet | @scio-labs/use-inkathon

Variable t0rnTestnetConst

t0rnTestnet: SubstrateChain = ...

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/talisman.html b/docs/variables/talisman.html index cc6ca68..2711474 100644 --- a/docs/variables/talisman.html +++ b/docs/variables/talisman.html @@ -1 +1 @@ -talisman | @scio-labs/use-inkathon

Variable talismanConst

talisman: SubstrateWallet = ...

Generated using TypeDoc

\ No newline at end of file +talisman | @scio-labs/use-inkathon

Variable talismanConst

talisman: SubstrateWallet = ...

Generated using TypeDoc

\ No newline at end of file