From e954d8d262d14ecaaa8fdc346d871adeb7007cb5 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 5 Feb 2024 08:24:20 +0000 Subject: [PATCH 1/2] RELEASING: Releasing 1 package(s) Releases: @scio-labs/use-inkathon@0.8.1 [skip ci] --- .changeset/nice-pants-serve.md | 5 ----- CHANGELOG.md | 6 ++++++ package.json | 2 +- 3 files changed, 7 insertions(+), 6 deletions(-) delete mode 100644 .changeset/nice-pants-serve.md diff --git a/.changeset/nice-pants-serve.md b/.changeset/nice-pants-serve.md deleted file mode 100644 index 308f32b..0000000 --- a/.changeset/nice-pants-serve.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@scio-labs/use-inkathon": patch ---- - -Revert to previous (silently failing) behavior when loading deployment metadata, due to it's async nature. diff --git a/CHANGELOG.md b/CHANGELOG.md index 13b3d09..46c59f0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # @scio-labs/use-inkathon +## 0.8.1 + +### Patch Changes + +- [`3dda3e1`](https://github.com/scio-labs/use-inkathon/commit/3dda3e1a2fbd873c74da8ae697561f8bf917678e) Thanks [@wottpal](https://github.com/wottpal)! - Revert to previous (silently failing) behavior when loading deployment metadata, due to it's async nature. + ## 0.8.0 ### Minor Changes diff --git a/package.json b/package.json index b9e4500..44c06c9 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@scio-labs/use-inkathon", "author": "Scio Labs (https://scio.xyz)", - "version": "0.8.0", + "version": "0.8.1", "description": "Typesafe React Hooks abstracting functionality by polkadot.js for working with Substrate-based networks and ink! Smart Contracts.", "homepage": "https://inkathon.xyz", "license": "GPL-3.0", From 9bce0498b50ce4920b29ec0a25191825c143fdbf Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 5 Feb 2024 08:24:20 +0000 Subject: [PATCH 2/2] 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/UseInkathonProvider.html | 2 +- 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/getWebsiteIcon.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/useRegisteredTypedContract.html | 2 +- docs/functions/watchBalance.html | 2 +- docs/functions/watchPSP22Balances.html | 2 +- docs/interfaces/ChainAsset.html | 4 ++-- docs/interfaces/DeployedContract.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/TypechainContractConstructor.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/allPSP22Assets.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/contracts.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/phalaPOC6Testnet.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 +- docs/variables/ternoa.html | 2 +- docs/variables/ternoaAlphanet.html | 2 +- 92 files changed, 103 insertions(+), 103 deletions(-) diff --git a/docs/enums/AssetType.html b/docs/enums/AssetType.html index 06835f5..f2cdf60 100644 --- a/docs/enums/AssetType.html +++ b/docs/enums/AssetType.html @@ -1,3 +1,3 @@ -AssetType | @scio-labs/use-inkathon

Enumeration AssetType

Enumeration Members

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

Enumeration AssetType

Enumeration Members

PSP22 PSP34 -

Enumeration Members

PSP22

PSP22: "PSP22"

PSP34

PSP34: "PSP34"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

PSP22

PSP22: "PSP22"

PSP34

PSP34: "PSP34"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/SubstrateExplorer.html b/docs/enums/SubstrateExplorer.html index 33f4e50..6a996e4 100644 --- a/docs/enums/SubstrateExplorer.html +++ b/docs/enums/SubstrateExplorer.html @@ -1,4 +1,4 @@ -SubstrateExplorer | @scio-labs/use-inkathon

Enumeration SubstrateExplorer

Enumeration Members

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

Enumeration SubstrateExplorer

Enumeration Members

Other PolkadotJs Subscan -

Enumeration Members

Other

Other: "other"

PolkadotJs

PolkadotJs: "polkadotjs"

Subscan

Subscan: "subscan"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

Other

Other: "other"

PolkadotJs

PolkadotJs: "polkadotjs"

Subscan

Subscan: "subscan"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/SubstrateWalletPlatform.html b/docs/enums/SubstrateWalletPlatform.html index 67f4933..80d8d51 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

Enumeration SubstrateWalletPlatform

Enumeration Members

Android Browser iOS -

Enumeration Members

Android

Android: "android"

Browser

Browser: "browser"

iOS

iOS: "ios"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

Android

Android: "android"

Browser

Browser: "browser"

iOS

iOS: "ios"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/UseInkathonErrorCode.html b/docs/enums/UseInkathonErrorCode.html index 6660581..74d382f 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

Enumeration UseInkathonErrorCode

Enumeration Members

InitializationError NoAccountInjected NoSubstrateExtensionDetected -

Enumeration Members

InitializationError

InitializationError: 0

NoAccountInjected

NoAccountInjected: 2

NoSubstrateExtensionDetected

NoSubstrateExtensionDetected: 1

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

InitializationError

InitializationError: 0

NoAccountInjected

NoAccountInjected: 2

NoSubstrateExtensionDetected

NoSubstrateExtensionDetected: 1

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/UseInkathonProvider.html b/docs/functions/UseInkathonProvider.html index 9c38593..ab0de79 100644 --- a/docs/functions/UseInkathonProvider.html +++ b/docs/functions/UseInkathonProvider.html @@ -1,4 +1,4 @@ -UseInkathonProvider | @scio-labs/use-inkathon

Function UseInkathonProvider

Properties

contextTypes? +UseInkathonProvider | @scio-labs/use-inkathon

Function UseInkathonProvider

Properties

contextTypes? defaultProps? displayName? propTypes? diff --git a/docs/functions/accountArraysAreEqual.html b/docs/functions/accountArraysAreEqual.html index b8e77d2..4143e9d 100644 --- a/docs/functions/accountArraysAreEqual.html +++ b/docs/functions/accountArraysAreEqual.html @@ -1,3 +1,3 @@ accountArraysAreEqual | @scio-labs/use-inkathon

Function accountArraysAreEqual

  • accountArraysAreEqual(a1, a2): boolean

  • 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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

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

Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/accountsAreEqual.html b/docs/functions/accountsAreEqual.html index 818df74..2229b45 100644 --- a/docs/functions/accountsAreEqual.html +++ b/docs/functions/accountsAreEqual.html @@ -1,2 +1,2 @@ accountsAreEqual | @scio-labs/use-inkathon

Function accountsAreEqual

  • accountsAreEqual(a1?, a2?): boolean

  • Returns true if both given injected accounts have the same address.

    -

    Parameters

    • Optional a1: InjectedAccount
    • Optional a2: InjectedAccount

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • Optional a1: InjectedAccount
  • Optional a2: InjectedAccount

Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function checkIfBalanceSufficient

  • checkIfBalanceSufficient(api, account, minBalance?): Promise<boolean>

  • 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>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

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

Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/contractCallDryRun.html b/docs/functions/contractCallDryRun.html index 6ccd2d1..77f9f99 100644 --- a/docs/functions/contractCallDryRun.html +++ b/docs/functions/contractCallDryRun.html @@ -1,3 +1,3 @@ contractCallDryRun | @scio-labs/use-inkathon

Function contractCallDryRun

  • contractCallDryRun(api, account, contract, method, options?, args?): Promise<ContractCallOutcome>

  • 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>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

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

Returns Promise<ContractCallOutcome>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/contractQuery.html b/docs/functions/contractQuery.html index 14f6a50..7d5773a 100644 --- a/docs/functions/contractQuery.html +++ b/docs/functions/contractQuery.html @@ -1,2 +1,2 @@ contractQuery | @scio-labs/use-inkathon

Function contractQuery

  • contractQuery(api, address, contract, method, options?, args?): Promise<ContractCallOutcome>

  • 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>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

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

Returns Promise<ContractCallOutcome>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/contractTx.html b/docs/functions/contractTx.html index 7bdecfd..e698b4c 100644 --- a/docs/functions/contractTx.html +++ b/docs/functions/contractTx.html @@ -1 +1 @@ -contractTx | @scio-labs/use-inkathon

Function contractTx

  • contractTx(api, account, contract, method, options?, args?, statusCb?): Promise<ContractTxResult>

  • 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>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function contractTx

  • contractTx(api, account, contract, method, options?, args?, statusCb?): Promise<ContractTxResult>

  • 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>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/decodeOutput.html b/docs/functions/decodeOutput.html index fd12bc8..0e9acd5 100644 --- a/docs/functions/decodeOutput.html +++ b/docs/functions/decodeOutput.html @@ -1,4 +1,4 @@ decodeOutput | @scio-labs/use-inkathon

Function decodeOutput

  • decodeOutput(__namedParameters, contract, method): {
        decodedOutput: string;
        isError: boolean;
        output: any;
    }

  • 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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

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

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

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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/deployContract.html b/docs/functions/deployContract.html index 860e400..8ddee01 100644 --- a/docs/functions/deployContract.html +++ b/docs/functions/deployContract.html @@ -1,2 +1,2 @@ deployContract | @scio-labs/use-inkathon

Function deployContract

  • deployContract(api, account, abi, wasm, constructorMethod?, args?, options?): Promise<DeployedContract>

  • 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<DeployedContract>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

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

Returns Promise<DeployedContract>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function enableWallet

  • enableWallet(wallet, appName): Promise<undefined | InjectedExtension>

  • Enables the given wallet (if existent) and returns the injected extension.

    -

    Parameters

    Returns Promise<undefined | InjectedExtension>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<undefined | InjectedExtension>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function formatBalance

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/getAbiMessage.html b/docs/functions/getAbiMessage.html index 56b95d6..558a0ec 100644 --- a/docs/functions/getAbiMessage.html +++ b/docs/functions/getAbiMessage.html @@ -1,2 +1,2 @@ getAbiMessage | @scio-labs/use-inkathon

Function getAbiMessage

  • getAbiMessage(contract, method): AbiMessage

  • Returns the ABI message for the given method name within the given contract.

    -

    Parameters

    • contract: ContractPromise
    • method: string

    Returns AbiMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • contract: ContractPromise
  • method: string

Returns AbiMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getBalance

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<BalanceData>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getDeployment

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns undefined | SubstrateDeployment

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getDeploymentContract

  • getDeploymentContract(api, deployments, contractId, networkId): undefined | ContractPromise

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

    -

    Parameters

    Returns undefined | ContractPromise

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns undefined | ContractPromise

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getExtrinsicErrorMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getExtrinsicErrorMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/getGasLimit.html b/docs/functions/getGasLimit.html index 8d55444..58e256a 100644 --- a/docs/functions/getGasLimit.html +++ b/docs/functions/getGasLimit.html @@ -1,2 +1,2 @@ getGasLimit | @scio-labs/use-inkathon

Function getGasLimit

  • getGasLimit(api, _refTime, _proofSize): WeightV2

  • Helper function that returns Weights V2 gasLimit object.

    -

    Parameters

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

    Returns WeightV2

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

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

Returns WeightV2

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/getMaxGasLimit.html b/docs/functions/getMaxGasLimit.html index 6f1eb0a..0622258 100644 --- a/docs/functions/getMaxGasLimit.html +++ b/docs/functions/getMaxGasLimit.html @@ -1,4 +1,4 @@ getMaxGasLimit | @scio-labs/use-inkathon

Function getMaxGasLimit

  • getMaxGasLimit(api, reductionFactor?): WeightV2

  • 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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • api: ApiPromise
  • reductionFactor: number = 0.8

Returns WeightV2

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getNightlyConnectAdapter

  • getNightlyConnectAdapter(appName?, appIcon?, appOrigin?, persisted?): Promise<any>

  • Parameters

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

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getNightlyConnectAdapter

  • getNightlyConnectAdapter(appName?, appIcon?, appOrigin?, persisted?): Promise<any>

  • Parameters

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

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getPSP22Balances

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • api: ApiPromise
  • address: undefined | string | AccountId
  • chainId: string
  • Optional formatterOptions: BalanceFormatterOptions

Returns Promise<PSP22BalanceData[]>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getSubstrateChain

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • Optional networkId: string

Returns undefined | SubstrateChain

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getSubstrateWallet

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • id: string

Returns undefined | SubstrateWallet

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getWebsiteIcon

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getWebsiteIcon

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/initPolkadotJs.html b/docs/functions/initPolkadotJs.html index 9291cd7..5b7b1e3 100644 --- a/docs/functions/initPolkadotJs.html +++ b/docs/functions/initPolkadotJs.html @@ -1,2 +1,2 @@ initPolkadotJs | @scio-labs/use-inkathon

Function initPolkadotJs

  • initPolkadotJs(chain, options?): Promise<{
        api: ApiPromise;
        provider: WsProvider | HttpProvider;
    }>

  • Helper to initialize polkadot.js API with given chain and options.

    -

    Parameters

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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isWalletInstalled

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isWalletInstalled

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function parsePSP22Balance

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/registerDeployment.html b/docs/functions/registerDeployment.html index a6e1cf7..84efd25 100644 --- a/docs/functions/registerDeployment.html +++ b/docs/functions/registerDeployment.html @@ -1,4 +1,4 @@ registerDeployment | @scio-labs/use-inkathon

Function registerDeployment

  • registerDeployment(setDeployments, deployment): void

  • 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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function registerDeployments

  • registerDeployments(setDeployments, deployments): Promise<void>

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

    -

    Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/transferBalance.html b/docs/functions/transferBalance.html index 26cec17..62daf68 100644 --- a/docs/functions/transferBalance.html +++ b/docs/functions/transferBalance.html @@ -1,2 +1,2 @@ transferBalance | @scio-labs/use-inkathon

Function transferBalance

  • transferBalance(api, fromAccount, toAddress, amount, allowDeath?, statusCb?): Promise<TransferBalanceResult>

  • 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>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

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>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function transferFullBalance

  • transferFullBalance(api, fromAccount, toAddress, keepAlive?, statusCb?): Promise<TransferBalanceResult>

  • 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>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

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>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function unwrapResultOrDefault

  • unwrapResultOrDefault<T>(outcome, defaultValue): T

  • 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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Type Parameters

  • T = any

Parameters

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

Returns T

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function unwrapResultOrError

  • unwrapResultOrError<T>(outcome): T

  • 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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Type Parameters

  • T = any

Parameters

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

Returns T

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function useBalance

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns BalanceData

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function useContract

  • useContract(abi?, address?): {
        address: undefined | string | AccountId;
        contract: undefined | ContractPromise;
    }

  • 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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/useInkathon.html b/docs/functions/useInkathon.html index 8d365a3..53fc70b 100644 --- a/docs/functions/useInkathon.html +++ b/docs/functions/useInkathon.html @@ -1,2 +1,2 @@ useInkathon | @scio-labs/use-inkathon

Function useInkathon

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns UseInkathonProviderContextType

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/usePSP22Balances.html b/docs/functions/usePSP22Balances.html index 92bf562..066e5fb 100644 --- a/docs/functions/usePSP22Balances.html +++ b/docs/functions/usePSP22Balances.html @@ -1,2 +1,2 @@ usePSP22Balances | @scio-labs/use-inkathon

Function usePSP22Balances

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns PSP22BalanceData[]

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function useRegisteredContract

  • useRegisteredContract(contractId, networkId?): {
        address: undefined | string | AccountId;
        contract: undefined | ContractPromise;
    }

  • React Hook that returns a ContractPromise object configured with the active api & chain with 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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • contractId: string
  • Optional networkId: string

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

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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/useRegisteredTypedContract.html b/docs/functions/useRegisteredTypedContract.html index f1b2f7a..0fc7073 100644 --- a/docs/functions/useRegisteredTypedContract.html +++ b/docs/functions/useRegisteredTypedContract.html @@ -1,4 +1,4 @@ useRegisteredTypedContract | @scio-labs/use-inkathon

Function useRegisteredTypedContract

  • useRegisteredTypedContract<T>(contractId, Contract, networkId?): {
        address: undefined | string | AccountId;
        contract: undefined | ContractPromise;
        typedContract: undefined | T;
    }

  • React Hook that returns a type-safe contract object by typechain-polkadot, configured with the active api & chain for the given deployment contract id which is looked up from the deployments registry.

    -

    Type Parameters

    • T

    Parameters

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

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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Type Parameters

  • T

Parameters

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

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function watchBalance

  • watchBalance(api, address, callback, formatterOptions?): Promise<null | VoidFunction>

  • 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>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

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

Returns Promise<null | VoidFunction>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function watchPSP22Balances

  • watchPSP22Balances(api, address, callback, chainId, formatterOptions?): null | VoidFunction

  • 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

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

    Returns null | VoidFunction

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

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

Returns null | VoidFunction

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Interface ChainAsset

interface ChainAsset {
    assetType: AssetType;
    decimals: number;
    iconPath: string;
    metadata: null | Record<any, any>;
    name: string;
    originChain: string;
    slug: string;
    symbol: string;
}

Properties

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

Interface ChainAsset

interface ChainAsset {
    assetType: AssetType;
    decimals: number;
    iconPath: string;
    metadata: null | Record<any, any>;
    name: string;
    originChain: string;
    slug: string;
    symbol: string;
}

Properties

assetType decimals iconPath metadata @@ -6,4 +6,4 @@ originChain slug symbol -

Properties

assetType

assetType: AssetType

decimals

decimals: number

iconPath

iconPath: string

metadata

metadata: null | Record<any, any>

name

name: string

originChain

originChain: string

slug

slug: string

symbol

symbol: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

assetType

assetType: AssetType

decimals

decimals: number

iconPath

iconPath: string

metadata

metadata: null | Record<any, any>

name

name: string

originChain

originChain: string

slug

slug: string

symbol

symbol: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/DeployedContract.html b/docs/interfaces/DeployedContract.html index eb89f85..4cb3806 100644 --- a/docs/interfaces/DeployedContract.html +++ b/docs/interfaces/DeployedContract.html @@ -1,5 +1,5 @@ -DeployedContract | @scio-labs/use-inkathon

Interface DeployedContract

interface DeployedContract {
    address: string;
    block: SignedBlock;
    blockNumber: number;
    hash: string;
}

Properties

address +DeployedContract | @scio-labs/use-inkathon

Interface DeployedContract

interface DeployedContract {
    address: string;
    block: SignedBlock;
    blockNumber: number;
    hash: string;
}

Properties

address block blockNumber hash -

Properties

address

address: string

block

block: SignedBlock

blockNumber

blockNumber: number

hash

hash: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

address

address: string

block

block: SignedBlock

blockNumber

blockNumber: number

hash

hash: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface SubstrateChain

Substrate Chain Type

-
interface SubstrateChain {
    explorerUrls?: Partial<Record<SubstrateExplorer, string>>;
    faucetUrls?: string[];
    name: string;
    network: string;
    rpcUrls: [string, ...string[]];
    ss58Prefix?: number;
    testnet?: boolean;
}

Properties

explorerUrls? +
interface SubstrateChain {
    explorerUrls?: Partial<Record<SubstrateExplorer, string>>;
    faucetUrls?: string[];
    name: string;
    network: string;
    rpcUrls: [string, ...string[]];
    ss58Prefix?: number;
    testnet?: boolean;
}

Properties

explorerUrls? faucetUrls? name network rpcUrls ss58Prefix? testnet? -

Properties

Optional explorerUrls

explorerUrls?: Partial<Record<SubstrateExplorer, string>>

Optional faucetUrls

faucetUrls?: string[]

name

name: string

network

network: string

rpcUrls

rpcUrls: [string, ...string[]]

Optional ss58Prefix

ss58Prefix?: number

Optional testnet

testnet?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional explorerUrls

explorerUrls?: Partial<Record<SubstrateExplorer, string>>

Optional faucetUrls

faucetUrls?: string[]

name

name: string

network

network: string

rpcUrls

rpcUrls: [string, ...string[]]

Optional ss58Prefix

ss58Prefix?: number

Optional testnet

testnet?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface SubstrateDeployment

interface SubstrateDeployment {
    abi: string | Record<string, unknown> | Abi;
    address: string | AccountId;
    contractId: string;
    networkId: string;
}

Properties

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

Interface SubstrateDeployment

interface SubstrateDeployment {
    abi: string | Record<string, unknown> | Abi;
    address: string | AccountId;
    contractId: string;
    networkId: string;
}

Properties

abi address contractId networkId -

Properties

abi

abi: string | Record<string, unknown> | Abi

address

address: string | AccountId

contractId

contractId: string

networkId

networkId: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

abi

abi: string | Record<string, unknown> | Abi

address

address: string | AccountId

contractId

contractId: string

networkId

networkId: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface SubstrateWallet

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

Properties

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

Interface SubstrateWallet

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

Properties

id logoUrls name platforms urls -

Properties

id

id: string

logoUrls

logoUrls: [string, ...string[]]

name

name: string

platforms

platforms: [SubstrateWalletPlatform, ...SubstrateWalletPlatform[]]

urls

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

id

id: string

logoUrls

logoUrls: [string, ...string[]]

name

name: string

platforms

platforms: [SubstrateWalletPlatform, ...SubstrateWalletPlatform[]]

urls

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface UseInkathonError

interface UseInkathonError {
    code: UseInkathonErrorCode;
    message: string;
}

Properties

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

Interface UseInkathonError

interface UseInkathonError {
    code: UseInkathonErrorCode;
    message: string;
}

Properties

code message -

Properties

code

code: UseInkathonErrorCode

message

message: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

code

code: UseInkathonErrorCode

message

message: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/UseInkathonProviderProps.html b/docs/interfaces/UseInkathonProviderProps.html index 0adf0ab..701f2c4 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.

-
interface UseInkathonProviderProps {
    apiOptions?: ApiOptions;
    appName: string;
    children?: ReactNode;
    connectOnInit?: boolean;
    defaultChain: string | SubstrateChain;
    deployments?: Promise<SubstrateDeployment[]>;
}

Hierarchy

  • PropsWithChildren
    • UseInkathonProviderProps

Properties

apiOptions? +
interface UseInkathonProviderProps {
    apiOptions?: ApiOptions;
    appName: string;
    children?: ReactNode;
    connectOnInit?: boolean;
    defaultChain: string | SubstrateChain;
    deployments?: Promise<SubstrateDeployment[]>;
}

Hierarchy

  • PropsWithChildren
    • UseInkathonProviderProps

Properties

apiOptions? appName children? connectOnInit? defaultChain deployments? -

Properties

Optional apiOptions

apiOptions?: ApiOptions

appName

appName: string

Optional children

children?: ReactNode

Optional connectOnInit

connectOnInit?: boolean

defaultChain

defaultChain: string | SubstrateChain

Optional deployments

deployments?: Promise<SubstrateDeployment[]>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional apiOptions

apiOptions?: ApiOptions

appName

appName: string

Optional children

children?: ReactNode

Optional connectOnInit

connectOnInit?: boolean

defaultChain

defaultChain: string | SubstrateChain

Optional deployments

deployments?: Promise<SubstrateDeployment[]>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/BalanceData.html b/docs/types/BalanceData.html index c694cef..1145f33 100644 --- a/docs/types/BalanceData.html +++ b/docs/types/BalanceData.html @@ -1 +1 @@ -BalanceData | @scio-labs/use-inkathon

Type alias BalanceData

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias BalanceData

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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/BalanceFormatterOptions.html b/docs/types/BalanceFormatterOptions.html index a0b69ce..ef4e5ef 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

Settings

Member Visibility

Theme

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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/ContractTxResult.html b/docs/types/ContractTxResult.html index a05d11a..bf6cbe3 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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/ExstrinsicThrowErrorMessage.html b/docs/types/ExstrinsicThrowErrorMessage.html index cd2d2c8..54855be 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.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/PSP22BalanceData.html b/docs/types/PSP22BalanceData.html index 69f980c..d285403 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

Settings

Member Visibility

Theme

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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/PolkadotBalanceFormatterOptions.html b/docs/types/PolkadotBalanceFormatterOptions.html index 3f1dcf6..3546126 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"]>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias PolkadotBalanceFormatterOptions

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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/TokenData.html b/docs/types/TokenData.html index 060fe19..e86bcd1 100644 --- a/docs/types/TokenData.html +++ b/docs/types/TokenData.html @@ -1 +1 @@ -TokenData | @scio-labs/use-inkathon

Type alias TokenData

TokenData: {
    tokenDecimals: number;
    tokenSymbol: string;
}

Type declaration

  • tokenDecimals: number
  • tokenSymbol: string

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias TokenData

TokenData: {
    tokenDecimals: number;
    tokenSymbol: string;
}

Type declaration

  • tokenDecimals: number
  • tokenSymbol: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/TransferBalanceResult.html b/docs/types/TransferBalanceResult.html index 90c6f20..d5f0bba 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

Settings

Member Visibility

Theme

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias TypechainContractConstructor<T>

TypechainContractConstructor<T>: (new (address, signer, nativeAPI) => T)

Type Parameters

  • T

Type declaration

    • new (address, signer, nativeAPI): T

    • Parameters

      • address: string
      • signer: KeyringPair
      • nativeAPI: ApiPromise

      Returns T

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias TypechainContractConstructor<T>

TypechainContractConstructor<T>: (new (address, signer, nativeAPI) => T)

Type Parameters

  • T

Type declaration

    • new (address, signer, nativeAPI): T

    • Parameters

      • address: string
      • signer: KeyringPair
      • nativeAPI: ApiPromise

      Returns T

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/UseInkathonProviderContextType.html b/docs/types/UseInkathonProviderContextType.html index 99cfc07..d7d4e58 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>

Settings

Member Visibility

Theme

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>

Settings

Member Visibility

Theme

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 9de5b71..03ce4f4 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.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable agungTestnetConst

agungTestnet: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable agungTestnetConst

agungTestnet: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/alephzero.html b/docs/variables/alephzero.html index 567bc63..206d375 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

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable alephzeroSignerConst

alephzeroSigner: SubstrateWallet = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable alephzeroSignerConst

alephzeroSigner: SubstrateWallet = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/alephzeroTestnet.html b/docs/variables/alephzeroTestnet.html index be496e7..379c7fd 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

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable allPSP22AssetsConst

allPSP22Assets: Record<string, ChainAsset> = ...

Acknowledgement: PSP22_ASSETS.json is inspired by Subwallet's ChainAsset.json

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/allSubstrateChains.html b/docs/variables/allSubstrateChains.html index 9cc1e1e..bcd1cd0 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

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/allSubstrateWallets.html b/docs/variables/allSubstrateWallets.html index 2b23b13..3bbf0aa 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

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable amplitudeConst

amplitude: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable amplitudeConst

amplitude: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable amplitudeTestnetConst

amplitudeTestnet: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable amplitudeTestnetConst

amplitudeTestnet: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable astarConst

astar: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable astarConst

astar: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/bitCountryAlphaTestnet.html b/docs/variables/bitCountryAlphaTestnet.html index 5d6e2a7..0afcc3e 100644 --- a/docs/variables/bitCountryAlphaTestnet.html +++ b/docs/variables/bitCountryAlphaTestnet.html @@ -1 +1 @@ -bitCountryAlphaTestnet | @scio-labs/use-inkathon

Variable bitCountryAlphaTestnetConst

bitCountryAlphaTestnet: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable bitCountryAlphaTestnetConst

bitCountryAlphaTestnet: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable contractsConst

contracts: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable contractsConst

contracts: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/development.html b/docs/variables/development.html index 91086d9..eef6c9d 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

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable khalaConst

khala: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable khalaConst

khala: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable nightlyConst

nightly: SubstrateWallet = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable nightlyConst

nightly: SubstrateWallet = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable nightlyConnectConst

nightlyConnect: SubstrateWallet = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable nightlyConnectConst

nightlyConnect: SubstrateWallet = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable novaConst

nova: SubstrateWallet = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable novaConst

nova: SubstrateWallet = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable pendulumConst

pendulum: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable pendulumConst

pendulum: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable phalaConst

phala: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable phalaConst

phala: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable phalaPOC6TestnetConst

phalaPOC6Testnet: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable phalaPOC6TestnetConst

phalaPOC6Testnet: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/polkadotjs.html b/docs/variables/polkadotjs.html index deb7bf2..77eed78 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

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable psp22AbiConst

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable psp22AbiConst

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable rococoConst

rococo: SubstrateChain = contracts

Deprecated

Use contracts instead, which is the smart contracts parachain of Rococo.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable shibuyaConst

shibuya: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable shibuyaConst

shibuya: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/shiden.html b/docs/variables/shiden.html index be1c058..37c92c5 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

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable subwalletConst

subwallet: SubstrateWallet = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable subwalletConst

subwallet: SubstrateWallet = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable t0rnTestnetConst

t0rnTestnet: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable t0rnTestnetConst

t0rnTestnet: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable talismanConst

talisman: SubstrateWallet = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable talismanConst

talisman: SubstrateWallet = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable ternoaConst

ternoa: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable ternoaConst

ternoa: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/ternoaAlphanet.html b/docs/variables/ternoaAlphanet.html index 6e5b773..4c0537b 100644 --- a/docs/variables/ternoaAlphanet.html +++ b/docs/variables/ternoaAlphanet.html @@ -1 +1 @@ -ternoaAlphanet | @scio-labs/use-inkathon

Variable ternoaAlphanetConst

ternoaAlphanet: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable ternoaAlphanetConst

ternoaAlphanet: SubstrateChain = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file