diff --git a/docs/.nojekyll b/docs/.nojekyll deleted file mode 100644 index e2ac6616..00000000 --- a/docs/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/Class.ZetaChainClient.md b/docs/Class.ZetaChainClient.md new file mode 100644 index 00000000..28d5018d --- /dev/null +++ b/docs/Class.ZetaChainClient.md @@ -0,0 +1,610 @@ +[@zetachain/toolkit](toolkit/index.md) / ZetaChainClient + +# Class: ZetaChainClient + +## Constructors + +### new ZetaChainClient() + +> **new ZetaChainClient**(`params`): [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +Initializes ZetaChainClient instance. + +```ts +new ZetaChainClient({ + network: "testnet" +}) +``` + +With an Ethers.js wallet: + +```ts +const client = new ZetaChainClient({ + network: "testnet", + wallet: ethers.Wallet.fromMnemonic(process.env.MNEMONIC as string), +}); +``` + +With a signer: + +```ts +const client = new ZetaChainClient({ + network: "testnet", + signer: await ethers.getSigners(), +}); +``` + +Use a custom RPC endpoint for ZetaChain or any connected chain: + +```ts +const client = new ZetaChainClient({ + network: "testnet", + chains: { + zeta_testnet: { + api: { + url: "https://zetachain-testnet-archive.allthatnode.com:8545/${process.env.KEY}", + type: "evm", + }, + }, + }, +}); +``` + +#### Parameters + +• **params**: [`ZetaChainClientParams`](toolkit/TypeAlias.ZetaChainClientParams.md) + +#### Returns + +[`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +#### Defined in + +[client.ts:87](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L87) + +## Properties + +### chains + +> **chains**: `object` + +#### Index Signature + + \[`key`: `string`\]: `any` + +#### Defined in + +[client.ts:37](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L37) + +*** + +### deposit() + +> **deposit**: (`this`, `options`) => `Promise`\<`any`\> + +Initiates a deposit transaction of native gas or ERC-20 assets as ZRC-20 from +a connected chain to ZetaChain. + +#### Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +ZetaChainClient instance. + +• **options** + +Deposit options. + +• **options.amount**: `string` + +Amount to be deposited in human readable form. For +example, 1.5 ETH is "1.5". + +• **options.chain**: `string` + +Label of the connected chain from which the deposit is +made. + +• **options.erc20?**: `string` + +If an ERC-20 token is being deposited, the address of +the ERC-20 token contract. If not provided, the deposit is assumed to be in +native gas token. + +• **options.message?**: [`string`[], `string`[]] + +If a message is specified, ZetaChain will deposit +tokens into the `recipient` contract and call with with the message as an argument. + +• **options.recipient**: `string` + +Recipient address for the deposit. If not provided, +the deposit is made to the signer's address. + +#### Returns + +`Promise`\<`any`\> + +A promise that resolves with the transaction details upon success. + +#### Defined in + +[client.ts:120](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L120) + +*** + +### getBalances() + +> **getBalances**: (`this`, `__namedParameters`) => `Promise`\<[`TokenBalance`](toolkit/Interface.TokenBalance.md)[]\> + +Get token balances of all tokens on all chains connected to ZetaChain. + +#### Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +ZetaChainClient instance. + +• **\_\_namedParameters** + +• **\_\_namedParameters.btcAddress?**: `string` + +• **\_\_namedParameters.evmAddress**: `string` + +#### Returns + +`Promise`\<[`TokenBalance`](toolkit/Interface.TokenBalance.md)[]\> + +#### Defined in + +[client.ts:114](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L114) + +*** + +### getChainId() + +> **getChainId**: (`this`, `chainNameOrAlias`) => `null` \| `number` + +Get chain ID from a chain label. + +#### Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +ZetaChainClient instance. + +• **chainNameOrAlias**: `string` + +Chain label like goerli_testnet + +#### Returns + +`null` \| `number` + +#### Defined in + +[client.ts:123](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L123) + +*** + +### getEndpoint() + +> **getEndpoint**: (`this`, `type`, `network`) => `any` + +#### Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +• **type**: `any` + +• **network**: `any` + +#### Returns + +`any` + +#### Defined in + +[client.ts:113](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L113) + +*** + +### getFees() + +> **getFees**: (`this`, `gas`) => `Promise`\<`Fees`\> + +#### Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +• **gas**: `Number` + +#### Returns + +`Promise`\<`Fees`\> + +#### Defined in + +[client.ts:117](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L117) + +*** + +### getForeignCoins() + +> **getForeignCoins**: (`this`) => `Promise`\<`any`\> + +#### Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +#### Returns + +`Promise`\<`any`\> + +#### Defined in + +[client.ts:115](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L115) + +*** + +### getPools() + +> **getPools**: (`this`) => `Promise`\<`any`[]\> + +#### Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +#### Returns + +`Promise`\<`any`[]\> + +#### Defined in + +[client.ts:118](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L118) + +*** + +### getQuote() + +> **getQuote**: (`this`, `inputAmount`, `inputToken`, `outputToken`) => `Promise`\<`object`\> + +Retrieves a quote for swapping input ZRC20 token to output ZRC20 token. + +#### Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +• **inputAmount**: `string` + +The amount of input ZRC20 token. + +• **inputToken**: `string` + +• **outputToken**: `string` + +#### Returns + +`Promise`\<`object`\> + +- An object containing the output amount and its decimals. + +##### amount + +> **amount**: `any` + +##### decimals + +> **decimals**: `any` = `outputDecimals` + +#### Defined in + +[client.ts:124](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L124) + +*** + +### getRefundFee() + +> **getRefundFee**: (`this`, `inputZRC20`) => `Promise`\<`object`\> + +Calculates the refund fee in the input ZRC20 token. + +#### Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +• **inputZRC20**: `string` + +The input ZRC20 token address. + +#### Returns + +`Promise`\<`object`\> + +- An object containing the refund fee amount and its decimals. + +##### amount + +> **amount**: `any` = `withdrawFee` + +##### decimals + +> **decimals**: `any` = `inputDecimals` + +#### Defined in + +[client.ts:126](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L126) + +*** + +### getSupportedChains() + +> **getSupportedChains**: (`this`) => `Promise`\<`any`\> + +#### Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +#### Returns + +`Promise`\<`any`\> + +#### Defined in + +[client.ts:116](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L116) + +*** + +### getWithdrawFeeInInputToken() + +> **getWithdrawFeeInInputToken**: (`this`, `inputZRC20`, `outputZRC20`) => `Promise`\<`object`\> + +Calculates the withdraw fee in the input ZRC20 token for a given output ZRC20 token. + +#### Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +• **inputZRC20**: `string` + +The input ZRC20 token address. + +• **outputZRC20**: `string` + +The output ZRC20 token address. + +#### Returns + +`Promise`\<`object`\> + +- An object containing the withdraw fee amount and its decimals. + +##### amount + +> **amount**: `any` + +##### decimals + +> **decimals**: `any` = `inputDecimals` + +#### Defined in + +[client.ts:125](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L125) + +*** + +### getZRC20FromERC20() + +> **getZRC20FromERC20**: (`this`, `erc20`) => `Promise`\<`any`\> + +Retrieves the ZRC20 contract address for a given ERC20 token. + +#### Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +• **erc20**: `string` + +The ERC20 token address. + +#### Returns + +`Promise`\<`any`\> + +- The ZRC20 contract address. + +#### Throws + +Will throw an error if the ERC-20 token is not supported. + +#### Defined in + +[client.ts:127](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L127) + +*** + +### getZRC20GasToken() + +> **getZRC20GasToken**: (`this`, `network`) => `Promise`\<`any`\> + +Retrieves the ZRC20 contract address for the gas token of a given network. + +#### Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +• **network**: `string` + +The network name. + +#### Returns + +`Promise`\<`any`\> + +- The ZRC20 contract address for the gas token. + +#### Defined in + +[client.ts:128](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L128) + +*** + +### network + +> **network**: `string` + +#### Defined in + +[client.ts:38](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L38) + +*** + +### sendZeta() + +> **sendZeta**: (`this`, `options`) => `Promise`\<`any`\> + +Initiates a cross-chain transfer of ZETA tokens from the source chain to the +destination chain. + +#### Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +ZetaChainClient instance. + +• **options** + +Send ZETA options. + +• **options.amount**: `string` + +Amount of ZETA tokens to be sent in human readable form. + +• **options.chain**: `string` + +Source chain label. + +• **options.destination**: `string` + +Destination chain label. + +• **options.gasLimit?**: `Number` = `500000` + +Optional gas limit on the destination chain. + +• **options.recipient**: `string` + +Optional recipient address for the token transfer. If not +provided, the token transfer is made to the signer's address. + +#### Returns + +`Promise`\<`any`\> + +A promise that resolves with the transaction details upon success. + +#### Defined in + +[client.ts:122](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L122) + +*** + +### signer + +> **signer**: `any` + +#### Defined in + +[client.ts:40](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L40) + +*** + +### trackCCTX() + +> **trackCCTX**: (`this`, `__namedParameters`) => `Promise`\<`void`\> + +#### Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +• **\_\_namedParameters** + +• **\_\_namedParameters.emitter**: `any` = `null` + +• **\_\_namedParameters.hash**: `string` + +• **\_\_namedParameters.json**: `Boolean` = `false` + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[client.ts:119](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L119) + +*** + +### wallet + +> **wallet**: `undefined` \| `Wallet` + +#### Defined in + +[client.ts:39](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L39) + +*** + +### withdraw() + +> **withdraw**: (`this`, `options`) => `Promise`\<`any`\> + +Initiates a withdraw transaction of a ZRC-20 token from ZetaChain to a +connected chain as a native gas or ERC-20 token. + +#### Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +ZetaChainClient instance. + +• **options** + +Withdrawal options. + +• **options.amount**: `string` + +Amount to be withdrawn in human readable form. + +• **options.recipient**: `string` + +Recipient address for the withdrawal. If not provided, +the withdrawal is made to the signer's address. + +• **options.zrc20**: `string` + +ZRC-20 token contract address. + +#### Returns + +`Promise`\<`any`\> + +A promise that resolves with the transaction details upon success. + +#### Defined in + +[client.ts:121](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L121) + +## Methods + +### getChains() + +> **getChains**(): `object` + +#### Returns + +`object` + +#### Defined in + +[client.ts:109](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L109) diff --git a/docs/Function.deposit.md b/docs/Function.deposit.md new file mode 100644 index 00000000..924024c6 --- /dev/null +++ b/docs/Function.deposit.md @@ -0,0 +1,54 @@ +[@zetachain/toolkit](toolkit/index.md) / deposit + +# Function: deposit() + +> **deposit**(`this`, `options`): `Promise`\<`any`\> + +Initiates a deposit transaction of native gas or ERC-20 assets as ZRC-20 from +a connected chain to ZetaChain. + +## Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +ZetaChainClient instance. + +• **options** + +Deposit options. + +• **options.amount**: `string` + +Amount to be deposited in human readable form. For +example, 1.5 ETH is "1.5". + +• **options.chain**: `string` + +Label of the connected chain from which the deposit is +made. + +• **options.erc20?**: `string` + +If an ERC-20 token is being deposited, the address of +the ERC-20 token contract. If not provided, the deposit is assumed to be in +native gas token. + +• **options.message?**: [`string`[], `string`[]] + +If a message is specified, ZetaChain will deposit +tokens into the `recipient` contract and call with with the message as an argument. + +• **options.recipient**: `string` + +Recipient address for the deposit. If not provided, +the deposit is made to the signer's address. + +## Returns + +`Promise`\<`any`\> + +A promise that resolves with the transaction details upon success. + +## Defined in + +[deposit.ts:29](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/deposit.ts#L29) diff --git a/docs/Function.getBalances.md b/docs/Function.getBalances.md new file mode 100644 index 00000000..f3546852 --- /dev/null +++ b/docs/Function.getBalances.md @@ -0,0 +1,27 @@ +[@zetachain/toolkit](toolkit/index.md) / getBalances + +# Function: getBalances() + +> **getBalances**(`this`, `__namedParameters`): `Promise`\<[`TokenBalance`](toolkit/Interface.TokenBalance.md)[]\> + +Get token balances of all tokens on all chains connected to ZetaChain. + +## Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +ZetaChainClient instance. + +• **\_\_namedParameters** + +• **\_\_namedParameters.btcAddress?**: `string` + +• **\_\_namedParameters.evmAddress**: `string` + +## Returns + +`Promise`\<[`TokenBalance`](toolkit/Interface.TokenBalance.md)[]\> + +## Defined in + +[getBalances.ts:54](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getBalances.ts#L54) diff --git a/docs/Function.getChainId.md b/docs/Function.getChainId.md new file mode 100644 index 00000000..4c7dbdf6 --- /dev/null +++ b/docs/Function.getChainId.md @@ -0,0 +1,25 @@ +[@zetachain/toolkit](toolkit/index.md) / getChainId + +# Function: getChainId() + +> **getChainId**(`this`, `chainNameOrAlias`): `null` \| `number` + +Get chain ID from a chain label. + +## Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +ZetaChainClient instance. + +• **chainNameOrAlias**: `string` + +Chain label like goerli_testnet + +## Returns + +`null` \| `number` + +## Defined in + +[getChainId.ts:10](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getChainId.ts#L10) diff --git a/docs/Function.getEndpoint.md b/docs/Function.getEndpoint.md new file mode 100644 index 00000000..3706382e --- /dev/null +++ b/docs/Function.getEndpoint.md @@ -0,0 +1,21 @@ +[@zetachain/toolkit](toolkit/index.md) / getEndpoint + +# Function: getEndpoint() + +> **getEndpoint**(`this`, `type`, `network`): `any` + +## Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +• **type**: `any` + +• **network**: `any` + +## Returns + +`any` + +## Defined in + +[getEndpoint.ts:3](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getEndpoint.ts#L3) diff --git a/docs/Function.getFees.md b/docs/Function.getFees.md new file mode 100644 index 00000000..f7cbe13a --- /dev/null +++ b/docs/Function.getFees.md @@ -0,0 +1,19 @@ +[@zetachain/toolkit](toolkit/index.md) / getFees + +# Function: getFees() + +> **getFees**(`this`, `gas`): `Promise`\<`Fees`\> + +## Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +• **gas**: `Number` + +## Returns + +`Promise`\<`Fees`\> + +## Defined in + +[getFees.ts:72](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getFees.ts#L72) diff --git a/docs/Function.getForeignCoins.md b/docs/Function.getForeignCoins.md new file mode 100644 index 00000000..4738ed41 --- /dev/null +++ b/docs/Function.getForeignCoins.md @@ -0,0 +1,17 @@ +[@zetachain/toolkit](toolkit/index.md) / getForeignCoins + +# Function: getForeignCoins() + +> **getForeignCoins**(`this`): `Promise`\<`any`\> + +## Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +## Returns + +`Promise`\<`any`\> + +## Defined in + +[getForeignCoins.ts:3](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getForeignCoins.ts#L3) diff --git a/docs/Function.getHardhatConfig.md b/docs/Function.getHardhatConfig.md new file mode 100644 index 00000000..3bb36155 --- /dev/null +++ b/docs/Function.getHardhatConfig.md @@ -0,0 +1,65 @@ +[@zetachain/toolkit](toolkit/index.md) / getHardhatConfig + +# Function: getHardhatConfig() + +> **getHardhatConfig**(`__namedParameters`): `object` + +## Parameters + +• **\_\_namedParameters**: `any` + +## Returns + +`object` + +### etherscan + +> **etherscan**: `object` + +### etherscan.apiKey + +> **apiKey**: `object` + +### etherscan.apiKey.zeta\_mainnet + +> **zeta\_mainnet**: `string` = `"YOUR_KEY_HERE"` + +### etherscan.apiKey.zeta\_testnet + +> **zeta\_testnet**: `string` = `"YOUR_KEY_HERE"` + +### etherscan.customChains + +> **customChains**: `object`[] + +### networks + +> **networks**: `object` + +### networks.hardhat + +> **hardhat**: `object` + +### networks.hardhat.chainId + +> **chainId**: `number` = `1337` + +### networks.hardhat.forking + +> **forking**: `object` + +### networks.hardhat.forking.blockNumber + +> **blockNumber**: `number` = `14672712` + +### networks.hardhat.forking.url + +> **url**: `string` = `"https://rpc.ankr.com/eth"` + +### solidity + +> **solidity**: `string` = `"0.8.7"` + +## Defined in + +[getHardhatConfig.ts:13](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getHardhatConfig.ts#L13) diff --git a/docs/Function.getPools.md b/docs/Function.getPools.md new file mode 100644 index 00000000..5f8d1982 --- /dev/null +++ b/docs/Function.getPools.md @@ -0,0 +1,17 @@ +[@zetachain/toolkit](toolkit/index.md) / getPools + +# Function: getPools() + +> **getPools**(`this`): `Promise`\<`any`[]\> + +## Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +## Returns + +`Promise`\<`any`[]\> + +## Defined in + +[getPools.ts:16](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getPools.ts#L16) diff --git a/docs/Function.getQuote.md b/docs/Function.getQuote.md new file mode 100644 index 00000000..e5bd9259 --- /dev/null +++ b/docs/Function.getQuote.md @@ -0,0 +1,37 @@ +[@zetachain/toolkit](toolkit/index.md) / getQuote + +# Function: getQuote() + +> **getQuote**(`this`, `inputAmount`, `inputToken`, `outputToken`): `Promise`\<`object`\> + +Retrieves a quote for swapping input ZRC20 token to output ZRC20 token. + +## Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +• **inputAmount**: `string` + +The amount of input ZRC20 token. + +• **inputToken**: `string` + +• **outputToken**: `string` + +## Returns + +`Promise`\<`object`\> + +- An object containing the output amount and its decimals. + +### amount + +> **amount**: `any` + +### decimals + +> **decimals**: `any` = `outputDecimals` + +## Defined in + +[getQuote.ts:144](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getQuote.ts#L144) diff --git a/docs/Function.getRefundFee.md b/docs/Function.getRefundFee.md new file mode 100644 index 00000000..3e3cff28 --- /dev/null +++ b/docs/Function.getRefundFee.md @@ -0,0 +1,33 @@ +[@zetachain/toolkit](toolkit/index.md) / getRefundFee + +# Function: getRefundFee() + +> **getRefundFee**(`this`, `inputZRC20`): `Promise`\<`object`\> + +Calculates the refund fee in the input ZRC20 token. + +## Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +• **inputZRC20**: `string` + +The input ZRC20 token address. + +## Returns + +`Promise`\<`object`\> + +- An object containing the refund fee amount and its decimals. + +### amount + +> **amount**: `any` = `withdrawFee` + +### decimals + +> **decimals**: `any` = `inputDecimals` + +## Defined in + +[getQuote.ts:62](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getQuote.ts#L62) diff --git a/docs/Function.getSupportedChains.md b/docs/Function.getSupportedChains.md new file mode 100644 index 00000000..cf8cf6d7 --- /dev/null +++ b/docs/Function.getSupportedChains.md @@ -0,0 +1,17 @@ +[@zetachain/toolkit](toolkit/index.md) / getSupportedChains + +# Function: getSupportedChains() + +> **getSupportedChains**(`this`): `Promise`\<`any`\> + +## Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +## Returns + +`Promise`\<`any`\> + +## Defined in + +[getSupportedChains.ts:3](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getSupportedChains.ts#L3) diff --git a/docs/Function.getWithdrawFeeInInputToken.md b/docs/Function.getWithdrawFeeInInputToken.md new file mode 100644 index 00000000..dbb6765c --- /dev/null +++ b/docs/Function.getWithdrawFeeInInputToken.md @@ -0,0 +1,37 @@ +[@zetachain/toolkit](toolkit/index.md) / getWithdrawFeeInInputToken + +# Function: getWithdrawFeeInInputToken() + +> **getWithdrawFeeInInputToken**(`this`, `inputZRC20`, `outputZRC20`): `Promise`\<`object`\> + +Calculates the withdraw fee in the input ZRC20 token for a given output ZRC20 token. + +## Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +• **inputZRC20**: `string` + +The input ZRC20 token address. + +• **outputZRC20**: `string` + +The output ZRC20 token address. + +## Returns + +`Promise`\<`object`\> + +- An object containing the withdraw fee amount and its decimals. + +### amount + +> **amount**: `any` + +### decimals + +> **decimals**: `any` = `inputDecimals` + +## Defined in + +[getQuote.ts:103](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getQuote.ts#L103) diff --git a/docs/Function.getZRC20FromERC20.md b/docs/Function.getZRC20FromERC20.md new file mode 100644 index 00000000..de8a41c8 --- /dev/null +++ b/docs/Function.getZRC20FromERC20.md @@ -0,0 +1,29 @@ +[@zetachain/toolkit](toolkit/index.md) / getZRC20FromERC20 + +# Function: getZRC20FromERC20() + +> **getZRC20FromERC20**(`this`, `erc20`): `Promise`\<`any`\> + +Retrieves the ZRC20 contract address for a given ERC20 token. + +## Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +• **erc20**: `string` + +The ERC20 token address. + +## Returns + +`Promise`\<`any`\> + +- The ZRC20 contract address. + +## Throws + +Will throw an error if the ERC-20 token is not supported. + +## Defined in + +[getQuote.ts:15](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getQuote.ts#L15) diff --git a/docs/Function.getZRC20GasToken.md b/docs/Function.getZRC20GasToken.md new file mode 100644 index 00000000..73f4589a --- /dev/null +++ b/docs/Function.getZRC20GasToken.md @@ -0,0 +1,25 @@ +[@zetachain/toolkit](toolkit/index.md) / getZRC20GasToken + +# Function: getZRC20GasToken() + +> **getZRC20GasToken**(`this`, `network`): `Promise`\<`any`\> + +Retrieves the ZRC20 contract address for the gas token of a given network. + +## Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +• **network**: `string` + +The network name. + +## Returns + +`Promise`\<`any`\> + +- The ZRC20 contract address for the gas token. + +## Defined in + +[getQuote.ts:32](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getQuote.ts#L32) diff --git a/docs/Function.prepareData.md b/docs/Function.prepareData.md new file mode 100644 index 00000000..65f2dd81 --- /dev/null +++ b/docs/Function.prepareData.md @@ -0,0 +1,21 @@ +[@zetachain/toolkit](toolkit/index.md) / prepareData + +# Function: prepareData() + +> **prepareData**(`contract`, `types`, `args`): `string` + +## Parameters + +• **contract**: `string` + +• **types**: `string`[] + +• **args**: `any`[] + +## Returns + +`string` + +## Defined in + +[prepareData.ts:3](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/prepareData.ts#L3) diff --git a/docs/Function.prepareParams.md b/docs/Function.prepareParams.md new file mode 100644 index 00000000..ce7929ca --- /dev/null +++ b/docs/Function.prepareParams.md @@ -0,0 +1,19 @@ +[@zetachain/toolkit](toolkit/index.md) / prepareParams + +# Function: prepareParams() + +> **prepareParams**(`types`, `args`): `string` + +## Parameters + +• **types**: `string`[] + +• **args**: `any`[] + +## Returns + +`string` + +## Defined in + +[prepareData.ts:8](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/prepareData.ts#L8) diff --git a/docs/Function.sendZeta.md b/docs/Function.sendZeta.md new file mode 100644 index 00000000..198e8aaf --- /dev/null +++ b/docs/Function.sendZeta.md @@ -0,0 +1,49 @@ +[@zetachain/toolkit](toolkit/index.md) / sendZeta + +# Function: sendZeta() + +> **sendZeta**(`this`, `options`): `Promise`\<`any`\> + +Initiates a cross-chain transfer of ZETA tokens from the source chain to the +destination chain. + +## Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +ZetaChainClient instance. + +• **options** + +Send ZETA options. + +• **options.amount**: `string` + +Amount of ZETA tokens to be sent in human readable form. + +• **options.chain**: `string` + +Source chain label. + +• **options.destination**: `string` + +Destination chain label. + +• **options.gasLimit?**: `Number` = `500000` + +Optional gas limit on the destination chain. + +• **options.recipient**: `string` + +Optional recipient address for the token transfer. If not +provided, the token transfer is made to the signer's address. + +## Returns + +`Promise`\<`any`\> + +A promise that resolves with the transaction details upon success. + +## Defined in + +[sendZeta.ts:25](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/sendZeta.ts#L25) diff --git a/docs/Function.trackCCTX.md b/docs/Function.trackCCTX.md new file mode 100644 index 00000000..007409f5 --- /dev/null +++ b/docs/Function.trackCCTX.md @@ -0,0 +1,25 @@ +[@zetachain/toolkit](toolkit/index.md) / trackCCTX + +# Function: trackCCTX() + +> **trackCCTX**(`this`, `__namedParameters`): `Promise`\<`void`\> + +## Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +• **\_\_namedParameters** + +• **\_\_namedParameters.emitter**: `any` = `null` + +• **\_\_namedParameters.hash**: `string` + +• **\_\_namedParameters.json**: `Boolean` = `false` + +## Returns + +`Promise`\<`void`\> + +## Defined in + +[trackCCTX.ts:138](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/trackCCTX.ts#L138) diff --git a/docs/Function.withdraw.md b/docs/Function.withdraw.md new file mode 100644 index 00000000..11b00501 --- /dev/null +++ b/docs/Function.withdraw.md @@ -0,0 +1,41 @@ +[@zetachain/toolkit](toolkit/index.md) / withdraw + +# Function: withdraw() + +> **withdraw**(`this`, `options`): `Promise`\<`any`\> + +Initiates a withdraw transaction of a ZRC-20 token from ZetaChain to a +connected chain as a native gas or ERC-20 token. + +## Parameters + +• **this**: [`ZetaChainClient`](toolkit/Class.ZetaChainClient.md) + +ZetaChainClient instance. + +• **options** + +Withdrawal options. + +• **options.amount**: `string` + +Amount to be withdrawn in human readable form. + +• **options.recipient**: `string` + +Recipient address for the withdrawal. If not provided, +the withdrawal is made to the signer's address. + +• **options.zrc20**: `string` + +ZRC-20 token contract address. + +## Returns + +`Promise`\<`any`\> + +A promise that resolves with the transaction details upon success. + +## Defined in + +[withdraw.ts:19](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/withdraw.ts#L19) diff --git a/docs/Interface.TokenBalance.md b/docs/Interface.TokenBalance.md new file mode 100644 index 00000000..9cc3fc4f --- /dev/null +++ b/docs/Interface.TokenBalance.md @@ -0,0 +1,103 @@ +[@zetachain/toolkit](toolkit/index.md) / TokenBalance + +# Interface: TokenBalance + +## Properties + +### balance + +> **balance**: `string` + +#### Defined in + +[getBalances.ts:11](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getBalances.ts#L11) + +*** + +### chain\_id + +> **chain\_id**: `string` \| `number` + +#### Defined in + +[getBalances.ts:12](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getBalances.ts#L12) + +*** + +### chain\_name + +> **chain\_name**: `string` + +#### Defined in + +[getBalances.ts:13](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getBalances.ts#L13) + +*** + +### coin\_type + +> **coin\_type**: `string` + +#### Defined in + +[getBalances.ts:14](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getBalances.ts#L14) + +*** + +### contract? + +> `optional` **contract**: `string` + +#### Defined in + +[getBalances.ts:15](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getBalances.ts#L15) + +*** + +### decimals + +> **decimals**: `number` + +#### Defined in + +[getBalances.ts:16](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getBalances.ts#L16) + +*** + +### id + +> **id**: `string` + +#### Defined in + +[getBalances.ts:17](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getBalances.ts#L17) + +*** + +### symbol + +> **symbol**: `string` + +#### Defined in + +[getBalances.ts:18](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getBalances.ts#L18) + +*** + +### ticker + +> **ticker**: `string` + +#### Defined in + +[getBalances.ts:19](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getBalances.ts#L19) + +*** + +### zrc20? + +> `optional` **zrc20**: `string` + +#### Defined in + +[getBalances.ts:20](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/getBalances.ts#L20) diff --git a/docs/Interface.ZetaChainClientParamsBase.md b/docs/Interface.ZetaChainClientParamsBase.md new file mode 100644 index 00000000..a6751a86 --- /dev/null +++ b/docs/Interface.ZetaChainClientParamsBase.md @@ -0,0 +1,27 @@ +[@zetachain/toolkit](toolkit/index.md) / ZetaChainClientParamsBase + +# Interface: ZetaChainClientParamsBase + +## Properties + +### chains? + +> `optional` **chains**: `object` + +#### Index Signature + + \[`key`: `string`\]: `any` + +#### Defined in + +[client.ts:25](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L25) + +*** + +### network? + +> `optional` **network**: `string` + +#### Defined in + +[client.ts:26](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L26) diff --git a/docs/TypeAlias.ZetaChainClientParams.md b/docs/TypeAlias.ZetaChainClientParams.md new file mode 100644 index 00000000..e45d2567 --- /dev/null +++ b/docs/TypeAlias.ZetaChainClientParams.md @@ -0,0 +1,9 @@ +[@zetachain/toolkit](toolkit/index.md) / ZetaChainClientParams + +# Type Alias: ZetaChainClientParams + +> **ZetaChainClientParams**: [`ZetaChainClientParamsBase`](toolkit/Interface.ZetaChainClientParamsBase.md) & `object` \| `object` \| `object` + +## Defined in + +[client.ts:29](https://github.com/zeta-chain/toolkit/blob/ff9b248edd3cba24d9f8444af6a768e2af201e71/packages/client/src/client.ts#L29) diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css deleted file mode 100644 index 65ac44e1..00000000 --- a/docs/assets/highlight.css +++ /dev/null @@ -1,85 +0,0 @@ -:root { - --light-hl-0: #001080; - --dark-hl-0: #9CDCFE; - --light-hl-1: #000000; - --dark-hl-1: #D4D4D4; - --light-hl-2: #AF00DB; - --dark-hl-2: #C586C0; - --light-hl-3: #A31515; - --dark-hl-3: #CE9178; - --light-hl-4: #800000; - --dark-hl-4: #569CD6; - --light-hl-5: #0000FF; - --dark-hl-5: #569CD6; - --light-hl-6: #795E26; - --dark-hl-6: #DCDCAA; - --light-hl-7: #0070C1; - --dark-hl-7: #4FC1FF; - --light-hl-8: #267F99; - --dark-hl-8: #4EC9B0; - --light-code-background: #FFFFFF; - --dark-code-background: #1E1E1E; -} - -@media (prefers-color-scheme: light) { :root { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --hl-4: var(--light-hl-4); - --hl-5: var(--light-hl-5); - --hl-6: var(--light-hl-6); - --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); - --code-background: var(--light-code-background); -} } - -@media (prefers-color-scheme: dark) { :root { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --hl-4: var(--dark-hl-4); - --hl-5: var(--dark-hl-5); - --hl-6: var(--dark-hl-6); - --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); - --code-background: var(--dark-code-background); -} } - -:root[data-theme='light'] { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --hl-4: var(--light-hl-4); - --hl-5: var(--light-hl-5); - --hl-6: var(--light-hl-6); - --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); - --code-background: var(--light-code-background); -} - -:root[data-theme='dark'] { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --hl-4: var(--dark-hl-4); - --hl-5: var(--dark-hl-5); - --hl-6: var(--dark-hl-6); - --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); - --code-background: var(--dark-code-background); -} - -.hl-0 { color: var(--hl-0); } -.hl-1 { color: var(--hl-1); } -.hl-2 { color: var(--hl-2); } -.hl-3 { color: var(--hl-3); } -.hl-4 { color: var(--hl-4); } -.hl-5 { color: var(--hl-5); } -.hl-6 { color: var(--hl-6); } -.hl-7 { color: var(--hl-7); } -.hl-8 { color: var(--hl-8); } -pre, code { background: var(--code-background); } diff --git a/docs/assets/main.js b/docs/assets/main.js deleted file mode 100644 index 3092fea0..00000000 --- a/docs/assets/main.js +++ /dev/null @@ -1,59 +0,0 @@ -"use strict"; -"use strict";(()=>{var Ie=Object.create;var ne=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ie(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` - ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",H="mouseup",J={x:0,y:0},fe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",pe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.updateIndexHeadingVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.updateIndexHeadingVisibility()}updateIndexHeadingVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}};var Z=class extends C{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); -/*! Bundled license information: - -lunr/lunr.js: - (** - * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 - * Copyright (C) 2020 Oliver Nightingale - * @license MIT - *) - (*! - * lunr.utils - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Set - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.tokenizer - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Pipeline - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Vector - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.stemmer - * Copyright (C) 2020 Oliver Nightingale - * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt - *) - (*! - * lunr.stopWordFilter - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.trimmer - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.TokenSet - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Index - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Builder - * Copyright (C) 2020 Oliver Nightingale - *) -*/ diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js deleted file mode 100644 index 099856ae..00000000 --- a/docs/assets/navigation.js +++ /dev/null @@ -1 +0,0 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE5XSwU4CMRAG4HfpeSOwEVSOrJp4I8rBYDxMtgPbsEybdgga47sbybKUpe2G8z//13bSjx/B+MViKpbIUFSgqKgVEotMGOBKTEVZg3PoBp2Bm4q3tcjERpEU01F+/5u11kJvkGZQA5V4ghQx2hWU6Ab+wDmUjyce1DlzDha2bgYurEanrz7ixPO3ickddfhwNxrnnizRaKe8Ta52VLLS5AZNdC5Mbr3yGrnZjwsBXpxGDrd+kRGjSdPEE0mjFXHsIm2eZp4x+pT/qKesLao1FVpRFPFG0thc6zqmHLJ0/W1njLaM8rC9GNSZSpDGogGLj8AQsry4H+l+3wsm9HXPIIckl69FPgwhbdgHYPgtxyxRZwvlpigW76F+GyaAveJKWtiH+sfsov75BwjJ76EJBQAA" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js deleted file mode 100644 index 58186000..00000000 --- a/docs/assets/search.js +++ /dev/null @@ -1 +0,0 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE71aTW/bOBD9L8xVcU1SlD+Oze4CuRW7xWJRIwgUm3GFOJIhKU3bIP99IZoiZ2yOQDmAT27jmTfDeY8jcqw3VlevDVuu3thTUW7YUqgsYWX+rNmSfdNtfvM9L8qbXaHL9kte58/N57zRLGEv9Y4tWVG2un7M17r5RBpPvrfPO5aw9S5vGt2wJWPvSR+OT0Xq4q0792Y8+JVzBDESts9rXbaD6/CJZEpJv/L7+/bX/oxl2kwmzn9kQhO7EqJApW5fq/rpjLy85/klEtPFjCsxLA+XW1cAIq1hRYg5FcFhW8dj9EFcxX3m66ps2vpl3VZ1FOYVdogqYaTIh8OO0nWsmiNCjhTwSNkOJjBSqVTM13y303GKuXK2H4rYFNtSR+rJ2Y6NKKap3x7Put7qmxF6wg4+dttsrovmel8XP/JWn5HJVrdj8oDml5O2izpx/7rmVunXQkWLPYBDaWKr2z/Lzb4qyja+NNDjotVxgfuizMbUxKdNF+NzvsvLtY6vBXC4aCn6uH0l5JhKuKTpQvxV1brYljfVmD1z5HTRgsDYfVE4H1MVlD1dmX9e9vuqbvVmZEM59btofY7CuxKNaivHaxjQjx6xiazxZfWi/eZZjJKJHtw4X6pqF7/y3vqiSzdBnQBGdY5DvtQBQ5ebb3/fiGnkGQOYX279LqorQPxDxGdMVKCt8/XTzc3X/+JygeaXq4CL6o4W8W3SZ0xUYKP3VVNEnmu98eVWb2M69qOX3idLneeL9vumzl8jT/Te+nJL74M63uO3vst3aOvrNh+xBw/WF974us0d8/Fd3+VLt31jfrsZd9A39pe/X9xu+hqMv1PcbmAq9L5/fCnXbVGVzad+ww3NPuBQ72v1pEt7Qg0NkuD38aO7hxGAV944XByU4tAY5b7YxEUE1h8Naf4zIqi1/0DYqijJcWQgKjD/SNCyexa1sTGd9fkhN3pdPOe74Pz3NCSwPj9krHw+KJzm1/NDtYsL5WzPD9cW6ycwiBoM52zPD/e7XoMj6WC03nRUsGx4guA7Iby2DzWubPDJgvD6fh4PdzruQYB+xBIPie56CM1cskYAhYYOGBDe8uOB8aUMIR4uQ/FQ1PUfgR5ftiPh97XuxPZHDg5SHhd8OxLw6JePE8iIXz2ygbOex3NnrDFQ6MZ4hGUuapFgp5cvD+bvPJFgJ8d5j+WO0QGou4QV5Ub/ZMs39kPXTVGVbMnERE660+ZjoXeb7sdM1j90q+fnrrfc2e/+1d0vOJ3FweTTlCWraSJnk2y+uLtLVr2H+cL8wZhxlqx4IsVEzTky48hMsGQlEp5OpFTITCAzyZKVDKFJZJayZJWGckuRmWLJSoXMFDLLWLLKQmYZMptRK50hszm10jkyW1ArXeDydtWehZLjRzx09Z4HDTETvKv4ImiIuejGMyselADHdPCUWjPHhHQjvxUPywVzwjMSErPCDS0iCImJ4SQzHFPTXc9WPEgOx+x03YOQNWZHmG2ShiDF0UahdwqmRxh6VBAS0yNIegSmRxh6siAkpkeQ9AhMjzD0zIKQmB5B0iMwPcLQMw9CYnokSY/E9EhDzyLYeDA9kqRHHnWyjgMxDUJieiRJj8T0yI4DEdw9EtMjSXokpkd2HIjg7pGYHknSIzE9ckHXEtOTGnpksI9jftKOBBHu+Jif1PATbPopJig1BAX7fnr0tDEEBZtwihlKDUPBLpxihlLDULANp5iitONBBttwiilKOyIkD1pijlLz9BFBS8yR6oiQQY4U5khxshErzJESpOgU5khJ8nmhMEcqJbuhOjoUKLK7K8yRysh2qDBHaka2d4U5UoajoJIV5kgZjsLHF8xRNiX7QoY5yjjZjTPMUSbIJpthjjK60WUHjszJ9IfuLiW3hxPqauWmh2/s3h5b3TtIb0yw5dt7wuaHD57az8x+2r+Lqf205sLaCWsnrJ20dtLaSWsnrZ00du/+TNz9r1uHG8aBJFOfZcoJPz9SA44KOIpBx8MJHbhmwFUOuTbQjXsvfljojPL1czEQdQaipqQnePnL+4KEM9rTzsVAyDkIqQhHP90CjgvgSEV0c2JQIuAnbZHkgvDf6vbBTVgABtAtnx0wFKWMrW4NUUfaABCyh6A00kPgJKYgCUoiW91qP4IBzlApyoYfAHnURxUA0hbS+lOK6fwPk5R1dbwICfJYWBxKBlvd7g+jFQAAdCf6hVBy2Oq26WclgYKCfS6sMhS1fzCbEnCRUi7mdbPTsECPnBKAewsQhAT6OeRKidiOXTZmzgMAwHIV1Q6t796OdIA3EICiIndDld8ahxVAedISlk2HAA5TUsAT6FLCbp2M2n39q4XeHTQcTnrZsTNYL0g7parVj4+BG9jmKVWmtpv0hh48gOOUKpGZNa3X7U9UIrBIYbdVRomrf9/Tu4MCcyquH1mBhME2kFaVGdVVOmGY3bC2bzN7HKitOO9TgcKH9hiMB/NCv8cBS6JKcaJQCYhTQa+7hO2Lvd4VpWbL1d37+//y1q58ejAAAA=="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css deleted file mode 100644 index 98a43779..00000000 --- a/docs/assets/style.css +++ /dev/null @@ -1,1414 +0,0 @@ -:root { - /* Light */ - --light-color-background: #f2f4f8; - --light-color-background-secondary: #eff0f1; - --light-color-warning-text: #222; - --light-color-background-warning: #e6e600; - --light-color-icon-background: var(--light-color-background); - --light-color-accent: #c5c7c9; - --light-color-active-menu-item: var(--light-color-accent); - --light-color-text: #222; - --light-color-text-aside: #6e6e6e; - --light-color-link: #1f70c2; - - --light-color-ts-keyword: #056bd6; - --light-color-ts-project: #b111c9; - --light-color-ts-module: var(--light-color-ts-project); - --light-color-ts-namespace: var(--light-color-ts-project); - --light-color-ts-enum: #7e6f15; - --light-color-ts-enum-member: var(--light-color-ts-enum); - --light-color-ts-variable: #4760ec; - --light-color-ts-function: #572be7; - --light-color-ts-class: #1f70c2; - --light-color-ts-interface: #108024; - --light-color-ts-constructor: var(--light-color-ts-class); - --light-color-ts-property: var(--light-color-ts-variable); - --light-color-ts-method: var(--light-color-ts-function); - --light-color-ts-call-signature: var(--light-color-ts-method); - --light-color-ts-index-signature: var(--light-color-ts-property); - --light-color-ts-constructor-signature: var(--light-color-ts-constructor); - --light-color-ts-parameter: var(--light-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --light-color-ts-type-parameter: #a55c0e; - --light-color-ts-accessor: var(--light-color-ts-property); - --light-color-ts-get-signature: var(--light-color-ts-accessor); - --light-color-ts-set-signature: var(--light-color-ts-accessor); - --light-color-ts-type-alias: #d51270; - /* reference not included as links will be colored with the kind that it points to */ - - --light-external-icon: url("data:image/svg+xml;utf8,"); - --light-color-scheme: light; - - /* Dark */ - --dark-color-background: #2b2e33; - --dark-color-background-secondary: #1e2024; - --dark-color-background-warning: #bebe00; - --dark-color-warning-text: #222; - --dark-color-icon-background: var(--dark-color-background-secondary); - --dark-color-accent: #9096a2; - --dark-color-active-menu-item: #5d5d6a; - --dark-color-text: #f5f5f5; - --dark-color-text-aside: #dddddd; - --dark-color-link: #00aff4; - - --dark-color-ts-keyword: #3399ff; - --dark-color-ts-project: #e358ff; - --dark-color-ts-module: var(--dark-color-ts-project); - --dark-color-ts-namespace: var(--dark-color-ts-project); - --dark-color-ts-enum: #f4d93e; - --dark-color-ts-enum-member: var(--dark-color-ts-enum); - --dark-color-ts-variable: #798dff; - --dark-color-ts-function: #a280ff; - --dark-color-ts-class: #8ac4ff; - --dark-color-ts-interface: #6cff87; - --dark-color-ts-constructor: var(--dark-color-ts-class); - --dark-color-ts-property: var(--dark-color-ts-variable); - --dark-color-ts-method: var(--dark-color-ts-function); - --dark-color-ts-call-signature: var(--dark-color-ts-method); - --dark-color-ts-index-signature: var(--dark-color-ts-property); - --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); - --dark-color-ts-parameter: var(--dark-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --dark-color-ts-type-parameter: #e07d13; - --dark-color-ts-accessor: var(--dark-color-ts-property); - --dark-color-ts-get-signature: var(--dark-color-ts-accessor); - --dark-color-ts-set-signature: var(--dark-color-ts-accessor); - --dark-color-ts-type-alias: #ff6492; - /* reference not included as links will be colored with the kind that it points to */ - - --dark-external-icon: url("data:image/svg+xml;utf8,"); - --dark-color-scheme: dark; -} - -@media (prefers-color-scheme: light) { - :root { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); - } -} - -@media (prefers-color-scheme: dark) { - :root { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); - } -} - -html { - color-scheme: var(--color-scheme); -} - -body { - margin: 0; -} - -:root[data-theme="light"] { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); -} - -:root[data-theme="dark"] { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); -} - -.always-visible, -.always-visible .tsd-signatures { - display: inherit !important; -} - -h1, -h2, -h3, -h4, -h5, -h6 { - line-height: 1.2; -} - -h1 > a:not(.link), -h2 > a:not(.link), -h3 > a:not(.link), -h4 > a:not(.link), -h5 > a:not(.link), -h6 > a:not(.link) { - text-decoration: none; - color: var(--color-text); -} - -h1 { - font-size: 1.875rem; - margin: 0.67rem 0; -} - -h2 { - font-size: 1.5rem; - margin: 0.83rem 0; -} - -h3 { - font-size: 1.25rem; - margin: 1rem 0; -} - -h4 { - font-size: 1.05rem; - margin: 1.33rem 0; -} - -h5 { - font-size: 1rem; - margin: 1.5rem 0; -} - -h6 { - font-size: 0.875rem; - margin: 2.33rem 0; -} - -.uppercase { - text-transform: uppercase; -} - -dl, -menu, -ol, -ul { - margin: 1em 0; -} - -dd { - margin: 0 0 0 40px; -} - -.container { - max-width: 1700px; - padding: 0 2rem; -} - -/* Footer */ -.tsd-generator { - border-top: 1px solid var(--color-accent); - padding-top: 1rem; - padding-bottom: 1rem; - max-height: 3.5rem; -} - -.tsd-generator > p { - margin-top: 0; - margin-bottom: 0; - padding: 0 1rem; -} - -.container-main { - margin: 0 auto; - /* toolbar, footer, margin */ - min-height: calc(100vh - 41px - 56px - 4rem); -} - -@keyframes fade-in { - from { - opacity: 0; - } - to { - opacity: 1; - } -} -@keyframes fade-out { - from { - opacity: 1; - visibility: visible; - } - to { - opacity: 0; - } -} -@keyframes fade-in-delayed { - 0% { - opacity: 0; - } - 33% { - opacity: 0; - } - 100% { - opacity: 1; - } -} -@keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; - } - 66% { - opacity: 0; - } - 100% { - opacity: 0; - } -} -@keyframes pop-in-from-right { - from { - transform: translate(100%, 0); - } - to { - transform: translate(0, 0); - } -} -@keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; - } - to { - transform: translate(100%, 0); - } -} -body { - background: var(--color-background); - font-family: "Segoe UI", sans-serif; - font-size: 16px; - color: var(--color-text); -} - -a { - color: var(--color-link); - text-decoration: none; -} -a:hover { - text-decoration: underline; -} -a.external[target="_blank"] { - background-image: var(--external-icon); - background-position: top 3px right; - background-repeat: no-repeat; - padding-right: 13px; -} - -code, -pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 0.875rem; - border-radius: 0.8em; -} - -pre { - position: relative; - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; - padding: 10px; - border: 1px solid var(--color-accent); -} -pre code { - padding: 0; - font-size: 100%; -} -pre > button { - position: absolute; - top: 10px; - right: 10px; - opacity: 0; - transition: opacity 0.1s; - box-sizing: border-box; -} -pre:hover > button, -pre > button.visible { - opacity: 1; -} - -blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; -} - -.tsd-typography { - line-height: 1.333em; -} -.tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-typography .tsd-index-panel h3, -.tsd-index-panel .tsd-typography h3, -.tsd-typography h4, -.tsd-typography h5, -.tsd-typography h6 { - font-size: 1em; -} -.tsd-typography h5, -.tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, -.tsd-typography ul, -.tsd-typography ol { - margin: 1em 0; -} -.tsd-typography table { - border-collapse: collapse; - border: none; -} -.tsd-typography td, -.tsd-typography th { - padding: 6px 13px; - border: 1px solid var(--color-accent); -} -.tsd-typography thead, -.tsd-typography tr:nth-child(even) { - background-color: var(--color-background-secondary); -} - -.tsd-breadcrumb { - margin: 0; - padding: 0; - color: var(--color-text-aside); -} -.tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; -} -.tsd-breadcrumb a:hover { - text-decoration: underline; -} -.tsd-breadcrumb li { - display: inline; -} -.tsd-breadcrumb li:after { - content: " / "; -} - -.tsd-comment-tags { - display: flex; - flex-direction: column; -} -dl.tsd-comment-tag-group { - display: flex; - align-items: center; - overflow: hidden; - margin: 0.5em 0; -} -dl.tsd-comment-tag-group dt { - display: flex; - margin-right: 0.5em; - font-size: 0.875em; - font-weight: normal; -} -dl.tsd-comment-tag-group dd { - margin: 0; -} -code.tsd-tag { - padding: 0.25em 0.4em; - border: 0.1em solid var(--color-accent); - margin-right: 0.25em; - font-size: 70%; -} -h1 code.tsd-tag:first-of-type { - margin-left: 0.25em; -} - -dl.tsd-comment-tag-group dd:before, -dl.tsd-comment-tag-group dd:after { - content: " "; -} -dl.tsd-comment-tag-group dd pre, -dl.tsd-comment-tag-group dd:after { - clear: both; -} -dl.tsd-comment-tag-group p { - margin: 0; -} - -.tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; -} -.tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; -} - -.tsd-filter-visibility h4 { - font-size: 1rem; - padding-top: 0.75rem; - padding-bottom: 0.5rem; - margin: 0; -} -.tsd-filter-item:not(:last-child) { - margin-bottom: 0.5rem; -} -.tsd-filter-input { - display: flex; - width: fit-content; - width: -moz-fit-content; - align-items: center; - user-select: none; - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - cursor: pointer; -} -.tsd-filter-input input[type="checkbox"] { - cursor: pointer; - position: absolute; - width: 1.5em; - height: 1.5em; - opacity: 0; -} -.tsd-filter-input input[type="checkbox"]:disabled { - pointer-events: none; -} -.tsd-filter-input svg { - cursor: pointer; - width: 1.5em; - height: 1.5em; - margin-right: 0.5em; - border-radius: 0.33em; - /* Leaving this at full opacity breaks event listeners on Firefox. - Don't remove unless you know what you're doing. */ - opacity: 0.99; -} -.tsd-filter-input input[type="checkbox"]:focus + svg { - transform: scale(0.95); -} -.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { - transform: scale(1); -} -.tsd-checkbox-background { - fill: var(--color-accent); -} -input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { - stroke: var(--color-text); -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { - fill: var(--color-background); - stroke: var(--color-accent); - stroke-width: 0.25rem; -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { - stroke: var(--color-accent); -} - -.tsd-theme-toggle { - padding-top: 0.75rem; -} -.tsd-theme-toggle > h4 { - display: inline; - vertical-align: middle; - margin-right: 0.75rem; -} - -.tsd-hierarchy { - list-style: square; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} - -.tsd-full-hierarchy:not(:last-child) { - margin-bottom: 1em; - padding-bottom: 1em; - border-bottom: 1px solid var(--color-accent); -} -.tsd-full-hierarchy, -.tsd-full-hierarchy ul { - list-style: none; - margin: 0; - padding: 0; -} -.tsd-full-hierarchy ul { - padding-left: 1.5rem; -} -.tsd-full-hierarchy a { - padding: 0.25rem 0 !important; - font-size: 1rem; - display: inline-flex; - align-items: center; - color: var(--color-text); -} - -.tsd-panel-group.tsd-index-group { - margin-bottom: 0; -} -.tsd-index-panel .tsd-index-list { - list-style: none; - line-height: 1.333em; - margin: 0; - padding: 0.25rem 0 0 0; - overflow: hidden; - display: grid; - grid-template-columns: repeat(3, 1fr); - column-gap: 1rem; - grid-template-rows: auto; -} -@media (max-width: 1024px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(2, 1fr); - } -} -@media (max-width: 768px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(1, 1fr); - } -} -.tsd-index-panel .tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; -} - -.tsd-flag { - display: inline-block; - padding: 0.25em 0.4em; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 75%; - line-height: 1; - font-weight: normal; -} - -.tsd-anchor { - position: relative; - top: -100px; -} - -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - display: flex; - align-items: center; - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} - -.tsd-navigation.settings { - margin: 1rem 0; -} -.tsd-navigation > a, -.tsd-navigation .tsd-accordion-summary { - width: calc(100% - 0.25rem); - display: flex; - align-items: center; -} -.tsd-navigation a, -.tsd-navigation summary > span, -.tsd-page-navigation a { - display: flex; - width: calc(100% - 0.25rem); - align-items: center; - padding: 0.25rem; - color: var(--color-text); - text-decoration: none; - box-sizing: border-box; -} -.tsd-navigation a.current, -.tsd-page-navigation a.current { - background: var(--color-active-menu-item); -} -.tsd-navigation a:hover, -.tsd-page-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul, -.tsd-page-navigation ul { - margin-top: 0; - margin-bottom: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li, -.tsd-page-navigation li { - padding: 0; - max-width: 100%; -} -.tsd-nested-navigation { - margin-left: 3rem; -} -.tsd-nested-navigation > li > details { - margin-left: -1.5rem; -} -.tsd-small-nested-navigation { - margin-left: 1.5rem; -} -.tsd-small-nested-navigation > li > details { - margin-left: -1.5rem; -} - -.tsd-page-navigation ul { - padding-left: 1.75rem; -} - -#tsd-sidebar-links a { - margin-top: 0; - margin-bottom: 0.5rem; - line-height: 1.25rem; -} -#tsd-sidebar-links a:last-of-type { - margin-bottom: 0; -} - -a.tsd-index-link { - padding: 0.25rem 0 !important; - font-size: 1rem; - line-height: 1.25rem; - display: inline-flex; - align-items: center; - color: var(--color-text); -} -.tsd-accordion-summary { - list-style-type: none; /* hide marker on non-safari */ - outline: none; /* broken on safari, so just hide it */ -} -.tsd-accordion-summary::-webkit-details-marker { - display: none; /* hide marker on safari */ -} -.tsd-accordion-summary, -.tsd-accordion-summary a { - user-select: none; - -moz-user-select: none; - -webkit-user-select: none; - -ms-user-select: none; - - cursor: pointer; -} -.tsd-accordion-summary a { - width: calc(100% - 1.5rem); -} -.tsd-accordion-summary > * { - margin-top: 0; - margin-bottom: 0; - padding-top: 0; - padding-bottom: 0; -} -.tsd-index-accordion .tsd-accordion-summary > svg { - margin-left: 0.25rem; -} -.tsd-index-content > :not(:first-child) { - margin-top: 0.75rem; -} -.tsd-index-heading { - margin-top: 1.5rem; - margin-bottom: 0.75rem; -} - -.tsd-kind-icon { - margin-right: 0.5rem; - width: 1.25rem; - height: 1.25rem; - min-width: 1.25rem; - min-height: 1.25rem; -} -.tsd-kind-icon path { - transform-origin: center; - transform: scale(1.1); -} -.tsd-signature > .tsd-kind-icon { - margin-right: 0.8rem; -} - -.tsd-panel { - margin-bottom: 2.5rem; -} -.tsd-panel.tsd-member { - margin-bottom: 4rem; -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, -.tsd-panel > h2, -.tsd-panel > h3 { - margin: 1.5rem -1.5rem 0.75rem -1.5rem; - padding: 0 1.5rem 0.75rem 1.5rem; -} -.tsd-panel > h1.tsd-before-signature, -.tsd-panel > h2.tsd-before-signature, -.tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: none; -} - -.tsd-panel-group { - margin: 4rem 0; -} -.tsd-panel-group.tsd-index-group { - margin: 2rem 0; -} -.tsd-panel-group.tsd-index-group details { - margin: 2rem 0; -} - -#tsd-search { - transition: background-color 0.2s; -} -#tsd-search .title { - position: relative; - z-index: 2; -} -#tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 2.5rem; - height: 100%; -} -#tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: var(--color-text); -} -#tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; -} -#tsd-search .field input, -#tsd-search .title, -#tsd-toolbar-links a { - transition: opacity 0.2s; -} -#tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -#tsd-search .results li { - background-color: var(--color-background); - line-height: initial; - padding: 4px; -} -#tsd-search .results li:nth-child(even) { - background-color: var(--color-background-secondary); -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current:not(.no-results), -#tsd-search .results li:hover:not(.no-results) { - background-color: var(--color-accent); -} -#tsd-search .results a { - display: flex; - align-items: center; - padding: 0.25rem; - box-sizing: border-box; -} -#tsd-search .results a:before { - top: 10px; -} -#tsd-search .results span.parent { - color: var(--color-text-aside); - font-weight: normal; -} -#tsd-search.has-focus { - background-color: var(--color-accent); -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title, -#tsd-search.has-focus #tsd-toolbar-links a { - z-index: 0; - opacity: 0; -} -#tsd-search.has-focus .results { - visibility: visible; -} -#tsd-search.loading .results li.state.loading { - display: block; -} -#tsd-search.failure .results li.state.failure { - display: block; -} - -#tsd-toolbar-links { - position: absolute; - top: 0; - right: 2rem; - height: 100%; - display: flex; - align-items: center; - justify-content: flex-end; -} -#tsd-toolbar-links a { - margin-left: 1.5rem; -} -#tsd-toolbar-links a:hover { - text-decoration: underline; -} - -.tsd-signature { - margin: 0 0 1rem 0; - padding: 1rem 0.5rem; - border: 1px solid var(--color-accent); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; -} - -.tsd-signature-keyword { - color: var(--color-ts-keyword); - font-weight: normal; -} - -.tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; -} - -.tsd-signature-type { - font-style: italic; - font-weight: normal; -} - -.tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - list-style-type: none; -} -.tsd-signatures .tsd-signature { - margin: 0; - border-color: var(--color-accent); - border-width: 1px 0; - transition: background-color 0.1s; -} -.tsd-description .tsd-signatures .tsd-signature { - border-width: 1px; -} - -ul.tsd-parameter-list, -ul.tsd-type-parameter-list { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameter-list > li.tsd-parameter-signature, -ul.tsd-type-parameter-list > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameter-list h5, -ul.tsd-type-parameter-list h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -.tsd-sources { - margin-top: 1rem; - font-size: 0.875em; -} -.tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: sticky; - z-index: 1; - top: 0; - left: 0; - width: 100%; - color: var(--color-text); - background: var(--color-background-secondary); - border-bottom: 1px var(--color-accent) solid; - transition: transform 0.3s ease-in-out; -} -.tsd-page-toolbar a { - color: var(--color-text); - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .tsd-toolbar-contents { - display: flex; - justify-content: space-between; - height: 2.5rem; - margin: 0 auto; -} -.tsd-page-toolbar .table-cell { - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} -.tsd-page-toolbar .tsd-toolbar-icon { - box-sizing: border-box; - line-height: 0; - padding: 12px 0; -} - -.tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.8; - height: 40px; - transition: - opacity 0.1s, - background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-widget:hover { - opacity: 0.9; -} -.tsd-widget.active { - opacity: 1; - background-color: var(--color-accent); -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} - -.tsd-widget.options, -.tsd-widget.menu { - display: none; -} -input[type="checkbox"] + .tsd-widget:before { - background-position: -120px 0; -} -input[type="checkbox"]:checked + .tsd-widget:before { - background-position: -160px 0; -} - -img { - max-width: 100%; -} - -.tsd-anchor-icon { - display: inline-flex; - align-items: center; - margin-left: 0.5rem; - vertical-align: middle; - color: var(--color-text); -} - -.tsd-anchor-icon svg { - width: 1em; - height: 1em; - visibility: hidden; -} - -.tsd-anchor-link:hover > .tsd-anchor-icon svg { - visibility: visible; -} - -.deprecated { - text-decoration: line-through !important; -} - -.warning { - padding: 1rem; - color: var(--color-warning-text); - background: var(--color-background-warning); -} - -.tsd-kind-project { - color: var(--color-ts-project); -} -.tsd-kind-module { - color: var(--color-ts-module); -} -.tsd-kind-namespace { - color: var(--color-ts-namespace); -} -.tsd-kind-enum { - color: var(--color-ts-enum); -} -.tsd-kind-enum-member { - color: var(--color-ts-enum-member); -} -.tsd-kind-variable { - color: var(--color-ts-variable); -} -.tsd-kind-function { - color: var(--color-ts-function); -} -.tsd-kind-class { - color: var(--color-ts-class); -} -.tsd-kind-interface { - color: var(--color-ts-interface); -} -.tsd-kind-constructor { - color: var(--color-ts-constructor); -} -.tsd-kind-property { - color: var(--color-ts-property); -} -.tsd-kind-method { - color: var(--color-ts-method); -} -.tsd-kind-call-signature { - color: var(--color-ts-call-signature); -} -.tsd-kind-index-signature { - color: var(--color-ts-index-signature); -} -.tsd-kind-constructor-signature { - color: var(--color-ts-constructor-signature); -} -.tsd-kind-parameter { - color: var(--color-ts-parameter); -} -.tsd-kind-type-literal { - color: var(--color-ts-type-literal); -} -.tsd-kind-type-parameter { - color: var(--color-ts-type-parameter); -} -.tsd-kind-accessor { - color: var(--color-ts-accessor); -} -.tsd-kind-get-signature { - color: var(--color-ts-get-signature); -} -.tsd-kind-set-signature { - color: var(--color-ts-set-signature); -} -.tsd-kind-type-alias { - color: var(--color-ts-type-alias); -} - -/* if we have a kind icon, don't color the text by kind */ -.tsd-kind-icon ~ span { - color: var(--color-text); -} - -* { - scrollbar-width: thin; - scrollbar-color: var(--color-accent) var(--color-icon-background); -} - -*::-webkit-scrollbar { - width: 0.75rem; -} - -*::-webkit-scrollbar-track { - background: var(--color-icon-background); -} - -*::-webkit-scrollbar-thumb { - background-color: var(--color-accent); - border-radius: 999rem; - border: 0.25rem solid var(--color-icon-background); -} - -/* mobile */ -@media (max-width: 769px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; - } - - .container-main { - display: flex; - } - html .col-content { - float: none; - max-width: 100%; - width: 100%; - } - html .col-sidebar { - position: fixed !important; - overflow-y: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - padding: 1.5rem 1.5rem 0 0; - width: 75vw; - visibility: hidden; - background-color: var(--color-background); - transform: translate(100%, 0); - } - html .col-sidebar > *:last-child { - padding-bottom: 20px; - } - html .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; - } - - .to-has-menu .overlay { - animation: fade-in 0.4s; - } - - .to-has-menu .col-sidebar { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu .col-sidebar { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu .col-sidebar { - visibility: visible; - transform: translate(0, 0); - display: flex; - flex-direction: column; - gap: 1.5rem; - max-height: 100vh; - padding: 1rem 2rem; - } - .has-menu .tsd-navigation { - max-height: 100%; - } -} - -/* one sidebar */ -@media (min-width: 770px) { - .container-main { - display: grid; - grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); - grid-template-areas: "sidebar content"; - margin: 2rem auto; - } - - .col-sidebar { - grid-area: sidebar; - } - .col-content { - grid-area: content; - padding: 0 1rem; - } -} -@media (min-width: 770px) and (max-width: 1399px) { - .col-sidebar { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - padding-top: 1rem; - } - .site-menu { - margin-top: 1rem; - } -} - -/* two sidebars */ -@media (min-width: 1200px) { - .container-main { - grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); - grid-template-areas: "sidebar content toc"; - } - - .col-sidebar { - display: contents; - } - - .page-menu { - grid-area: toc; - padding-left: 1rem; - } - .site-menu { - grid-area: sidebar; - } - - .site-menu { - margin-top: 1rem 0; - } - - .page-menu, - .site-menu { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - } -} diff --git a/docs/classes/ZetaChainClient.html b/docs/classes/ZetaChainClient.html deleted file mode 100644 index a7f4e25c..00000000 --- a/docs/classes/ZetaChainClient.html +++ /dev/null @@ -1,67 +0,0 @@ -ZetaChainClient | @zetachain/toolkit

Constructors

  • Initializes ZetaChainClient instance.

    -
    new ZetaChainClient({
    network: "testnet"
    }) -
    -

    With an Ethers.js wallet:

    -
    const client = new ZetaChainClient({
    network: "testnet",
    wallet: ethers.Wallet.fromMnemonic(process.env.MNEMONIC as string),
    }); -
    -

    With a signer:

    -
    const client = new ZetaChainClient({
    network: "testnet",
    signer: await ethers.getSigners(),
    }); -
    -

    Use a custom RPC endpoint for ZetaChain or any connected chain:

    -
    const client = new ZetaChainClient({
    network: "testnet",
    chains: {
    zeta_testnet: {
    api: {
    url: "https://zetachain-testnet-archive.allthatnode.com:8545/${process.env.KEY}",
    type: "evm",
    },
    },
    },
    }); -
    -

    Parameters

    Returns ZetaChainClient

Properties

chains: {
    [key: string]: any;
}

Type declaration

  • [key: string]: any
deposit: ((this, options) => Promise<any>) = deposit

Type declaration

    • (this, options): Promise<any>
    • Initiates a deposit transaction of native gas or ERC-20 assets as ZRC-20 from -a connected chain to ZetaChain.

      -

      Parameters

      • this: ZetaChainClient

        ZetaChainClient instance.

        -
      • options: {
            amount: string;
            chain: string;
            erc20?: string;
            message?: [string[], string[]];
            recipient?: string;
        }

        Deposit options.

        -
        • amount: string

          Amount to be deposited in human readable form. For -example, 1.5 ETH is "1.5".

          -
        • chain: string
        • Optional erc20?: string

          If an ERC-20 token is being deposited, the address of -the ERC-20 token contract. If not provided, the deposit is assumed to be in -native gas token.

          -
        • Optional message?: [string[], string[]]

          If a message is specified, ZetaChain will deposit -tokens into the recipient contract and call with with the message as an argument.

          -
        • Optional recipient?: string

          Recipient address for the deposit. If not provided, -the deposit is made to the signer's address. If the message is provided, the -recipient is assumed to be a contract address.

          -

      Returns Promise<any>

      A promise that resolves with the transaction details upon success.

      -
getBalances: ((this, __namedParameters) => Promise<TokenBalance[]>) = getBalances

Type declaration

    • (this, __namedParameters): Promise<TokenBalance[]>
    • Parameters

      • this: ZetaChainClient
      • __namedParameters: {
            btc?: string;
            evm: string;
        }
        • Optional btc?: string
        • evm: string

      Returns Promise<TokenBalance[]>

getChainId: ((this, chainNameOrAlias) => null | number) = getChainId

Type declaration

    • (this, chainNameOrAlias): null | number
    • Parameters

      Returns null | number

getEndpoints: ((this, type, network) => any) = getEndpoints

Type declaration

    • (this, type, network): any
    • Parameters

      Returns any

getFees: ((this, gas) => Promise<{
    feesCCM: Record<string, any>;
    feesZEVM: Record<string, any>;
}>) = getFees

Type declaration

    • (this, gas): Promise<{
          feesCCM: Record<string, any>;
          feesZEVM: Record<string, any>;
      }>
    • Parameters

      Returns Promise<{
          feesCCM: Record<string, any>;
          feesZEVM: Record<string, any>;
      }>

getForeignCoins: ((this) => Promise<any>) = getForeignCoins

Type declaration

getPools: ((this) => Promise<any[]>) = getPools

Type declaration

    • (this): Promise<any[]>
    • Parameters

      Returns Promise<any[]>

getSupportedChains: ((this) => Promise<any>) = getSupportedChains

Type declaration

network: string
sendZRC20: ((this, signer, amount, network, destination, recipient, token) => Promise<any>) = sendZRC20

Type declaration

    • (this, signer, amount, network, destination, recipient, token): Promise<any>
    • Parameters

      • this: ZetaChainClient
      • signer: any
      • amount: string
      • network: string
      • destination: string
      • recipient: string
      • token: string

      Returns Promise<any>

sendZeta: ((this, options) => Promise<any>) = sendZeta

Type declaration

    • (this, options): Promise<any>
    • Initiates a cross-chain transfer of ZETA tokens from the source chain to the -destination chain.

      -

      Parameters

      • this: ZetaChainClient

        ZetaChainClient instance.

        -
      • options: {
            amount: string;
            chain: string;
            destination: string;
            gasLimit?: Number;
            recipient: string;
        }

        Send ZETA options.

        -
        • amount: string

          Amount of ZETA tokens to be sent in human readable form.

          -
        • chain: string

          Source chain label.

          -
        • destination: string

          Destination chain label.

          -
        • Optional gasLimit?: Number

          Optional gas limit on the destination chain.

          -
        • recipient: string

          Optional recipient address for the token transfer. If not -provided, the token transfer is made to the signer's address.

          -

      Returns Promise<any>

      A promise that resolves with the transaction details upon success.

      -
signer: any
trackCCTX: ((this, hash, json?, emitter?) => Promise<void>) = trackCCTX

Type declaration

    • (this, hash, json?, emitter?): Promise<void>
    • Parameters

      Returns Promise<void>

wallet: undefined | Wallet
withdraw: ((this, options) => Promise<any>) = withdraw

Type declaration

    • (this, options): Promise<any>
    • Initiates a withdraw transaction of a ZRC-20 token from ZetaChain to a -connected chain as a native gas or ERC-20 token.

      -

      Parameters

      • this: ZetaChainClient

        ZetaChainClient instance.

        -
      • options: {
            amount: string;
            recipient?: string;
            zrc20: string;
        }

        Withdrawal options.

        -
        • amount: string

          Amount to be withdrawn in human readable form.

          -
        • Optional recipient?: string

          Recipient address for the withdrawal. If not provided, -the withdrawal is made to the signer's address.

          -
        • zrc20: string

          ZRC-20 token contract address.

          -

      Returns Promise<any>

      A promise that resolves with the transaction details upon success.

      -

Methods

  • Returns {
        [key: string]: any;
    }

    • [key: string]: any
  • Parameters

    • customChains: {
          [key: string]: any;
      } = {}
      • [key: string]: any

    Returns void

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/deposit.html b/docs/functions/deposit.html deleted file mode 100644 index 984ef2f9..00000000 --- a/docs/functions/deposit.html +++ /dev/null @@ -1,16 +0,0 @@ -deposit | @zetachain/toolkit
  • Initiates a deposit transaction of native gas or ERC-20 assets as ZRC-20 from -a connected chain to ZetaChain.

    -

    Parameters

    • this: ZetaChainClient

      ZetaChainClient instance.

      -
    • options: {
          amount: string;
          chain: string;
          erc20?: string;
          message?: [string[], string[]];
          recipient?: string;
      }

      Deposit options.

      -
      • amount: string

        Amount to be deposited in human readable form. For -example, 1.5 ETH is "1.5".

        -
      • chain: string
      • Optional erc20?: string

        If an ERC-20 token is being deposited, the address of -the ERC-20 token contract. If not provided, the deposit is assumed to be in -native gas token.

        -
      • Optional message?: [string[], string[]]

        If a message is specified, ZetaChain will deposit -tokens into the recipient contract and call with with the message as an argument.

        -
      • Optional recipient?: string

        Recipient address for the deposit. If not provided, -the deposit is made to the signer's address. If the message is provided, the -recipient is assumed to be a contract address.

        -

    Returns Promise<any>

    A promise that resolves with the transaction details upon success.

    -

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/getBalances.html b/docs/functions/getBalances.html deleted file mode 100644 index 11d7f22a..00000000 --- a/docs/functions/getBalances.html +++ /dev/null @@ -1 +0,0 @@ -getBalances | @zetachain/toolkit

Function getBalances

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/getChainId.html b/docs/functions/getChainId.html deleted file mode 100644 index f998d221..00000000 --- a/docs/functions/getChainId.html +++ /dev/null @@ -1 +0,0 @@ -getChainId | @zetachain/toolkit

Function getChainId

  • Parameters

    Returns null | number

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/getEndpoints.html b/docs/functions/getEndpoints.html deleted file mode 100644 index 7821bc38..00000000 --- a/docs/functions/getEndpoints.html +++ /dev/null @@ -1 +0,0 @@ -getEndpoints | @zetachain/toolkit

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/getFees.html b/docs/functions/getFees.html deleted file mode 100644 index ef735b58..00000000 --- a/docs/functions/getFees.html +++ /dev/null @@ -1 +0,0 @@ -getFees | @zetachain/toolkit
  • Parameters

    Returns Promise<{
        feesCCM: Record<string, any>;
        feesZEVM: Record<string, any>;
    }>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/getForeignCoins.html b/docs/functions/getForeignCoins.html deleted file mode 100644 index c55079b1..00000000 --- a/docs/functions/getForeignCoins.html +++ /dev/null @@ -1 +0,0 @@ -getForeignCoins | @zetachain/toolkit

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/getPools.html b/docs/functions/getPools.html deleted file mode 100644 index c136008e..00000000 --- a/docs/functions/getPools.html +++ /dev/null @@ -1 +0,0 @@ -getPools | @zetachain/toolkit

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/getSupportedChains.html b/docs/functions/getSupportedChains.html deleted file mode 100644 index 8d035a60..00000000 --- a/docs/functions/getSupportedChains.html +++ /dev/null @@ -1 +0,0 @@ -getSupportedChains | @zetachain/toolkit

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/prepareData.html b/docs/functions/prepareData.html deleted file mode 100644 index 00d9d3fe..00000000 --- a/docs/functions/prepareData.html +++ /dev/null @@ -1 +0,0 @@ -prepareData | @zetachain/toolkit

Function prepareData

  • Parameters

    • contract: string
    • types: string[]
    • args: any[]

    Returns string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/prepareParams.html b/docs/functions/prepareParams.html deleted file mode 100644 index 834fd481..00000000 --- a/docs/functions/prepareParams.html +++ /dev/null @@ -1 +0,0 @@ -prepareParams | @zetachain/toolkit

Function prepareParams

  • Parameters

    • types: string[]
    • args: any[]

    Returns string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/sendZRC20.html b/docs/functions/sendZRC20.html deleted file mode 100644 index a501650e..00000000 --- a/docs/functions/sendZRC20.html +++ /dev/null @@ -1 +0,0 @@ -sendZRC20 | @zetachain/toolkit

Function sendZRC20

  • Parameters

    • this: ZetaChainClient
    • signer: any
    • amount: string
    • network: string
    • destination: string
    • recipient: string
    • token: string

    Returns Promise<any>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/sendZeta.html b/docs/functions/sendZeta.html deleted file mode 100644 index 1cffde77..00000000 --- a/docs/functions/sendZeta.html +++ /dev/null @@ -1,12 +0,0 @@ -sendZeta | @zetachain/toolkit
  • Initiates a cross-chain transfer of ZETA tokens from the source chain to the -destination chain.

    -

    Parameters

    • this: ZetaChainClient

      ZetaChainClient instance.

      -
    • options: {
          amount: string;
          chain: string;
          destination: string;
          gasLimit?: Number;
          recipient: string;
      }

      Send ZETA options.

      -
      • amount: string

        Amount of ZETA tokens to be sent in human readable form.

        -
      • chain: string

        Source chain label.

        -
      • destination: string

        Destination chain label.

        -
      • Optional gasLimit?: Number

        Optional gas limit on the destination chain.

        -
      • recipient: string

        Optional recipient address for the token transfer. If not -provided, the token transfer is made to the signer's address.

        -

    Returns Promise<any>

    A promise that resolves with the transaction details upon success.

    -

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/trackCCTX.html b/docs/functions/trackCCTX.html deleted file mode 100644 index b347056c..00000000 --- a/docs/functions/trackCCTX.html +++ /dev/null @@ -1 +0,0 @@ -trackCCTX | @zetachain/toolkit

Function trackCCTX

  • Parameters

    Returns Promise<void>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/withdraw.html b/docs/functions/withdraw.html deleted file mode 100644 index fb4b83fc..00000000 --- a/docs/functions/withdraw.html +++ /dev/null @@ -1,10 +0,0 @@ -withdraw | @zetachain/toolkit
  • Initiates a withdraw transaction of a ZRC-20 token from ZetaChain to a -connected chain as a native gas or ERC-20 token.

    -

    Parameters

    • this: ZetaChainClient

      ZetaChainClient instance.

      -
    • options: {
          amount: string;
          recipient?: string;
          zrc20: string;
      }

      Withdrawal options.

      -
      • amount: string

        Amount to be withdrawn in human readable form.

        -
      • Optional recipient?: string

        Recipient address for the withdrawal. If not provided, -the withdrawal is made to the signer's address.

        -
      • zrc20: string

        ZRC-20 token contract address.

        -

    Returns Promise<any>

    A promise that resolves with the transaction details upon success.

    -

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 9d68ac0c..00000000 --- a/docs/index.html +++ /dev/null @@ -1,26 +0,0 @@ -@zetachain/toolkit

@zetachain/toolkit

ZetaChain Toolkit

This repository contains a collection of helper contracts, Hardhat tasks, and -utility functions that make it easier to build with ZetaChain.

-

Building a dApp on ZetaChain

If you're looking to build a dapp on ZetaChain, we recommend using the Hardhat -template. This template has all the -toolkit featured imported, so you don't need to install this package manually.

-

Prerequisites

Before getting started, ensure that you have -Node.js and Yarn -installed on your system.

-

Installation

To install this package in Hardhat project, add it as a development dependency:

-
yarn add --dev @zetachain/toolkit
-
-

Installing tasks

To install all the the tasks into a Hardhat template, add the following import -statement to hardhat.config.js:

-
import "@zetachain/toolkit/tasks";
-
-

Importing Helper Functions

import {
deployZetaConnectorMock,
deployZetaEthMock,
prepareData,
prepareParams,
evmSetup,
} from "@zetachain/toolkit/helpers"; -
-

Importing Helper Contracts

pragma solidity 0.8.7;

import "@zetachain/toolkit/contracts/BytesHelperLib.sol";
import "@zetachain/toolkit/contracts/TestSystemContract.sol";
import "@zetachain/toolkit/contracts/TestZRC20.sol";
import "@zetachain/toolkit/contracts/SwapHelperLib.sol";
import "@zetachain/toolkit/contracts/ZetaConnectorMock.sol";
import "@zetachain/toolkit/contracts/EthZetaMock.sol"; -
-

Contributing to the Project

To get started, install the necessary dependencies by running the following -command in your terminal:

-
yarn
-
-
yarn build
-
-

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..b6c7524d --- /dev/null +++ b/docs/index.md @@ -0,0 +1,110 @@ +--- +title: Toolkit +--- + +# ZetaChain Toolkit + +This repository contains a collection of helper contracts, Hardhat tasks, and +utility functions that make it easier to build with ZetaChain. + +## Building a dApp on ZetaChain + +If you're looking to build a dapp on ZetaChain, we recommend using the Hardhat +[template](https://github.com/zeta-chain/template). This template has all the +toolkit featured imported, so you don't need to install this package manually. + +## Prerequisites + +Before getting started, ensure that you have +[Node.js](https://nodejs.org/en/download) and [Yarn](https://yarnpkg.com/) +installed on your system. + +## Installation + +To install this package in Hardhat project, add it as a development dependency: + +``` +yarn add --dev @zetachain/toolkit +``` + +## Installing tasks + +To install all the the tasks into a Hardhat template, add the following import +statement to `hardhat.config.js`: + +```ts +import "@zetachain/toolkit/tasks"; +``` + +## Importing Helper Functions + +```ts +import { + deployZetaConnectorMock, + deployZetaEthMock, + prepareData, + prepareParams, + evmSetup, +} from "@zetachain/toolkit/helpers"; +``` + +## Importing Helper Contracts + +```solidity +pragma solidity 0.8.7; + +import "@zetachain/toolkit/contracts/BytesHelperLib.sol"; +import "@zetachain/toolkit/contracts/TestSystemContract.sol"; +import "@zetachain/toolkit/contracts/TestZRC20.sol"; +import "@zetachain/toolkit/contracts/SwapHelperLib.sol"; +import "@zetachain/toolkit/contracts/ZetaConnectorMock.sol"; +import "@zetachain/toolkit/contracts/EthZetaMock.sol"; +``` + +## Contributing to the Project + +To get started, install the necessary dependencies by running the following +command in your terminal: + +``` +yarn +``` + +``` +yarn build +``` + +## Classes + +- [ZetaChainClient](toolkit/Class.ZetaChainClient.md) + +## Interfaces + +- [TokenBalance](toolkit/Interface.TokenBalance.md) +- [ZetaChainClientParamsBase](toolkit/Interface.ZetaChainClientParamsBase.md) + +## Type Aliases + +- [ZetaChainClientParams](toolkit/TypeAlias.ZetaChainClientParams.md) + +## Functions + +- [deposit](toolkit/Function.deposit.md) +- [getBalances](toolkit/Function.getBalances.md) +- [getChainId](toolkit/Function.getChainId.md) +- [getEndpoint](toolkit/Function.getEndpoint.md) +- [getFees](toolkit/Function.getFees.md) +- [getForeignCoins](toolkit/Function.getForeignCoins.md) +- [getHardhatConfig](toolkit/Function.getHardhatConfig.md) +- [getPools](toolkit/Function.getPools.md) +- [getQuote](toolkit/Function.getQuote.md) +- [getRefundFee](toolkit/Function.getRefundFee.md) +- [getSupportedChains](toolkit/Function.getSupportedChains.md) +- [getWithdrawFeeInInputToken](toolkit/Function.getWithdrawFeeInInputToken.md) +- [getZRC20FromERC20](toolkit/Function.getZRC20FromERC20.md) +- [getZRC20GasToken](toolkit/Function.getZRC20GasToken.md) +- [prepareData](toolkit/Function.prepareData.md) +- [prepareParams](toolkit/Function.prepareParams.md) +- [sendZeta](toolkit/Function.sendZeta.md) +- [trackCCTX](toolkit/Function.trackCCTX.md) +- [withdraw](toolkit/Function.withdraw.md) diff --git a/docs/interfaces/TokenBalance.html b/docs/interfaces/TokenBalance.html deleted file mode 100644 index 9de9af6c..00000000 --- a/docs/interfaces/TokenBalance.html +++ /dev/null @@ -1,11 +0,0 @@ -TokenBalance | @zetachain/toolkit

Interface TokenBalance

interface TokenBalance {
    balance: string;
    chain_id: string | number;
    chain_name: string;
    coin_type: string;
    contract?: string;
    decimals: number;
    id: string;
    symbol: string;
    ticker: string;
    zrc20?: string;
}

Properties

balance: string
chain_id: string | number
chain_name: string
coin_type: string
contract?: string
decimals: number
id: string
symbol: string
ticker: string
zrc20?: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/ZetaChainClientParamsBase.html b/docs/interfaces/ZetaChainClientParamsBase.html deleted file mode 100644 index b26c99ff..00000000 --- a/docs/interfaces/ZetaChainClientParamsBase.html +++ /dev/null @@ -1,3 +0,0 @@ -ZetaChainClientParamsBase | @zetachain/toolkit

Interface ZetaChainClientParamsBase

interface ZetaChainClientParamsBase {
    chains?: {
        [key: string]: any;
    };
    network?: string;
}

Properties

Properties

chains?: {
    [key: string]: any;
}

Type declaration

  • [key: string]: any
network?: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html deleted file mode 100644 index 86a36c54..00000000 --- a/docs/modules.html +++ /dev/null @@ -1,19 +0,0 @@ -@zetachain/toolkit

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/ZetaChainClientParams.html b/docs/types/ZetaChainClientParams.html deleted file mode 100644 index 3c016b12..00000000 --- a/docs/types/ZetaChainClientParams.html +++ /dev/null @@ -1 +0,0 @@ -ZetaChainClientParams | @zetachain/toolkit

Type alias ZetaChainClientParams

ZetaChainClientParams: ZetaChainClientParamsBase & ({
    signer: any;
    wallet?: never;
} | {
    signer?: never;
    wallet: any;
} | {
    signer?: undefined;
    wallet?: undefined;
})

Generated using TypeDoc

\ No newline at end of file diff --git a/package.json b/package.json index 77bf6fa4..cedccad2 100644 --- a/package.json +++ b/package.json @@ -28,9 +28,7 @@ "lint:sol:fix": "prettier --write \"contracts/**/*.sol\"", "lint:sol": "solhint 'contracts/**/*.sol' && prettier -c 'contracts/**/*.sol'", "lint": "npm run lint:js && npm run lint:sol", - "docs:build": "typedoc ./packages/client/src/index.ts", - "docs:start": "http-server ./docs", - "docs": "yarn docs:build && yarn docs:start", + "docs": "rimraf docs && typedoc ./packages/client/src/index.ts", "copy-templates": "npx cpx './packages/tasks/templates/**/*' ./dist/packages/tasks/templates", "copy-types": "npx cpx './typechain-types/**/*' ./dist/typechain-types" }, @@ -78,7 +76,9 @@ "solidity-coverage": "^0.8.0", "ts-node": ">=8.0.0", "typechain": "^8.1.0", - "typedoc": "^0.25.9", + "typedoc": "^0.26.5", + "typedoc-plugin-frontmatter": "^1.0.0", + "typedoc-plugin-markdown": "^4.2.4", "typescript": ">=4.5.0" }, "files": [ @@ -94,7 +94,7 @@ "@uniswap/v2-periphery": "^1.1.0-beta.0", "@zetachain/faucet-cli": "^4.0.1", "@zetachain/networks": "^9.0.0", - "@zetachain/protocol-contracts": "^9.0.0", + "@zetachain/protocol-contracts": "8.0.0-rc1", "axios": "^1.4.0", "bech32": "^2.0.0", "bip39": "^3.1.0", @@ -116,4 +116,4 @@ "ws": "^8.13.0" }, "packageManager": "yarn@1.22.21+sha1.1959a18351b811cdeedbd484a8f86c3cc3bbaf72" -} +} \ No newline at end of file diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 00000000..0c544ef3 --- /dev/null +++ b/typedoc.json @@ -0,0 +1,11 @@ +{ + "flattenOutputFiles": true, + "mergeReadme": true, + "entryFileName": "index", + "publicPath": "toolkit", + "hidePageHeader": true, + "plugin": ["typedoc-plugin-markdown", "typedoc-plugin-frontmatter"], + "readmeFrontmatter": { + "title": "Toolkit" + } +} diff --git a/yarn.lock b/yarn.lock index 866a47bc..f10f5c28 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1361,6 +1361,13 @@ "@sentry/types" "5.30.0" tslib "^1.9.3" +"@shikijs/core@1.13.0": + version "1.13.0" + resolved "https://registry.yarnpkg.com/@shikijs/core/-/core-1.13.0.tgz#ffbdf8d27ce5783d97b979659194367e06b63af7" + integrity sha512-Mj5NVfbAXcD1GnwOTSPl8hBn/T8UDpfFQTptp+p41n/CbUcJtOq98WaRD7Lz3hCglYotUTHUWtzu3JhK6XlkAA== + dependencies: + "@types/hast" "^3.0.4" + "@sinonjs/commons@^2.0.0": version "2.0.0" resolved "https://registry.yarnpkg.com/@sinonjs/commons/-/commons-2.0.0.tgz#fd4ca5b063554307e8327b4564bd56d3b73924a3" @@ -1510,6 +1517,13 @@ "@types/minimatch" "*" "@types/node" "*" +"@types/hast@^3.0.4": + version "3.0.4" + resolved "https://registry.yarnpkg.com/@types/hast/-/hast-3.0.4.tgz#1d6b39993b82cea6ad783945b0508c25903e15aa" + integrity sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ== + dependencies: + "@types/unist" "*" + "@types/isomorphic-fetch@^0.0.38": version "0.0.38" resolved "https://registry.yarnpkg.com/@types/isomorphic-fetch/-/isomorphic-fetch-0.0.38.tgz#90882932a371e294a3c6143430275c15cb6ebf1b" @@ -1610,6 +1624,11 @@ resolved "https://registry.yarnpkg.com/@types/spinnies/-/spinnies-0.5.3.tgz#53530f0e7cfacc46f7992b3155a5440e5301d0ac" integrity sha512-HYrOubG2TVgRQRKcW1HJ/1eJIIBpLqDoJo551McJgWdO8xzxnaxu/bPKdqC/7okoEy4ZZjy3I4/DwK1sz2OCog== +"@types/unist@*": + version "3.0.3" + resolved "https://registry.yarnpkg.com/@types/unist/-/unist-3.0.3.tgz#acaab0f919ce69cce629c2d4ed2eb4adc1b6c20c" + integrity sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q== + "@types/wrap-ansi@^3.0.0": version "3.0.0" resolved "https://registry.yarnpkg.com/@types/wrap-ansi/-/wrap-ansi-3.0.0.tgz#18b97a972f94f60a679fd5c796d96421b9abb9fd" @@ -1767,10 +1786,10 @@ dependencies: dotenv "^16.1.4" -"@zetachain/protocol-contracts@^9.0.0": - version "9.0.0" - resolved "https://registry.yarnpkg.com/@zetachain/protocol-contracts/-/protocol-contracts-9.0.0.tgz#c20ad5da43f6f3676f31556b303d1cb4ea17357e" - integrity sha512-L4A8bddlyhjaBAsIv/x1Bvxc38RJz8U8rbbBtxK5oVyOAd5Zz04ZiT3HqzO4FuKq6RGGM1uiA8jvUfmRkKchXw== +"@zetachain/protocol-contracts@8.0.0-rc1": + version "8.0.0-rc1" + resolved "https://registry.yarnpkg.com/@zetachain/protocol-contracts/-/protocol-contracts-8.0.0-rc1.tgz#34df589c1b56df77f2695b37bd8a4b79df1787b1" + integrity sha512-VpgbQtVUxy4XYFb0P9UN9nQZkhQ+fr3Bg7A5SqZJCH3fi8QELSn6qaVSwATn+mXdnSMD2uXWSnyy/ANXFqedmw== abbrev@1: version "1.1.1" @@ -1896,11 +1915,6 @@ ansi-regex@^6.0.1: resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-6.0.1.tgz#3183e38fae9a65d7cb5e53945cd5897d0260a06a" integrity sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA== -ansi-sequence-parser@^1.1.0: - version "1.1.1" - resolved "https://registry.yarnpkg.com/ansi-sequence-parser/-/ansi-sequence-parser-1.1.1.tgz#e0aa1cdcbc8f8bb0b5bca625aac41f5f056973cf" - integrity sha512-vJXt3yiaUL4UU546s3rPXlsry/RnM730G1+HkpKE012AN0sx1eOrxSu95oKDIonskeLTijMgqWZ3uDEe3NFvyg== - ansi-styles@^3.2.1: version "3.2.1" resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-3.2.1.tgz#41fbb20243e50b12be0f04b8dedbf07520ce841d" @@ -3111,6 +3125,11 @@ enquirer@^2.3.0: ansi-colors "^4.1.1" strip-ansi "^6.0.1" +entities@^4.4.0: + version "4.5.0" + resolved "https://registry.yarnpkg.com/entities/-/entities-4.5.0.tgz#5d268ea5e7113ec74c4d033b79ea5a35a488fb48" + integrity sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw== + env-paths@^2.2.0: version "2.2.1" resolved "https://registry.yarnpkg.com/env-paths/-/env-paths-2.2.1.tgz#420399d416ce1fbe9bc0a07c62fa68d67fd0f8f2" @@ -5036,11 +5055,6 @@ json5@^1.0.2: dependencies: minimist "^1.2.0" -jsonc-parser@^3.2.0: - version "3.2.1" - resolved "https://registry.yarnpkg.com/jsonc-parser/-/jsonc-parser-3.2.1.tgz#031904571ccf929d7670ee8c547545081cb37f1a" - integrity sha512-AilxAyFOAcK5wA1+LeaySVBrHsGQvUFCDWXKpZjzaL0PqW+xfBOttn8GNtWKFWqneyMZj41MWF9Kl6iPWLwgOA== - jsonfile@^2.1.0: version "2.4.0" resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-2.4.0.tgz#3736a2b428b87bbda0cc83b53fa3d633a35c2ae8" @@ -5162,6 +5176,13 @@ lines-and-columns@^1.1.6: resolved "https://registry.yarnpkg.com/lines-and-columns/-/lines-and-columns-1.2.4.tgz#eca284f75d2965079309dc0ad9255abb2ebc1632" integrity sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg== +linkify-it@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/linkify-it/-/linkify-it-5.0.0.tgz#9ef238bfa6dc70bd8e7f9572b52d369af569b421" + integrity sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ== + dependencies: + uc.micro "^2.0.0" + locate-path@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-2.0.0.tgz#2b568b265eec944c6d9c0de9c3dbbbca0354cd8e" @@ -5256,16 +5277,23 @@ map-visit@^1.0.0: dependencies: object-visit "^1.0.0" +markdown-it@^14.1.0: + version "14.1.0" + resolved "https://registry.yarnpkg.com/markdown-it/-/markdown-it-14.1.0.tgz#3c3c5992883c633db4714ccb4d7b5935d98b7d45" + integrity sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg== + dependencies: + argparse "^2.0.1" + entities "^4.4.0" + linkify-it "^5.0.0" + mdurl "^2.0.0" + punycode.js "^2.3.1" + uc.micro "^2.1.0" + markdown-table@^1.1.3: version "1.1.3" resolved "https://registry.yarnpkg.com/markdown-table/-/markdown-table-1.1.3.tgz#9fcb69bcfdb8717bfd0398c6ec2d93036ef8de60" integrity sha512-1RUZVgQlpJSPWYbFSpmudq5nHY1doEIv89gBtF0s4gW1GF2XorxcA/70M5vq7rLv0a6mhOUccRsqkwhwLCIQ2Q== -marked@^4.3.0: - version "4.3.0" - resolved "https://registry.yarnpkg.com/marked/-/marked-4.3.0.tgz#796362821b019f734054582038b116481b456cf3" - integrity sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A== - math-random@^1.0.1: version "1.0.4" resolved "https://registry.yarnpkg.com/math-random/-/math-random-1.0.4.tgz#5dd6943c938548267016d4e34f057583080c514c" @@ -5280,6 +5308,11 @@ md5.js@^1.3.4: inherits "^2.0.1" safe-buffer "^5.1.2" +mdurl@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/mdurl/-/mdurl-2.0.0.tgz#80676ec0433025dd3e17ee983d0fe8de5a2237e0" + integrity sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w== + memorystream@^0.3.1: version "0.3.1" resolved "https://registry.yarnpkg.com/memorystream/-/memorystream-0.3.1.tgz#86d7090b30ce455d63fbae12dda51a47ddcaf9b2" @@ -5394,13 +5427,20 @@ minimatch@^5.0.1: dependencies: brace-expansion "^2.0.1" -minimatch@^9.0.1, minimatch@^9.0.3: +minimatch@^9.0.1: version "9.0.4" resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-9.0.4.tgz#8e49c731d1749cbec05050ee5145147b32496a51" integrity sha512-KqWh+VchfxcMNRAJjj2tnsSJdNbHsVgnkBhTNrW7AjVo6OvLtxw8zfT9oLw1JSohlFzJ8jCoTgaoXvJ+kHt6fw== dependencies: brace-expansion "^2.0.1" +minimatch@^9.0.5: + version "9.0.5" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-9.0.5.tgz#d74f9dd6b57d83d8e98cfb82133b03978bc929e5" + integrity sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow== + dependencies: + brace-expansion "^2.0.1" + minimist@^1.1.0, minimist@^1.2.0, minimist@^1.2.5, minimist@^1.2.6: version "1.2.8" resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.8.tgz#c1a464e7693302e082a075cee0c057741ac4772c" @@ -5992,6 +6032,11 @@ proxy-from-env@^1.1.0: resolved "https://registry.yarnpkg.com/proxy-from-env/-/proxy-from-env-1.1.0.tgz#e102f16ca355424865755d2c9e8ea4f24d58c3e2" integrity sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg== +punycode.js@^2.3.1: + version "2.3.1" + resolved "https://registry.yarnpkg.com/punycode.js/-/punycode.js-2.3.1.tgz#6b53e56ad75588234e79f4affa90972c7dd8cdb7" + integrity sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA== + punycode@^2.1.0: version "2.3.1" resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.3.1.tgz#027422e2faec0b25e1549c3e1bd8309b9133b6e5" @@ -6471,15 +6516,13 @@ shelljs@^0.8.3: interpret "^1.0.0" rechoir "^0.6.2" -shiki@^0.14.7: - version "0.14.7" - resolved "https://registry.yarnpkg.com/shiki/-/shiki-0.14.7.tgz#c3c9e1853e9737845f1d2ef81b31bcfb07056d4e" - integrity sha512-dNPAPrxSc87ua2sKJ3H5dQ/6ZaY8RNnaAqK+t0eG7p0Soi2ydiqbGOTaZCqaYvA/uZYfS1LJnemt3Q+mSfcPCg== +shiki@^1.9.1: + version "1.13.0" + resolved "https://registry.yarnpkg.com/shiki/-/shiki-1.13.0.tgz#129986ad475ad4a962b5c681eabb843e38dde65e" + integrity sha512-e0dWfnONbEv6xl7FJy3XIhsVHQ/65XHDZl92+6H9+4xWjfdo7pmkqG7Kg47KWtDiEtzM5Z+oEfb4vtRvoZ/X9w== dependencies: - ansi-sequence-parser "^1.1.0" - jsonc-parser "^3.2.0" - vscode-oniguruma "^1.7.0" - vscode-textmate "^8.0.0" + "@shikijs/core" "1.13.0" + "@types/hast" "^3.0.4" side-channel@^1.0.4, side-channel@^1.0.6: version "1.0.6" @@ -7162,15 +7205,28 @@ typedarray@^0.0.6: resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777" integrity sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA== -typedoc@^0.25.9: - version "0.25.13" - resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.25.13.tgz#9a98819e3b2d155a6d78589b46fa4c03768f0922" - integrity sha512-pQqiwiJ+Z4pigfOnnysObszLiU3mVLWAExSPf+Mu06G/qsc3wzbuM56SZQvONhHLncLUhYzOVkjFFpFfL5AzhQ== +typedoc-plugin-frontmatter@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/typedoc-plugin-frontmatter/-/typedoc-plugin-frontmatter-1.0.0.tgz#908ccbfb27587a64f259c0250c5992497cb59e48" + integrity sha512-Mqn96+RjUjPUz/42H8MOp/8eOKjE5MVIgZRFDGmSI2YuggnMZSfh5MMpvd6ykjNTpq7gV5D2iwjqLt8nYRg9rg== + dependencies: + yaml "^2.3.4" + +typedoc-plugin-markdown@^4.2.4: + version "4.2.4" + resolved "https://registry.yarnpkg.com/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.2.4.tgz#91253bdd94c117a72916b08816be80d949e0c078" + integrity sha512-9jdYqF5Sx1qxvSo7wV1mUHA2XYn3Y1DJ/ttCWW1V4lHdzDAwIA/EB9U92Ryx3GOSD73X1u8eTu8fBjoCmkURTQ== + +typedoc@^0.26.5: + version "0.26.5" + resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.26.5.tgz#08032bd57cac3d56e8ac296a07e3482dc0c645ac" + integrity sha512-Vn9YKdjKtDZqSk+by7beZ+xzkkr8T8CYoiasqyt4TTRFy5+UHzL/mF/o4wGBjRF+rlWQHDb0t6xCpA3JNL5phg== dependencies: lunr "^2.3.9" - marked "^4.3.0" - minimatch "^9.0.3" - shiki "^0.14.7" + markdown-it "^14.1.0" + minimatch "^9.0.5" + shiki "^1.9.1" + yaml "^2.4.5" typeforce@^1.11.3, typeforce@^1.18.0: version "1.18.0" @@ -7197,6 +7253,11 @@ typical@^5.2.0: resolved "https://registry.yarnpkg.com/typical/-/typical-5.2.0.tgz#4daaac4f2b5315460804f0acf6cb69c52bb93066" integrity sha512-dvdQgNDNJo+8B2uBQoqdb11eUCE1JQXhvjC/CZtgvZseVd5TYMXnq0+vuUemXbd/Se29cTaUuPX3YIc2xgbvIg== +uc.micro@^2.0.0, uc.micro@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/uc.micro/-/uc.micro-2.1.0.tgz#f8d3f7d0ec4c3dea35a7e3c8efa4cb8b45c9e7ee" + integrity sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A== + uglify-js@^3.1.4: version "3.17.4" resolved "https://registry.yarnpkg.com/uglify-js/-/uglify-js-3.17.4.tgz#61678cf5fa3f5b7eb789bb345df29afb8257c22c" @@ -7326,16 +7387,6 @@ varuint-bitcoin@^1.1.2: dependencies: safe-buffer "^5.1.1" -vscode-oniguruma@^1.7.0: - version "1.7.0" - resolved "https://registry.yarnpkg.com/vscode-oniguruma/-/vscode-oniguruma-1.7.0.tgz#439bfad8fe71abd7798338d1cd3dc53a8beea94b" - integrity sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA== - -vscode-textmate@^8.0.0: - version "8.0.0" - resolved "https://registry.yarnpkg.com/vscode-textmate/-/vscode-textmate-8.0.0.tgz#2c7a3b1163ef0441097e0b5d6389cd5504b59e5d" - integrity sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg== - wcwidth@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/wcwidth/-/wcwidth-1.0.1.tgz#f0b0dcf915bc5ff1528afadb2c0e17b532da2fe8" @@ -7521,6 +7572,11 @@ yallist@^4.0.0: resolved "https://registry.yarnpkg.com/yallist/-/yallist-4.0.0.tgz#9bb92790d9c0effec63be73519e11a35019a3a72" integrity sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A== +yaml@^2.3.4, yaml@^2.4.5: + version "2.5.0" + resolved "https://registry.yarnpkg.com/yaml/-/yaml-2.5.0.tgz#c6165a721cf8000e91c36490a41d7be25176cf5d" + integrity sha512-2wWLbGbYDiSqqIKoPjar3MPgB94ErzCtrNE1FdqGuaO0pi2JGjmE8aW8TDZwzU7vuxcGRdL/4gPQwQ7hD5AMSw== + yargs-parser@20.2.4: version "20.2.4" resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-20.2.4.tgz#b42890f14566796f85ae8e3a25290d205f154a54"