diff --git a/.changeset/tiny-geese-yawn.md b/.changeset/tiny-geese-yawn.md deleted file mode 100644 index e252350..0000000 --- a/.changeset/tiny-geese-yawn.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@scio-labs/use-inkathon': patch ---- - -Fix frozen balance diff --git a/CHANGELOG.md b/CHANGELOG.md index b337e66..d93f67c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # @scio-labs/use-inkathon +## 0.11.1 + +### Patch Changes + +- [#84](https://github.com/scio-labs/use-inkathon/pull/84) [`dd1c172`](https://github.com/scio-labs/use-inkathon/commit/dd1c172df12f02f1ffe15b359afe216890610a93) Thanks [@bgibers](https://github.com/bgibers)! - Fix frozen balance + ## 0.11.0 ### Minor Changes diff --git a/docs/enums/AssetType.html b/docs/enums/AssetType.html index d35755e..192eea4 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

On This Page

Enumeration Members
+

Enumeration Members

PSP22

PSP22: "PSP22"

PSP34

PSP34: "PSP34"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/docs/enums/SubstrateExplorer.html b/docs/enums/SubstrateExplorer.html index b02afbf..067a6d1 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

On This Page

Enumeration Members
+

Enumeration Members

Other

Other: "other"

PolkadotJs

PolkadotJs: "polkadotjs"

Subscan

Subscan: "subscan"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/docs/enums/SubstrateWalletPlatform.html b/docs/enums/SubstrateWalletPlatform.html index 906a8a3..8930d7b 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

On This Page

Enumeration Members
+

Enumeration Members

Android

Android: "android"

Browser

Browser: "browser"

iOS

iOS: "ios"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/docs/enums/UseInkathonErrorCode.html b/docs/enums/UseInkathonErrorCode.html index 33d355d..19efda0 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

On This Page

Enumeration Members
+

Enumeration Members

InitializationError

InitializationError: 0

NoAccountInjected

NoAccountInjected: 2

NoSubstrateExtensionDetected

NoSubstrateExtensionDetected: 1

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/docs/functions/UseInkathonProvider.html b/docs/functions/UseInkathonProvider.html index 503a0f0..8fd576c 100644 --- a/docs/functions/UseInkathonProvider.html +++ b/docs/functions/UseInkathonProvider.html @@ -1,5 +1,5 @@ UseInkathonProvider | @scio-labs/use-inkathon

Function UseInkathonProvider

Properties

contextTypes? +

Returns ReactNode

Properties

contextTypes? defaultProps? displayName? propTypes? diff --git a/docs/functions/accountArraysAreEqual.html b/docs/functions/accountArraysAreEqual.html index 7e118fa..eed44d6 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.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/accountsAreEqual.html b/docs/functions/accountsAreEqual.html index 1154620..f66bdaf 100644 --- a/docs/functions/accountsAreEqual.html +++ b/docs/functions/accountsAreEqual.html @@ -1,2 +1,2 @@ accountsAreEqual | @scio-labs/use-inkathon

Function accountsAreEqual

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

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/checkIfBalanceSufficient.html b/docs/functions/checkIfBalanceSufficient.html index 7ff280a..5c70752 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.

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

  • Parameters

    • api: ApiPromise
    • account: string | IKeyringPair
    • OptionalminBalance:
          | string
          | number
          | bigint
          | BN

    Returns Promise<boolean>

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/contractCallDryRun.html b/docs/functions/contractCallDryRun.html index e041a47..e5aec50 100644 --- a/docs/functions/contractCallDryRun.html +++ b/docs/functions/contractCallDryRun.html @@ -1,3 +1,3 @@ contractCallDryRun | @scio-labs/use-inkathon

Function contractCallDryRun

Performs a dry run for the given contract method and arguments. Is used within contractQuery & contractTx for gas estimation.

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

  • Parameters

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

    Returns Promise<ContractCallOutcome>

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/contractQuery.html b/docs/functions/contractQuery.html index f7d5226..d491477 100644 --- a/docs/functions/contractQuery.html +++ b/docs/functions/contractQuery.html @@ -1,2 +1,2 @@ contractQuery | @scio-labs/use-inkathon

Function contractQuery

Calls a given non-mutating contract method (query) with maximum possible gas limit.

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

  • Parameters

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

    Returns Promise<ContractCallOutcome>

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/contractTx.html b/docs/functions/contractTx.html index fe3656a..424847b 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?, signerOptions?): Promise<ContractTxResult>

  • Parameters

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

        • Parameters

          • result: ISubmittableResult

          Returns void | Promise<void>

    • signerOptions: Partial<SignerOptions> = ...

    Returns Promise<ContractTxResult>

Settings

Member Visibility
+contractTx | @scio-labs/use-inkathon

Function contractTx

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

  • Parameters

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

        • Parameters

          • result: ISubmittableResult

          Returns void | Promise<void>

    • signerOptions: Partial<SignerOptions> = ...

    Returns Promise<ContractTxResult>

Settings

Member Visibility
diff --git a/docs/functions/decodeOutput.html b/docs/functions/decodeOutput.html index cdd9aeb..5400d2c 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
+

Parameters

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

Settings

Member Visibility
diff --git a/docs/functions/deployContract.html b/docs/functions/deployContract.html index 8dc61fb..53c4479 100644 --- a/docs/functions/deployContract.html +++ b/docs/functions/deployContract.html @@ -1,2 +1,2 @@ deployContract | @scio-labs/use-inkathon

Function deployContract

Uploads & instantiates a contract on-chain.

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

  • Parameters

    • api: ApiPromise
    • account: string | IKeyringPair
    • abi: any
    • wasm: string | Uint8Array | Buffer
    • constructorMethod: string = 'new'
    • args: unknown[] = ...
    • contractOptions: Partial<ContractOptions> = ...
    • signerOptions: Partial<SignerOptions> = ...

    Returns Promise<DeployedContract>

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/enableWallet.html b/docs/functions/enableWallet.html index 3126a82..70d57a6 100644 --- a/docs/functions/enableWallet.html +++ b/docs/functions/enableWallet.html @@ -1,2 +1,2 @@ enableWallet | @scio-labs/use-inkathon

Function enableWallet

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

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

  • Parameters

    Returns Promise<undefined | InjectedExtension>

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/formatBalance.html b/docs/functions/formatBalance.html index ca7fb06..f067029 100644 --- a/docs/functions/formatBalance.html +++ b/docs/functions/formatBalance.html @@ -1,2 +1,2 @@ formatBalance | @scio-labs/use-inkathon

Function formatBalance

Improved & extended version of formatBalance from @polkadot/util.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/getAbiMessage.html b/docs/functions/getAbiMessage.html index 5f107dd..52cda4c 100644 --- a/docs/functions/getAbiMessage.html +++ b/docs/functions/getAbiMessage.html @@ -1,2 +1,2 @@ getAbiMessage | @scio-labs/use-inkathon

Function getAbiMessage

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

-
  • getAbiMessage(contract, method): AbiMessage

  • Parameters

    • contract: ContractPromise
    • method: string

    Returns AbiMessage

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/getBalance.html b/docs/functions/getBalance.html index 337dd58..5af8e5e 100644 --- a/docs/functions/getBalance.html +++ b/docs/functions/getBalance.html @@ -1,2 +1,2 @@ getBalance | @scio-labs/use-inkathon

Function getBalance

Returns the native token balance of the given address.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/getDeployment.html b/docs/functions/getDeployment.html index 0de669f..a378ebd 100644 --- a/docs/functions/getDeployment.html +++ b/docs/functions/getDeployment.html @@ -1,3 +1,3 @@ getDeployment | @scio-labs/use-inkathon

Function getDeployment

Returns the first matching deployment from the given deployments array with an equal contractId and networkId

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/getDeploymentContract.html b/docs/functions/getDeploymentContract.html index f6e5665..a49be5b 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.

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

  • Parameters

    Returns undefined | ContractPromise

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/getExtrinsicErrorMessage.html b/docs/functions/getExtrinsicErrorMessage.html index d5e810c..0b38a5f 100644 --- a/docs/functions/getExtrinsicErrorMessage.html +++ b/docs/functions/getExtrinsicErrorMessage.html @@ -1 +1 @@ -getExtrinsicErrorMessage | @scio-labs/use-inkathon

Function getExtrinsicErrorMessage

Settings

Member Visibility
+getExtrinsicErrorMessage | @scio-labs/use-inkathon

Function getExtrinsicErrorMessage

Settings

Member Visibility
diff --git a/docs/functions/getGasLimit.html b/docs/functions/getGasLimit.html index 9c34666..a98d23f 100644 --- a/docs/functions/getGasLimit.html +++ b/docs/functions/getGasLimit.html @@ -1,2 +1,2 @@ getGasLimit | @scio-labs/use-inkathon

Function getGasLimit

Helper function that returns Weights V2 gasLimit object.

-
  • getGasLimit(api, _refTime, _proofSize): WeightV2

  • Parameters

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

    Returns WeightV2

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/getMaxGasLimit.html b/docs/functions/getMaxGasLimit.html index 8f042a3..54686e5 100644 --- a/docs/functions/getMaxGasLimit.html +++ b/docs/functions/getMaxGasLimit.html @@ -1,4 +1,4 @@ getMaxGasLimit | @scio-labs/use-inkathon

Function getMaxGasLimit

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.

-
  • getMaxGasLimit(api, reductionFactor?): WeightV2

  • Parameters

    • api: ApiPromise
    • reductionFactor: number = 0.8

    Returns WeightV2

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/getNightlyConnectAdapter.html b/docs/functions/getNightlyConnectAdapter.html index 6ea1d34..2366512 100644 --- a/docs/functions/getNightlyConnectAdapter.html +++ b/docs/functions/getNightlyConnectAdapter.html @@ -1 +1 @@ -getNightlyConnectAdapter | @scio-labs/use-inkathon

Function getNightlyConnectAdapter

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

  • Parameters

    • OptionalappName: string
    • OptionalappIcon: string
    • OptionalappOrigin: string
    • connectionOptions: undefined | ConnectionOptions = ...

    Returns Promise<any>

Settings

Member Visibility
+getNightlyConnectAdapter | @scio-labs/use-inkathon

Function getNightlyConnectAdapter

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

  • Parameters

    • OptionalappName: string
    • OptionalappIcon: string
    • OptionalappOrigin: string
    • connectionOptions: undefined | ConnectionOptions = ...

    Returns Promise<any>

Settings

Member Visibility
diff --git a/docs/functions/getPSP22Balances.html b/docs/functions/getPSP22Balances.html index 13781d0..4ac17d6 100644 --- a/docs/functions/getPSP22Balances.html +++ b/docs/functions/getPSP22Balances.html @@ -1,2 +1,2 @@ getPSP22Balances | @scio-labs/use-inkathon

Function getPSP22Balances

Returns the PSP-22 token balances of the given address.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/getSubstrateChain.html b/docs/functions/getSubstrateChain.html index dbfc652..8a927f8 100644 --- a/docs/functions/getSubstrateChain.html +++ b/docs/functions/getSubstrateChain.html @@ -1,2 +1,2 @@ getSubstrateChain | @scio-labs/use-inkathon

Function getSubstrateChain

Returns chain (if existent) for given identifier (network field).

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/getSubstrateWallet.html b/docs/functions/getSubstrateWallet.html index 018f5af..27eef33 100644 --- a/docs/functions/getSubstrateWallet.html +++ b/docs/functions/getSubstrateWallet.html @@ -1,2 +1,2 @@ getSubstrateWallet | @scio-labs/use-inkathon

Function getSubstrateWallet

Returns wallet (if existent) for given identifier (id field).

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/getWebsiteIcon.html b/docs/functions/getWebsiteIcon.html index 7bf0e82..dafdd3a 100644 --- a/docs/functions/getWebsiteIcon.html +++ b/docs/functions/getWebsiteIcon.html @@ -1 +1 @@ -getWebsiteIcon | @scio-labs/use-inkathon

Function getWebsiteIcon

Settings

Member Visibility
+getWebsiteIcon | @scio-labs/use-inkathon

Function getWebsiteIcon

Settings

Member Visibility
diff --git a/docs/functions/initPolkadotJs.html b/docs/functions/initPolkadotJs.html index 7c4716a..6626834 100644 --- a/docs/functions/initPolkadotJs.html +++ b/docs/functions/initPolkadotJs.html @@ -1,2 +1,2 @@ initPolkadotJs | @scio-labs/use-inkathon

Function initPolkadotJs

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

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

  • Parameters

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

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/isWalletInstalled.html b/docs/functions/isWalletInstalled.html index 7237516..c4134da 100644 --- a/docs/functions/isWalletInstalled.html +++ b/docs/functions/isWalletInstalled.html @@ -1 +1 @@ -isWalletInstalled | @scio-labs/use-inkathon

Function isWalletInstalled

Settings

Member Visibility
+isWalletInstalled | @scio-labs/use-inkathon

Function isWalletInstalled

Settings

Member Visibility
diff --git a/docs/functions/parsePSP22Balance.html b/docs/functions/parsePSP22Balance.html index 0ee5022..fc841ec 100644 --- a/docs/functions/parsePSP22Balance.html +++ b/docs/functions/parsePSP22Balance.html @@ -1,2 +1,2 @@ parsePSP22Balance | @scio-labs/use-inkathon

Function parsePSP22Balance

Helper to parse the fetched PSP22 token balance data.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/registerDeployment.html b/docs/functions/registerDeployment.html index 4cbdbbe..579bb71 100644 --- a/docs/functions/registerDeployment.html +++ b/docs/functions/registerDeployment.html @@ -1,4 +1,4 @@ registerDeployment | @scio-labs/use-inkathon

Function registerDeployment

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.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/registerDeployments.html b/docs/functions/registerDeployments.html index 29d60e2..e3cff6f 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.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/transferBalance.html b/docs/functions/transferBalance.html index 83d7aa8..6e351c7 100644 --- a/docs/functions/transferBalance.html +++ b/docs/functions/transferBalance.html @@ -1,2 +1,2 @@ transferBalance | @scio-labs/use-inkathon

Function transferBalance

Transfers a given amount of tokens from one account to another.

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

  • Parameters

    • api: ApiPromise
    • fromAccount: string | IKeyringPair
    • toAddress: string | AccountId
    • amount:
          | string
          | number
          | bigint
          | BN
    • OptionalallowDeath: boolean
    • OptionalstatusCb: ((result: ISubmittableResult) => void | Promise<void>)
        • (result): void | Promise<void>

        • Parameters

          • result: ISubmittableResult

          Returns void | Promise<void>

    Returns Promise<TransferBalanceResult>

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/transferFullBalance.html b/docs/functions/transferFullBalance.html index 7f5ee67..e79d3f9 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.

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

  • Parameters

    • api: ApiPromise
    • fromAccount: string | IKeyringPair
    • toAddress: string | AccountId
    • OptionalkeepAlive: boolean
    • OptionalstatusCb: ((result: ISubmittableResult) => void | Promise<void>)
        • (result): void | Promise<void>

        • Parameters

          • result: ISubmittableResult

          Returns void | Promise<void>

    Returns Promise<TransferBalanceResult>

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/unwrapResultOrDefault.html b/docs/functions/unwrapResultOrDefault.html index f8f1f1e..b319614 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.

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

  • Type Parameters

    • T = any

    Parameters

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

    Returns T

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/unwrapResultOrError.html b/docs/functions/unwrapResultOrError.html index 7d0ae7e..4951740 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.

-
  • unwrapResultOrError<T>(outcome): T

  • Type Parameters

    • T = any

    Parameters

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

    Returns T

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/useBalance.html b/docs/functions/useBalance.html index f76662f..2e94416 100644 --- a/docs/functions/useBalance.html +++ b/docs/functions/useBalance.html @@ -1,2 +1,2 @@ useBalance | @scio-labs/use-inkathon

Function useBalance

Hook that returns the native token balance of the given address.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/useContract.html b/docs/functions/useContract.html index 02ba458..0e3e6c1 100644 --- a/docs/functions/useContract.html +++ b/docs/functions/useContract.html @@ -1,3 +1,3 @@ useContract | @scio-labs/use-inkathon

Function useContract

React Hook that returns a ContractPromise object configured with the active api & chain as well as the given abi and address.

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

  • Parameters

    • Optionalabi: string | Record<string, unknown> | Abi
    • Optionaladdress: string | AccountId

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

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

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/useInkathon.html b/docs/functions/useInkathon.html index aba270a..4034618 100644 --- a/docs/functions/useInkathon.html +++ b/docs/functions/useInkathon.html @@ -1,2 +1,2 @@ useInkathon | @scio-labs/use-inkathon

Function useInkathon

Primary useInkathon hook that exposes UseInkathonProviderContext.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/usePSP22Balances.html b/docs/functions/usePSP22Balances.html index 2abb781..1aa9011 100644 --- a/docs/functions/usePSP22Balances.html +++ b/docs/functions/usePSP22Balances.html @@ -1,2 +1,2 @@ usePSP22Balances | @scio-labs/use-inkathon

Function usePSP22Balances

Hook that returns the PSP-22 token balances of the given address.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/useRegisteredContract.html b/docs/functions/useRegisteredContract.html index dfb592f..68c703b 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 with the given deployment contract id which is looked up from the deployments registry.

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

  • Parameters

    • contractId: string
    • OptionalnetworkId: string

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

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

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/useRegisteredTypedContract.html b/docs/functions/useRegisteredTypedContract.html index a00d3bd..d2d9405 100644 --- a/docs/functions/useRegisteredTypedContract.html +++ b/docs/functions/useRegisteredTypedContract.html @@ -1,4 +1,4 @@ useRegisteredTypedContract | @scio-labs/use-inkathon

Function useRegisteredTypedContract

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.

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

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

Settings

Member Visibility
diff --git a/docs/functions/watchBalance.html b/docs/functions/watchBalance.html index ec66206..6bb835c 100644 --- a/docs/functions/watchBalance.html +++ b/docs/functions/watchBalance.html @@ -1,3 +1,3 @@ watchBalance | @scio-labs/use-inkathon

Function watchBalance

Watches the native token balance of the given address and returns it in a callback. The returned void function can be used to unsubscribe.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/watchPSP22Balances.html b/docs/functions/watchPSP22Balances.html index 1036bbb..0200bc8 100644 --- a/docs/functions/watchPSP22Balances.html +++ b/docs/functions/watchPSP22Balances.html @@ -1,3 +1,3 @@ watchPSP22Balances | @scio-labs/use-inkathon

Function watchPSP22Balances

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.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/interfaces/ChainAsset.html b/docs/interfaces/ChainAsset.html index 527d09c..d61def7 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

On This Page

Properties
+

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

On This Page

Properties
diff --git a/docs/interfaces/DeployedContract.html b/docs/interfaces/DeployedContract.html index eaf30b9..f3aa086 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

On This Page

Properties
+

Properties

address

address: string

block

block: SignedBlock

blockNumber

blockNumber: number

hash

hash: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/SubstrateChain.html b/docs/interfaces/SubstrateChain.html index 0ec344e..d9a7c78 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

OptionalexplorerUrls

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

OptionalfaucetUrls

faucetUrls?: string[]

name

name: string

network

network: string

rpcUrls

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

Optionalss58Prefix

ss58Prefix?: number

Optionaltestnet

testnet?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

OptionalexplorerUrls

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

OptionalfaucetUrls

faucetUrls?: string[]

name

name: string

network

network: string

rpcUrls

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

Optionalss58Prefix

ss58Prefix?: number

Optionaltestnet

testnet?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/SubstrateDeployment.html b/docs/interfaces/SubstrateDeployment.html index 5c65745..7f6bff6 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

On This Page

Properties
+

Properties

abi

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

address

address: string | AccountId

contractId

contractId: string

networkId

networkId: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/SubstrateWallet.html b/docs/interfaces/SubstrateWallet.html index 108e61b..863b1f0 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;
}

Settings

Member Visibility

On This Page

Properties
+

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;
}

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/UseInkathonError.html b/docs/interfaces/UseInkathonError.html index 3e41c9d..dbfcfd2 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

On This Page

Properties
+

Properties

code

code: UseInkathonErrorCode

message

message: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/UseInkathonProviderProps.html b/docs/interfaces/UseInkathonProviderProps.html index c404692..edb1738 100644 --- a/docs/interfaces/UseInkathonProviderProps.html +++ b/docs/interfaces/UseInkathonProviderProps.html @@ -1,10 +1,10 @@ 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[]>;
    supportedWallets?: SubstrateWallet[];
}

Hierarchy

  • PropsWithChildren
    • UseInkathonProviderProps

Properties

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

Hierarchy

  • PropsWithChildren
    • UseInkathonProviderProps

Properties

apiOptions? appName children? connectOnInit? defaultChain deployments? supportedWallets? -

Properties

OptionalapiOptions

apiOptions?: ApiOptions

appName

appName: string

Optionalchildren

children?: ReactNode

OptionalconnectOnInit

connectOnInit?: boolean

defaultChain

defaultChain: string | SubstrateChain

Optionaldeployments

deployments?: Promise<SubstrateDeployment[]>

OptionalsupportedWallets

supportedWallets?: SubstrateWallet[]

Settings

Member Visibility

On This Page

Properties
+

Properties

OptionalapiOptions

apiOptions?: ApiOptions

appName

appName: string

Optionalchildren

children?: ReactNode

OptionalconnectOnInit

connectOnInit?: boolean

defaultChain

defaultChain: string | SubstrateChain

Optionaldeployments

deployments?: Promise<SubstrateDeployment[]>

OptionalsupportedWallets

supportedWallets?: SubstrateWallet[]

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/types/BalanceData.html b/docs/types/BalanceData.html index caf7c2e..e6941bf 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;
}

Settings

Member Visibility
+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;
}

Settings

Member Visibility
diff --git a/docs/types/BalanceFormatterOptions.html b/docs/types/BalanceFormatterOptions.html index 0cb8345..7cd76df 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;
}

Settings

Member Visibility
+BalanceFormatterOptions | @scio-labs/use-inkathon

Type Alias BalanceFormatterOptions

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

Settings

Member Visibility
diff --git a/docs/types/ContractTxResult.html b/docs/types/ContractTxResult.html index 81e3337..6a23f19 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.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/types/ExstrinsicThrowErrorMessage.html b/docs/types/ExstrinsicThrowErrorMessage.html index 98b68e2..c1c9042 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
+

Settings

Member Visibility
diff --git a/docs/types/PSP22BalanceData.html b/docs/types/PSP22BalanceData.html index 602ac0a..3c63157 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;
}

Settings

Member Visibility
+PSP22BalanceData | @scio-labs/use-inkathon

Type Alias PSP22BalanceData

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

Settings

Member Visibility
diff --git a/docs/types/PolkadotBalanceFormatterOptions.html b/docs/types/PolkadotBalanceFormatterOptions.html index 7d8f752..b1ebfc1 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
+PolkadotBalanceFormatterOptions | @scio-labs/use-inkathon

Type Alias PolkadotBalanceFormatterOptions

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

Settings

Member Visibility
diff --git a/docs/types/TokenData.html b/docs/types/TokenData.html index 9fd6c98..c534a6e 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;
}

Settings

Member Visibility
+TokenData | @scio-labs/use-inkathon

Type Alias TokenData

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

Settings

Member Visibility
diff --git a/docs/types/TransferBalanceResult.html b/docs/types/TransferBalanceResult.html index 08632f6..b022c28 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;
}

Settings

Member Visibility
+TransferBalanceResult | @scio-labs/use-inkathon

Type Alias TransferBalanceResult

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

Settings

Member Visibility
diff --git a/docs/types/TypechainContractConstructor.html b/docs/types/TypechainContractConstructor.html index 576a468..9edd329 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: string, signer: KeyringPair, nativeAPI: ApiPromise) => T)

Type Parameters

  • T

Settings

Member Visibility
+TypechainContractConstructor | @scio-labs/use-inkathon

Type Alias TypechainContractConstructor<T>

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

Type Parameters

  • T

Settings

Member Visibility
diff --git a/docs/types/UseInkathonProviderContextType.html b/docs/types/UseInkathonProviderContextType.html index 96cc353..54d134a 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?: SubstrateChain, wallet?: SubstrateWallet, lastActiveAccountAddress?: string) => 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>>;
    supportedWallets?: SubstrateWallet[];
    switchActiveChain?: ((chain: SubstrateChain) => Promise<void>);
}

Settings

Member Visibility
+UseInkathonProviderContextType | @scio-labs/use-inkathon

Type Alias UseInkathonProviderContextType

UseInkathonProviderContextType: {
    accounts?: InjectedAccount[];
    activeAccount?: InjectedAccount;
    activeChain?: SubstrateChain;
    activeExtension?: InjectedExtension;
    activeSigner?: Signer;
    api?: ApiPromise;
    connect?: ((chain?: SubstrateChain, wallet?: SubstrateWallet, lastActiveAccountAddress?: string) => 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>>;
    supportedWallets?: SubstrateWallet[];
    switchActiveChain?: ((chain: SubstrateChain) => Promise<void>);
}

Settings

Member Visibility
diff --git a/docs/variables/PSP22_TOKEN_BALANCE_SUBSCRIPTION_INTERVAL.html b/docs/variables/PSP22_TOKEN_BALANCE_SUBSCRIPTION_INTERVAL.html index fad8286..0e3bbf3 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
+

Settings

Member Visibility
diff --git a/docs/variables/agungTestnet.html b/docs/variables/agungTestnet.html index a45ca01..00d4017 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
+agungTestnet | @scio-labs/use-inkathon

Variable agungTestnetConst

agungTestnet: SubstrateChain = ...

Settings

Member Visibility
diff --git a/docs/variables/alephzero.html b/docs/variables/alephzero.html index 7c53388..ff1bfb9 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
+

Settings

Member Visibility
diff --git a/docs/variables/alephzeroSigner.html b/docs/variables/alephzeroSigner.html index 4f173d4..aa5b68c 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
+alephzeroSigner | @scio-labs/use-inkathon

Variable alephzeroSignerConst

alephzeroSigner: SubstrateWallet = ...

Settings

Member Visibility
diff --git a/docs/variables/alephzeroTestnet.html b/docs/variables/alephzeroTestnet.html index d471341..2c93fcf 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
+

Settings

Member Visibility
diff --git a/docs/variables/allPSP22Assets.html b/docs/variables/allPSP22Assets.html index a6ed8bd..98afa0d 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
+

Settings

Member Visibility
diff --git a/docs/variables/allSubstrateChains.html b/docs/variables/allSubstrateChains.html index cf79f25..c5fe189 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
+

Settings

Member Visibility
diff --git a/docs/variables/allSubstrateWallets.html b/docs/variables/allSubstrateWallets.html index e57d36b..0a3a340 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
+

Settings

Member Visibility
diff --git a/docs/variables/amplitude.html b/docs/variables/amplitude.html index 3e8235c..129c23e 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
+amplitude | @scio-labs/use-inkathon

Variable amplitudeConst

amplitude: SubstrateChain = ...

Settings

Member Visibility
diff --git a/docs/variables/amplitudeTestnet.html b/docs/variables/amplitudeTestnet.html index bec857b..b9214c9 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
+amplitudeTestnet | @scio-labs/use-inkathon

Variable amplitudeTestnetConst

amplitudeTestnet: SubstrateChain = ...

Settings

Member Visibility
diff --git a/docs/variables/astar.html b/docs/variables/astar.html index aa2a830..26ac698 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
+astar | @scio-labs/use-inkathon

Variable astarConst

astar: SubstrateChain = ...

Settings

Member Visibility
diff --git a/docs/variables/bitCountryAlphaTestnet.html b/docs/variables/bitCountryAlphaTestnet.html index 3644e12..68d9171 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
+bitCountryAlphaTestnet | @scio-labs/use-inkathon

Variable bitCountryAlphaTestnetConst

bitCountryAlphaTestnet: SubstrateChain = ...

Settings

Member Visibility
diff --git a/docs/variables/contracts.html b/docs/variables/contracts.html index 66ea973..5b0a62b 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
+contracts | @scio-labs/use-inkathon

Variable contractsConst

contracts: SubstrateChain = ...

Settings

Member Visibility
diff --git a/docs/variables/development.html b/docs/variables/development.html index c19db37..856f4b5 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
+

Settings

Member Visibility
diff --git a/docs/variables/khala.html b/docs/variables/khala.html index 42333e2..45bcca9 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
+khala | @scio-labs/use-inkathon

Variable khalaConst

khala: SubstrateChain = ...

Settings

Member Visibility
diff --git a/docs/variables/nightly.html b/docs/variables/nightly.html index 5aa30ab..65b98d3 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
+nightly | @scio-labs/use-inkathon

Variable nightlyConst

nightly: SubstrateWallet = ...

Settings

Member Visibility
diff --git a/docs/variables/nightlyConnect.html b/docs/variables/nightlyConnect.html index 1f49b58..bb34de9 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
+nightlyConnect | @scio-labs/use-inkathon

Variable nightlyConnectConst

nightlyConnect: SubstrateWallet = ...

Settings

Member Visibility
diff --git a/docs/variables/nova.html b/docs/variables/nova.html index a2cfedd..cbe4206 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
+nova | @scio-labs/use-inkathon

Variable novaConst

nova: SubstrateWallet = ...

Settings

Member Visibility
diff --git a/docs/variables/pendulum.html b/docs/variables/pendulum.html index 0b198f5..86f97c3 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
+pendulum | @scio-labs/use-inkathon

Variable pendulumConst

pendulum: SubstrateChain = ...

Settings

Member Visibility
diff --git a/docs/variables/phala.html b/docs/variables/phala.html index 4d4bc0f..e6e513e 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
+phala | @scio-labs/use-inkathon

Variable phalaConst

phala: SubstrateChain = ...

Settings

Member Visibility
diff --git a/docs/variables/phalaPOC6Testnet.html b/docs/variables/phalaPOC6Testnet.html index 1dad2ea..430d8c2 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
+phalaPOC6Testnet | @scio-labs/use-inkathon

Variable phalaPOC6TestnetConst

phalaPOC6Testnet: SubstrateChain = ...

Settings

Member Visibility
diff --git a/docs/variables/polkadotjs.html b/docs/variables/polkadotjs.html index f1e2ce2..b5bfb83 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
+

Settings

Member Visibility
diff --git a/docs/variables/popNetworkTestnet.html b/docs/variables/popNetworkTestnet.html index eb39123..8bf953c 100644 --- a/docs/variables/popNetworkTestnet.html +++ b/docs/variables/popNetworkTestnet.html @@ -1 +1 @@ -popNetworkTestnet | @scio-labs/use-inkathon

Variable popNetworkTestnetConst

popNetworkTestnet: SubstrateChain = ...

Settings

Member Visibility
+popNetworkTestnet | @scio-labs/use-inkathon

Variable popNetworkTestnetConst

popNetworkTestnet: SubstrateChain = ...

Settings

Member Visibility
diff --git a/docs/variables/psp22Abi.html b/docs/variables/psp22Abi.html index b308d75..8f55024 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
+psp22Abi | @scio-labs/use-inkathon

Variable psp22AbiConst

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

Settings

Member Visibility
diff --git a/docs/variables/rococo.html b/docs/variables/rococo.html index 5b9393c..279a975 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
+

Settings

Member Visibility
diff --git a/docs/variables/shibuya.html b/docs/variables/shibuya.html index 96c8afb..9b17ae1 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
+shibuya | @scio-labs/use-inkathon

Variable shibuyaConst

shibuya: SubstrateChain = ...

Settings

Member Visibility
diff --git a/docs/variables/shiden.html b/docs/variables/shiden.html index 6015eea..ba7f467 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
+

Settings

Member Visibility
diff --git a/docs/variables/subwallet.html b/docs/variables/subwallet.html index 32c0aa9..1f48068 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
+subwallet | @scio-labs/use-inkathon

Variable subwalletConst

subwallet: SubstrateWallet = ...

Settings

Member Visibility
diff --git a/docs/variables/t0rnTestnet.html b/docs/variables/t0rnTestnet.html index 702453a..b85b156 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
+t0rnTestnet | @scio-labs/use-inkathon

Variable t0rnTestnetConst

t0rnTestnet: SubstrateChain = ...

Settings

Member Visibility
diff --git a/docs/variables/talisman.html b/docs/variables/talisman.html index 5e29636..b09d959 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
+talisman | @scio-labs/use-inkathon

Variable talismanConst

talisman: SubstrateWallet = ...

Settings

Member Visibility
diff --git a/docs/variables/ternoa.html b/docs/variables/ternoa.html index c0a9094..07dc761 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
+ternoa | @scio-labs/use-inkathon

Variable ternoaConst

ternoa: SubstrateChain = ...

Settings

Member Visibility
diff --git a/docs/variables/ternoaAlphanet.html b/docs/variables/ternoaAlphanet.html index 9a52991..38c726e 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
+ternoaAlphanet | @scio-labs/use-inkathon

Variable ternoaAlphanetConst

ternoaAlphanet: SubstrateChain = ...

Settings

Member Visibility
diff --git a/package.json b/package.json index 50e7cda..6592436 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@scio-labs/use-inkathon", "author": "Scio Labs (https://scio.xyz)", - "version": "0.11.0", + "version": "0.11.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",