PHP WebShell
Текущая директория: /opt/BitGoJS/node_modules/@substrate/connect/dist
Просмотр файла: index.d.ts
/**
* List of popular chains that are likely to be connected to.
*
* The values in this enum correspond to the `id` field of the relevant chain specification.
*/
declare enum WellKnownChain {
polkadot = "polkadot",
ksmcc3 = "ksmcc3",
rococo_v2_2 = "rococo_v2_2",
westend2 = "westend2"
}
/**
* Active connection to a blockchain.
*/
interface Chain {
/**
* Enqueues a JSON-RPC request that the client will process as soon as possible.
*
* The response will be sent back using the callback passed when adding the chain.
*
* See <https://www.jsonrpc.org/specification> for a specification of the JSON-RPC format. Only
* version 2 is supported.
* Be aware that some requests will cause notifications to be sent back using the same callback
* as the responses.
*
* No response is generated if the request isn't a valid JSON-RPC request or if the request is
* unreasonably large (8 MiB at the time of writing of this comment). The request is then
* silently discarded.
* If, however, the request is a valid JSON-RPC request but that concerns an unknown method, a
* error response is properly generated.
*
* Two JSON-RPC APIs are supported:
*
* - The "legacy" one, documented here: <https://polkadot.js.org/docs/substrate/rpc>
* - The more recent one: <https://github.com/paritytech/json-rpc-interface-spec>
*
* @param rpc JSON-encoded RPC request.
*
* @throws {AlreadyDestroyedError} If the chain has been removed.
* @throws {JsonRpcDisabledError} If no JSON-RPC callback was passed in the options of the chain.
* @throws {CrashError} If the background client has crashed.
*/
sendJsonRpc(rpc: string): void;
/**
* Disconnects from the blockchain.
*
* The JSON-RPC callback will no longer be called.
*
* Trying to use the chain again will lead to an exception being thrown.
*
* If this chain is a relay chain, then all parachains that use it will continue to work. Smoldot
* automatically keeps alive all relay chains that have an active parachains. There is no need
* to track parachains and relaychains, or to destroy them in the correct order, as this is
* handled automatically.
*
* @throws {AlreadyDestroyedError} If the chain has already been removed.
* @throws {CrashError} If the background client has crashed.
*/
remove(): void;
/**
* Connects to a parachain.
*
* Throws an exception if the chain specification isn't valid, or if the chain specification
* concerns a parachain but no corresponding relay chain can be found.
*
* Substrate-connect will automatically de-duplicate chains if multiple identical chains are
* added, in order to save resources. In other words, it is not a problem to call `addChain`
* multiple times with the same chain specifications and obtain multiple `Chain`.
* When the same client is used for multiple different purposes, you are in fact strongly
* encouraged to trust substrate-connect and not attempt to de-duplicate chains yourself, as
* determining whether two chains are identical is complicated and might have security
* implications.
*
* Substrate-connect tries to distribute CPU resources equally between all active `Chain`
* objects.
*
* @param chainSpec Specification of the chain to add.
* @param jsonRpcCallback Callback invoked in response to calling {Chain.sendJsonRpc}.
* This field is optional. If no callback is provided, the client will save up resources by not
* starting the JSON-RPC endpoint, and it is forbidden to call {Chain.sendJsonRpc}.
* Will never be called after ̀{Chain.remove} has been called or if a {CrashError} has been
* generated.
*
* @throws {AddChainError} If the chain can't be added.
* @throws {CrashError} If the background client has crashed.
*/
addChain: AddChain;
}
type JsonRpcCallback = (response: string) => void;
type AddChain = (chainSpec: string, jsonRpcCallback?: JsonRpcCallback, databaseContent?: string) => Promise<Chain>;
type AddWellKnownChain = (id: WellKnownChain, jsonRpcCallback?: JsonRpcCallback, databaseContent?: string) => Promise<Chain>;
/**
* Client that allows connecting to chains.
*
* Use {ScClient.addChain} or {ScClient.addWellKnownChain} to connect to a
* chain.
*
* If you want to connect to a parachain, you **must** have connected to its corresponding relay
* chain with the same instance of {ScClient}. The matching between relay chains and
* parachains is done through the `relay_chain` field in the parachain specification.
*/
interface ScClient {
/**
* Connects to a chain.
*
* Throws an exception if the chain specification isn't valid, or if the chain specification
* concerns a parachain but no corresponding relay chain can be found.
*
* Substrate-connect will automatically de-duplicate chains if multiple identical chains are
* added, in order to save resources. In other words, it is not a problem to call `addChain`
* multiple times with the same chain specifications and obtain multiple `Chain`.
* When the same client is used for multiple different purposes, you are in fact strongly
* encouraged to trust substrate-connect and not attempt to de-duplicate chains yourself, as
* determining whether two chains are identical is complicated and might have security
* implications.
*
* Substrate-connect tries to distribute CPU resources equally between all active `Chain`
* objects.
*
* @param chainSpec Specification of the chain to add.
* @param jsonRpcCallback Callback invoked in response to calling {Chain.sendJsonRpc}.
* This field is optional. If no callback is provided, the client will save up resources by not
* starting the JSON-RPC endpoint, and it is forbidden to call {Chain.sendJsonRpc}.
* Will never be called after ̀{Chain.remove} has been called or if a {CrashError} has been
* generated.
*
* @throws {AddChainError} If the chain can't be added.
* @throws {CrashError} If the background client has crashed.
*/
addChain: AddChain;
/**
* Connects to a chain, by its `id`.
*
* Throws an exception if no chain with this name is known.
*
* Substrate-connect will automatically de-duplicate chains if multiple identical chains are
* added, in order to save resources. In other words, it is not a problem to call `addChain`
* multiple times with the same chain specifications and obtain multiple `Chain`.
* When the same client is used for multiple different purposes, you are in fact strongly
* encouraged to trust substrate-connect and not attempt to de-duplicate chains yourself, as
* determining whether two chains are identical is complicated and might have security
* implications.
*
* Substrate-connect tries to distribute CPU resources equally between all active `Chain`
* objects.
*
* @param id Name of the well-known chain to add.
* @param jsonRpcCallback Same parameter as for {ScClient.addChain}
*
* @throws {AddChainError} If no chain with this name is known.
* @throws {CrashError} If the background client has crashed.
*/
addWellKnownChain: AddWellKnownChain;
}
declare class AlreadyDestroyedError extends Error {
constructor();
}
declare class CrashError extends Error {
constructor(message: string);
}
declare class JsonRpcDisabledError extends Error {
constructor();
}
/**
* Configuration that can be passed to {createScClient}.
*/
interface Config$1 {
/**
* The client prints logs in the console. By default, only log levels 1, 2, and 3 (corresponding
* respectively to ERROR, WARN, and INFO) are printed.
*
* In order to more easily debug problems, you can pass 4 (DEBUG) or more.
*
* This setting is only taken into account between the moment when you use this chain to add a
* chain for the first time, and the moment when all the chains that you have added have been
* removed.
*
* If {createScClient} is called multiple times with multiple different log levels, the highest
* value will be used.
*/
maxLogLevel?: number;
/**
* Creates a `Worker` that is expected to import `@substrate/connect/worker`.
*
* If this option isn't set then the smoldot light client will run entirely on the "current thread", which might slow
* down other components that also run on this thread.
*/
workerFactory?: () => Worker;
}
/**
* Configuration that can be passed to {createScClient}.
*/
interface Config {
/**
* If `true`, then the client will always use a node embedded within the page and never use
* the substrate-connect extension.
*
* Defaults to `false`.
*/
forceEmbeddedNode?: boolean;
/**
* Configuration to use for the embedded node. Ignored if the extension is present.
*
* If you want to make sure that this configuration isn't ignored, use this option in
* conjunction with {Config.forceEmbeddedNode}.
*/
embeddedNodeConfig?: Config$1;
}
/**
* Returns a {@link ScClient} that connects to chains, either through the substrate-connect
* extension or by executing a light client directly from JavaScript, depending on whether the
* extension is installed and available.
*/
declare const createScClient: (config?: Config) => ScClient;
export { type AddChain, type AddWellKnownChain, AlreadyDestroyedError, type Chain, type Config, CrashError, type Config$1 as EmbeddedNodeConfig, type JsonRpcCallback, JsonRpcDisabledError, type ScClient, WellKnownChain, createScClient };
Выполнить команду
Для локальной разработки. Не используйте в интернете!