diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS deleted file mode 100644 index ac00976..0000000 --- a/.github/CODEOWNERS +++ /dev/null @@ -1 +0,0 @@ -* @prestwich @ltchang2019 @erinhales @yourbuddyconner @kekonen @anna-carroll @imti @pranaymohan @barbaraliau \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/track-documentation-task.md b/.github/ISSUE_TEMPLATE/track-documentation-task.md new file mode 100644 index 0000000..7b30728 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/track-documentation-task.md @@ -0,0 +1,34 @@ +--- +name: Track documentation task +about: Template to track a documentation task +title: '' +labels: '' +assignees: '' + +--- + +## Description + +I'm working on pull request/ issue: + + +Supply further description as needed. + +## Research + +- [ ] New documents: Collect input from engineers +- [ ] Existing documents: Get familiar with existing documents +- [ ] Add more tasks as needed + +## Production + +- [ ] New documents: Create draft +- [ ] Existing documents: Refine document +- [ ] Get technical review +- [ ] Get peer review + +## Publication + +- [ ] Merge PR +- [ ] Approve ingest PR on netdata/learn +- [ ] Check for broken links in build log diff --git a/.github/workflows/check-broken-links.md b/.github/workflows/check-broken-links.md new file mode 100644 index 0000000..3dcc8f4 --- /dev/null +++ b/.github/workflows/check-broken-links.md @@ -0,0 +1,11 @@ +--- +title: Nomad docs contains broken links! +labels: broken-links +assignees: '' +--- + +## Nomad docs contains broken links! + + +[View the results](https://github.com/nomad-xyz/learn/commit/{{sha}}/checks). + diff --git a/.github/workflows/check-broken-links.yml b/.github/workflows/check-broken-links.yml new file mode 100644 index 0000000..f2efc4a --- /dev/null +++ b/.github/workflows/check-broken-links.yml @@ -0,0 +1,26 @@ +name: Test internal links +on: + workflow_dispatch: + schedule: + - cron: '0 17 * * *' +env: + WEBSITE_URL: "https://docs.nomad.xyz/" + ISSUE_TEMPLATE: ".github/workflows/check-broken-links.md" + +jobs: + check: + runs-on: ubuntu-latest + + steps: + - name: Run BLC on internal links + run: npx broken-link-checker $WEBSITE_URL --ordered --recursive --exclude-external --user-agent 'Mozilla/5.0 (Macintosh; Intel Mac OS X 11_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.101 Safari/537.36' + + - uses: actions/checkout@v2 + if: failure() + + - uses: JasonEtco/create-an-issue@v2 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + filename: ${{ env.ISSUE_TEMPLATE }} + if: failure() diff --git a/.gitignore b/.gitignore index 3d6a3b1..106e768 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,26 @@ -node_modules -docs/.vitepress/dist -.DS_STORE \ No newline at end of file +# Dependencies +node_modules/ +docs/.vitepress/ +# Production +/build + +# Generated files +.docusaurus/ +.cache-loader + +# Misc +.DS_Store +.env +.env.local +.env.development.local +.env.test.local +.env.production.local + +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# Local Netlify folder +.netlify +.vscode/settings.json +/.idea/ diff --git a/.nvmrc b/.nvmrc deleted file mode 100644 index f0b10f1..0000000 --- a/.nvmrc +++ /dev/null @@ -1 +0,0 @@ -v16.13.1 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..38e5be8 --- /dev/null +++ b/LICENSE @@ -0,0 +1,13 @@ +Copyright 2022 Illusory Systems Inc. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/README.md b/README.md index ddcf93d..8a37d63 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,21 @@ -# Documentation Site +# Nomad Docs -## Install -```sh -npm install -``` +## Development -## Build +- You will need `docusaurus` and `node 16` to develop and test locally the documentation website +- [Install Docusaurus](https://docusaurus.io/docs/installation) +- `git clone` the repository locally +- Run `yarn` or `npm install` from inside the repository to install all dependencies +- `yarn start`: Will start a local dev server that will automatically reload with every change to the source code +- Please use named or forked branches. All changes should be PRed to `dev` and if everything works as expected, only then `dev` should be merged into `main` -```sh -npm run docs:build -``` +## Deployment -## Serve Dev Environment +- The docs are automatically deployed from the github repo via Netlify + - `main` is deployed to `docs.nomad.xyz` + - `dev` is deployed to `dev.docs.nomad.xyz` -```sh -npm run docs:dev -``` +## License -## Serve Prod Environment - -```sh -npm run docs:serve -``` +Apache License 2.0 diff --git a/babel.config.js b/babel.config.js new file mode 100644 index 0000000..03afab4 --- /dev/null +++ b/babel.config.js @@ -0,0 +1,3 @@ +module.exports = { + presets: [require.resolve('@docusaurus/core/lib/babel/preset')], +}; \ No newline at end of file diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js deleted file mode 100644 index 79cdc26..0000000 --- a/docs/.vitepress/config.js +++ /dev/null @@ -1,94 +0,0 @@ -module.exports = { - lang: "en-US", - title: "Nomad", - description: "Documentation", - - head: [["link", { rel: "icon", href: `/favicon.png` }]], - - themeConfig: { - // repo: 'https://github.com/nomad-xyz/nomad-monorepo', - docsDir: "docs", - - nav: [ - { text: "Home", link: "/", activeMatch: "^/$|^/home/" }, - { text: "Bridge", link: "/bridge/index.html", activeMatch: "^/bridge" }, - { - text: "Developer Resources", - link: "/dev/index.html", - activeMatch: "^/dev/", - }, - ], - - sidebar: { - "/home/": getHomeSidebar(), - "/bridge/": getBridgeSidebar(), - "/dev": getIntegrationsSidebar(), - "/": getHomeSidebar(), - }, - }, -}; - -function getHomeSidebar() { - return [ - { text: "What is Nomad?", link: "/" }, - { text: "Brand Kit", link: "/brand-kit.html" }, - ]; -} - -function getBridgeSidebar() { - return [ - { text: "Getting Started", link: "/bridge/index.html" }, - { - text: "Resources", - children: [ - { text: "Deployed Domains and Addresses", link: "/bridge/domains.html" }, - ], - }, - { text: "FAQs", link: "/bridge/faq.html" }, - { - text: "Ways to Bridge Using Nomad", - children: [ - { text: "Nomad GUI", link: "/bridge/nomad-gui.html" }, - { - text: "Send Native Tokens Using Etherscan", - link: "/bridge/etherscan-native.html", - }, - { - text: "Send ERC-20 Tokens Using Etherscan", - link: "/bridge/etherscan.html", - }, - ], - }, - ]; -} - -function getIntegrationsSidebar() { - return [ - { - text: "Developer Resources", - children: [ - { text: "Nomad Domain IDs", link: "/dev/domain-ids.html" }, - { text: "SDK Documentation", link: "/dev/sdk.html" }, - { text: "Writing a xApp", link: "/dev/xapps.html" }, - ], - }, - { - text: "Technical Docs", - children: [ - { text: "Nomad Architecture", link: "/dev/architecture.html" }, - { text: "Token Bridge xApp", link: "/dev/token-bridge.html" }, - { text: "Governance", link: "/dev/governance.html" }, - { text: "Upgrade Setup", link: "/dev/upgrade-setup.html" }, - { - text: "Deploy Contracts to Dev", - link: "/dev/dev-contract-deployment.html", - }, - { - text: "Deploy Contracts to Prod", - link: "/dev/prod-contract-deployment.html", - }, - { text: "Off-Chain Agents", link: "/dev/agents/" }, - ], - }, - ]; -} diff --git a/docs/.vitepress/theme/custom.css b/docs/.vitepress/theme/custom.css deleted file mode 100644 index b64dddc..0000000 --- a/docs/.vitepress/theme/custom.css +++ /dev/null @@ -1,8 +0,0 @@ -:root { - --c-brand: #4b7bec; - --c-brand-light: #5b8bfc; -} - -.container { - max-width: 60rem !important; -} \ No newline at end of file diff --git a/docs/.vitepress/theme/index.js b/docs/.vitepress/theme/index.js deleted file mode 100644 index 42fe9a9..0000000 --- a/docs/.vitepress/theme/index.js +++ /dev/null @@ -1,4 +0,0 @@ -import DefaultTheme from 'vitepress/theme' -import './custom.css' - -export default DefaultTheme diff --git a/docs/agents/overview.md b/docs/agents/overview.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/agents/processor.md b/docs/agents/processor.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/agents/relayer.md b/docs/agents/relayer.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/agents/updater.md b/docs/agents/updater.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/agents/watcher.md b/docs/agents/watcher.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/brand-kit.md b/docs/brand-kit.md deleted file mode 100644 index f3c3064..0000000 --- a/docs/brand-kit.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Nomad Brand Kit -lang: en-US ---- - -# Brand kit - - - My HTML Document - - - - - - -

Download

- -
- diff --git a/docs/bridge/domains-testnet.md b/docs/bridge/domains-testnet.md deleted file mode 100644 index 764acda..0000000 --- a/docs/bridge/domains-testnet.md +++ /dev/null @@ -1,35 +0,0 @@ -# Deployed ERC-20 Tokens (Production) - -## Rinkeby - -**Domain ID:** `2000` - -| Name | Symbol | Decimals | Address | -| ------------ | ------ | -------- | ------------------------------------------ | -| Wrapped GLMR | WGLMR | `18` | 0xba8d75BAcCC4d5c4bD814FDe69267213052EA663 | - -
- -## Moonbeam - -**Domain ID:** `1650811245` - -| Name | Symbol | Decimals | Address | -| -------------- | ------ | -------- | ------------------------------------------ | -| Wrapped Ether | WETH | `18` | 0x30D2a9F5FDf90ACe8c17952cbb4eE48a55D916A7 | -| Wrapped BTC | WBTC | `8` | 0x1DC78Acda13a8BC4408B207c9E48CDBc096D95e0 | -| Dai Stablecoin | DAI | `18` | 0xc234A67a4F840E61adE794be47de455361b52413 | -| USD Coin | USDC | `6` | 0x8f552a71EFE5eeFc207Bf75485b356A0b3f01eC9 | -| Tether USD | USDT | `6` | 0x8e70cD5B4Ff3f62659049e74b6649c6603A0E594 | - -## Milkomeda C1 - -**Domain ID:** `25393` - -| Name | Symbol | Decimals | Address | -| -------------- | ------ | -------- | ------------------------------------------ | -| Wrapped Ether | WETH | `18` | 0x5950F9B6EF36f3127Ea66799e64D0ea1f5fdb9D1 | -| Wrapped BTC | WBTC | `8` | 0x48AEB7584BA26D3791f06fBA360dB435B3d7A174 | -| Dai Stablecoin | DAI | `18` | 0x41eAFC40CD5Cb904157A10158F73fF2824dC1339 | -| USD Coin | USDC | `6` | 0x5a955FDdF055F2dE3281d99718f5f1531744B102 | -| Tether USD | USDT | `6` | 0xab58DA63DFDd6B97EAaB3C94165Ef6f43d951fb2 | diff --git a/docs/bridge/domains.md b/docs/bridge/domains.md deleted file mode 100644 index 7659949..0000000 --- a/docs/bridge/domains.md +++ /dev/null @@ -1,119 +0,0 @@ -# Nomad - Deployed Domains - -## Production (Mainnet) - -### Ethereum - -**Domain ID:** `6648936` - -| Name | Symbol | Decimals | Address | Origin | -| ------------ | ------ | -------- | ------------------------------------------ | -------- | -| Wrapped GLMR | WGLMR | `18` | 0xba8d75BAcCC4d5c4bD814FDe69267213052EA663 | Moonbeam | - -### Moonbeam - -**Domain ID:** `1650811245` - -| Name | Symbol | Decimals | Address | Origin | -| -------------- | ------ | -------- | ------------------------------------------ | -------- | -| Wrapped Ether | WETH | `18` | 0x30D2a9F5FDf90ACe8c17952cbb4eE48a55D916A7 | Ethereum | -| Wrapped BTC | WBTC | `8` | 0x1DC78Acda13a8BC4408B207c9E48CDBc096D95e0 | Ethereum | -| Dai Stablecoin | DAI | `18` | 0xc234A67a4F840E61adE794be47de455361b52413 | Ethereum | -| USD Coin | USDC | `6` | 0x8f552a71EFE5eeFc207Bf75485b356A0b3f01eC9 | Ethereum | -| Tether USD | USDT | `6` | 0x8e70cD5B4Ff3f62659049e74b6649c6603A0E594 | Ethereum | -| CQT | CQT | `18` | 0x5130ca61bf02618548dfc3fdef50b50b36b11f2b | Ethereum | -| FRAX | FRAX | `18` | 0x8d6e233106733c7cc1ba962f8de9e4dcd3b0308e | Ethereum | -| FXS | FXS | `18` | 0x21a8daca6a56434bdb6f39e7616c0f9891829aec | Ethereum | - -### Milkomeda C1 - -**Domain ID:** `25393` - -| Name | Symbol | Decimals | Address | Origin | -| -------------- | ------ | -------- | ------------------------------------------ | -------- | -| Wrapped Ether | WETH | `18` | 0x5950F9B6EF36f3127Ea66799e64D0ea1f5fdb9D1 | Ethereum | -| Wrapped BTC | WBTC | `8` | 0x48AEB7584BA26D3791f06fBA360dB435B3d7A174 | Ethereum | -| Dai Stablecoin | DAI | `18` | 0x41eAFC40CD5Cb904157A10158F73fF2824dC1339 | Ethereum | -| USD Coin | USDC | `6` | 0x5a955FDdF055F2dE3281d99718f5f1531744B102 | Ethereum | -| Tether USD | USDT | `6` | 0xab58DA63DFDd6B97EAaB3C94165Ef6f43d951fb2 | Ethereum | -| FRAX | FRAX | `18` | 0x362233f1ef554ca08555ca191b4887c2c3132834 | Ethereum | -| FXS | FXS | `18` | 0xe5e25df85f6a17fc5681dee7b6b080933476630d | Ethereum | -| Wrapped STR | WSTR | `18` | 0x0c2d8604c89d126133bed39967e69272960bc430 | Ethereum | - -### Evmos - -**Domain ID:** `1702260083` - -**wEVMOS9 Contract Address**: [`0xD4949664cD82660AaE99bEdc034a0deA8A0bd517`](https://evm.evmos.org/address/0xD4949664cD82660AaE99bEdc034a0deA8A0bd517) - -| Name | Symbol | Decimals | Address | Origin | -| -------------- | ------ | -------- | ------------------------------------------ | -------- | -| Wrapped Ether | WETH | `18` | 0x5842C5532b61aCF3227679a8b1BD0242a41752f2 | Ethereum | -| Wrapped BTC | WBTC | `8` | 0xF80699Dc594e00aE7bA200c7533a07C1604A106D | Ethereum | -| Dai Stablecoin | DAI | `18` | 0x63743ACF2c7cfee65A5E356A4C4A005b586fC7AA | Ethereum | -| USD Coin | USDC | `6` | 0x51e44FfaD5C2B122C8b635671FCC8139dc636E82 | Ethereum | -| Tether USD | USDT | `6` | 0x7FF4a56B32ee13D7D4D405887E0eA37d61Ed919e | Ethereum | -| FRAX | FRAX | `18` | 0x28eC4B29657959F4A5052B41079fe32919Ec3Bd3 | Ethereum | -| FXS | FXS | `18` | 0xd0ec216A38F199B0229AE668a96c3Cd9F9f118A6 | Ethereum | - -
- -## Development (Testnet) - -### Rinkeby (Testnet) - -**Domain ID:** `2000` - -| Name | Symbol | Decimals | Address | Origin Domain | -| ------------- | ------ | -------- | ------------------------------------------ | ------------- | -| Wrapped Ether | WETH | `18` | 0xf1A137F67aa6aE2FEba192de252f7D4FC244766A | 3000 | -| Test Token | TEST | `18` | 0xf4CF3FcC8dC7E5171Bb08bef75EDe3fEf00F46E6 | 3000 | -| USD Coin | USDC | `6` | 0x238Afa01c004CD2a82908D3B80CF421040601244 | 3000 | -| Wrapped wADA | WWADA | `18` | 0xeBe76a234bC185606601C807352876Ae757b54D5 | 8000 | -| Wrapped MOVR | WMOVR | `18` | 0x6FAe8aee3A8681B604837a72b203A72C93987562 | 5000 | -| Wrapped wADA | WWADA | `18` | 0xc7D9c115e40Bd0a362270A9240975C0009E97c31 | 8000 | -| Random ERC20 | rERC20 | `18` | 0x2D997F0917Ce644B6d31303300913E17178F3F3F | 3000 | -| Wrapped ADA | WADA | `18` | 0xA9aE90E9D541F726ae8Fb39C5172F2c9D09E2E54 | 8000 | -| Wrapped Ether | WETH | `18` | 0x12a89f0Cdf44082aEEF0194924A5280Cc178073A | 9000 | - -
- -### Kovan (Testnet) - -**Domain ID:** `3000` - -| Name | Symbol | Decimals | Address | Origin Domain | -| ------------- | ------ | -------- | ------------------------------------------ | ------------- | -| Wrapped Ether | WETH | `18` | 0x6A8a5FB1bd977849b4fEcFb1e104ABfeB23b440b | 2000 | -| USD Coin | USDC | `6` | 0x10e8BD2aEa9d43439aC072bF4C68Fb41fa6eB73A | 2000 | - -
- -### Moonbase Alpha (Testnet) - -**Domain ID:** `5000` - -| Name | Symbol | Decimals | Address | Origin Domain | -| ------------- | ------ | -------- | ------------------------------------------ | ------------- | -| Wrapped Ether | WETH | `18` | 0x6A8a5FB1bd977849b4fEcFb1e104ABfeB23b440b | 2000 | -| USD Coin | USDC | `6` | 0x10e8BD2aEa9d43439aC072bF4C68Fb41fa6eB73A | 2000 | - -
- -### Milkomeda C1 (Testnet) - -**Domain ID:** `8000` - -| Name | Symbol | Decimals | Address | Origin Domain | -| ------------- | ------ | -------- | ------------------------------------------ | ------------- | -| Wrapped Ether | WETH | `18` | 0x6A8a5FB1bd977849b4fEcFb1e104ABfeB23b440b | 2000 | -| USD Coin | USDC | `6` | 0x10e8BD2aEa9d43439aC072bF4C68Fb41fa6eB73A | 2000 | - -
- -### Evmos (Testnet) - -**Domain ID:** `9000` - -| Name | Symbol | Decimals | Address | Origin Domain | -| ---- | ------ | -------- | ------- | ------------- | diff --git a/docs/bridge/etherscan-native.md b/docs/bridge/etherscan-native.md deleted file mode 100644 index eaf3d56..0000000 --- a/docs/bridge/etherscan-native.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Bridge Using Etherscan -lang: en-US ---- - -# Bridge Native Assets with Etherscan - -Coming soon! \ No newline at end of file diff --git a/docs/bridge/etherscan.md b/docs/bridge/etherscan.md deleted file mode 100644 index 6d978dc..0000000 --- a/docs/bridge/etherscan.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Bridge ERC-20s Using Etherscan -lang: en-US ---- - -# Bridge Tokens with Etherscan - -Coming soon! \ No newline at end of file diff --git a/docs/bridge/faq.md b/docs/bridge/faq.md deleted file mode 100644 index e8aacf4..0000000 --- a/docs/bridge/faq.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -title: FAQs -lang: en-US ---- - -# FAQs - -## Nomad Bridge Features - -### What assets are available to bridge? (updated 01/13/2022) - -The Nomad app at https://app.nomad.xyz supports the following assets. For a complete list of tokens and their addresses see the [Deployed Tokens List](./domains.md). - -* WETH -* ETH -* USDT -* USDC -* DAI -* GLMR -* WGLMR -* WBTC -* FRAX -* FXS - -We are actively adding more assets. If you would like an asset listed, make your voice heard in the Nomad [Discord](https://discord.gg/RurtmJApqm)!! - -### Do you have `` feature? - -We deployed on Jan 11, 2022 🚀 and are adding new features and making updates on a daily basis. Some things we have in the works: - -* Transaction History View -* WalletConnect Support -* Better error messages -* UI improvements - -## Bridging 101 - -### I bridged over my assets with `someOtherBridgeNotNomad`, why can’t I see them? - -Each bridge deploys their own token contracts, so assets bridged using one Bridge A are not compatible with assets bridged using Bridge B, even though they started out with the same original asset. - -If you want to bridge over with Nomad but you've already used another bridge, you'll need to bridge _back_ to the origin chain, and then bridge again with Nomad. This will get you back on track. - -### How long does it take to bridge? - -Bridging using Nomad usually takes around 35 mins, but can be up to +60 mins depending on on- and off- chain activity (see our [docs on the Nomad architecture](../index.md) for more information). - -However, we've partnered with Connext to give users an option to have a faster cross-chain experience! For a small fee, you can use Connext to enable faster transfers--around 7-15 mins! - -### It's been longer than the estimated time--where are my tokens? - -Ocassionally there are times where it takes longer to process a transaction. This could be due to on-chain activity, or a delay in agent processing. - -This could also be due to missing a step in the process, such as when sending assets back to Ethereum. You'll need to manually process the transaction. See [this answer](#why-is-gas-estimate-so-high-to-get-my-funds-on-ethereum). - -### Do I get WETH or ETH? - -You can bridge over WETH or ETH from Ethereum, but you will always receive WETH on the destination. If you bridge over ETH, the contract will automatically call a helper function to wrap your ETH for you. - -If you use Connext to bridge your WETH back to Ethereum, you will receive ETH automatically through the Connext process. - -If you use Nomad to bridge your WETH back to Ethereum, you will receive WETH and will need to unwrap it manually if you want ETH again. - -### Do you have a development/testnet site? - -Yes! It is available at [development.app.nomad.xyz](https://development.app.nomad.xyz) - -## Connext + Nomad ----- -### What is your relationship with Connext? - -Nomad and Connext are complementary pieces that work together to provide a better cross-chain experience for users. Connext is an interoperability protocol that allows users to swap/transact over liquidity that already exists on the chain. Nomad is at its core protocol for passing generalized data between arbitrary chains, and the Nomad Bridge is an application built to pass specific kinds of messages that allow you to bridge tokens. - -Connext routers set up cross-chain liquidity pools for Nomad assets. For a small fee, these liquidity pools allow users to make faster swaps, since the assets have already been bridged over. - -### I bridged using Connext, where are my tokens? - -When you bridge with Connext, you'll need to manually claim your tokens after the transaction has processed. You can claim your transaction using the [Nomad bridge](https://app.nomad.xyz), or you can also use the Connext UI at `https://connextscan.io/tx/` - -## Bridging to Ethereum ------- - -### I'm trying to bridge my assets back to Ethereum and it's taking a long time. - -When you bridge back to Ethereum, you'll need to process the transaction manually to disperse your funds at the end. You can do this by going to: -`https://app.nomad.xyz/tx/nomad//` - -### Why is gas estimate so high to get my funds on Ethereum? - -You need to submit a higher buffer for gas because the function that needs to be called to disperse funds, `proveAndProcess`, is permissionless. If there was no gas buffer, anyone could cancel your transaction by processing it with too-low gas. So the protocol specifies a gas buffer in order to submit the transaction, but in this case, the majority of the gas is not actually used. - -**In actuality, only about 1/5 of the estimated gas is used.** - -Here are a few transactions you can look at to see what the actual cost of the transaction was: -* [Transaction 1](https://etherscan.io/tx/0x60e20861d22a6931d9731e0c00dcd6984857140c86cf83f94be888e7af5bab91) -* [Transaction 2](https://etherscan.io/tx/0x73bae115015885371b295daad8225493571b6963f550cd1d7b009c00921b9b91) - -You can also look through the [contract](https://etherscan.io/address/0x049b51e531fd8f90da6d92ea83dc4125002f20ef) for the transactions that called the `Prove And Process` method for further verification. - -## General - -### What is Nomad's security model? How does it compare to other well-known models, such as header verification? - -Every cross-chain message passing system is going to have tradeoffs, and we've carefully considered how security is affected with design choices. Nomad adopts an optimistic mechanism inspired by optimistic roll-ups like Optimism and Arbitrum, which is a different approach than block header verification. You can read a little bit more about the benefits and tradeoffs of this kind of architecture in our [docs](https://docs.nomad.xyz/#benefits-and-trade-offs-of-the-nomad-architecture). - -### Wen token? - -Nomad does not have a token at this time. If you hear any references to a Nomad token, they are definitely scams. - -### What is madWETH? - -These are the same assets! Often times applications will prefix assets depending on the bridge that was used. Nomad assets are listed with either no prefix (WETH), or the mad- prefix (madWETH). We prefer to use no prefix or the mad- prefix and will kindly ask applications to change this for us, but sometimes there may be a delay in this change. - -### Why does my recently-bridged token have a funny name like `0006648936.eb48`? - -In order to avoid sending redundant data like the token name and symbol with every message, the first time a bridged ERC-20 Token representation is deployed, metadata is pulled from the originating chain after initial deployment. This involves a round-trip between the replica and originating chain wherein data about name/symbol/decimals is synced. - -This is expected behavior, and the explorer will update after a day or two. - -### Why is the ERC-20 token placeholder name like that? - -`0006648936.eb48` is the Nomad domain ID for Ethereum and the last 4 letters of the token address on Ethereum - -`6648936 == 0x657468` -- the utf8 encoding of 'eth' - -USDC's address is `0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48` - -Note the `eb48` at the end. diff --git a/docs/bridge/index.md b/docs/bridge/index.md deleted file mode 100644 index 0f76821..0000000 --- a/docs/bridge/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Bridging with Nomad -lang: en-US ---- - -# Bridging with Nomad - -* [Nomad Bridge](../index.md) - * Nomad Web UIs - * [Nomad GUI](./nomad-gui.md) - * [Testnet GUI](https://development.app.nomad.xyz) - * Manually Using Etherscan - * [Bridge Native Tokens via Etherscan](./etherscan-native.md) - * [Bridge ERC-20 Tokens via Etherscan](./etherscan.md) - -

Nomad is a novel new cross-chain protocol. Please only bridge funds to the extent that you feel comfortable deploying on chain.

diff --git a/docs/bridge/nomad-gui.md b/docs/bridge/nomad-gui.md deleted file mode 100644 index bf5c3c4..0000000 --- a/docs/bridge/nomad-gui.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -title: Nomad Bridge GUI -lang: en-US ---- - -# Nomad Bridge GUI - -## Nomad vs Connext, which should I use? - -There are two options available to send funds through the GUI, Nomad and Connext. These are two distinct protocols that are complimentary to one another. We have partnered with Connext to provide an optimal experience for users! - -Nomad is a secure gas efficient cross-chain protocol that allows users to bridge funds between networks. This takes, on average, 35-60 minutes. There are no fees associated with Nomad, just pay gas! Connext provides liquidity pools for Nomad assets, meaning users can receive funds on the destination chain much faster (less than 10 minutes) for an additional fee. Nomad is advised for large transfers. - -Connext is not available for every asset and may not be available for larger sums. We recommend using Nomad if you intend to send large transfers. - -## Bridging Through Nomad - -Bridging assets across chains using Nomad should be intuitive and easy with the Nomad GUI. In this tutorial, we will walk through the steps required to bridge your assets. - -Please find our production bridge GUI at [app.nomad.xyz](https://app.nomad.xyz/). - -If you would like to test our bridge using testnet funds before using real funds, please visit our development GUI at [development.app.nomad.xyz](https://development.app.nomad.xyz/). - -
- -Connect to Metamask: - -![Connect to Metamask](../public/tutorials/bridge-gui/connect-metamask.png) - -
- -Select origin and destination networks: - -![Select Origin and Destination Networks](../public/tutorials/bridge-gui/select-networks.png) - -
- -(Optional) Change Destination address. This is set as your wallet address by default. Click "edit". A modal will pop up, click "change" inside the input. Then copy your address, click to paste, and save. -::: warning CAUTION -Sending assets to an address you do not control can result in a permanent loss of funds! -::: - -![Change Destination](../public/tutorials/bridge-gui/change-dest-1.png) -![Paste Destination](../public/tutorials/bridge-gui/change-dest-2.png) - -
- -Select the asset you want to send using the asset dropdown menu and the amount you want to send using the input prompt: - -![Select an Asset and Amount](../public/tutorials/bridge-gui/select-token.png) - -
- -Click `Next`: - -![Select an Asset and Amount](../public/tutorials/bridge-gui/input-data.png) - -
- -Review your transaction details and associated fees. Check if Connext liquidity is available for your transfer for a faster bridging experience! If proceeding with Connext, continue reading [here](#fast-transfers-with-connext). - -![Approve Bridge Transaction](../public/tutorials/bridge-gui/review.png) - -
- -Click `Bridge Tokens` and approve the transaction in Metamask: - -![Approve Bridge Transaction](../public/tutorials/bridge-gui/sending.png) - -
- -After approving the transaction, you will be taken to the transaction details page. Here, you will see the estimated time remaining for your transfer to complete. Please save your transaction hash for convenience. If you lose it, you can visit your wallet address on the block explorer of the origin network and find the transaction again. - -::: info -You must return to the Transaction Page after bridging has concluded to pay for gas and complete your transfer. Nomad may cover the processing and gas fees for some chains. -::: - -![See Transaction Details](../public/tutorials/bridge-gui/transfer-pending.png) - -
- -You can expand the time estimate tab to track your transaction status by clicking the down arrow in the blue box: - -![See Expanded Transaction Details](../public/tutorials/bridge-gui/expand-status.png) - -
- -(Optional) If you navigated away from the GUI at any point and want to find your transfer's progress page again, visit [https://app.nomad.xyz/tx](https://app.nomad.xyz/tx) and enter the origin network and your transfer's transaction hash. - -![Search Tx](../public/tutorials/bridge-gui/search-transfer.png) - -
- -Once your transfer has completed, you should see the below display and your funds will be in the account of your destination address. If your transfer is taking longer than expected, please reach out to us on [Discord](https://discord.gg/RurtmJApqm) in the #support channel: - -![Finished](../public/tutorials/bridge-gui/transfer-complete.png) - -
- -## Completing a Transfer (Ethereum Destination Only) - -If you are sending to Ethereum, there is one additional processing step due to the high cost of processing transactions on Ethereum. You will see the following display and should click "Complete Transfer" and complete the Metamask transaction. After this, your funds should be at your destination on Ethereum! - -![Self Process](../public/tutorials/bridge-gui/complete-transfer.png) - -
- -## Fast Transfers with Connext - -Fill out data for your transfer and click "Next." Select "Connext." If there is liquidity available for your transfer, it will calculate associated fees for your transaction. Note that Connext collects gas fees in the asset that is being sent. - -If there is not liquidity available, you can continue by using Nomad. - -![Self Process](../public/tutorials/bridge-gui/check-connext.png) - -Click `Send` and approve the transaction in Metamask! - -In a few minutes, you will see your transfer appear in a table below. Click "Claim" to submit a transaction to receive your funds on the destination chain. - -Click "View" to go to your transaction in the ConnextScan block explorer. Or you can visit `https://connextscan.io/tx/`. - -![Claim Connext funds](../public/tutorials/bridge-gui/connext-claim.png) diff --git a/docs/bridge/resources.md b/docs/bridge/resources.md deleted file mode 100644 index 1182622..0000000 --- a/docs/bridge/resources.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: FAQs -lang: en-US ---- - -# Resources - -- [Deployed Tokens List](domains.md) diff --git a/docs/build/agents.md b/docs/build/agents.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/build/checklist.md b/docs/build/checklist.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/build/invariants.md b/docs/build/invariants.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/build/overview.md b/docs/build/overview.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/build/sdk.md b/docs/build/sdk.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/build/smart-contracts.md b/docs/build/smart-contracts.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/dev/agents/agent-development.md b/docs/dev/agents/agent-development.md deleted file mode 100644 index b15342e..0000000 --- a/docs/dev/agents/agent-development.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: Agent Development -lang: en-US ---- - -# Developing the Agents - -## Configuration - -Agents read settings from the config files and/or env. - -Config files are loaded from `rust/config/default` unless specified otherwise. Currently deployment config directories are labeled by the timestamp at which they were deployed - -Configuration key/value pairs are loaded in the following order, with later sources taking precedence: - -1. The config file specified by the `RUN_ENV` and `BASE_CONFIG` env vars. `$RUN_ENV/$BASE_CONFIG` -2. The config file specified by the `RUN_ENV` env var and the agent's name. `$RUN_ENV/{agent}-partial.json`. - E.g. `$RUN_ENV/updater-partial.json` -3. Configuration env vars with the prefix `OPT_BASE` intended to be shared by multiple agents in the same environment - E.g. `export OPT_BASE_REPLICAS_KOVAN_DOMAIN=3000` -4. Configuration env vars with the prefix `OPT_{agent name}` intended to be used by a specific agent. - E.g. `export OPT_KATHY_CHAT_TYPE="static message"` - -## Building an Agent for Development - -For contributing to the Rust codebase, it is advantageous and preferable to build agents using your host dev environment. As mentioned in the previous section, configuration precedence is your friend here. You can specify the base config json to use, and then override variables via the environment. - -Below is a sample env file with appropriate variables to run an agent instance against the development environment. - -Note: You will need to fetch dev keys (or generate your own via a contract deployment) for this to work properly. - -``` -RUN_ENV=1625169020727 -OPT_BASE_TRACING_LEVEL=info - -OPT_UPDATER_UPDATER_KEY= - -OPT_UPDATER_DB=updaterdb -OPT_RELAYER_DB=relayerdb -OPT_KATHY_DB=kathydb - -OPT_KATHY_SIGNERS_ALFAJORES_KEY= -OPT_UPDATER_SIGNERS_ALFAJORES_KEY= -OPT_RELAYER_SIGNERS_ALFAJORES_KEY= -OPT_PROCESSOR_SIGNERS_ALFAJORES_KEY= - -OPT_KATHY_SIGNERS_KOVAN_KEY= -OPT_UPDATER_SIGNERS_KOVAN_KEY= -OPT_RELAYER_SIGNERS_KOVAN_KEY= -OPT_PROCESSOR_SIGNERS_KOVAN_KEY= -``` - -Lets walk through the variables here: - -`RUN_ENV` - Specifies the config folder to load configuration from, defaults to `default`. -`OPT_BASE_TRACING_LEVEL` - Specifies the log level the agents should boot up with. -`OPT_UPDATER_UPDATER_KEY` - The Updater attestation key. - - - -For a full list of potentially useful common environment variables, check out the Agent Helm Chart's [ConfigMap](https://github.com/nomad-xyz/nomad-monorepo/blob/main/rust/helm/nomad-agent/templates/configmap.yaml#L8-L34) - -Agents also have role-specific environment variables in their StatefulSet definitions: -- [Updater](https://github.com/nomad-xyz/nomad-monorepo/blob/main/rust/helm/nomad-agent/templates/updater-statefulset.yaml#L54-L89) -- [Relayer](https://github.com/nomad-xyz/nomad-monorepo/blob/main/rust/helm/nomad-agent/templates/relayer-statefulset.yaml#L54-L74) -- [Processor](https://github.com/nomad-xyz/nomad-monorepo/blob/main/rust/helm/nomad-agent/templates/processor-statefulset.yaml#L54-L74) -- [Kathy](https://github.com/nomad-xyz/nomad-monorepo/blob/main/rust/helm/nomad-agent/templates/kathy-statefulset.yaml#L54-L74) - -To run an agent, you can use the following command: -`BASE_CONFIG=kovan_config.json env $(cat ../tmp.env | xargs) cargo run --bin ` - -This will build the codebase and run the specified `` binary using the provided environment variables. - -## Production Builds - -It is important when making changes to the Rust codebase, to ensure the Docker build used in production environments still works. You can check this automatically in CI as it is built on every PR ([see docker workflow here](https://github.com/nomad-xyz/nomad-monorepo/blob/main/.github/workflows/docker.yml)), however you can check it much faster usually by attempting to build it locally. - -You can build the docker image by running the following script in the `rust` directory: - -`./build.sh latest` - -If that goes smoothly, you can rest assured it will most likely also work in CI. diff --git a/docs/dev/agents/agent-operations.md b/docs/dev/agents/agent-operations.md deleted file mode 100644 index a68b135..0000000 --- a/docs/dev/agents/agent-operations.md +++ /dev/null @@ -1,339 +0,0 @@ ---- -title: Agent Operations -lang: en-US ---- - -# Agent Operations - -## Deployment Environments - -There will exist several logical deployments of Nomad to enable us to test new code/logic before releasing it to Mainnet. Each environment encompasses the various Home/Replica contracts deployed to many blockchains, as well as the agent deployments and their associated account secrets. - -The environments have various purposes and can be described as follows: - -### Development - -Purpose: Allows us to test changes to contracts and agents. *Bugs should be found here.* - -- Deployed against testnets -- Agent Accounts: HexKeys stored in a secret manager for ease of rotation/access -- Agent Infrastructure: Nomad core team will operate agent infrastructure for this. -- Node Infrastructure: Forno/Infura -- Agent Deployments: Automatic, continuous deployment -- Contract Deployments: Automatic, with human intervention required for updating the **upgradeBeacon**. - -**Current Dev Contract Deployment:** - -[development](https://github.com/nomad-xyz/nomad-monorepo/rust/config/development/) - -### Staging - -Purpose: Allows us to test the full-stack integration, specifically surrounding the KMS access control and federated secret management. *Issues with process should be found here.* - -- Deployed against testnets, mirrors Mainnet deployment. -- Agent Accounts: KMS-provisioned keys -- Agent Infrastructure: Agent operations will be decentralized -- Node Infrastructure: Node infrastructure will be decentralized -- Agent Deployments: Determined by whoever is running the agents -- Contract Deployments: Automatic, with human intervention required for updating the **upgradeBeacon**. - -**Current Staging Contract Deployment:** - -[staging](https://github.com/nomad-xyz/nomad-monorepo/rust/config/staging/) - -### Production - -Purpose: Where the magic happens, **things should not break here.** - -- Deployed against Mainnets -- Agent Accounts: KMS-provisioned keys -- Agent Infrastructure: Agent operations will be decentralized -- Node Infrastructure: Node infrastructure will be decentralized -- Agent Deployments: Determined by whoever is running the agents -- Contract Deployments: ***Manual*** - Existing tooling can be used, but deploys will be gated and require approval as contract deployments are expensive on Mainnet. - -**Current Production Contract Deployment:** - -[mainnet](https://github.com/nomad-xyz/nomad-monorepo/rust/config/mainnet/) - -## Key Material - -Keys for Staging and Production environments will be stored in AWS KMS, which is a highly flexible solution in terms of granting access. It guarantees nobody will ever have access to the key material itself, while still allowing granular permissions over access to remote signing. - -At the outset, the Nomad team will have full control over agent keys, and any contracted party will simply be granted access through existing IAM tooling/roles. - -### Provision KMS Keys - -There exists a script in the monorepo [(`rust/provision_kms_keys.py`)](https://github.com/nomad-xyz/nomad-monorepo/blob/main/rust/provision_kms_keys.py) that facilitates KMS key provisioning for agent roles. - -The script will produce a single set of keys per "environment." Where an __environment__ is a logical set of smart contract deployments, as documented [here](#deployment-environments). By default there are two environments configured, `staging` and `production`. - -#### Keys Explained - -**Transaction Signers** - -One signer key should be provisioned for each agent per-network. These keys are used to sign transactions on the respective networks Nomad is deployed to. - -**Attestation Signers** - -One additional key is provisioned for both the Watcher and Updater Agents. The Updater uses its key to sign updates to its assigned Home contract, while the Watcher uses its key to sign fraud proofs when it observes the Updater commiting fraud. - -Note: Attestation signer addresses are used as input to the contract deployment process. They can be configured in the `nomad-deploy` package [like so](https://github.com/nomad-xyz/nomad-monorepo/blob/main/typescript/nomad-deploy/config/testnets/kovan.ts#L28-L30). - -You may configure the script to generate arbitrary signer keys on a per-environment basis. -```python -# Agent Keys -agent_keys = { - "staging": [ - "watcher-signer", - "watcher-attestation", - "updater-signer", - "updater-attestation", - "processor-signer", - "relayer-signer", - "kathy-signer" - ], - "production": [ - "watcher-signer", - "watcher-attestation", - "updater-signer", - "updater-attestation", - "processor-signer", - "relayer-signer", - ] -} -``` - -Additionally, the supported networks for each environment are configured below. -```python -networks = { - "production": [ - "ethereum", - "moonbeam", - "evmos" - ], - "staging": [ - "moonbasealpha", - "kovan" - ] -} -``` - - -#### Run the Key Provisioning Script - -```bash -AWS_ACCESS_KEY_ID=accesskey AWS_SECRET_ACCESS_KEY=secretkey python3 provision_kms_keys.py -``` - -If the required keys are not present, the script will generate them. If they keys _are_ present, their information will be fetched and displayed non-destructively. - -Upon successful operation, the script will output a table of the required keys, their ARNs, ETH addresses (for funding the accounts), and their regions. - -#### Provision IAM Policies and Users - -This is an opinionated setup that works for most general agent operations use-cases. The same permissions boundaries can be achieved through different means, like using only [Key Policies](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) - -Background Reading/Documentation: - -- [KMS Policy Conditions](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.htm) -- [KMS Policy Examples](https://docs.aws.amazon.com/kms/latest/developerguide/customer-managed-policies.html) -- [CMK Alias Authorization](https://docs.aws.amazon.com/kms/latest/developerguide/alias-authorization.html) - -The following sequence describes how to set up IAM policies staging and production deployments. - -- Create two users - - nomad-signer-staging - - nomad-signer-production - - kms-admin - - Save IAM credential CSV -- Create staging signer policies - - staging-processor-signer - - staging-relayer-signer - - staging-updater-signer - - staging-watcher-signer - - With the following policy, modified appropriately: - - ```json - { - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "NomadStagingPolicy", - "Effect": "Allow", - "Action": [ - "kms:GetPublicKey", - "kms:Sign" - ], - "Resource": "arn:aws:kms:*:11111111111:key/*", - "Condition": { - "ForAnyValue:StringLike": { - "kms:ResourceAliases": "alias/staging-processor*" - } - } - } - ] - } - ``` - - - production-processor-signer - - production-relayer-signer - - production-updater-signer - - production-watcher-signer - - With the following policy, modified appropriately: - - ```json - { - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "NomadProductionPolicy", - "Effect": "Allow", - "Action": [ - "kms:GetPublicKey", - "kms:Sign" - ], - "Resource": "arn:aws:kms:*:11111111111:key/*", - "Condition": { - "ForAnyValue:StringLike": { - "kms:ResourceAliases": "alias/production-processor*" - } - } - } - ] - } - ``` - -- Create kms-admin policy - - ```json - { - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "KMSAdminPolicy", - "Effect": "Allow", - "Action": [ - "kms:DescribeCustomKeyStores", - "kms:ListKeys", - "kms:DeleteCustomKeyStore", - "kms:GenerateRandom", - "kms:UpdateCustomKeyStore", - "kms:ListAliases", - "kms:DisconnectCustomKeyStore", - "kms:CreateKey", - "kms:ConnectCustomKeyStore", - "kms:CreateCustomKeyStore" - ], - "Resource": "*" - }, - { - "Sid": "VisualEditor1", - "Effect": "Allow", - "Action": "kms:*", - "Resource": [ - "arn:aws:kms:*:756467427867:alias/*", - "arn:aws:kms:*:756467427867:key/*" - ] - } - ] - } - ``` - - - Create IAM groups - - staging-signer - - production-signer - - kms-admin - - Add previously created users to the corresponding groups - - nomad-signer-staging -> staging-signer - - nomad-signer-production -> production-signer - - kms-admin -> kms-admin - -## Funding Addresses - -Each agent should be configured with a unique wallet to be used to signing transactions and paying gas. In order to automate the process of monitoring and topping up agent wallets, the Nomad core team built a CLI tool called [The Keymaster](the-keymaster.md). - -The Keymaster, upon configuration, enables the manual one-off topping up of agent wallets on an arbitrary number of netorks. Additionally, it is capable of running this functionality as a service, topping up accounts on an interval and exposing prometheus metrics about the addresses it is monitoring for use in dashboards. - -## Self-Service Proofs in S3 - -In order to facilitate users processing their own proofs in the GUI, agents (specifically the Processor), have the functionality to upload raw proofs to an AWS S3 bucket. In the default configuration, the bucket is publicly accessible and allows end-users to fetch them via the GUI and submit them in a transaction to the apropriate blockchain. - -### Pre-Requisites -- AWS Account -- Agent Infrastructure - -### Bucket Setup - -Setup is simple, create a bucket in your desired region via the AWS UI, ensuring to uncheck "Block Public Access" as the desired outcome is for the contents of this bucket to be publicly accessible on the internet. - -Use the following bucket policy to enable public access to `s3:getObject` in your newly created bucket: - -``` -{ - "Version": "2012-10-17", - "Id": "S3PublicRead", - "Statement": [ - { - "Sid": "IPAllow", - "Effect": "Allow", - "Principal": "*", - "Action": "s3:getObject", - "Resource": "arn:aws:s3:::/*" - } - ] -} -``` - -### AWS IAM Permissions - -NOTE: Currently, Agents only support a single AWS key for both KMS Signing and S3 Upload. This enforces a non-functional requirement that the S3 bucket proofs are uploaded to and the KMS keys used to sign transactions are in the same logical AWS account. - -Create an IAM policy that allows a user to write to the S3 bucket you created in the previous step: - -``` -{ - "Version": "2012-10-17", - "Statement": [ - { - "Sid": "ListObjectsInBucket", - "Effect": "Allow", - "Action": [ - "s3:ListBucket" - ], - "Resource": [ - "arn:aws:s3:::" - ] - }, - { - "Sid": "AllObjectActions", - "Effect": "Allow", - "Action": "s3:*Object*", - "Resource": [ - "arn:aws:s3:::/*" - ] - } - ] -} -``` - -Attach this policy to an IAM user and provision/download AWS keys. - -### Configuring the Agent - -The Processor agent has special config for S3 proof indexing, located in the code [here](https://github.com/nomad-xyz/nomad-monorepo-archive/blob/main/rust/agents/processor/src/settings.rs#L9-L24). - -Buckets can be configured at agent runtime via the following environment variables: - -`OPT_PROCESSOR_S3_BUCKET` -> Name of the bucket. Ex. `nomadxyz-development-proofs` -`OPT_PROCESSOR_S3_REGION` -> AWS region the bucket lives in. Ex. `us-west-1` - -If you are using the helm chart, these values can be passed via [`values.yaml`](https://github.com/nomad-xyz/nomad-monorepo/blob/main/rust/helm/nomad-agent/values.yaml#L147-L149) like so: - -``` -processor: -... - s3Proofs: - bucket: nomadxyz-development-proofs - region: us-west-1 -``` \ No newline at end of file diff --git a/docs/dev/agents/debug-agents.md b/docs/dev/agents/debug-agents.md deleted file mode 100644 index b5d13c1..0000000 --- a/docs/dev/agents/debug-agents.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -title: Debugging Agents using Grafana -lang: en-US ---- - -# Nomad Bridge GUI - -As much as we'd like agents to run smoothly 24/7 without a hitch, in practice, this doesn't always happen. As we deploy to new networks, bugs in both our code and those of our RPC providers will surface over time. This tutorial examines a hypothetical example regression and to how to use Grafana dashboards and logs to debug the issue. - -## Example Investigation - -At a high level, these are the steps to debugging a regression: - -1. Identify a regression and its time window. -2. Examine that time window in other dashboards for any immediate hints. -3. Query logs and reference the code to identify the root cause of the error or stall. - -
- -We will go through these steps in more detail below, starting with identifying a regression. - -The most important birds-eye-view dashboard for initially spotting a regression is the `Bridge Health `dashboard. This dashboard tracks the number of outstanding, unprocessed messages and the number of processed messages. If our agents are keeping up with processing messages, these lines should always follow each other and should never diverge. - -First navigate to the Bridge Health dashboard as shown below. On the main page, click on the `Search dashboards` tab on the far left. - -![Find Explore](../public/../../public/tutorials/debug-agents/find-dashboards.png) - -
- -Now find the Bridge Health dashboard among the listed dashboards. - -![Find Bridge Health](../public/../../public/tutorials/debug-agents/find-bridge-health.png) - -
- -Now that we have the `Bridge Health` dashboard in front of us, we spot a regression. In the highlighted region, we see that while the number of unprocessed messages continued increasing, the number of processed messages did not, meaning that there was a some kind of stall. This is almost always what regressions look like. - -![Regression Found](../public/../../public/tutorials/debug-agents/identify-regression.png) - -
- -Highlight the regression to zoom in. We can already see a plethora of errors emitted during the stall in the error graph below the regression. More importantly, by highlighting the regression, we have identified the start and end timestamps for which the regression occurred (see top right corner). - -![Regression Zoom](../public/../../public/tutorials/debug-agents/zoom-in-regression.png) - -
- -Now that we know the general timestamp of the regression, we know where to look in other dashboards and in logs. Lets take a look at the `Agents` dashboard to see if we can find anything. This dashboard shows several agent-specific metrics and the activity rates of each agent. Navigate back to the Grafana home page and find the `Agents` dashboard in the same way we found the `Bridge Health` dashboard. - -
- -Once you have navigated to the `Agents` dashboard, copy-paste the regression timestamps into the timestamp window in the top right. This will narrow our examination window. - -![Agents Timestamp Paste](../public/../../public/tutorials/debug-agents/agents-timestamp-paste.png) - -
- -Once we've narrowed our time window, let's look at the processor `next_message_nonce` metric. This metric tracks what message a given processor is currently on for each channel. The `next_message_nonce` should be moving up and to the right if all is healthy. In the highlighted region, however, it looks it looks like the Moonbase processor metric stopped being reported. - -![Zoom Agent Regression](../public/../../public/tutorials/debug-agents/agents-no-zoom.png) - -
- -Lets zoom in even more to see the discontinued reporting. - -![Zoom Agent Regression](../public/../../public/tutorials/debug-agents/agents-regression-zoom.png) - -
- -Now that we have a better idea of what our issue might be, let's check if our hypothesis about crash looping is correct using Grafana logs. Navigate back to the Grafana home page and find the `Explore` tab on the far left. - -![Find Explore](../public/../../public/tutorials/debug-agents/find-explore.png) - -
- -You should see a prompt at the top where you can write log queries. To query Grafana logs, we write Loki queries. For more details on writing Loki queries to narrow down your searches, see this [cheat sheet](https://grafana.com/docs/loki/latest/logql/log_queries/). Here, we just want a simple query that shows all logs during the time window for the Moonbase processor (see query in prompt). - -![Write Query](../public/../../public/tutorials/debug-agents/enter-agent-pod-and-timestamp.png) - -
- -If we look at our query results, we can see, the Moonbase processor is indeed crash looping with some error about a local root mismatch. This is when we would go back to the codebase and piece together the root cause of the error. The same applies for stalls that are not emitting explicit errors. - -![Error Logs](../public/../../public/tutorials/debug-agents/log-errors.png) - -
- -While we are not going to actually debug this regression, you get the idea. To reiterate, the general steps are to: - -1. Identify a regression and its time window. -2. Examine that time window in other dashboards for any immediate hints. -3. Query logs and reference the code to identify the root cause of the error or stall. - -
- -In an ideal world, nobody has to go through these steps but errors and stalls are inevitable in the messy world of off-chain operations. With that said, happy debugging! diff --git a/docs/dev/agents/index.md b/docs/dev/agents/index.md deleted file mode 100644 index 748f718..0000000 --- a/docs/dev/agents/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Developer Resources -lang: en-US ---- - -# Agent Resources - -- [Agent Development](./agent-development.md) - How to Contribute to the Agent Codebase -- [Agent Operations](./agent-operations.md) - How to Run Agents in Production -- [Agent Debugging](./debug-agents.md) - Runbook for Debugging Agent Regressions -- [The Keymaster](./the-keymaster.md) - Tooling for Agent Wallets diff --git a/docs/dev/agents/the-keymaster.md b/docs/dev/agents/the-keymaster.md deleted file mode 100644 index bcd6241..0000000 --- a/docs/dev/agents/the-keymaster.md +++ /dev/null @@ -1,105 +0,0 @@ -# The Keymaster - -[_I am Vinz, Vinz Clortho, Keymaster of Gozer...Volguus Zildrohoar, Lord of the Seboullia. Are you the Gatekeeper?_](https://www.youtube.com/watch?v=xSp5QwKRwqM) - -![Keymaster from Ghostbusters](https://i.pinimg.com/originals/9d/5b/a0/9d5ba02875ce7921d092038d1543b1f4.jpg) - -## Summary - -The Keymaster is a tool that is used to manage funds for Nomad Agent Wallets. Due to the sheer number of networks Nomad supports, and the necessity for having a unique set of keys for each home, managing funds and ensuring agents can continue to function quickly becomes difficult as the network of Nomad channels grows. - -Example: - -For 4 homes (alfajores, kovan, rinkeby, rinkarby) with 5 addresses each (kathy, watcher, updater, processor, relayer), this means there will be 20 unique addresses and each address has to be funded on each network resulting in 20 \* 4 = 80 unique accounts across all networks which must be funded and topped up regularly. - -Generalized: num_homes^2 \* num_addresses - -The Keymaster stores metadata about addresses, sources of funds, network RPC endpoints, and more to facilitate solving this problem. - -## Using The Keymaster - -Note: Before you do _anything_, [call the Ghostbusters](https://www.youtube.com/watch?v=Fe93CLbHjxQ). - -The Keymaster is a simple Python-based CLI program, the entrypoint is `keymaster.py` - -Install the requirements via pip: - -`pip3 install -r requirements.txt` - -The Keymaster can be invoked via `python3` like so: - -``` -$ python3 keymaster.py --help -Usage: keymaster.py [OPTIONS] COMMAND [ARGS]... - -Options: - --debug / --no-debug - --config-path TEXT - --help Show this message and exit. - -Commands: - top-up -``` - -Subcommands can be invoked by passing them as arguments to the CLI: - -``` -$ python3 keymaster.py top-up --help -Usage: keymaster.py top-up [OPTIONS] - -Options: - --help Show this message and exit. -``` - -## Configuration File - -The Keymaster relies on a JSON configuration file, by default located at `./keymaster.json`. You can pass a new path to the file using the `--config-path` argument. - -An example can be found at `./keymaster-example.json` and its contents are repeated here for convenience: - -``` -{ - "networks": { - "alfajores": { - "endpoint": "https://alfajores-forno.celo-testnet.org", - "bank": { - "signer": "", - "address": "
" - }, - "threshold": 500000000000000000 - }, - "kovan": { - "endpoint": "", - "bank": { - "signer": "", - "address": "
" - }, - "threshold": 500000000000000000 - } - }, - "homes": { - "alfajores": { - "replicas": ["kovan"], - "addresses": { - "kathy": "
", - "watcher": "
", - "updater": "
", - "relayer": "
", - "processor": "
" - } - }, - "kovan": { - "replicas": ["alfajores"], - "addresses": { - "kathy": "
", - "watcher": "
", - "updater": "
", - "relayer": "
", - "processor": "
" - } - } - } -} -``` - -In the `top-up` command, The Keymaster will load the contents of this file and use it to dynamically query the configured accounts and determine if they need to be topped up. \ No newline at end of file diff --git a/docs/dev/architecture.md b/docs/dev/architecture.md deleted file mode 100644 index 4b3a59f..0000000 --- a/docs/dev/architecture.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: Architecture -lang: en-US ---- - -# Nomad Architecture - -## Components - -![Nomad Architecture Diagram](/Nomad-Architecture.png) - -Nomad has several logical components: - -- Home - The on-chain contract responsible for producing the message tree -- Replica - The on-chain contract responsible for replicating the message root on some other chain -- Updater - The off-chain participant responsible for submitting updates to the home chain -- Watcher - The off-chain participant responsible for observing a replica, and submitting fraud proofs to the home chain -- Relayer - The off-chain participant responsible for submitting updates to a replica -- Processor - The off-chain participant responsible for causing messages to be processed - -### On-chain (Contracts) - -#### Home - -The home contract is responsible for managing production of the message tree and holding custody of the updater bond. It performs the following functions: - -1. Expose a "send message" API to other contracts on the home chain -2. Enforce the message format -3. Commit messages to the message tree -4. Maintain a queue of tree roots -5. Hold the updater bond -6. Slash on double-update proofs (not implemented) -7. Slash on improper update proofs (not implemented) -8. Future: manage updater rotation/bond -9. Future: recover from `FAILED` state - -#### Replica - -The replica contract is responsible for managing optimistic replication and dispatching messages to end recipients. It performs the following functions: - -1. Maintain a queue of pending updates -2. Finalize updates as their timeouts elapse -3. Accept double-update proofs -4. Validate message proofs -5. Enforce the message format -6. Dispatch messages to their destination -7. Expose a "disconnect" feature -8. Future: recover from `FAILED` state - -### Off-chain (Agents) - -#### Updater - -The updater is responsible for signing attestations of new roots. It is an off-chain actor that does the following: - -1. Observe the home chain contract -2. Sign attestations to new roots -3. Publish the signed attestation to the home chain -4. Future: manage Updater bond - -#### Watcher - -The watcher observes the Updater's interactions with the Home contract (by watching the Home contract) and reacts to malicious or faulty attestations. It also observes any number of replicas to ensure the Updater does not bypass the Home and go straight to a replica. It is an off-chain actor that does the following: - -1. Observe the home -2. Observe 1 or more replicas -3. Maintain a DB of seen updates -4. Submit double-update proofs -5. Submit invalid update proofs -6. If configured, issue an emergency halt transaction - -#### Relayer - -The relayer forwards updates from the home to one or more replicas. It is an off-chain actor that does the following: - -1. Observe the home -2. Observe 1 or more replicas -3. Polls home for new signed updates (since replica's current root) and submits them to replica -4. Polls replica for confirmable updates (that have passed their optimistic time window) and confirms if available (updating replica's current root) - -#### Processor - -The processor proves the validity of pending messages and sends them to end recipients. It is an off-chain actor that does the following: - -1. Observe the home -2. Generate and submit merkle proofs for pending (unproven) messages -3. Maintain local merkle tree with all leaves -4. Observe 1 or more replicas -5. Maintain list of messages corresponding to each leaf -6. Dispatch proven messages to end recipients diff --git a/docs/dev/dev-contract-deployment.md b/docs/dev/dev-contract-deployment.md deleted file mode 100644 index d69f9de..0000000 --- a/docs/dev/dev-contract-deployment.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: Dev Contract Deployment -lang: en-US ---- - -# Deploying Dev Setup - -This section goes through the steps of adding a new development network to `nomad-deploy` and deploying a new set of dev contracts. If you will not be adding a new network, please skip to [Deploying the Contracts to Dev](#deploying-the-contracts-to-dev). If you are looking to deploy a new network to the production setup, please refer to the separate page on deploying new contracts to production. - -## Add a New Network Config - -If you are looking to add a new network to your dev setup, you will need to create a new config file for that network in `typescript/nomad-deploy/config/testnets`. - -1. Copy the contents of one of the existing network's files into a new file titled `.ts`. -2. Rename the `process.env` variables (deployer key and RPC URL) such that they pull from the `.env` variables for your new network. -3. Set the `chainJson` fields appropriately. For dev, this usually just means updating the following fields: `name`, `domain`, `timelag`. -4. Set the `devConfig` and `stagingConfig` object fields appropriately. In practice, for dev, you leave `devConfig` the same and only update `stagingConfig.optimisticSeconds`. - -## Writing a New Deploy Script - -Now that you've added a new network config, you must write a new deploy script that includes your new network. - -1. Duplicate the contents of an existing folder in `typescript/nomad-deploy/scripts` (`core.ts` and `bridge.ts`) and put them in a new folder for your new deploy script. -2. In `core.ts` and `bridge.ts` adjust any import paths to pull in your new network config from `typescript/nomad-deploy/config/testnets`. -3. Add or remove any other existing networks in `core.ts` and `bridge.ts` and ensure that the `CoreDeploy` objects for the desired networks are used in the `deployTwoChains` or `deployNChains` calls at the bottom of the files. -4. Add new npm scripts to `typescript/nomad-deploy/package.json` that execute your new `core.ts` and `bridge.ts` files. The scripts will look like the following: - -``` -"scripts": { - ... - "deploy--core": npx ts-node scripts//core.ts, - "deploy--bridge": npx ts-node scripts//bridge.ts - ... -} -``` - -## Deploying the Contracts to Dev - -The following section walks through the steps for deploying a new set of contracts to dev. - -1. Clone the monorepo and take a look at [nomad-deploy](https://github.com/nomad-xyz/nomad-monorepo/tree/main/typescript/nomad-deploy). - -2. Populate `.env.example` with the required RPC endpoints and funded deployer keys -- place it at `typescript/nomad-deploy/.env`, [see the example](https://github.com/nomad-xyz/nomad-monorepo/blob/main/typescript/nomad-deploy/.env.example) - -3. Prepare Local Dependencies - -`nomad-deploy` is configured to use the local versions of the Nomad typechain interface and the Nomad SDK, as such the local Node modules must be initialized. - -``` -# Install dependencies for typechain -$ cd typescript/typechain -$ npm i - -... - -# Install dependencies for nomad-sdk -$ cd typescript/nomad-sdk -$ npm i -``` - -3. Install Dependencies - -``` -$ cd typescript/nomad-deploy -$ npm i -# Links local modules to nomad-deploy -$ npm run relink-all -``` - -4. Execute a Deploy Script - -Note: See below for more details about the available deployment scripts. - -``` -# Deploy core contracts first -$ npm run deploy--core - -# Then deploy bridge contracts -$ npm run deploy--bridge -``` - -5. Commit Outputted Configs - -If all goes according to plan, you will have a new folder at `rust/config/` containing JSON files that are used by the Off-Chain Agents. Please rename this folder appropriately (`development` if this will become the new dev setup). When committed to the monorepo, the config files are automatically bundled into the resultant Agent docker image in CI. - -Note: Deployment environments may be overridden by replacing the environment's config folder with the contents of your new timestamped configuration. - -## Updating Nomad SDK Dev Addresses - -If your newly deployed setup will become the new dev setup, you will need to adjust the hardcoded domains, indexing parameters, and addresses in the Nomad SDK. Go to `typescript/nomad-sdk/src/nomad/domains/dev.ts`. For each `NomadDomain` object: - -1. Update the indexing parameters (`blocks` and `from`) with the `chunk` and `from` fields from `rust/config/development/_config.json`. -2. Replace all addresses with those in the the newly outputted config file `rust/config/development/_contracts.json`. For the home and replica addresses, use the _proxy_ addresses. -3. If you deployed a new network that has not been seen before, add a new `NomadDomain` object and fill it with the correct fields. diff --git a/docs/dev/domain-ids.md b/docs/dev/domain-ids.md deleted file mode 100644 index 1f5a898..0000000 --- a/docs/dev/domain-ids.md +++ /dev/null @@ -1,19 +0,0 @@ -# Nomad Domain IDs - -## Mainnet - -| Chain | Domain | -| -------------- | ----------- | -| Ethereum (hub) | 6648936 | -| Moonbeam | 1650811245 | - -
- -## Testnet - -| Chain | Domain | -| ---------------- | ----------- | -| Rinkeby (hub) | 2000 | -| Kovan | 3000 | -| MoonbaseAlpha | 5000 | -| MilkomedaTestnet | 8000 | \ No newline at end of file diff --git a/docs/dev/governance.md b/docs/dev/governance.md deleted file mode 100644 index ccddfef..0000000 --- a/docs/dev/governance.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -title: Governance -lang: en-US ---- - -# Cross-Chain Governance - -## Pre-Requisite Reading - -- [Nomad: Optimistic Interchain Communication](../index.md) - -## Summary - -### Purpose - -This document describes **a governable system for executing permissioned actions across chains**. - -We aim to clearly describe - -- **what** contracts comprise the system for calling permissioned functions across chains -- **which** functions will be delegated to this system at launch, and -- (directionally) **who** will have permission to call these functions at launch and in the future - -### Out of Scope - -This document does NOT describe a system for **how** governance actions will be proposed, voted on, and/or approved before being executed. - -It does not describe how contract upgrades will be written, reviewed, verified. - -### Overview - -We define a role, `governor`, with the power to perform permissioned actions across chains. In order to empower the `governor`, we deploy a cross-chain application comprised of a `GovernanceRouter` contract on each chain. - -Each `GovernanceRouter` can be delegated control over an arbitrary set of permissioned functions on its local chain. The only way to access the permissioned functionality is to call the function via the `GovernanceRouter` contract. - -Each `GovernanceRouter` is programmed to accept messages ***only*** from the `governor`, which is deployed on only one chain. The `governor` may call the contract locally (if it is deployed on the same chain), or it may send it messages remotely via Nomad. Because of its exclusive power over the `GovernanceRouter` contracts, the `governor` has exclusive rights to perform **all** of the permissioned roles that are delegated to the `GovernanceRouter` on each chain. - -The system receives orders from the `governor` and carries out their effects across chains; it is agnostic to how the `governor` chooses to operate. This maintains flexibility to design the governance proposal process in the future. - -At launch, the core functionality that will be delegated to the `GovernanceRouter` on each chain is the power to upgrade the implementation of the `Home` and `Replica` contracts. This way, the `governor` will have the power to conduct upgrades of the Nomad system on every chain. More details on the upgradability system can be found [here](./upgrade-setup.md). - -At launch, the `governor` will be a multisig of trusted team and community members. In the near future, the `governor` role will most likely be transferred to a more fully-featured set of contracts capable of accepting proposals, tallying votes, and executing successful proposals. - -## Message Flow Diagram - -![Cross-chain Governance Diagram](/governance-diagram.png) - -1. `governor` sends message to its local `GovernanceRouter` -2. `GovernanceRouter` dispatches the message... - 1. if the recipient is local, to the recipient directly (→ process finished) - 2. if the recipient is remote, via Nomad to the local Home contract (→ continue to 3) -3. Message is relayed from local `Home` to remote `Replica` via Nomad -4. `Replica` dispatches message to the remote `GovernanceRouter` -5. `GovernanceRouter` dispatched the message directly to the local recipient - -**Note on message recipient:** - -- the recipient may be a `Replica` or `Home` contract -- it may be an `UpgradeBeacon` that controls the implementation of `Replica` or `Home` -- it may be any other app - -For simplicity & clarity to show the message flow, this diagram represents the recipient as a generic "App" - -## Specification - -### Glossary of Terms - -- **xApp** - Cross-Chain Application -- **role** — - - an address stored in a smart contract's state that specifies an entity with special permissions on the contract - - permission to call certain functions is usually implemented using a function modifier that requires that the caller of the function is one of the roles with permission to call it; all contract calls sent from callers that do not have valid permission will revert - - *example*: `owner` is the **role** set on all [Ownable](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/access/Ownable.sol) contracts upon deployment; the `owner` **role** has exclusive permission to call functions with the `onlyOwner` modifier -- **permissioned function** — - - any smart contract function that restricts callers of the function to a certain role or roles - - *example*: functions using the `onlyOwner` modifier on [Ownable](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/access/Ownable.sol) contracts -- **permissioned call** — a call to a **permissioned function** -- **governor chain** — - - the chain on which the `governor` is deployed - - the chain whose `GovernanceRouter` is also the special `GovernorRouter` which can *send* messages; all `GovernanceRouters` on other chains can only *receive* governance messages - -### On-Chain Components - -#### **GovernanceRouter** - -- xApp designed to perform permissioned roles on core Nomad contracts on all chains -- State Variables -- **governor** state variable - - if the `governor` is local, `governor` will be set to the EVM address of the `governor` - - if the `governor` is remote, `governor` will be `address(0)` -- **governorDomain** state variable - - the Nomad domain of the **governor chain** - - stored as a state variable on all `GovernanceRouters`; should be the same on all `GovernanceRouters`; always non-zero - - if the `governor` is local, `governorDomain` is equal to the `originDomain` of the local `Home` contract - - if the `governor` is remote, `governorDomain` is equal to the `originDomain` of the remote `Home` contract - - equal to the `originDomain` of the local `Home` contract on the chain of the `GovernorRouter` - - used by all `GovernanceRouters` to determine whether an incoming Nomad message was sent from the `GovernorRouter` - - if the message is from the `GovernorRouter`, the `GovernanceRouter` will handle the incoming message - - if not, it will revert -- **routers** state variable - - a mapping of domain → address of the remote `GovernanceRouter` on every other chain -- **domains** state variable - - an array of all domains that are registered in `routers` - - used to loop through and message all other chains when taking governance actions - - there is the possibility that some domains in the array are null (if a chain has been de-registered) -- **GovernorRouter** - - the special `GovernanceRouter` that has *permission to send* governance messages to all other `GovernanceRouters` - - the `GovernanceRouter` on the **governor chain** - -#### **Governor** - -- via the `GovernanceRouter` system, it has the unique ability to call permissioned functions on **any contract** on **any chain** that transfers permission to the local `GovernanceRouter` -- the **role** with permission to send messages to the `GovernorRouter` - - the `GovernorRouter` has exclusive permission to send messages via Nomad to all other `GovernanceRouters` - - the `GovernanceRouters` can have arbitrary permissions delegated to them by any contract on their local chain - - therefore, the `governor` is the entity with the power to call any **permissioned function** delegated to any `GovernanceRouter` on any chain -- there is only one `governor` throughout the Nomad system; it can be deployed on any chain -- the `governor` role can always be transferred to another contract, on the same chain **or** a different remote chain -- stored as a state variable on `GovernanceRouters`; set to zero on all `GovernanceRouters` except on the **governor chain** -- **Any contract** on **any chain** that wishes for this governance system to have discretion to call a set of its functions can create a role & a function modifier giving exclusive permission to that role to call the function(s) (similar pattern to Ownable). The contract must then set the local `GovernanceRouter` to the permissioned role, which — by extension — gives the `governor` exclusive permission to call those functions (regardless of whether the `governor` is remote or local) - -### Failure States - -If there is fraud on the Nomad `Home` contract on the **governor chain**, this is currently a "catastrophic failure state" — no further governance actions can be rolled out to remote chains; we must create a plan to recover the system in this case. - ---- - -## Message Types - -### Executing (Arbitrary) Calls - -1. **for each chain**, the `governor` constructs the array of `(to, data)` calls to the permissioned functions on the contracts that will perform the upgrades on that chain -2. the `governor` sends a transaction to the `GovernanceRouter.callRemote` function on its local the , passing in the `domain` of the remote chain and the array of `(to, data)` calls of transactions to execute on that chain -3. the local `GovernanceRouter` constructs an Nomad-compatible message from the array of calls, addresses the message to the remote `GovernanceRouter`, and sends the message to the local `Home` contract -4. the message is relayed from the local `Home` to the remote `Replica` contract on the specified `domain` -5. the `Replica` dispatches the message to the specified recipient, which is the local `GovernanceRouter` -6. the `GovernanceRouter` parses the message to decode the array of `(to, data)` calls -7. the `GovernanceRouter` uses low-level call to execute each of the transactions in the array within the local chain - -### **Transferring Governor** - -#### **Possible State Transitions** - -1. called by the local owner to transfer ownership to another local owner (`domain` does not change, `owner` changes to a new `bytes32` address) -2. called by the local owner to transfer ownership to a remote owner (`domain` changes to the remote, `owner` changes from a non-zero `bytes32` to `bytes32(0)`) -3. called by a remote owner to transfer ownership to a local owner (`domain` changes to the local domain, `owner` changes from `bytes32(0)` to a non-zero `bytes32`) -4. called by a remote owner to transfer ownership to another remote owner (`domain` changes to the new remote owner, `owner` remains `bytes32(0)`) - -### Enrolling a Router - -- used when a new chain is added to Nomad after we've already set up the system and transferred governorship -- add a new domain → address mapping to the `routers` mapping on every other `GovernanceRouter` - ---- - -## Functionality at Launch - -### Permissioned Roles - -At launch, the `GovernanceRouter` system **will have the following permissions**: - -1. upgrade the implementation of `Home` (via `UpgradeBeacon` pattern) -2. upgrade the implementation of all `Replicas` (via 1-to-N `UpgradeBeacon` pattern) -3. upgrade the implementation of itself (via `UpgradeBeacon` pattern) - -The `GovernanceRouter` **will NOT have permission** to: - -- un-enroll a `Replica` from the `UsingNomad` contract, which will require a specialized role that can act quickly - -### Governor - -The flexibility of this system will support a move to progressive decentralization. - -Initially, the `governor` will most likely be a multisig controlled by trusted team and community members - -Later, the `governor` role will most likely be transferred to a decentralized governance contract \ No newline at end of file diff --git a/docs/dev/index.md b/docs/dev/index.md deleted file mode 100644 index 9cff2b6..0000000 --- a/docs/dev/index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Developer Resources -lang: en-US ---- - -# Developer Resources for Nomad Integration - -- [Nomad](../index.md) -- [xApps](./xapps.md) -- [Token Bridge xApp](./token-bridge.md) -- [SDK](./sdk.md) -- [Agents](./agents/index.md) -- [Network Topology](./topology.md) - -# Code Examples - -- [Counter xApp](https://github.com/nomad-xyz/nomad-monorepo/tree/main/examples/counter-xapp) -- [Example UI](https://github.com/nomad-xyz/nomad-monorepo/tree/main/examples/example-ui) diff --git a/docs/dev/prod-contract-deployment.md b/docs/dev/prod-contract-deployment.md deleted file mode 100644 index c2236ef..0000000 --- a/docs/dev/prod-contract-deployment.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Production Contract Deployment -lang: en-US ---- - -# Incrementally Deploy New Network to Production Setup - -TODO diff --git a/docs/dev/sdk.md b/docs/dev/sdk.md deleted file mode 100644 index efe4476..0000000 --- a/docs/dev/sdk.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Nomad SDK -lang: en-US ---- - -# Nomad SDK - -### Core - - - npm package - - docs - -### Bridge - - - npm package - - docs - -### Governance - - - npm package - - docs - -### Multi Provider - - - npm package diff --git a/docs/dev/token-bridge.md b/docs/dev/token-bridge.md deleted file mode 100644 index 9717a1a..0000000 --- a/docs/dev/token-bridge.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -title: Token Bridge xApp -lang: en-US ---- - -# Token Bridge xApp - -## Summary - -The Token Bridge xApp implements a bridge that is capable of sending tokens across blockchains. - -Features: - -- Ensures that circulating token supply remains constant across all chains. - -## Limitations - -The Token Bridge xApp only supports standard, non-rebasing ERC20-compliant tokens. - -## Protocol - -### Handling Messages - -- the BridgeRouter contract only accepts messages from other remote BridgeRouter contracts, which are registered by each BridgeRouter - - therefore, every message received follows the same "rules" that the local BridgeRouter expects - - for example, any tokens sent in a message are ensured to be valid, because the remote BridgeRouter sending the message should locally enforce that a user has custody before sending the message to the remote chain -- the messages from remote BridgeRouter contracts must be sent via Nomad, dispatched by a local Replica contract, which are registered with the UsingNomad contract - - thus, the BridgeRouter depends on the UsingNomad contract for a valid registry of local Replicas -- if another chain has sent a token that's "native" to this chain, we send that token from the Router contract's escrow to the recipient on this chain -- if we're receiving a token that's not "native" to this chain, - - we check whether a representation token contract has already been deployed by the Router contract on this chain; if not, we deploy that representation token contract and add its address to the token registry - - we mint representation tokens on this chain and send them to the recipient - -### Dispatching Messages - -- **TODO**: describe rules — person must approve token to Router on local chain (if it's a native token) proving they have ownership over that token and can send to the native chain -- sending tokens - - the user uses ERC-20 `approve` to grant allowance for the tokens being sent to the local BridgeRouter contract - - the user calls send on the local BridgeRouter to transfer the tokens to a remote -- if the token being sent is "native" to the BridgeRouter's chain, the BridgeRouter contract holds the token in escrow -- if the token being sent is not "native" to the chain, then the local token is a representation token contract deployed by the BridgeRouter in the first place; the BridgeRouter contract burns the tokens before sending them to another chain - -### Message Format - -- **TODO**: specify how messages are encoded for this application - -## Architecture - -**BridgeRouter ([code](https://github.com/nomad-xyz/nomad-monorepo/blob/main/solidity/nomad-xapps/contracts/bridge/BridgeRouter.sol))** - -- Receives incoming messages from local `Replica` contracts sending tokens from another chain -- Dispatches outgoing messages to local `Home` contract in order to send tokens to other chains -- Manages a registry of representation ERC-20 token contracts that it deploys on its local chain -- Maintains a registry of remote `BridgeRouter` contracts to - - authenticate that incoming messages come from a remote `BridgeRouter` contract - - properly address outgoing messages to remote `BridgeRouter` contracts - -**TokenRegistry ([code](https://github.com/nomad-xyz/nomad-monorepo/blob/main/solidity/nomad-xapps/contracts/bridge/TokenRegistry.sol))** - -- Responsible for deploying and keeping track of representation ERC-20 token contracts on this chain -- When a new token is transferred, deploys a new representation token contract on this chain, and stores a two-way mapping between the information of the original token contract & the address of the representation on this chain -- Inherited by the `BridgeRouter`, who uses this to make sure a representation of the token exists on this chain before minting/burning - -**BridgeMessage library ([code](https://github.com/nomad-xyz/nomad-monorepo/blob/main/solidity/nomad-xapps/contracts/bridge/BridgeMessage.sol))** - -- Library for handling all the nitty gritty of encoding / decoding messages in a standardized way so they can be sent via Nomad - -## Message Flow - -The logical steps and flow of information involved in sending tokens from one chain to another. - -- **Chain A** - - User wants to send their tokens to Chain B - - If it's a native token, the user must first `approve` tokens to the local `BridgeRouter-A` - - User calls `send` on the local `BridgeRouter-A` - - If it's a native token, tokens are pulled from the User's wallet to `BridgeRouter-A` and held in escrow - - If it's a non-native token, tokens are burned from User's wallet by `BridgeRouter-A` - - _Note:_ `BridgeRouter-A` can burn non-native tokens because the representative contract for the token on its non-native chain was originally deployed by `BridgeRouter-A` when it received a message sending the token from another chain. The router has administrative rights on representations - - `BridgeRouter-A` constructs a message to `BridgeRouter-B` - - `BridgeRouter-A` keeps a mapping of `BridgeRouter` contracts on other chains so it knows where to send the message on Chain B - - `BridgeRouter-A` calls `enqueue` on `Home-A` contract to send the message to Chain B -- **Off-Chain** - - Standard Nomad behavior. Updater → Relayer → Processor - - Relayers see message on `Home-A` - - Relayers pass message to `Replica-A` on Chain B -- **Chain B** - - After waiting for the acceptance timeout, `Replica-A` processes the message and dispatches it to `BridgeRouter-B` - - `BridgeRouter-B` keeps a mapping `Replica` contracts that it trusts on the local chain. It uses this to authenticate that the incoming message came from chain A - - `BridgeRouter-B` keeps a mapping of `BridgeRouter` contracts on other chains, so it can authenticate that this message came from `BridgeRouter-A` - - `BridgeRouter-B` looks for the corresponding ERC-20 token contract in its registry, and deploys a new representative one if it doesn't already exist - - `BridgeRouter-B` sends the token to the recipient - - If it's a native token, `BridgeRouter-B` sends the tokens from the pool it's holding in escrow - - If it's a non-native token, `BridgeRouter-B` mints the token to the recipient ( - - _Note:_ `BridgeRouter-B` can mint non-native tokens because the representative contract for the token on its non-native chain is deployed by `BridgeRouter-B` when it received a message sending the token from another chain. The router has administrative rights on representations. - -## Tracing a Message - -Nomad is currently still under active development. Because Nomad batches messages and sends only tree roots, there is no way to track individual messages on-chain once a message is passed to the Home contract. A agent-querying tool could be built to query off-chain agents for individual transactions, but such a tool does not currently exist. - -What this means for the token bridge is that there is going to be a state of unknown during the time of send and receipt. You can think of this as snail mail without any tracking but with delivery confirmation. The only things that can be confirmed on-chain are: - -1. A transaction was sent on chain A to the BridgeRouter contract -2. The recipient addressed received a token mint on chain B - -### Pseudo-tracking - -1. Start by locating the `bridgeRouter` contract you are looking for, addresses in the config dir: - -- [Dev Contracts](https://github.com/nomad-xyz/nomad-monorepo/tree/main/rust/config/development) -- [Staging Contracts](https://github.com/nomad-xyz/nomad-monorepo/tree/main/rust/config/staging) -- [Prod Contracts](https://github.com/nomad-xyz/nomad-monorepo/tree/main/rust/config/mainnet) - -2. Verify that a transaction was sent to the BridgeRouter contract on the Home chain - - - _Wait time_: dependent on block confirmation times for each chain - -3. Verify a transaction was sent on the Home contract - - - _Wait time_: dependent on block confirmation for each chain, but should be shortly after transaction is sent to BridgeRouter contract - - There is not a way to query for a particular transactions at this time. Cross-check timestamps with BridgeRouter transaction. - -4. After acceptance period, verify a transaction was sent on the destination Replica - - - _Wait time_: acceptance period. Currently 30 minutes - - Cross-check timestamps - -5. Verify a transaction was sent on the destination BridgeRouter - - - _Wait time_: acceptance period + block confirmation time - -6. Verify that the recipient address received a token mint - 1. _Wait time_: block confirmation time for chain A + acceptance period + block confirmation time for chain B - -## The Token Registry - -The Token Bridge xApp relies on a [`TokenRegistry`](https://github.com/nomad-xyz/monorepo/blob/main/packages/contracts-bridge/contracts/TokenRegistry.sol) smart contract. This contract handles mapping canonical Nomad token identifiers to their local representation (or native local deployment) and vice versa. - -For most tokens there is a 1:1 relationship between the canonical identifier and the local version. Regrettably, tokens are not always that simple. The token registry allows us to support more complex use cases by adjusting the relationship between identifiers and local tokens. - -### Custom Tokens - -To support teams desiring specific token functionality, the registry supports enrolling "custom" tokens. Governance may instruct the token registry to change the official local representation of a token to a new address. Any ERC20-compliant contract that allows the Bridge Router to mint & burn tokens may be enrolled as a custom token. - -When a custom token is enrolled, that token no longer has a 1:1 correspondence between local representation and canonical identifier. Instead, there are >1 local representations. Incoming transfers mint the **latest** representation (the most recently enrolled custom token), while outgoing transfer may burn **any** previous representation. This ensures that users' tokens are never invalidated, but new users get the best version. - -For convenience, we also expose a `migrate` function that allows users to immediately exchange any previous representation for the **latest** representation. This allows a user to upgrade outdated representations and receive the latest without dispatching a cross-chain message. - -### Dust - -We provide the users with `dust` in order to facilitate their onboarding to the chain (all chains apart from Ethereum). - -We provide no guarantees to the end users that they will necessarily receive gas from the Dust feature. We provide it in **good faith** that it won't be abused and will be used by users who need it. - -Dust is donated by people who are incentivized for users to have gas after they bridge. Large $$$ values of dust should not be donated at any given time and we are actively talking with teams to avoid doing so. - -It is hoped that the gas is used for genuine users, but not a concern if the gas is used improperly, as it should be of negligible importance to the donor. diff --git a/docs/dev/topology.md b/docs/dev/topology.md deleted file mode 100644 index 9b68f96..0000000 --- a/docs/dev/topology.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Nomad Network Topology -lang: en-US ---- - -Nomad provides cheap cross-chain communication channels, which are (documented -[here](./architecture.md)). From there we have to decide which -chains are worth connecting. The map of connections between chains is called -the network topology. - -## Nomad's Topology - -Generally, Nomad follows a **Hub and Spoke** network topology. That is to say, -one chain (Ethereum) is the logical hub of the Nomad network. We guarantee that -all other chains have active channels to Ethereum. While connections between -spokes may exist, we don't guarantee that they do. - -Hub and Spoke topology has a number of advantages: - -1. It guarantees a route from point A to point B exists. -1. It makes finding that route very simple. -1. It guarantees that the route is at most 2 hops. -1. It allows applications to assume direct communication with their own hub. -1. It minimizes the number of channels we must deploy and maintain -1. It allows us to directly connect spokes _if there is a compelling reason to - do so_ - -### Other Options - -IBC follows a **Mesh** topology, which does not guarantee that any specific -cross-chain channel exists. Instead, users must observe the available channels -and chart a route that hops across some number of channels to get to their -destination. - -Some networks may follow a **Total Graph** topology, which guarantees that all -chains are connected to all other chains. This results in a very large number -of channels, but cuts out all route finding. - -## For Developers - -xApp developers may make the following assumptions: - -- That a Nomad channel to Ethereum exists on any chain in the Nomad network. -- That a xApp contract deployed on Ethereum can communicate directly with xApp - contracts on any chain in the Nomad network. -- That this will remain true as new chains are added to the Nomad network. diff --git a/docs/dev/upgrade-setup.md b/docs/dev/upgrade-setup.md deleted file mode 100644 index 3a9e4a7..0000000 --- a/docs/dev/upgrade-setup.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Upgrade Setup -lang: en-US ---- - -# Upgrade Setup - -We will use the `UpgradeBeacon` pattern to implement three upgradable contract types: `Home`, `Replica`, and `GovernanceRouter`. - -Each upgradable contract will have: - -- **Proxy** - - the permanent address of the contract that external entities interact with - - holds the storage of the contract - - uses the logic specified by `Implementation` - - uses `delegatecall` to forward contract calls from `Proxy` → `UpgradeBeacon` → `Implementation` -- **UpgradeBeacon** - - stores the (mutable) address of the `Implementation` - - forwards `delegatecalls` to the `Implementation` - - accepts new `Implementation` addresses from its `Controller` (thereby performing upgrades for all `Proxies`) -- **Implementation** - - specifies the logic of the contract - - code is the same as a normal, non-upgradable contract implementation (though it should use upgrade-safe storage) - -Each of the three `UpgradeBeacon` contracts will share a the same `Controller` — the contract with the power to perform upgrades. - -The **Controller** contract will have two roles: controller and saver. - -- `controller` - - is a transferrable role that should be performing upgrades in almost every case. - - will be set to the `GovernanceRouter Proxy`, so that the Governance xApp ultimately controls the upgrades of the entire system. Note that this creates a circular dependency which makes upgrades of the `GovernanceRouter Implementation` particularly sensitive. -- `saver` - - is a transferrable(?) role that is responsible for recovering the system in a catastrophic failure case. Actions performed by the `saver` will be subject to a timelock enforced by the Controller contract. - - will be set to a multisig contract where the signatories are a set of known / trusted community members. the signatories for the `saver` multisig be the same on every chain - -## Diagrams - -![Upgrade Setup Diagram 1](/Upgrade-Setup-1.png) - -![Upgrade Setup Diagram 2](/Upgrade-Setup-2.png) diff --git a/docs/dev/xapps.md b/docs/dev/xapps.md deleted file mode 100644 index f77a615..0000000 --- a/docs/dev/xapps.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -title: xApps -lang: en-US ---- - -# Developing Cross-Chain Applications - -::: info -A xApp (pronounced "zap") is a cross-chain application built on top of the [Nomad Protocol](../index.md). -::: - -## Summary - -Nomad sends messages from one chain to another in the form of raw bytes. A cross-chain application that wishes to _use_ Nomad will need to define the rules for sending and receiving messages for its use case. - -Each cross-chain application must implement its own messaging protocol. By convention, we call the contracts that implement this protocol the application's **Router contracts.** These Router contracts must: - -- **maintain a permissioned set** of the contract(s) on remote chains from which it will accept messages via Nomad — this could be a single owner of the application on one chain; it could be a registry of other applications implementing the same rules on various chains -- **maintain a permissioned registry of connections** via the `XappConnectionManager` contract (see "Connection Management"). -- **encode messages in a standardized format**, so they can be decoded by the Router contract on the destination chain -- **handle messages** from remote Router contracts -- **dispatch messages** to remote Router contracts - -By implementing these pieces of functionality within a Router contract and deploying it across multiple chains, we create a working cross-chain application using a common language and set of rules. Applications of this kind may use Nomad as the cross-chain courier for sending and receiving messages to each other. - -## Example Code - -This repository has several examples one can use to build understanding around Cross-Chain Applications. - -### xApp Template - -**Important!** The template supported Solidity version is **<0.8**! - -[This is a template](https://github.com/nomad-xyz/nomad-monorepo/tree/main/solidity/nomad-xapps/contracts/xapp-template) provided by the Nomad team that shows the high-level components of an xApp, ready for one to fill in their own application logic and utilize an Nomad channel for cross-chain communication. - -To implement a xApp, define the actions you would like to execute across chains. -For each type of action, - -- in the [xApp Router](https://github.com/nomad-xyz/nomad-monorepo/blob/main/solidity/nomad-xapps/contracts/xapp-template/RouterTemplate.sol) - - implement a function like doTypeA to initiate the action from one domain to another (add your own parameters and logic) - - implement a corresponding \_handle function to receive, parse, and execute this type of message on the remote domain - - add logic to the handle function to route incoming messages to the appropriate \_handle function -- in the [Message library](https://github.com/nomad-xyz/nomad-monorepo/blob/main/solidity/nomad-xapps/contracts/xapp-template/MessageTemplate.sol), - - implement functions to _format_ the message to send to the other chain (encodes all necessary information for the action) - - implement functions to _parse_ the message once it is received on the other chain (decode all necessary information for the action) - -### Connection Management - -The router implements the [`XappConnectionClient`](https://github.com/nomad-xyz/monorepo/blob/main/packages/contracts-router/contracts/XAppConnectionClient.sol) abstract contract. This contract provides convenience functions for working with a [`XAppConnectionManager`](https://github.com/nomad-xyz/monorepo/blob/main/packages/contracts-core/contracts/XAppConnectionManager.sol). - -The XCM is the primary permissioning point for channels. It provides functions by which - -- xApp administrators can enroll or unenroll `Replica` contracts for inbound messages -- xApp administrators can enroll or unenroll a `Home` contract for outbound messages -- xApp administrators can permission or de-permission watchers -- watchers can unenroll `Replica` contracts - -When deploying a xApp `Router`, the xApp administrators must select an existing XCM, or deploy their own. The address of the XCM must be passed to the router's initialization method. - -### Ping Pong xApp - -**Important!** The Ping Pong xApp is for reference only. Please do not deploy! - -[The PingPong xApp](https://github.com/nomad-xyz/nomad-monorepo/tree/main/solidity/nomad-xapps/contracts/ping-pong) is capable of initiating PingPong "matches" between two chains. A match consists of "volleys" sent back-and-forth between the two chains via Nomad. - -The first volley in a match is always a Ping volley. - -- When a Router receives a Ping volley, it returns a Pong. -- When a Router receives a Pong volley, it returns a Ping. - -The Routers keep track of the number of volleys in a given match, and emit events for each Sent and Received volley so that spectators can watch. - -### Token Bridge xApp - -See the full-length [Token Bridge Documentation](./token-bridge.md) for in-depth details on Token Bridge operation and construction. - -[Link to Contracts](https://github.com/nomad-xyz/nomad-monorepo/tree/main/solidity/nomad-xapps/contracts/bridge) - -### Cross-Chain Governance xApp - -See the full-length [Nomad Governance Documentation](./governance.md) for in-depth details on Governance xApp operation and construction. - -[Link to Contracts](https://github.com/nomad-xyz/nomad-monorepo/tree/main/solidity/nomad-core/contracts/governance) - -## Useful Links - -- [xApp Developers Workshop @ EthCC 2021 by Anna Carroll](https://www.youtube.com/watch?v=E_zhTRsxWtw) - -## Glossary of Terms - -- **Local vs Remote**: in the context of discussing a particular contract, it is deployed on a particular chain. Contracts and assets on that chain are "local." Contracts and assets on another chain are "remote" - - e.g. Uniswap is deployed on Ethereum. Ethereum is the local chain. Celo is a remote chain - - e.g. there is a token deployed on Celo. There is a local `Home` contract (on Celo), and a local `Replica` contract (on Celo) receiving messages from Ethereum. There is a remote `Home` (on Ethereum) sending messages. There is a remote `Replica` (on Ethereum) receiving messages from Celo. There is a remote `Router` (on Ethereum) communicating with the local `Router` on Celo. -- **"Locally originating" vs "Remotely Originating"**: in the context of a token or asset in a specific contract, these terms denote whether the original canonical contract is deployed on the local chain, or on a remote chain - - e.g. cUSD originates on Celo. in the context of the Celo blockchain, cUSD is "of local origin" or "locally originating"; in the context of the Ethereum blockchain, cUSD is "of remote origin" - - e.g. Ether and WETH originate on Ethereum. When used in a Celo contract, they are "remotely originating" or "of remote origin" - - e.g. a `Router` receives a Transfer message for a remotely-originating asset. It finds the local contract that represents that asset. When it receives a message for a locally originating asset, it knows that it can find the original asset contract locally -- **Router Contract**: a contract that implements a cross-chain application by specifying the: - - **message format** - the bytes-encoded format of messages for the application - - **registry of remote Router contracts** that implement the same application on remote chains - - **rules & behavior for handling messages** sent via Nomad by a registered Router contract on a remote chain - - **rules & behavior for dispatching messages** via Nomad to a registered Router contract on a remote chain -- **Message**: bytes transferred via Nomad that encode some application-specific instructions via a standardized set of rules -- **Instructions**: set of application-specific actions (e.g. "send 5 token X to 0x123...456 on chain Z" in the case of a Token Bridge); calls to functions on the Router contract -- **Handling Messages from Nomad Channels**: - - receive bytes-encoded message from Nomad (sent from a remote chain) - - enact or dispatch the instructions on the local chain - - local handler decodes the message into application-specific instructions -- **Dispatching Message to Nomad Channels**: - - receive instructions on the local chain (via local users and contracts calling functions on the contract) - - encode the instructions into bytes using standardized message format - - dispatch the bytes-encoded message to Nomad (to be sent to a remote chain) diff --git a/docs/docs.mdx b/docs/docs.mdx new file mode 100644 index 0000000..3a59616 --- /dev/null +++ b/docs/docs.mdx @@ -0,0 +1,13 @@ +--- +title: Nomad Docs +description: Use Nomad's documentation to dive into the cross-chain world of tomorrow +sidebar_label: 'Home' +custom_edit_url: https://github.com/nomad-xyz/learn/blob/master/docs/docs.mdx +id: docs +slug: / +--- + +_Welcome!_ You’ve arrived at Nomad's documentation. + +Nomad is a novel approach to blockchain interoperability that leverages an optimistic mechanism to increase the security of cross-chain communication. Using Nomad, developers can securely build cross-chain applications (or xApps) and bridge assets between chains. Nomad channels and the flagship xApp, the Nomad token bridge, are live on Ethereum and Moonbeam, with more chains coming soon. + diff --git a/docs/governance-bridge/overview.md b/docs/governance-bridge/overview.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 0c6b3c8..0000000 --- a/docs/index.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -title: What is the Nomad Protocol? -lang: en-US ---- - -# What is the Nomad Protocol? - -Nomad is a new design for radically cheaper cross-chain communication without header verification. We expect operating Nomad to cut 90% of gas costs compared to a traditional header relay. To accomplish this, we took inspiration from optimistic systems (a la Optimistic Roll-ups). Nomad features many of the features we prize in an optimistic mechanism, like public verification, low gas fees, broad participation, but has a slightly different security model. - -Nomad will form the base layer of a cross-chain communication network that provides fast, cheap communication for all smart contract chains and rollups. It relies only on widely-available cryptographic primitives (unlike header relays), has a latency of thirty minutes (rather than an ORU’s one week latency), and imposes only about 120,000 gas overhead on message senders. - -Nomad has been designed for ease of implementation in any blockchain that supports user-defined computations. We will provide initial Solidity implementations of the on-chain contracts, and Rust implementations of the off-chain system agents. - -Nomad is an implementation and extension of the [Optics protocol](https://github.com/celo-org/celo-monorepo) (OPTimistic Interchain Communication). - -## Building Intuition for Nomad - -Nomad works something like a notary service. - -nomad-notary - -The sending (or “home”) chain produces a series of documents ("messages") that needs notarization. A notary (called the “updater”) is contracted to sign it. The notary can produce a fraudulent copy, but they will be punished by having their bond and license publicly revoked. When this happens, everyone relying on the notary learns that the notary is malicious. All the notary's customers can immediately block the notary and prevent any malicious access to their accounts. - -## How does Nomad work? - -Nomad is patterned after optimistic systems. It sees an attestation of some data, and accepts it as valid after a timer elapses. While the timer is running, honest participants have a chance to respond to the attestation and/or submit fraud proofs. - -Unlike most optimistic systems, Nomad spans multiple chains. The sending chain is the source of truth, and contains the “Home” contract where messages are enqueued. Messages are committed to in a merkle tree (the “message tree”). The root of this tree is notarized by the updater and relayed to the receiving chain in an “update”. Updates are signed by the updater. They commit to the previous root and a new root. - -Any chain can maintain a “Replica” contract, which holds knowledge of the updater and the current root. Signed updates are held by the Replica, and accepted after a timeout. The Replica effectively replays a series of updates to reach the same root as the Home chain. Because the root commits to the message tree, once the root has been transmitted this way, the message can be proven and processed. - -This leaves open the possibility that the Updater signs a fraudulent update. Unlike an optimistic rollup, Nomad permits fraud. This is the single most important change to the security model. Importantly, fraud can always be proven to the Home contract on the sending chain. Because of this, the updater must submit a bonded stake on the sending chain. Fraud can always be proven on the sending chain, and the bond can be slashed as punishment. - -Unfortunately, certain types of fraud can't be objectively proven on the receiving chain; Replicas can't know which messages the home chain intended to send and therefore can't check message tree validity in all cases. However, if a message is falsified by an Updater and submitted to the Replica, that update is public. This means that any honest actor can prove this fraud on the original Home contract and cause slashing. There is no way to hide fraud. - -In addition, because the Replica waits to process messages, Nomad guarantees that honest dapps can always prevent processing of dishonest messages. Fraud is always public knowledge before the fraudulent message is processed. In this sense, Nomad (like atomic swaps and other locally verified systems) includes a requirement for honest users to stay online. We have built a robust system for delegating this responsibility. - -All off-chain observers can be immediately convinced of fraud (as they can check the home chain). This means that the validity of a message sent by Nomad is not 100% guaranteed. - -Instead, Nomad guarantees the following: - -- Fraud is costly -- All users can learn about fraud -- All users can block a fraudulent message before they are accepted - - In other words, rather than using a globally verifiable fraud-proof, Nomad relies on local verification by participants. This tradeoff allows Nomad to save 90% on gas fees compared to pessimistic relays, while still maintaining a high degree of security. - -## Nomad Architecture - -Nomad contains several on-chain and off-chain components. For convenience, we’ll be referring to the Home and Replica as contracts, when in fact they are several contracts working together. - -![Nomad Components](/Nomad-Architecture.png) - -## On-chain (Contracts) - -### Home - -The home contract is responsible for managing production of the message tree and holding custody of the updater bond. - -__It performs the following functions:__ - -- Expose a "send message" API to other contracts on the home chain -- Enforce the message format -- Commit messages to the message tree -- Maintain a queue of tree roots -- Slash the updater's bond - - Double-update proofs - - Improper update proofs - -### Replica - -The replica contract is responsible for managing optimistic replication and dispatching messages to end recipients. - -__It performs the following functions:__ - -- Maintain a queue of pending updates -- Finalize updates as their timeouts elapse -- Accept double-update proofs -- Validate message inclusion proofs -- Enforce the message format -- Dispatch messages to their destination - -## Off-chain (Agents) - -### Updater - -The updater is responsible for signing attestations of new roots. - -__It is an off-chain actor that does the following:__ - -- Observe the home chain contract -- Sign attestations to new roots -- Publish the signed attestation to the home chain - -### Watcher - -The watcher observes the Updater's interactions with the Home contract (by watching the Home contract) and reacts to malicious or faulty attestations. It also observes any number of replicas to ensure the Updater does not bypass the Home and go straight to a replica. - -__It is an off-chain actor that does the following:__ - -- Observe the home -- Observe 1 or more replicas -- Maintain a DB of seen updates -- Submit double-update proofs -- Submit invalid update proofs -- If configured, issue an emergency halt transaction - -### Relayer - -The relayer forwards updates from the home to one or more replicas. - -__It is an off-chain actor that does the following:__ - -- Observe the home -- Observe 1 or more replicas -- Polls home for new signed updates (since replica's current root) and submits them to replica -- Polls replica for confirmable updates (that have passed their optimistic time window) and confirms if available (updating replica's current root) - -### Processor - -The processor proves the validity of pending messages and sends them to end recipients. - -__It is an off-chain actor that does the following:__ - -- Observe the home -- Maintain local merkle tree with all leaves -- Observe 1 or more replicas -- Maintain list of messages corresponding to each leaf -- Generate and submit merkle proofs for pending (unproven) messages -- Dispatch proven messages to end recipients - -## How Nomad passes messages between chains - -Nomad creates an authenticated data structure on a home chain, and relays updates to that data structure on any number of replicas. As a result, the home chain and all replicas will agree on the state of the data structure. By embedding data ("messages") in this data structure we can propagate it between chains with a high degree of confidence. - -The home chain enforces rules on the creation of this data structure. In the current design, this data structure is a sparse merkle tree based on the design used in the eth2 deposit contract. This tree commits to the vector of all previous messages. The home chain enforces an addressing and message scheme for messages and calculates the tree root. This root will be propagated to the replicas. The home chain maintains a queue of roots (one for each message). - -The home chain elects an "updater" that must attest to the state of the message tree. The updater places a bond on the home chain and is required to periodically sign attestations (updates or U). Each attestation contains the root from the previous attestation (U_prev), and a new root (U_new). - -The home chain slashes when it sees two conflicting updates (U_i and U_i' where U_i_prev == U_i'_prev && U_i_new != U_i'_new) or a single update where U_new is not an element of the queue. The new root MUST be a member of the queue. E.g a list of updates U_1...U_i should follow the form [(A, B), (B, C), (C, D)...]. - -Semantically, updates represent a batch commitment to the messages between the two roots. Updates contain one or more messages that ought to be propagated to the replica chain. Updates may occur at any frequency, as often as once per message. Because updates are chain-independent, any home chain update may be presented to any replica, and any replica update may be presented to the home chain. In other words, data availability of signed updates is guaranteed by each chain. - -Before accepting an update, a replica places it into a queue of pending updates. Each update must wait for some time parameter before being accepted. While a replica can't know that an update is certainly valid, the waiting system guarantees that fraud is publicly visible on the home chain before being accepted by the replica. In other words, the security guarantee of the system is that all frauds may be published by any participant, all published frauds may be slashed, and all participants have a window to react to any fraud. Therefore updates that are not blacklisted by participants are sufficiently trustworthy for the replica to accept. - -## Nomad Channels for Cross-Chain Communication - -Nomad sends messages from one chain to another in the form of raw bytes. A cross-chain application that wishes to use Nomad will need to define the rules for sending and receiving messages for its use case. - -Each cross-chain application must implement its own messaging protocol. By convention, we call the contracts that implement this protocol the application's Router contracts. Their function is broadly similar to routers in local networks. They ensure that incoming and outgoing messages are in the protocol-defined format, and facilitate handling and dispatch. - -__These Router contracts must:__ - -- maintain a permissioned set of the contract(s) on remote chains from which it will accept messages via Nomad — this could be a single owner of the application on one chain; it could be a registry of other applications implementing the same rules on various chains -- encode messages in a standardized format, so they can be decoded by the Router contract on the destination chain -- handle messages from remote Router contracts -- dispatch messages to remote Router contracts - - By implementing these pieces of functionality within a Router contract and deploying it across multiple chains, we create a working cross-chain application using a common language and set of rules. Applications of this kind may use Nomad as the cross-chain courier for sending and receiving messages to each other. - -## Benefits and Trade-offs of the Nomad Architecture - -__Benefits__ | __Challenges__ --- | -- -Broadcast channel | 1-of-N fraud-proof trust model -Cheap | Liveness failure if updater goes down -One-solution fits all | Updater could voluntarily forfeit bond to try to pass forged messages -Simple |   - -The benefit of Nomad is that the broadcast channel allows for a single-producer, multi-consumer model. This ensures that 1 accumulator can communicate with any number of receiving chains. It’s also much cheaper than other options, allowing updates and proofs to cost <100k gas and be checked by only 1 signature. With Nomad, one-solution fits all meaning that constraints on receiving chains are minimal (1 hash function + 1 signature check). There is no implementation or security difference between Proof of Stake and Proof of Work chains. There is also many fewer LoC than a Relay, much lower design maintenance overhead, and much less expertise required to maintain and operate. - -We’ve been careful to address all concerns with the Nomad system and have designed solutions that allow for optimal speed, cost, and security of the network. For example, we rely on fraud publication rather than fraud proofs to improve the speed and cost of sending messages. In this security model, any potential fraud is disincentivized and costly, and all participants will always learn of any potential fraud with plenty of time to mitigate harm. - -## Governance - -Nomad will roll out its finalized governance process and signer composition in April 2022. - -### Governor - -[Etherscan](https://etherscan.io/address/0x93277b8f5939975b9e6694d5fd2837143afbf68a), [Gnosis Safe](https://gnosis-safe.io/app/eth:0x93277b8f5939975b9E6694d5Fd2837143afBf68A/settings/owners) - -**Policy:** 3 of 5 - of the five total signers, three signatures are required to execute a transaction - -**Signers:** -- [Layne Haber](https://twitter.com/LayneHaber): `0xC69b66cc2811B509829448FBFfb2553c4CBb627e` -- [Praneeth Srikanti](https://twitter.com/bees_neeth): `0x9bdD76b2a69Db43Fa695a10f5977b8FD891225f3` -- [Pranay Mohan](https://twitter.com/pranaymohan): `0xab0614cE8d53ea2c67B87f8ad4d8Fac7A4a516e5` -- [Anna Carroll](https://twitter.com/annascarroll): `0x25270d2e6980C5b343C4866Aea904a9A9bCA733F` -- [Katherine Wu](https://twitter.com/katherineykwu): `0x83865712c50f702fA4650C7fadEd90A54242046e` - ----- -### Ethereum Recovery Manager - -[Etherscan](https://etherscan.io/address/0xda2f881f7f4e9d2b9559f97c7670472a85c1986a), [Gnosis Safe](https://gnosis-safe.io/app/eth:0xda2f881f7f4e9d2b9559f97c7670472a85c1986a/settings/owners) - -**Policy:** 2 of 3 - of the three total signers, two signatures are required to execute a transaction - -**Signers:** -- [Eli Krenzke](https://twitter.com/eKRENZKE): `0x347Ae1a35BED71BB796A5279CD85FED964468aE9` -- [Barbara Liau](https://twitter.com/barbaraliau): `0xDE9cfb1216889Dee0cAB8afB04c63911427659E4` -- [Conner Swann](https://twitter.com/YourBuddyConner): `0xea24Ac04DEFb338CA8595C3750E20166F3b4998A` - ----- -### Moonbeam Recovery Manager - -[Moonscan](https://moonbeam.moonscan.io/address/0x2D23B3865D5B7CD88Ce9CE7514a13545672d9eF7), [Gnosis Safe](https://multisig.moonbeam.network/mbeam:0x2D23B3865D5B7CD88Ce9CE7514a13545672d9eF7/settings/owners) - -**Policy:** 3 of 5 - of the five total signers, three signatures are required to execute a transaction - -**Signers:** -- [Barbara Liau](https://twitter.com/barbaraliau): `0xDE9cfb1216889Dee0cAB8afB04c63911427659E4` -- [Conner Swann](https://twitter.com/YourBuddyConner): `0xea24Ac04DEFb338CA8595C3750E20166F3b4998A` -- [Alberto Viera](https://twitter.com/theAlbertoV19): `0x4E8ee1AEFEf37c431c6B68F1F5fE6e309ba44376` -- [Arthur Kaseman](https://www.purestake.com/about/): `0x9A23197B7d8bA57E8fe62c3047003C8854F688Cc` -- [Aaron Evans](https://www.linkedin.com/in/aaron-evans-a2366/): `0x3DfED02fEFDDA06A80E21f35097fb910a4a790ef` diff --git a/docs/overview/nomad-vs-the-world.md b/docs/overview/nomad-vs-the-world.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/overview/what-is-nomad.md b/docs/overview/what-is-nomad.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/overview/why-nomad.md b/docs/overview/why-nomad.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/partners/nomad-appendix.md b/docs/partners/nomad-appendix.md deleted file mode 100644 index 2d01940..0000000 --- a/docs/partners/nomad-appendix.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Nomad - Appendix -lang: en-US ---- - -# Appendix - - - **Nomad**: A security-first cross-chain messaging protocol. Nomad is radically cheaper compared to a traditional header relay. Additionally, it is designed for high reusability, meaning it can be quickly deployed to any EVM chain without the need for any custom logic. - - - **Nomad Token Bridge**: A xApp (cross-chain application) that leverages the Nomad messaging channels to enable sending ERC-20 tokens between supported chains. - - - **Connext**: An interoperability protocol that allows users to swap/transact existing liquidity across chains. Connext is closely partnered with Nomad and is a complementary piece for a seamless end-user experience. Nomad includes a thirty minute dispute window as part of its security model. However, Connext routers are able to bridge funds in advance and pre-fill liquidity for a faster bridging experience. - - - **Message**: Bytes transferred via Nomad that encode some application-specific instructions via a standardized set of rules. - - - **Messaging Channel**: The infrustructure laid by the core Nomad protocol that allows for the passing of arbitrary bytes between chains. - - - **Origin vs Destination**: Most often refers to the direction of a message, where `origin` is the sending chain and `destination` is the receiving chain. - - - **Local vs Remote**: In the context of discussing a particular contract, it is deployed on a particular chain. Contracts and assets on that chain are `local`. Contracts and assets on another chain are `remote`. - - - **Native Assets**: Any asset that resides on it's original chain (e.g. `ETH`, `DAI` and `USDC` are native to the Ethereum chain) - - - **Representations**: When an asset is sent cross-chain, the Token Bridge mints a representation of that token on the destination chain. - - - **Core**: Reference to the core Nomad protocol, or the messaging channels implemented by the core protocol. - - - **xApps**: Pronounced `zap`. A cross-chain application that utilizes the infrastructure of the core Nomad protocol. xApps define the rules for encoding and decoding messages sent via Nomad. - - - **Routers**: A xApp contract that implements a cross-chain application by specifying the message format, as well as rules for dispatching and handling messages. - - - **Domain**: The Nomad-specific id associated with a chain. - - - **Home**: The on-chain contract that is responsible for managing production of the message tree and holding custody of the updater bond. - - - **Replica**: The on-chain contract that is responsible for managing optimistic replication and dispatching messages to end recipients. There is a Replica responsible for each remote chain. - - - **Updater**: The off-chain agent responsible for signing attestations of new roots. - - - **Watcher**: The off-chain agent responsible for reporting faulty attestations. Note that Nomad needs only *one* honest watcher to maintain security of the entire system, rather that relying on custodians or external validators. This allows Nomad to be decentralized and *highly* secure. - - - **Relayer**: The off-chain agent which forwards updates from the home to one or more replicas. - - - **Processor**: The off-chain agent which proves the validity of pending messages and sends them to end recipients. - - - **Governor**: A multi-sig with the power to perform permissioned actions across chains. [Learn more](../dev/governance.md) - - - **Dispute Window**: The time period during which fraud (if any) would be reported. Currently 30 minutes for each chain. - - - **Merkle (or Message) Tree**: A data structure that encodes data efficiently and securely. Used to verify message authenticity by the Home, Updater and Watcher. - - - **Processing or Claiming**: The final step of dispatching a message to the recipient. Processing gas fees are subsidized on most chains. However, when sending to Ethereum (due to the high gas fees), users are required to submit an additional transaction to process messages or token transfers. diff --git a/docs/partners/nomad-bridging-to-evmos.md b/docs/partners/nomad-bridging-to-evmos.md deleted file mode 100644 index 81fa213..0000000 --- a/docs/partners/nomad-bridging-to-evmos.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -title: Nomad Bridge GUI -lang: en-US ---- - -# Nomad Bridge GUI - -## Nomad vs Connext, which should I use? - -There are two options available to send funds through the GUI, Nomad and Connext. These are two distinct protocols that are complimentary to one another. We have partnered with Connext to provide an optimal experience for users! - -Nomad is a secure gas efficient cross-chain protocol that allows users to bridge funds between networks. This takes, on average, 35-60 minutes. There are no fees associated with Nomad, just pay gas! Connext provides liquidity pools for Nomad assets, meaning users can receive funds on the destination chain much faster (less than 10 minutes) for an additional fee. Nomad is advised for large transfers. - -Connext is not available for every asset and may not be available for larger sums. We recommend using Nomad if you intend to send large transfers. - -## Bridging Through Nomad - -Bridging assets across chains using Nomad should be intuitive and easy with the Nomad GUI. In this tutorial, we will walk through the steps required to bridge your assets. - -Please find our production bridge GUI at [app.nomad.xyz](https://app.nomad.xyz/). - -If you would like to test our bridge using testnet funds before using real funds, please visit our development GUI at [development.app.nomad.xyz](https://development.app.nomad.xyz/). - -
- -Connect to Metamask: - -![Connect to Metamask](../public/partner-assets/ethereum-to-evmos/connect-metamask.png) - -
- -Select origin and destination networks: - -![Select Origin and Destination Networks](../public/partner-assets/ethereum-to-evmos/select-networks.png) - -
- -(Optional) Change Destination address. This is set as your wallet address by default. Click "edit". A modal will pop up, click "change" inside the input. Then copy your address, click to paste, and save. -::: warning CAUTION -Sending assets to an address you do not control can result in a permanent loss of funds! -::: - -![Change Destination](../public/partner-assets/ethereum-to-evmos/change-dest-1.png) -![Paste Destination](../public/partner-assets/ethereum-to-evmos/change-dest-2.png) - -
- -Select the asset you want to send using the asset dropdown menu and the amount you want to send using the input prompt: - -![Select an Asset and Amount](../public/partner-assets/ethereum-to-evmos/select-token.png) - -
- -Click `Next`: - -![Select an Asset and Amount](../public/partner-assets/ethereum-to-evmos/input-data.png) - -
- -Review your transaction details and associated fees. Check if Connext liquidity is available for your transfer for a faster bridging experience! If proceeding with Connext, continue reading [here](#fast-transfers-with-connext). - -![Approve Bridge Transaction](../public/partner-assets/ethereum-to-evmos/review.png) - -
- -Click `Bridge Tokens` and approve the transaction in Metamask: - -![Approve Bridge Transaction](../public/partner-assets/ethereum-to-evmos/sending.png) - -
- -After approving the transaction, you will be taken to the transaction details page. Here, you will see the estimated time remaining for your transfer to complete. Please save your transaction hash for convenience. If you lose it, you can visit your wallet address on the block explorer of the origin network and find the transaction again. - -::: info -You must return to the Transaction Page after bridging has concluded to pay for gas and complete your transfer. Nomad may cover the processing and gas fees for some chains. -::: - -![See Transaction Details](../public/partner-assets/ethereum-to-evmos/transfer-pending.png) - -
- -You can expand the time estimate tab to track your transaction status by clicking the down arrow in the blue box: - -![See Expanded Transaction Details](../public/partner-assets/ethereum-to-evmos/expand-status.png) - -
- -(Optional) If you navigated away from the GUI at any point and want to find your transfer's progress page again, visit [https://app.nomad.xyz/tx](https://app.nomad.xyz/tx) and enter the origin network and your transfer's transaction hash. - -![Search Tx](../public/partner-assets/ethereum-to-evmos/search-transfer.png) - -
- -Once your transfer has completed, you should see the below display and your funds will be in the account of your destination address. If your transfer is taking longer than expected, please reach out to us on [Discord](https://discord.gg/RurtmJApqm) in the #support channel: - -![Finished](../public/partner-assets/ethereum-to-evmos/transfer-complete.png) - -
- -## Completing a Transfer (Ethereum Destination Only) - -If you are sending to Ethereum, there is one additional processing step due to the high cost of processing transactions on Ethereum. You will see the following display and should click "Complete Transfer" and complete the Metamask transaction. After this, your funds should be at your destination on Ethereum! - -![Self Process](../public/partner-assets/ethereum-to-evmos/complete-transfer.png) - -
- -## Fast Transfers with Connext - -Fill out data for your transfer and click "Next." Select "Connext." If there is liquidity available for your transfer, it will calculate associated fees for your transaction. Note that Connext collects gas fees in the asset that is being sent. - -If there is not liquidity available, you can continue by using Nomad. - -![Self Process](../public/partner-assets/ethereum-to-evmos/check-connext.png) - -Click `Send` and approve the transaction in Metamask! - -In a few minutes, you will see your transfer appear in a table below. Click "Claim" to submit a transaction to receive your funds on the destination chain. - -Click "View" to go to your transaction in the ConnextScan block explorer. Or you can visit `https://connextscan.io/tx/`. - -![Claim Connext funds](../public/partner-assets/ethereum-to-evmos/connext-claim.png) diff --git a/docs/partners/nomad-bridging-to-milkomeda.md b/docs/partners/nomad-bridging-to-milkomeda.md deleted file mode 100644 index f6e0f17..0000000 --- a/docs/partners/nomad-bridging-to-milkomeda.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -title: Nomad Bridge GUI -lang: en-US ---- - -# Nomad Bridge GUI - -## Nomad vs Connext, which should I use? - -There are two options available to send funds through the GUI, Nomad and Connext. These are two distinct protocols that are complimentary to one another. We have partnered with Connext to provide an optimal experience for users! - -Nomad is a secure gas efficient cross-chain protocol that allows users to bridge funds between networks. This takes, on average, 35-60 minutes. There are no fees associated with Nomad, just pay gas! Connext provides liquidity pools for Nomad assets, meaning users can receive funds on the destination chain much faster (less than 10 minutes) for an additional fee. Nomad is advised for large transfers. - -Connext is not available for every asset and may not be available for larger sums. We recommend using Nomad if you intend to send large transfers. - -## Bridging Through Nomad - -Bridging assets across chains using Nomad should be intuitive and easy with the Nomad GUI. In this tutorial, we will walk through the steps required to bridge your assets. - -Please find our production bridge GUI at [app.nomad.xyz](https://app.nomad.xyz/). - -If you would like to test our bridge using testnet funds before using real funds, please visit our development GUI at [development.app.nomad.xyz](https://development.app.nomad.xyz/). - -
- -Connect to Metamask: - -![Connect to Metamask](../public/partner-assets/ethereum-to-milkomeda/connect-metamask.png) - -
- -Select origin and destination networks: - -![Select Origin and Destination Networks](../public/partner-assets/ethereum-to-milkomeda/select-networks.png) - -
- -(Optional) Change Destination address. This is set as your wallet address by default. Click "edit". A modal will pop up, click "change" inside the input. Then copy your address, click to paste, and save. -::: warning CAUTION -Sending assets to an address you do not control can result in a permanent loss of funds! -::: - -![Change Destination](../public/partner-assets/ethereum-to-milkomeda/change-dest-1.png) -![Paste Destination](../public/partner-assets/ethereum-to-milkomeda/change-dest-2.png) - -
- -Select the asset you want to send using the asset dropdown menu and the amount you want to send using the input prompt: - -![Select an Asset and Amount](../public/partner-assets/ethereum-to-milkomeda/select-token.png) - -
- -Click `Next`: - -![Select an Asset and Amount](../public/partner-assets/ethereum-to-milkomeda/input-data.png) - -
- -Review your transaction details and associated fees. Check if Connext liquidity is available for your transfer for a faster bridging experience! If proceeding with Connext, continue reading [here](#fast-transfers-with-connext). - -![Approve Bridge Transaction](../public/partner-assets/ethereum-to-milkomeda/review.png) - -
- -Click `Bridge Tokens` and approve the transaction in Metamask: - -![Approve Bridge Transaction](../public/partner-assets/ethereum-to-milkomeda/sending.png) - -
- -After approving the transaction, you will be taken to the transaction details page. Here, you will see the estimated time remaining for your transfer to complete. Please save your transaction hash for convenience. If you lose it, you can visit your wallet address on the block explorer of the origin network and find the transaction again. - -::: info -You must return to the Transaction Page after bridging has concluded to pay for gas and complete your transfer. Nomad may cover the processing and gas fees for some chains. -::: - -![See Transaction Details](../public/partner-assets/ethereum-to-milkomeda/transfer-pending.png) - -
- -You can expand the time estimate tab to track your transaction status by clicking the down arrow in the blue box: - -![See Expanded Transaction Details](../public/partner-assets/ethereum-to-milkomeda/expand-status.png) - -
- -(Optional) If you navigated away from the GUI at any point and want to find your transfer's progress page again, visit [https://app.nomad.xyz/tx](https://app.nomad.xyz/tx) and enter the origin network and your transfer's transaction hash. - -![Search Tx](../public/partner-assets/ethereum-to-milkomeda/search-transfer.png) - -
- -Once your transfer has completed, you should see the below display and your funds will be in the account of your destination address. If your transfer is taking longer than expected, please reach out to us on [Discord](https://discord.gg/RurtmJApqm) in the #support channel: - -![Finished](../public/partner-assets/ethereum-to-milkomeda/transfer-complete.png) - -
- -## Completing a Transfer (Ethereum Destination Only) - -If you are sending to Ethereum, there is one additional processing step due to the high cost of processing transactions on Ethereum. You will see the following display and should click "Complete Transfer" and complete the Metamask transaction. After this, your funds should be at your destination on Ethereum! - -![Self Process](../public/partner-assets/ethereum-to-milkomeda/complete-transfer.png) - -
- -## Fast Transfers with Connext - -Fill out data for your transfer and click "Next." Select "Connext." If there is liquidity available for your transfer, it will calculate associated fees for your transaction. Note that Connext collects gas fees in the asset that is being sent. - -If there is not liquidity available, you can continue by using Nomad. - -![Self Process](../public/partner-assets/ethereum-to-milkomeda/check-connext.png) - -Click `Send` and approve the transaction in Metamask! - -In a few minutes, you will see your transfer appear in a table below. Click "Claim" to submit a transaction to receive your funds on the destination chain. - -Click "View" to go to your transaction in the ConnextScan block explorer. Or you can visit `https://connextscan.io/tx/`. - -![Claim Connext funds](../public/partner-assets/ethereum-to-milkomeda/connext-claim.png) diff --git a/docs/partners/nomad-building-xapps.md b/docs/partners/nomad-building-xapps.md deleted file mode 100644 index 62ccd03..0000000 --- a/docs/partners/nomad-building-xapps.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Building Cross-Chain Apps -lang: en-US ---- - -# Building Cross-Chain Apps (xApps) - -### What is a xApp? - -xApp (pronounced "zap") is short for cross-chain application. A xApp is an application that uses cross-chain messaging channels. - -Nomad makes it radically easier to use cross-chain messaging channels to communicate between chains in the form of raw bytes, which can be used to execute actions on-chain. xApp developers - -### What are some examples of a xApp? -- token bridge (most common example) -- on-chain treasury -- permissionless faucet - -### How do I build a xApp? - -To get started with building your own xApp, first you'll need to define the rules for sending and receiving messages for your xApps' use case. We call these rules the ***Router Contracts***. These Router contracts must: - -- ***maintain a permissioned set*** of the contract(s) on remote chains from which it will accept messages via Nomad — this could be a single owner of the application on one chain; it could be a registry of other applications implementing the same rules on various chains - -- ***encode messages in a standardized format***, so they can be decoded by the Router contract on the destination chain - -- ***handle messages*** from remote Router contracts - -- ***dispatch messages*** to remote Router contracts - -By implementing these pieces of functionality within a Router contract and deploying it across multiple chains, we create a working xApp using a common language and set of rules. - -## Example xApp Code - -[The examples repo](https://github.com/nomad-xyz/examples) has several code examples for sample xApps. - -### xApp Template - -Start building your own xApp today! We've got you started with this simple [template](https://github.com/nomad-xyz/examples/tree/main/packages/xapp-example/contracts/xapp-template) - -### Ping Pong xApp - -See how messages are passed back and forth between 2 chains in our [Ping Pong example](https://github.com/nomad-xyz/examples/tree/main/packages/xapp-example/contracts/ping-pong) - -### Token Bridge xApp - -The Token Bridge xApp is our first fully fledged application and is maintained by the Nomad core team. Users can bridge tokens between any networks currently supported by Nomad. - - - [Code](https://github.com/nomad-xyz/monorepo/tree/main/packages/contracts-bridge) - - [Bridge GUI](https://app.nomad.xyz/) - -### Cross-Chain Governance xApp - -Coming soon - -## Additional Resources - -- [How to Build xApps](https://www.youtube.com/watch?v=E_zhTRsxWtw) -- [Connext Network](https://docs.connext.network/) \ No newline at end of file diff --git a/docs/partners/nomad-integrating-bridge.md b/docs/partners/nomad-integrating-bridge.md deleted file mode 100644 index ecb0743..0000000 --- a/docs/partners/nomad-integrating-bridge.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: Integrating with Nomad Bridge -lang: en-US ---- - -# Integrating with Nomad Bridge - -You: *“Ahhhhhhhh I’m Integratinggg!!”* - -There are several target audiences for this section: -- dApps deployed to a Nomad-supported Domain -- Wallets or DeFi portals looking to natively embed a bridge in the app -- Anyone who would like to write software that reacts to or ingests state from Nomad - -## The Nomad SDKs - -Nomad has a suite of SDKs that are used to interact with Nomad Protocol. The functionality of each package is split logically between the various components of Nomad: - -- `@nomad-xyz/configuration` - - Configuration data for all Nomad domains (includes network data, core contract addresses, bridge contract addresses, etc) - - [Link to NPM](https://www.npmjs.com/package/@nomad-xyz/configuration) -- `@nomad-xyz/multi-provider` - - A useful library for interacting with many blockchains at once via Ethers.js, underpins the entirety of the Nomad SDK stack. - - [Link to NPM](https://www.npmjs.com/package/@nomad-xyz/multi-provider) -- `@nomad-xyz/sdk` - - The Core SDK, encapsulating the core contracts and providing primitives which are used by higher layers - - [Link to NPM](https://www.npmjs.com/package/@nomad-xyz/sdk) - - [API Documentation](https://docs.nomad.xyz/sdk/) -- `@nomad-xyz/sdk-bridge` - - The Bridge SDK, encapsulating the bridge contracts, providing primitives and convenience methods for interacting with the Nomad Bridge xApp. - - [Link to NPM](https://www.npmjs.com/package/@nomad-xyz/sdk-bridge) - - [API Documentation](https://docs.nomad.xyz/sdk-bridge/) - -## Examples Repository - -Nomad has a wonderful [Examples Repo](https://github.com/nomad-xyz/examples) which you may use as a reference when planning your integration. - -If you're: -- Building a Bridge UI, check out the [Example UI](https://github.com/nomad-xyz/examples/tree/main/packages/sdk-bridge-integration) -- Interested in writing scripts that query or interact with Nomad, check out the [SDK Quickstart](https://github.com/nomad-xyz/examples/tree/main/packages/sdk-quickstart) - -## A note about Nomad Representation Tokens - -The Nomad bridge is a burn/lock/mint model. When a user bridges an asset *from* it's native chain, that amount is locked and the Nomad representation is minted by the bridge contracts. When bridging *back* to the native chain, the representation tokens are burned and the native token is unlocked. This lock/mint model is common among many bridges. However, as a result, this means that Nomad representations are differnt from other bridges' representations. - -Why? Think of this arcade scenario (where arcades are bridges, USD is the native token and arcade coins are representations on other chains). You pay money and receive coins that you can use to play games. These coins would not be accepted at another arcade (You didn't pay that arcade for your tokens!). Likewise, coins from other arcades would not be accepted here. At the end of the night, some coins will have been spent and other coins can be turned in for the equivalent amount in cash. - -See the [token list](../bridge/domains.md) for a complete documentation of all Nomad tokens on each chain. - -## Integrading the Nomad Bridge - -### Getting started - -```ts -import { BridgeContext } from '@nomad-xyz/configuration' -const nomad = new BridgeContext('production') -nomad.registerRpcProvider('ethereum', 'https://some-rpc-url') -nomad.registerRpcProvider('moonbeam', 'https://some-rpc-url') -nomad.registerSigner('ethereum', someSigner) -nomad.registerSigner('moonbeam', someSigner) -``` - -### Sending tokens using the sdk-bridge - -**`sendNative`**: -The Nomad bridge can only send ERC-20 tokens. This function is available for native assets, such as ETH, that need to be wrapped prior to bridging. -```ts -const transferMessage = await nomad.sendNative( - originDomain, // 'ethereum' or 6648936 - destDomain, // 'moonbeam' or 1650811245 - amnt: ethers.utils.parseUnits(amnt, 18), // amount as a big number, format by token decimals (ETH has 18) - destinationAddr, // user's address -) -``` - -**`send`**: -This function is for sending any ERC-20 token. Each token has a corresponding `tokenIdentifier` which includes the name or domain of it's native chain and its address on that native chain. -```ts -// USDC has 6 decimals. Format amount accordingly -const decimals = 6 -const amountBN = ethers.utils.parseUnits(amnt, 6) -// Token Identifier for USDC -const USDCTokenIdentifier = { - domain: 'ethereum', - id: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', -} -const transferMessage = await nomad.send( - originDomain, // 'ethereum' or 6648936 - destDomain, // 'moonbeam' or 1650811245 - USDCTokenIdentifier, - amnt, // amount as a big number, format by token decimals - destinationAddr, // user's address -) -``` - -### Useful Helper Functions - -**`resolveDomain`**: Takes a domain name *or* number and returns the domain number -**`resolveDomainName`**: Takes a domain name *or* number and returns the domain name -**`resolveRepresentation`**: Takes a domain and Token Identifier and returns the token representation on that chain. diff --git a/docs/partners/nomad-overview.md b/docs/partners/nomad-overview.md deleted file mode 100644 index 16fdf78..0000000 --- a/docs/partners/nomad-overview.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: Nomad Protocol - Overview -lang: en-US ---- - -# Nomad and Connext - An Overview - -Nomad and Connext are available on ``! - -- Bridge Today: [app.nomad.xyz](https://app.nomad.xyz) -- Read the Docs: [docs.nomad.xyz](https://docs.nomad.xyz) -- Join the Nomad Discord: [Become a MadLad](https://discord.gg/nomadxyz) -- Follow [Nomad](https://twitter.com/nomadxyz_) and [Connext](https://twitter.com/ConnextNetwork) on Twitter! - -## What is Nomad Protocol? - -Nomad is a new design for radically cheaper cross-chain communication without header verification, taking inspiration from optimistic systems (a la Optimistic Roll-ups). Nomad features many of the properties we prize in an optimistic mechanism, like public verification, low gas fees, broad participation, but has a slightly different security model. - -Nomad provides the base layer of a cross-chain communication network that provides fast, cheap communication for all smart contract chains and rollups. It relies only on widely-available cryptographic primitives (unlike header relays) and measures message latency in minutes (rather than an ORU’s one-week latency). - -## What is Connext? - -Connext, using the **N**oncustodial **X**domain **T**ransfer **P**rotocol or **NXTP**, is a lightweight protocol that enables cross-chain/rollup transactions that retain the security properties of the underlying execution environment. It facilitates cross-chain value transfers via a network of liquidity providers (called Routers) which allows for near-instant settlement of cross-chain token transfers, assuming an existing liquidity environment on the receiving blockchain. - -Connext does not rely on any external validator set in order to operate -- a trust model that is highly complimentary with that of Nomad. - - -## Nomad Architecture - -Nomad works something like a notary service. - -nomad-notary - -The sending (or “home”) chain produces a series of documents ("messages") that needs notarization. A notary (called the “updater”) is contracted to sign it. The notary can produce a fraudulent copy, but they will be punished by having their bond and license publicly revoked. When this happens, everyone relying on the notary learns that the notary is malicious. All the notary's customers can immediately block the notary and prevent any malicious access to their accounts. - -Nomad's Core system is split between on-chain and off-chain components. The protocol is implemented in Smart Contracts, with the bulk of the protocol interactions being automated by a series of off-chain "Agents". - -![Nomad Components](../public/Nomad-Architecture.png) - -For a detailed deep dive on the protocol, check out the complete [Nomad Documentation](https://docs.nomad.xyz/) - -## Connext Architecture - -### How it works - -This iteration of Connext's network utilizes NXTP, a lightweight protocol for generalized crosschain transfers. - -Nxtp is made up of a simple contract that uses a locking pattern to prepare and fulfill transactions, a network of offchain routers that participate in pricing auctions and pass calldata between chains, and a user-side sdk that finds routes and prompts onchain transactions. - -### Transaction Lifecycle - -![Connext High Level Flow](../public/partner-assets/overview/connext-highlevel-flow.png) - -Transactions go through three phases: - -1. **Route Auction**: User broadcasts to our network signalling their desired route. Routers respond with sealed bids containing commitments to fulfilling the transaction within a certain time and price range. -2. **Prepare**: Once the auction is completed, the transaction can be prepared. The user submits a transaction to TransactionManager contract on sender-side chain containing router's signed bid. This transaction locks up the users funds on the sending chiain. Upon detecting an event containing their signed bid from the chain, router submits the same transaction to TransactionManager on the receiver-side chain, and locks up a corresponding amount of liquidity. The amount locked on the receiving chain is sending amount - auction fee so the router is incentivized to complete the transaction. -3. **Fulfill**: Upon detecting the TransactionPrepared event on the receiver-side chain, the user signs a message and sends it to a relayer, who will earn a fee for submission. The relayer (which is typically another router) then submits the message to the TransactionManager to complete the user's transaction on receiver-side chain and claim the funds locked by the router. A relayer is used here to allow users to submit transactions with arbitrary calldata on the receiving chain without needing gas to do so. The router then submits the same signed message and completes transaction on sender-side, unlocking the original amount. - -If a transaction is not fulfilled within a fixed expiry, it reverts and can be reclaimed by the party that called prepare on each chain (initiator). - -Additionally, transactions can be cancelled unilaterally by the person owed funds on that chain (router for sending chain, user for receiving chain) prior to expiry. - -It is important to note that neither participant should require a store to complete these transactions. All information to `prepare`, `fulfill`, or `cancel` transactions should be retrievable through contract events. - -### Architecture - -![Connext Architecture](../public/partner-assets/overview/connext-architecture.png) - -The system contains the following pieces: - - - Contracts - hold funds for all network participants, and lock/unlock based on data submitted by users and routers - - Subgraph - enables scalable querying/responding by caching onchain data and events. - - TxService - resiliently attempts to send transactions to chain (with retries, etc.) - - Messaging - prepares, sends, and listens for message data over nats - - Router - listens for events from messaging service and subgraph, and then dispatches transactions to txService - - SDK - creates auctions, listens for events and creates transactions on the user side. - -## Nomad x Connext vs XYZ Bridge - -| Approach | Mechanism | Examples | Trust Minimized | Generalized | Cheap/Fast to Implement | -| ------------------- | ---------------------------------------------------- | ------------------------------------------------------ | --------------- | ----------- | ----------------------- | -| Natively Verified | Chain's own validator set verifies xchain data. | IBC, Near Rainbowbridge, BTC Relay, rollup entry/exit | ✅ | ✅ | ❌ | -| Externally Verified | 3rd party validator set verifies data across chains. | Thorchain, Anyswap, Synapse, Hyphen, many many others. | ❌ | ✅ | ✅ | -| Locally Verified | N-party system is reduced to 1:1 interaction | Connext, Hop, Nomad, simple atomic swaps. | ✅ | ❌ | ✅ | - -### The Nomad x Connext Approach to Bridging - -Nomad's core protocol facilitates generalized cross-chain message passing via an Optimistic Mechaism. While not 100% locally verified, it enables broad protocol participation via the inclusion of fraud proofs, enabling anyone with a computer to participate in securing the protocol. The main trade-off that results in the desirable trust model, also introduces a period of latency for each message. Many users will opt to leverage the highly secure Nomad Messaging channels, despite the increased latency! - -This is where the properties of Connext become highly desirable, as it provides comparatively quick settlement of cross-chain transfers without sacrificing on trust model, assuming there's enough liquidity to complete the transfer. - -## Try It For Yourself - -You can bridge today via the [Nomad Bridge App](https://app.nomad.xyz)! \ No newline at end of file diff --git a/docs/protocol/agents.md b/docs/protocol/agents.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/protocol/governance.md b/docs/protocol/governance.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/protocol/messaging.md b/docs/protocol/messaging.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/protocol/overview.md b/docs/protocol/overview.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/protocol/security.md b/docs/protocol/security.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/public/Logo-Black.png b/docs/public/Logo-Black.png deleted file mode 100644 index 76fb618..0000000 Binary files a/docs/public/Logo-Black.png and /dev/null differ diff --git a/docs/public/Logo-White.png b/docs/public/Logo-White.png deleted file mode 100644 index 0c9867e..0000000 Binary files a/docs/public/Logo-White.png and /dev/null differ diff --git a/docs/public/Nomad-Architecture.png b/docs/public/Nomad-Architecture.png deleted file mode 100644 index 5486999..0000000 Binary files a/docs/public/Nomad-Architecture.png and /dev/null differ diff --git a/docs/public/Upgrade-Setup-1.png b/docs/public/Upgrade-Setup-1.png deleted file mode 100644 index 098a02a..0000000 Binary files a/docs/public/Upgrade-Setup-1.png and /dev/null differ diff --git a/docs/public/Upgrade-Setup-2.png b/docs/public/Upgrade-Setup-2.png deleted file mode 100644 index d3b550e..0000000 Binary files a/docs/public/Upgrade-Setup-2.png and /dev/null differ diff --git a/docs/public/brand-kit.css b/docs/public/brand-kit.css deleted file mode 100644 index d55c06c..0000000 --- a/docs/public/brand-kit.css +++ /dev/null @@ -1,27 +0,0 @@ -.logo { - width: 100%; - margin: 20px 0; -} - -.logo--black { - background-color: white; - border: 1px solid black; -} - -.logo--white { - background-color: black; -} - -.download { - color: black; - text-decoration: none; - cursor: pointer; - display: flex; - align-items: center; - margin-top: 30px; -} - -.download__text { - margin-top: 0; - margin-right: 5px; -} \ No newline at end of file diff --git a/docs/public/download.svg b/docs/public/download.svg deleted file mode 100644 index 5965951..0000000 --- a/docs/public/download.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - - \ No newline at end of file diff --git a/docs/public/favicon.png b/docs/public/favicon.png deleted file mode 100644 index d7a5200..0000000 Binary files a/docs/public/favicon.png and /dev/null differ diff --git a/docs/public/governance-diagram.png b/docs/public/governance-diagram.png deleted file mode 100644 index d8b5c79..0000000 Binary files a/docs/public/governance-diagram.png and /dev/null differ diff --git a/docs/public/multi-provider/.nojekyll b/docs/public/multi-provider/.nojekyll deleted file mode 100644 index e2ac661..0000000 --- a/docs/public/multi-provider/.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/public/multi-provider/assets/highlight.css b/docs/public/multi-provider/assets/highlight.css deleted file mode 100644 index b31fca2..0000000 --- a/docs/public/multi-provider/assets/highlight.css +++ /dev/null @@ -1,85 +0,0 @@ -:root { - --light-hl-0: #AF00DB; - --dark-hl-0: #C586C0; - --light-hl-1: #000000; - --dark-hl-1: #D4D4D4; - --light-hl-2: #001080; - --dark-hl-2: #9CDCFE; - --light-hl-3: #A31515; - --dark-hl-3: #CE9178; - --light-hl-4: #0000FF; - --dark-hl-4: #569CD6; - --light-hl-5: #0070C1; - --dark-hl-5: #4FC1FF; - --light-hl-6: #795E26; - --dark-hl-6: #DCDCAA; - --light-hl-7: #267F99; - --dark-hl-7: #4EC9B0; - --light-hl-8: #098658; - --dark-hl-8: #B5CEA8; - --light-code-background: #F5F5F5; - --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); -} } - -body.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); -} - -body.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/public/multi-provider/assets/icons.css b/docs/public/multi-provider/assets/icons.css deleted file mode 100644 index 776a356..0000000 --- a/docs/public/multi-provider/assets/icons.css +++ /dev/null @@ -1,1043 +0,0 @@ -.tsd-kind-icon { - display: block; - position: relative; - padding-left: 20px; - text-indent: -20px; -} -.tsd-kind-icon:before { - content: ""; - display: inline-block; - vertical-align: middle; - width: 17px; - height: 17px; - margin: 0 3px 2px 0; - background-image: url(./icons.png); -} -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-kind-icon:before { - background-image: url(./icons@2x.png); - background-size: 238px 204px; - } -} - -.tsd-signature.tsd-kind-icon:before { - background-position: 0 -153px; -} - -.tsd-kind-object-literal > .tsd-kind-icon:before { - background-position: 0px -17px; -} -.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -17px; -} -.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -17px; -} - -.tsd-kind-class > .tsd-kind-icon:before { - background-position: 0px -34px; -} -.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -34px; -} -.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -34px; -} - -.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -51px; -} -.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -17px -51px; -} -.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -51px; -} - -.tsd-kind-interface > .tsd-kind-icon:before { - background-position: 0px -68px; -} -.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -68px; -} -.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -68px; -} - -.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -85px; -} -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -17px -85px; -} -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private - > .tsd-kind-icon:before { - background-position: -34px -85px; -} - -.tsd-kind-namespace > .tsd-kind-icon:before { - background-position: 0px -102px; -} -.tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; -} -.tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; -} - -.tsd-kind-module > .tsd-kind-icon:before { - background-position: 0px -102px; -} -.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; -} -.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; -} - -.tsd-kind-enum > .tsd-kind-icon:before { - background-position: 0px -119px; -} -.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -119px; -} -.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -119px; -} - -.tsd-kind-enum-member > .tsd-kind-icon:before { - background-position: 0px -136px; -} -.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -136px; -} -.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -136px; -} - -.tsd-kind-signature > .tsd-kind-icon:before { - background-position: 0px -153px; -} -.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -153px; -} -.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -153px; -} - -.tsd-kind-type-alias > .tsd-kind-icon:before { - background-position: 0px -170px; -} -.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -170px; -} -.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -170px; -} - -.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -187px; -} -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -17px -187px; -} -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private - > .tsd-kind-icon:before { - background-position: -34px -187px; -} - -.tsd-kind-variable > .tsd-kind-icon:before { - background-position: -136px -0px; -} -.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; -} -.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; -} -.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -0px; -} - -.tsd-kind-property > .tsd-kind-icon:before { - background-position: -136px -0px; -} -.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; -} -.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; -} -.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -0px; -} - -.tsd-kind-get-signature > .tsd-kind-icon:before { - background-position: -136px -17px; -} -.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -17px; -} -.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -17px; -} - -.tsd-kind-set-signature > .tsd-kind-icon:before { - background-position: -136px -34px; -} -.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -34px; -} -.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -34px; -} - -.tsd-kind-accessor > .tsd-kind-icon:before { - background-position: -136px -51px; -} -.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -51px; -} -.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -51px; -} - -.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -153px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class - > .tsd-kind-icon:before { - background-position: -51px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum - > .tsd-kind-icon:before { - background-position: -170px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -85px; -} - -.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -153px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class - > .tsd-kind-icon:before { - background-position: -51px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum - > .tsd-kind-icon:before { - background-position: -170px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -85px; -} - -.tsd-kind-constructor > .tsd-kind-icon:before { - background-position: -136px -102px; -} -.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; -} -.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -102px; -} - -.tsd-kind-constructor-signature > .tsd-kind-icon:before { - background-position: -136px -102px; -} -.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; -} -.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -102px; -} - -.tsd-kind-index-signature > .tsd-kind-icon:before { - background-position: -136px -119px; -} -.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -119px; -} -.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -119px; -} - -.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -136px; -} -.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -136px; -} -.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -136px; -} -.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -136px; -} - -.tsd-is-static > .tsd-kind-icon:before { - background-position: -136px -153px; -} -.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -153px; -} -.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -153px; -} -.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -153px; -} -.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -153px; -} -.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -153px; -} - -.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class - > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum - > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -187px; -} diff --git a/docs/public/multi-provider/assets/icons.png b/docs/public/multi-provider/assets/icons.png deleted file mode 100644 index 3836d5f..0000000 Binary files a/docs/public/multi-provider/assets/icons.png and /dev/null differ diff --git a/docs/public/multi-provider/assets/icons@2x.png b/docs/public/multi-provider/assets/icons@2x.png deleted file mode 100644 index 5a209e2..0000000 Binary files a/docs/public/multi-provider/assets/icons@2x.png and /dev/null differ diff --git a/docs/public/multi-provider/assets/main.js b/docs/public/multi-provider/assets/main.js deleted file mode 100644 index 54869f4..0000000 --- a/docs/public/multi-provider/assets/main.js +++ /dev/null @@ -1,52 +0,0 @@ -(()=>{var Ce=Object.create;var J=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,_e=Object.prototype.hasOwnProperty;var Me=t=>J(t,"__esModule",{value:!0});var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!_e.call(t,i)&&(r||i!=="default")&&J(t,i,{get:()=>e[i],enumerable:!(n=Pe(e,i))||n.enumerable});return t},Ae=(t,e)=>De(Me(J(t!=null?Ce(Re(t)):{},"default",!e&&t&&t.__esModule?{get:()=>t.default,enumerable:!0}:{value:t,enumerable:!0})),t);var de=Fe((ce,he)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var h=t.utils.clone(r)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(n.slice(a,o),h))}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,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ou?h+=2:a==u&&(r+=n[l+1]*i[h+1],l+=2,h+=2);return r},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),r=1,n=0;r0){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 u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,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 l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),p=s.str.charAt(1),v;p in s.node.edges?v=s.node.edges[p]:(v=new t.TokenSet,s.node.edges[p]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.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(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},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,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<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 r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,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 r=e.peekLexeme();if(r!=null)switch(r.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 n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.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 r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.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 '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;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 r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;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,r){typeof define=="function"&&define.amd?define(r):typeof ce=="object"?he.exports=r():e.lunr=r()}(this,function(){return t})})()});var le=[];function N(t,e){le.push({selector:e,constructor:t})}var X=class{constructor(){this.createComponents(document.body)}createComponents(e){le.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n}),n.dataset.hasInstance=String(!0))})})}};var Q=class{constructor(e){this.el=e.el}};var Z=class{constructor(){this.listeners={}}addEventListener(e,r){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(r)}removeEventListener(e,r){if(!(e in this.listeners))return;let n=this.listeners[e];for(let i=0,s=n.length;i{let r=Date.now();return(...n)=>{r+e-Date.now()<0&&(t(...n),r=Date.now())}};var ee=class extends Z{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.secondaryNav=document.querySelector(".tsd-navigation.secondary"),window.addEventListener("scroll",K(()=>this.onScroll(),10)),window.addEventListener("resize",K(()=>this.onResize(),10)),this.onResize(),this.onScroll()}triggerResize(){let e=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(e)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let e=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(e)}onScroll(){this.scrollTop=window.scrollY||0;let e=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(e),this.hideShowToolbar()}hideShowToolbar(){var r;let e=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0,e!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),(r=this.secondaryNav)==null||r.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop}},I=ee;I.instance=new ee;var te=class extends Q{constructor(e){super(e);this.anchors=[];this.index=-1;I.instance.addEventListener("resize",()=>this.onResize()),I.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let e=window.location.href;e.indexOf("#")!=-1&&(e=e.substr(0,e.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let n=r.href;if(n.indexOf("#")==-1||n.substr(0,e.length)!=e)return;let i=n.substr(n.indexOf("#")+1),s=document.querySelector("a.tsd-anchor[name="+i+"]"),o=r.parentNode;!s||!o||this.anchors.push({link:o,anchor:s,position:0})}),this.onResize()}onResize(){let e;for(let n=0,i=this.anchors.length;nn.position-i.position);let r=new CustomEvent("scroll",{detail:{scrollTop:I.instance.scrollTop}});this.onScroll(r)}onScroll(e){let r=e.detail.scrollTop+5,n=this.anchors,i=n.length-1,s=this.index;for(;s>-1&&n[s].position>r;)s-=1;for(;s-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=s,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let r;return(...n)=>{clearTimeout(r),r=setTimeout(()=>t(n),e)}};var me=Ae(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Ve(t,n,r,s)}function Ve(t,e,r,n){r.addEventListener("input",ue(()=>{ze(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ne(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?fe(e,-1):s.key==="ArrowDown"?fe(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function He(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function ze(t,e,r,n){if(He(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=n.index.search(`*${i}*`);for(let o=0,a=Math.min(10,s.length);o${pe(u.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=u.classes;let p=document.createElement("a");p.href=n.base+u.url,p.classList.add("tsd-kind-icon"),p.innerHTML=l,h.append(p),e.appendChild(h)}}function fe(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Ne(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function pe(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(re(t.substring(s,o)),`${re(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(re(t.substring(s))),i.join("")}var je={"&":"&","<":"<",">":">","'":"'",'"':"""};function re(t){return t.replace(/[&<>"'"]/g,e=>je[e])}var ge=class{constructor(e,r){this.signature=e,this.description=r}addClass(e){return this.signature.classList.add(e),this.description.classList.add(e),this}removeClass(e){return this.signature.classList.remove(e),this.description.classList.remove(e),this}},ne=class extends Q{constructor(e){super(e);this.groups=[];this.index=-1;this.createGroups(),this.container&&(this.el.classList.add("active"),Array.from(this.el.children).forEach(r=>{r.addEventListener("touchstart",n=>this.onClick(n)),r.addEventListener("click",n=>this.onClick(n))}),this.container.classList.add("active"),this.setIndex(0))}setIndex(e){if(e<0&&(e=0),e>this.groups.length-1&&(e=this.groups.length-1),this.index==e)return;let r=this.groups[e];if(this.index>-1){let n=this.groups[this.index];n.removeClass("current").addClass("fade-out"),r.addClass("current"),r.addClass("fade-in"),I.instance.triggerResize(),setTimeout(()=>{n.removeClass("fade-out"),r.removeClass("fade-in")},300)}else r.addClass("current"),I.instance.triggerResize();this.index=e}createGroups(){let e=this.el.children;if(e.length<2)return;this.container=this.el.nextElementSibling;let r=this.container.children;this.groups=[];for(let n=0;n{r.signature===e.currentTarget&&this.setIndex(n)})}};var C="mousedown",xe="mousemove",_="mouseup",G={x:0,y:0},ye=!1,ie=!1,Be=!1,A=!1,Le=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Le?"is-mobile":"not-mobile");Le&&"ontouchstart"in document.documentElement&&(Be=!0,C="touchstart",xe="touchmove",_="touchend");document.addEventListener(C,t=>{ie=!0,A=!1;let e=C=="touchstart"?t.targetTouches[0]:t;G.y=e.pageY||0,G.x=e.pageX||0});document.addEventListener(xe,t=>{if(!!ie&&!A){let e=C=="touchstart"?t.targetTouches[0]:t,r=G.x-(e.pageX||0),n=G.y-(e.pageY||0);A=Math.sqrt(r*r+n*n)>10}});document.addEventListener(_,()=>{ie=!1});document.addEventListener("click",t=>{ye&&(t.preventDefault(),t.stopImmediatePropagation(),ye=!1)});var se=class extends Q{constructor(e){super(e);this.className=this.el.dataset.toggle||"",this.el.addEventListener(_,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(C,r=>this.onDocumentPointerDown(r)),document.addEventListener(_,r=>this.onDocumentPointerUp(r))}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 r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(e){A||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!A&&this.active&&e.target.closest(".col-menu")){let r=e.target.closest("a");if(r){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substr(0,n.indexOf("#"))),r.href.substr(0,n.length)==n&&setTimeout(()=>this.setActive(!1),250)}}}};var ae=class{constructor(e,r){this.key=e,this.value=r,this.defaultValue=r,this.initialize(),window.localStorage[this.key]&&this.setValue(this.fromLocalStorage(window.localStorage[this.key]))}initialize(){}setValue(e){if(this.value==e)return;let r=this.value;this.value=e,window.localStorage[this.key]=this.toLocalStorage(e),this.handleValueChange(r,e)}},oe=class extends ae{initialize(){let e=document.querySelector("#tsd-filter-"+this.key);!e||(this.checkbox=e,this.checkbox.addEventListener("change",()=>{this.setValue(this.checkbox.checked)}))}handleValueChange(e,r){!this.checkbox||(this.checkbox.checked=this.value,document.documentElement.classList.toggle("toggle-"+this.key,this.value!=this.defaultValue))}fromLocalStorage(e){return e=="true"}toLocalStorage(e){return e?"true":"false"}},Ee=class extends ae{initialize(){document.documentElement.classList.add("toggle-"+this.key+this.value);let e=document.querySelector("#tsd-filter-"+this.key);if(!e)return;this.select=e;let r=()=>{this.select.classList.add("active")},n=()=>{this.select.classList.remove("active")};this.select.addEventListener(C,r),this.select.addEventListener("mouseover",r),this.select.addEventListener("mouseleave",n),this.select.querySelectorAll("li").forEach(i=>{i.addEventListener(_,s=>{e.classList.remove("active"),this.setValue(s.target.dataset.value||"")})}),document.addEventListener(C,i=>{this.select.contains(i.target)||this.select.classList.remove("active")})}handleValueChange(e,r){this.select.querySelectorAll("li.selected").forEach(s=>{s.classList.remove("selected")});let n=this.select.querySelector('li[data-value="'+r+'"]'),i=this.select.querySelector(".tsd-select-label");n&&i&&(n.classList.add("selected"),i.textContent=n.textContent),document.documentElement.classList.remove("toggle-"+e),document.documentElement.classList.add("toggle-"+r)}fromLocalStorage(e){return e}toLocalStorage(e){return e}},Y=class extends Q{constructor(e){super(e);this.optionVisibility=new Ee("visibility","private"),this.optionInherited=new oe("inherited",!0),this.optionExternals=new oe("externals",!0)}static isSupported(){try{return typeof window.localStorage!="undefined"}catch{return!1}}};function we(t){let e=localStorage.getItem("tsd-theme")||"os";t.value=e,be(e),t.addEventListener("change",()=>{localStorage.setItem("tsd-theme",t.value),be(t.value)})}function be(t){switch(t){case"os":document.body.classList.remove("light","dark");break;case"light":document.body.classList.remove("dark"),document.body.classList.add("light");break;case"dark":document.body.classList.remove("light"),document.body.classList.add("dark");break}}ve();N(te,".menu-highlight");N(ne,".tsd-signatures");N(se,"a[data-toggle]");Y.isSupported()?N(Y,"#tsd-filter"):document.documentElement.classList.add("no-filter");var Te=document.getElementById("theme");Te&&we(Te);var qe=new X;Object.defineProperty(window,"app",{value:qe});})(); -/*! - * lunr.Builder - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Index - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Pipeline - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Set - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.TokenSet - * 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.tokenizer - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.trimmer - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.utils - * Copyright (C) 2020 Oliver Nightingale - */ -/** - * 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 - */ diff --git a/docs/public/multi-provider/assets/search.js b/docs/public/multi-provider/assets/search.js deleted file mode 100644 index a9e5f4a..0000000 --- a/docs/public/multi-provider/assets/search.js +++ /dev/null @@ -1 +0,0 @@ -window.searchData = JSON.parse("{\"kinds\":{\"4\":\"Namespace\",\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\",\"262144\":\"Accessor\",\"4194304\":\"Type alias\"},\"rows\":[{\"id\":0,\"kind\":128,\"name\":\"MultiProvider\",\"url\":\"classes/MultiProvider.html\",\"classes\":\"tsd-kind-class tsd-has-type-parameter\"},{\"id\":1,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/MultiProvider.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"MultiProvider\"},{\"id\":2,\"kind\":1024,\"name\":\"domains\",\"url\":\"classes/MultiProvider.html#domains\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"MultiProvider\"},{\"id\":3,\"kind\":1024,\"name\":\"providers\",\"url\":\"classes/MultiProvider.html#providers\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"MultiProvider\"},{\"id\":4,\"kind\":1024,\"name\":\"signers\",\"url\":\"classes/MultiProvider.html#signers\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"MultiProvider\"},{\"id\":5,\"kind\":2048,\"name\":\"registerDomain\",\"url\":\"classes/MultiProvider.html#registerDomain\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":6,\"kind\":262144,\"name\":\"registeredDomains\",\"url\":\"classes/MultiProvider.html#registeredDomains\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":7,\"kind\":262144,\"name\":\"domainNumbers\",\"url\":\"classes/MultiProvider.html#domainNumbers\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":8,\"kind\":262144,\"name\":\"domainNames\",\"url\":\"classes/MultiProvider.html#domainNames\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":9,\"kind\":262144,\"name\":\"missingProviders\",\"url\":\"classes/MultiProvider.html#missingProviders\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":10,\"kind\":2048,\"name\":\"resolveDomain\",\"url\":\"classes/MultiProvider.html#resolveDomain\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":11,\"kind\":2048,\"name\":\"resolveDomainName\",\"url\":\"classes/MultiProvider.html#resolveDomainName\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":12,\"kind\":2048,\"name\":\"knownDomain\",\"url\":\"classes/MultiProvider.html#knownDomain\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":13,\"kind\":2048,\"name\":\"getDomain\",\"url\":\"classes/MultiProvider.html#getDomain\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":14,\"kind\":2048,\"name\":\"mustGetDomain\",\"url\":\"classes/MultiProvider.html#mustGetDomain\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":15,\"kind\":2048,\"name\":\"registerProvider\",\"url\":\"classes/MultiProvider.html#registerProvider\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":16,\"kind\":2048,\"name\":\"registerRpcProvider\",\"url\":\"classes/MultiProvider.html#registerRpcProvider\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":17,\"kind\":2048,\"name\":\"getProvider\",\"url\":\"classes/MultiProvider.html#getProvider\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":18,\"kind\":2048,\"name\":\"mustGetProvider\",\"url\":\"classes/MultiProvider.html#mustGetProvider\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":19,\"kind\":2048,\"name\":\"registerSigner\",\"url\":\"classes/MultiProvider.html#registerSigner\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":20,\"kind\":2048,\"name\":\"unregisterSigner\",\"url\":\"classes/MultiProvider.html#unregisterSigner\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":21,\"kind\":2048,\"name\":\"clearSigners\",\"url\":\"classes/MultiProvider.html#clearSigners\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":22,\"kind\":2048,\"name\":\"registerWalletSigner\",\"url\":\"classes/MultiProvider.html#registerWalletSigner\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":23,\"kind\":2048,\"name\":\"getSigner\",\"url\":\"classes/MultiProvider.html#getSigner\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":24,\"kind\":2048,\"name\":\"mustGetSigner\",\"url\":\"classes/MultiProvider.html#mustGetSigner\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":25,\"kind\":2048,\"name\":\"getConnection\",\"url\":\"classes/MultiProvider.html#getConnection\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":26,\"kind\":2048,\"name\":\"mustGetConnection\",\"url\":\"classes/MultiProvider.html#mustGetConnection\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":27,\"kind\":2048,\"name\":\"getAddress\",\"url\":\"classes/MultiProvider.html#getAddress\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"MultiProvider\"},{\"id\":28,\"kind\":128,\"name\":\"Contracts\",\"url\":\"classes/Contracts.html\",\"classes\":\"tsd-kind-class\"},{\"id\":29,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/Contracts.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"Contracts\"},{\"id\":30,\"kind\":1024,\"name\":\"args\",\"url\":\"classes/Contracts.html#args\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Contracts\"},{\"id\":31,\"kind\":2048,\"name\":\"connect\",\"url\":\"classes/Contracts.html#connect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Contracts\"},{\"id\":32,\"kind\":4,\"name\":\"utils\",\"url\":\"modules/utils.html\",\"classes\":\"tsd-kind-namespace\"},{\"id\":33,\"kind\":64,\"name\":\"chainIdToDomain\",\"url\":\"modules/utils.html#chainIdToDomain\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"utils\"},{\"id\":34,\"kind\":64,\"name\":\"getHexDomainFromString\",\"url\":\"modules/utils.html#getHexDomainFromString\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"utils\"},{\"id\":35,\"kind\":64,\"name\":\"getDomainFromString\",\"url\":\"modules/utils.html#getDomainFromString\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"utils\"},{\"id\":36,\"kind\":64,\"name\":\"canonizeId\",\"url\":\"modules/utils.html#canonizeId\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"utils\"},{\"id\":37,\"kind\":64,\"name\":\"evmId\",\"url\":\"modules/utils.html#evmId\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"utils\"},{\"id\":38,\"kind\":64,\"name\":\"equalIds\",\"url\":\"modules/utils.html#equalIds\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"utils\"},{\"id\":39,\"kind\":64,\"name\":\"delay\",\"url\":\"modules/utils.html#delay\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"utils\"},{\"id\":40,\"kind\":64,\"name\":\"parseInt\",\"url\":\"modules/utils.html#parseInt\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"utils\"},{\"id\":41,\"kind\":4194304,\"name\":\"Address\",\"url\":\"modules/utils.html#Address\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-namespace\",\"parent\":\"utils\"},{\"id\":42,\"kind\":256,\"name\":\"Domain\",\"url\":\"interfaces/Domain.html\",\"classes\":\"tsd-kind-interface\"},{\"id\":43,\"kind\":1024,\"name\":\"name\",\"url\":\"interfaces/Domain.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Domain\"},{\"id\":44,\"kind\":1024,\"name\":\"domain\",\"url\":\"interfaces/Domain.html#domain\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Domain\"},{\"id\":45,\"kind\":1024,\"name\":\"paginate\",\"url\":\"interfaces/Domain.html#paginate\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Domain\"},{\"id\":46,\"kind\":256,\"name\":\"Pagination\",\"url\":\"interfaces/Pagination.html\",\"classes\":\"tsd-kind-interface\"},{\"id\":47,\"kind\":1024,\"name\":\"blocks\",\"url\":\"interfaces/Pagination.html#blocks\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Pagination\"},{\"id\":48,\"kind\":1024,\"name\":\"from\",\"url\":\"interfaces/Pagination.html#from\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Pagination\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"parent\"],\"fieldVectors\":[[\"name/0\",[0,5.621]],[\"parent/0\",[]],[\"name/1\",[1,29.957]],[\"parent/1\",[0,0.537]],[\"name/2\",[2,35.066]],[\"parent/2\",[0,0.537]],[\"name/3\",[3,35.066]],[\"parent/3\",[0,0.537]],[\"name/4\",[4,35.066]],[\"parent/4\",[0,0.537]],[\"name/5\",[5,35.066]],[\"parent/5\",[0,0.537]],[\"name/6\",[6,35.066]],[\"parent/6\",[0,0.537]],[\"name/7\",[7,35.066]],[\"parent/7\",[0,0.537]],[\"name/8\",[8,35.066]],[\"parent/8\",[0,0.537]],[\"name/9\",[9,35.066]],[\"parent/9\",[0,0.537]],[\"name/10\",[10,35.066]],[\"parent/10\",[0,0.537]],[\"name/11\",[11,35.066]],[\"parent/11\",[0,0.537]],[\"name/12\",[12,35.066]],[\"parent/12\",[0,0.537]],[\"name/13\",[13,35.066]],[\"parent/13\",[0,0.537]],[\"name/14\",[14,35.066]],[\"parent/14\",[0,0.537]],[\"name/15\",[15,35.066]],[\"parent/15\",[0,0.537]],[\"name/16\",[16,35.066]],[\"parent/16\",[0,0.537]],[\"name/17\",[17,35.066]],[\"parent/17\",[0,0.537]],[\"name/18\",[18,35.066]],[\"parent/18\",[0,0.537]],[\"name/19\",[19,35.066]],[\"parent/19\",[0,0.537]],[\"name/20\",[20,35.066]],[\"parent/20\",[0,0.537]],[\"name/21\",[21,35.066]],[\"parent/21\",[0,0.537]],[\"name/22\",[22,35.066]],[\"parent/22\",[0,0.537]],[\"name/23\",[23,35.066]],[\"parent/23\",[0,0.537]],[\"name/24\",[24,35.066]],[\"parent/24\",[0,0.537]],[\"name/25\",[25,35.066]],[\"parent/25\",[0,0.537]],[\"name/26\",[26,35.066]],[\"parent/26\",[0,0.537]],[\"name/27\",[27,35.066]],[\"parent/27\",[0,0.537]],[\"name/28\",[28,24.079]],[\"parent/28\",[]],[\"name/29\",[1,29.957]],[\"parent/29\",[28,2.301]],[\"name/30\",[29,35.066]],[\"parent/30\",[28,2.301]],[\"name/31\",[30,35.066]],[\"parent/31\",[28,2.301]],[\"name/32\",[31,15.606]],[\"parent/32\",[]],[\"name/33\",[32,35.066]],[\"parent/33\",[31,1.491]],[\"name/34\",[33,35.066]],[\"parent/34\",[31,1.491]],[\"name/35\",[34,35.066]],[\"parent/35\",[31,1.491]],[\"name/36\",[35,35.066]],[\"parent/36\",[31,1.491]],[\"name/37\",[36,35.066]],[\"parent/37\",[31,1.491]],[\"name/38\",[37,35.066]],[\"parent/38\",[31,1.491]],[\"name/39\",[38,35.066]],[\"parent/39\",[31,1.491]],[\"name/40\",[39,35.066]],[\"parent/40\",[31,1.491]],[\"name/41\",[40,35.066]],[\"parent/41\",[31,1.491]],[\"name/42\",[41,22.073]],[\"parent/42\",[]],[\"name/43\",[42,35.066]],[\"parent/43\",[41,2.109]],[\"name/44\",[41,22.073]],[\"parent/44\",[41,2.109]],[\"name/45\",[43,35.066]],[\"parent/45\",[41,2.109]],[\"name/46\",[44,26.593]],[\"parent/46\",[]],[\"name/47\",[45,35.066]],[\"parent/47\",[44,2.541]],[\"name/48\",[46,35.066]],[\"parent/48\",[44,2.541]]],\"invertedIndex\":[[\"address\",{\"_index\":40,\"name\":{\"41\":{}},\"parent\":{}}],[\"args\",{\"_index\":29,\"name\":{\"30\":{}},\"parent\":{}}],[\"blocks\",{\"_index\":45,\"name\":{\"47\":{}},\"parent\":{}}],[\"canonizeid\",{\"_index\":35,\"name\":{\"36\":{}},\"parent\":{}}],[\"chainidtodomain\",{\"_index\":32,\"name\":{\"33\":{}},\"parent\":{}}],[\"clearsigners\",{\"_index\":21,\"name\":{\"21\":{}},\"parent\":{}}],[\"connect\",{\"_index\":30,\"name\":{\"31\":{}},\"parent\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{},\"29\":{}},\"parent\":{}}],[\"contracts\",{\"_index\":28,\"name\":{\"28\":{}},\"parent\":{\"29\":{},\"30\":{},\"31\":{}}}],[\"delay\",{\"_index\":38,\"name\":{\"39\":{}},\"parent\":{}}],[\"domain\",{\"_index\":41,\"name\":{\"42\":{},\"44\":{}},\"parent\":{\"43\":{},\"44\":{},\"45\":{}}}],[\"domainnames\",{\"_index\":8,\"name\":{\"8\":{}},\"parent\":{}}],[\"domainnumbers\",{\"_index\":7,\"name\":{\"7\":{}},\"parent\":{}}],[\"domains\",{\"_index\":2,\"name\":{\"2\":{}},\"parent\":{}}],[\"equalids\",{\"_index\":37,\"name\":{\"38\":{}},\"parent\":{}}],[\"evmid\",{\"_index\":36,\"name\":{\"37\":{}},\"parent\":{}}],[\"from\",{\"_index\":46,\"name\":{\"48\":{}},\"parent\":{}}],[\"getaddress\",{\"_index\":27,\"name\":{\"27\":{}},\"parent\":{}}],[\"getconnection\",{\"_index\":25,\"name\":{\"25\":{}},\"parent\":{}}],[\"getdomain\",{\"_index\":13,\"name\":{\"13\":{}},\"parent\":{}}],[\"getdomainfromstring\",{\"_index\":34,\"name\":{\"35\":{}},\"parent\":{}}],[\"gethexdomainfromstring\",{\"_index\":33,\"name\":{\"34\":{}},\"parent\":{}}],[\"getprovider\",{\"_index\":17,\"name\":{\"17\":{}},\"parent\":{}}],[\"getsigner\",{\"_index\":23,\"name\":{\"23\":{}},\"parent\":{}}],[\"knowndomain\",{\"_index\":12,\"name\":{\"12\":{}},\"parent\":{}}],[\"missingproviders\",{\"_index\":9,\"name\":{\"9\":{}},\"parent\":{}}],[\"multiprovider\",{\"_index\":0,\"name\":{\"0\":{}},\"parent\":{\"1\":{},\"2\":{},\"3\":{},\"4\":{},\"5\":{},\"6\":{},\"7\":{},\"8\":{},\"9\":{},\"10\":{},\"11\":{},\"12\":{},\"13\":{},\"14\":{},\"15\":{},\"16\":{},\"17\":{},\"18\":{},\"19\":{},\"20\":{},\"21\":{},\"22\":{},\"23\":{},\"24\":{},\"25\":{},\"26\":{},\"27\":{}}}],[\"mustgetconnection\",{\"_index\":26,\"name\":{\"26\":{}},\"parent\":{}}],[\"mustgetdomain\",{\"_index\":14,\"name\":{\"14\":{}},\"parent\":{}}],[\"mustgetprovider\",{\"_index\":18,\"name\":{\"18\":{}},\"parent\":{}}],[\"mustgetsigner\",{\"_index\":24,\"name\":{\"24\":{}},\"parent\":{}}],[\"name\",{\"_index\":42,\"name\":{\"43\":{}},\"parent\":{}}],[\"paginate\",{\"_index\":43,\"name\":{\"45\":{}},\"parent\":{}}],[\"pagination\",{\"_index\":44,\"name\":{\"46\":{}},\"parent\":{\"47\":{},\"48\":{}}}],[\"parseint\",{\"_index\":39,\"name\":{\"40\":{}},\"parent\":{}}],[\"providers\",{\"_index\":3,\"name\":{\"3\":{}},\"parent\":{}}],[\"registerdomain\",{\"_index\":5,\"name\":{\"5\":{}},\"parent\":{}}],[\"registereddomains\",{\"_index\":6,\"name\":{\"6\":{}},\"parent\":{}}],[\"registerprovider\",{\"_index\":15,\"name\":{\"15\":{}},\"parent\":{}}],[\"registerrpcprovider\",{\"_index\":16,\"name\":{\"16\":{}},\"parent\":{}}],[\"registersigner\",{\"_index\":19,\"name\":{\"19\":{}},\"parent\":{}}],[\"registerwalletsigner\",{\"_index\":22,\"name\":{\"22\":{}},\"parent\":{}}],[\"resolvedomain\",{\"_index\":10,\"name\":{\"10\":{}},\"parent\":{}}],[\"resolvedomainname\",{\"_index\":11,\"name\":{\"11\":{}},\"parent\":{}}],[\"signers\",{\"_index\":4,\"name\":{\"4\":{}},\"parent\":{}}],[\"unregistersigner\",{\"_index\":20,\"name\":{\"20\":{}},\"parent\":{}}],[\"utils\",{\"_index\":31,\"name\":{\"32\":{}},\"parent\":{\"33\":{},\"34\":{},\"35\":{},\"36\":{},\"37\":{},\"38\":{},\"39\":{},\"40\":{},\"41\":{}}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/public/multi-provider/assets/style.css b/docs/public/multi-provider/assets/style.css deleted file mode 100644 index a16ed02..0000000 --- a/docs/public/multi-provider/assets/style.css +++ /dev/null @@ -1,1413 +0,0 @@ -@import url("./icons.css"); - -:root { - /* Light */ - --light-color-background: #fcfcfc; - --light-color-secondary-background: #fff; - --light-color-text: #222; - --light-color-text-aside: #707070; - --light-color-link: #4da6ff; - --light-color-menu-divider: #eee; - --light-color-menu-divider-focus: #000; - --light-color-menu-label: #707070; - --light-color-panel: var(--light-color-secondary-background); - --light-color-panel-divider: #eee; - --light-color-comment-tag: #707070; - --light-color-comment-tag-text: #fff; - --light-color-ts: #9600ff; - --light-color-ts-interface: #647f1b; - --light-color-ts-enum: #937210; - --light-color-ts-class: #0672de; - --light-color-ts-private: #707070; - --light-color-toolbar: #fff; - --light-color-toolbar-text: #333; - --light-icon-filter: invert(0); - --light-external-icon: url("data:image/svg+xml;utf8,"); - - /* Dark */ - --dark-color-background: #36393f; - --dark-color-secondary-background: #2f3136; - --dark-color-text: #ffffff; - --dark-color-text-aside: #e6e4e4; - --dark-color-link: #00aff4; - --dark-color-menu-divider: #eee; - --dark-color-menu-divider-focus: #000; - --dark-color-menu-label: #707070; - --dark-color-panel: var(--dark-color-secondary-background); - --dark-color-panel-divider: #818181; - --dark-color-comment-tag: #dcddde; - --dark-color-comment-tag-text: #2f3136; - --dark-color-ts: #c97dff; - --dark-color-ts-interface: #9cbe3c; - --dark-color-ts-enum: #d6ab29; - --dark-color-ts-class: #3695f3; - --dark-color-ts-private: #e2e2e2; - --dark-color-toolbar: #34373c; - --dark-color-toolbar-text: #ffffff; - --dark-icon-filter: invert(1); - --dark-external-icon: url("data:image/svg+xml;utf8,"); -} - -@media (prefers-color-scheme: light) { - :root { - --color-background: var(--light-color-background); - --color-secondary-background: var(--light-color-secondary-background); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - --color-menu-divider: var(--light-color-menu-divider); - --color-menu-divider-focus: var(--light-color-menu-divider-focus); - --color-menu-label: var(--light-color-menu-label); - --color-panel: var(--light-color-panel); - --color-panel-divider: var(--light-color-panel-divider); - --color-comment-tag: var(--light-color-comment-tag); - --color-comment-tag-text: var(--light-color-comment-tag-text); - --color-ts: var(--light-color-ts); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-class: var(--light-color-ts-class); - --color-ts-private: var(--light-color-ts-private); - --color-toolbar: var(--light-color-toolbar); - --color-toolbar-text: var(--light-color-toolbar-text); - --icon-filter: var(--light-icon-filter); - --external-icon: var(--light-external-icon); - } -} - -@media (prefers-color-scheme: dark) { - :root { - --color-background: var(--dark-color-background); - --color-secondary-background: var(--dark-color-secondary-background); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - --color-menu-divider: var(--dark-color-menu-divider); - --color-menu-divider-focus: var(--dark-color-menu-divider-focus); - --color-menu-label: var(--dark-color-menu-label); - --color-panel: var(--dark-color-panel); - --color-panel-divider: var(--dark-color-panel-divider); - --color-comment-tag: var(--dark-color-comment-tag); - --color-comment-tag-text: var(--dark-color-comment-tag-text); - --color-ts: var(--dark-color-ts); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-private: var(--dark-color-ts-private); - --color-toolbar: var(--dark-color-toolbar); - --color-toolbar-text: var(--dark-color-toolbar-text); - --icon-filter: var(--dark-icon-filter); - --external-icon: var(--dark-external-icon); - } -} - -body { - margin: 0; -} - -body.light { - --color-background: var(--light-color-background); - --color-secondary-background: var(--light-color-secondary-background); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - --color-menu-divider: var(--light-color-menu-divider); - --color-menu-divider-focus: var(--light-color-menu-divider-focus); - --color-menu-label: var(--light-color-menu-label); - --color-panel: var(--light-color-panel); - --color-panel-divider: var(--light-color-panel-divider); - --color-comment-tag: var(--light-color-comment-tag); - --color-comment-tag-text: var(--light-color-comment-tag-text); - --color-ts: var(--light-color-ts); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-class: var(--light-color-ts-class); - --color-ts-private: var(--light-color-ts-private); - --color-toolbar: var(--light-color-toolbar); - --color-toolbar-text: var(--light-color-toolbar-text); - --icon-filter: var(--light-icon-filter); - --external-icon: var(--light-external-icon); -} - -body.dark { - --color-background: var(--dark-color-background); - --color-secondary-background: var(--dark-color-secondary-background); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - --color-menu-divider: var(--dark-color-menu-divider); - --color-menu-divider-focus: var(--dark-color-menu-divider-focus); - --color-menu-label: var(--dark-color-menu-label); - --color-panel: var(--dark-color-panel); - --color-panel-divider: var(--dark-color-panel-divider); - --color-comment-tag: var(--dark-color-comment-tag); - --color-comment-tag-text: var(--dark-color-comment-tag-text); - --color-ts: var(--dark-color-ts); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-private: var(--dark-color-ts-private); - --color-toolbar: var(--dark-color-toolbar); - --color-toolbar-text: var(--dark-color-toolbar-text); - --icon-filter: var(--dark-icon-filter); - --external-icon: var(--dark-external-icon); -} - -h1, -h2, -h3, -h4, -h5, -h6 { - line-height: 1.2; -} - -h1 { - font-size: 2em; - margin: 0.67em 0; -} - -h2 { - font-size: 1.5em; - margin: 0.83em 0; -} - -h3 { - font-size: 1.17em; - margin: 1em 0; -} - -h4, -.tsd-index-panel h3 { - font-size: 1em; - margin: 1.33em 0; -} - -h5 { - font-size: 0.83em; - margin: 1.67em 0; -} - -h6 { - font-size: 0.67em; - margin: 2.33em 0; -} - -pre { - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; -} - -dl, -menu, -ol, -ul { - margin: 1em 0; -} - -dd { - margin: 0 0 0 40px; -} - -.container { - max-width: 1200px; - margin: 0 auto; - padding: 0 40px; -} -@media (max-width: 640px) { - .container { - padding: 0 20px; - } -} - -.container-main { - padding-bottom: 200px; -} - -.row { - display: flex; - position: relative; - margin: 0 -10px; -} -.row:after { - visibility: hidden; - display: block; - content: ""; - clear: both; - height: 0; -} - -.col-4, -.col-8 { - box-sizing: border-box; - float: left; - padding: 0 10px; -} - -.col-4 { - width: 33.3333333333%; -} -.col-8 { - width: 66.6666666667%; -} - -ul.tsd-descriptions > li > :first-child, -.tsd-panel > :first-child, -.col-8 > :first-child, -.col-4 > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child, -.tsd-panel > :first-child > :first-child, -.col-8 > :first-child > :first-child, -.col-4 > :first-child > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child > :first-child, -.tsd-panel > :first-child > :first-child > :first-child, -.col-8 > :first-child > :first-child > :first-child, -.col-4 > :first-child > :first-child > :first-child { - margin-top: 0; -} -ul.tsd-descriptions > li > :last-child, -.tsd-panel > :last-child, -.col-8 > :last-child, -.col-4 > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child, -.tsd-panel > :last-child > :last-child, -.col-8 > :last-child > :last-child, -.col-4 > :last-child > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child > :last-child, -.tsd-panel > :last-child > :last-child > :last-child, -.col-8 > :last-child > :last-child > :last-child, -.col-4 > :last-child > :last-child > :last-child { - margin-bottom: 0; -} - -@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 shift-to-left { - from { - transform: translate(0, 0); - } - to { - transform: translate(-25%, 0); - } -} -@keyframes unshift-to-left { - from { - transform: translate(-25%, 0); - } - to { - transform: translate(0, 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: 14px; -} - -pre { - padding: 10px; -} -pre code { - padding: 0; - font-size: 100%; -} - -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 h4, -.tsd-typography .tsd-index-panel h3, -.tsd-index-panel .tsd-typography h3, -.tsd-typography h5, -.tsd-typography h6 { - font-size: 1em; - margin: 0; -} -.tsd-typography h5, -.tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, -.tsd-typography ul, -.tsd-typography ol { - margin: 1em 0; -} - -@media (min-width: 901px) and (max-width: 1024px) { - html .col-content { - width: 72%; - } - html .col-menu { - width: 28%; - } - html .tsd-navigation { - padding-left: 10px; - } -} -@media (max-width: 900px) { - html .col-content { - float: none; - width: 100%; - } - html .col-menu { - position: fixed !important; - overflow: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - width: 100%; - padding: 20px 20px 0 0; - max-width: 450px; - visibility: hidden; - background-color: var(--color-panel); - transform: translate(100%, 0); - } - html .col-menu > *: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 :is(header, footer, .col-content) { - animation: shift-to-left 0.4s; - } - - .to-has-menu .col-menu { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu :is(header, footer, .col-content) { - animation: unshift-to-left 0.4s; - } - - .from-has-menu .col-menu { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu :is(header, footer, .col-content) { - transform: translate(-25%, 0); - } - .has-menu .col-menu { - visibility: visible; - transform: translate(0, 0); - display: grid; - grid-template-rows: auto 1fr; - max-height: 100vh; - } - .has-menu .tsd-navigation { - max-height: 100%; - } -} - -.tsd-page-title { - padding: 70px 0 20px 0; - margin: 0 0 40px 0; - background: var(--color-panel); - box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); -} -.tsd-page-title h1 { - margin: 0; -} - -.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: " / "; -} - -dl.tsd-comment-tags { - overflow: hidden; -} -dl.tsd-comment-tags dt { - float: left; - padding: 1px 5px; - margin: 0 10px 0 0; - border-radius: 4px; - border: 1px solid var(--color-comment-tag); - color: var(--color-comment-tag); - font-size: 0.8em; - font-weight: normal; -} -dl.tsd-comment-tags dd { - margin: 0 0 10px 0; -} -dl.tsd-comment-tags dd:before, -dl.tsd-comment-tags dd:after { - display: table; - content: " "; -} -dl.tsd-comment-tags dd pre, -dl.tsd-comment-tags dd:after { - clear: both; -} -dl.tsd-comment-tags 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; -} - -.toggle-protected .tsd-is-private { - display: none; -} - -.toggle-public .tsd-is-private, -.toggle-public .tsd-is-protected, -.toggle-public .tsd-is-private-protected { - display: none; -} - -.toggle-inherited .tsd-is-inherited { - display: none; -} - -.toggle-externals .tsd-is-external { - display: none; -} - -#tsd-filter { - position: relative; - display: inline-block; - height: 40px; - vertical-align: bottom; -} -.no-filter #tsd-filter { - display: none; -} -#tsd-filter .tsd-filter-group { - display: inline-block; - height: 40px; - vertical-align: bottom; - white-space: nowrap; -} -#tsd-filter input { - display: none; -} -@media (max-width: 900px) { - #tsd-filter .tsd-filter-group { - display: block; - position: absolute; - top: 40px; - right: 20px; - height: auto; - background-color: var(--color-panel); - visibility: hidden; - transform: translate(50%, 0); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - } - .has-options #tsd-filter .tsd-filter-group { - visibility: visible; - } - .to-has-options #tsd-filter .tsd-filter-group { - animation: fade-in 0.2s; - } - .from-has-options #tsd-filter .tsd-filter-group { - animation: fade-out 0.2s; - } - #tsd-filter label, - #tsd-filter .tsd-select { - display: block; - padding-right: 20px; - } -} - -footer { - border-top: 1px solid var(--color-panel-divider); - background-color: var(--color-panel); -} -footer:after { - content: ""; - display: table; -} -footer.with-border-bottom { - border-bottom: 1px solid var(--color-panel-divider); -} -footer .tsd-legend-group { - font-size: 0; -} -footer .tsd-legend { - display: inline-block; - width: 25%; - padding: 0; - font-size: 16px; - list-style: none; - line-height: 1.333em; - vertical-align: top; -} -@media (max-width: 900px) { - footer .tsd-legend { - width: 50%; - } -} - -.tsd-hierarchy { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} - -.tsd-index-panel .tsd-index-content { - margin-bottom: -30px !important; -} -.tsd-index-panel .tsd-index-section { - margin-bottom: 30px !important; -} -.tsd-index-panel h3 { - margin: 0 -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 3; - -moz-column-count: 3; - -ms-column-count: 3; - -o-column-count: 3; - column-count: 3; - -webkit-column-gap: 20px; - -moz-column-gap: 20px; - -ms-column-gap: 20px; - -o-column-gap: 20px; - column-gap: 20px; - padding: 0; - list-style: none; - line-height: 1.333em; -} -@media (max-width: 900px) { - .tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 1; - -moz-column-count: 1; - -ms-column-count: 1; - -o-column-count: 1; - column-count: 1; - } -} -@media (min-width: 901px) and (max-width: 1024px) { - .tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 2; - -moz-column-count: 2; - -ms-column-count: 2; - -o-column-count: 2; - column-count: 2; - } -} -.tsd-index-panel ul.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-index-panel a, -.tsd-index-panel .tsd-parent-kind-module a { - color: var(--color-ts); -} -.tsd-index-panel .tsd-parent-kind-interface a { - color: var(--color-ts-interface); -} -.tsd-index-panel .tsd-parent-kind-enum a { - color: var(--color-ts-enum); -} -.tsd-index-panel .tsd-parent-kind-class a { - color: var(--color-ts-class); -} -.tsd-index-panel .tsd-kind-module a { - color: var(--color-ts); -} -.tsd-index-panel .tsd-kind-interface a { - color: var(--color-ts-interface); -} -.tsd-index-panel .tsd-kind-enum a { - color: var(--color-ts-enum); -} -.tsd-index-panel .tsd-kind-class a { - color: var(--color-ts-class); -} -.tsd-index-panel .tsd-is-private a { - color: var(--color-ts-private); -} - -.tsd-flag { - display: inline-block; - padding: 1px 5px; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 14px; - font-weight: normal; -} - -.tsd-anchor { - position: absolute; - top: -100px; -} - -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} -.tsd-member [data-tsd-kind] { - color: var(--color-ts); -} -.tsd-member [data-tsd-kind="Interface"] { - color: var(--color-ts-interface); -} -.tsd-member [data-tsd-kind="Enum"] { - color: var(--color-ts-enum); -} -.tsd-member [data-tsd-kind="Class"] { - color: var(--color-ts-class); -} -.tsd-member [data-tsd-kind="Private"] { - color: var(--color-ts-private); -} - -.tsd-navigation { - margin: 0 0 0 40px; -} -.tsd-navigation a { - display: block; - padding-top: 2px; - padding-bottom: 2px; - border-left: 2px solid transparent; - color: var(--color-text); - text-decoration: none; - transition: border-left-color 0.1s; -} -.tsd-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul { - margin: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li { - padding: 0; -} - -.tsd-navigation.primary { - padding-bottom: 40px; -} -.tsd-navigation.primary a { - display: block; - padding-top: 6px; - padding-bottom: 6px; -} -.tsd-navigation.primary ul li a { - padding-left: 5px; -} -.tsd-navigation.primary ul li li a { - padding-left: 25px; -} -.tsd-navigation.primary ul li li li a { - padding-left: 45px; -} -.tsd-navigation.primary ul li li li li a { - padding-left: 65px; -} -.tsd-navigation.primary ul li li li li li a { - padding-left: 85px; -} -.tsd-navigation.primary ul li li li li li li a { - padding-left: 105px; -} -.tsd-navigation.primary > ul { - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-navigation.primary li { - border-top: 1px solid var(--color-panel-divider); -} -.tsd-navigation.primary li.current > a { - font-weight: bold; -} -.tsd-navigation.primary li.label span { - display: block; - padding: 20px 0 6px 5px; - color: var(--color-menu-label); -} -.tsd-navigation.primary li.globals + li > span, -.tsd-navigation.primary li.globals + li > a { - padding-top: 20px; -} - -.tsd-navigation.secondary { - max-height: calc(100vh - 1rem - 40px); - overflow: auto; - position: sticky; - top: calc(0.5rem + 40px); - transition: 0.3s; -} -.tsd-navigation.secondary.tsd-navigation--toolbar-hide { - max-height: calc(100vh - 1rem); - top: 0.5rem; -} -.tsd-navigation.secondary ul { - transition: opacity 0.2s; -} -.tsd-navigation.secondary ul li a { - padding-left: 25px; -} -.tsd-navigation.secondary ul li li a { - padding-left: 45px; -} -.tsd-navigation.secondary ul li li li a { - padding-left: 65px; -} -.tsd-navigation.secondary ul li li li li a { - padding-left: 85px; -} -.tsd-navigation.secondary ul li li li li li a { - padding-left: 105px; -} -.tsd-navigation.secondary ul li li li li li li a { - padding-left: 125px; -} -.tsd-navigation.secondary ul.current a { - border-left-color: var(--color-panel-divider); -} -.tsd-navigation.secondary li.focus > a, -.tsd-navigation.secondary ul.current li.focus > a { - border-left-color: var(--color-menu-divider-focus); -} -.tsd-navigation.secondary li.current { - margin-top: 20px; - margin-bottom: 20px; - border-left-color: var(--color-panel-divider); -} -.tsd-navigation.secondary li.current > a { - font-weight: bold; -} - -@media (min-width: 901px) { - .menu-sticky-wrap { - position: static; - } -} - -.tsd-panel { - margin: 20px 0; - padding: 20px; - background-color: var(--color-panel); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, -.tsd-panel > h2, -.tsd-panel > h3 { - margin: 1.5em -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-panel > h1.tsd-before-signature, -.tsd-panel > h2.tsd-before-signature, -.tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: 0; -} -.tsd-panel table { - display: block; - width: 100%; - overflow: auto; - margin-top: 10px; - word-break: normal; - word-break: keep-all; - border-collapse: collapse; -} -.tsd-panel table th { - font-weight: bold; -} -.tsd-panel table th, -.tsd-panel table td { - padding: 6px 13px; - border: 1px solid var(--color-panel-divider); -} -.tsd-panel table tr { - background: var(--color-background); -} -.tsd-panel table tr:nth-child(even) { - background: var(--color-secondary-background); -} - -.tsd-panel-group { - margin: 60px 0; -} -.tsd-panel-group > h1, -.tsd-panel-group > h2, -.tsd-panel-group > h3 { - padding-left: 20px; - padding-right: 20px; -} - -#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: 40px; - height: 40px; -} -#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 { - 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 { - padding: 0 10px; - background-color: var(--color-background); -} -#tsd-search .results li:nth-child(even) { - background-color: var(--color-panel); -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current, -#tsd-search .results li:hover { - background-color: var(--color-panel-divider); -} -#tsd-search .results a { - display: block; -} -#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-panel-divider); -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title { - 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-signature { - margin: 0 0 1em 0; - padding: 10px; - border: 1px solid var(--color-panel-divider); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; -} -.tsd-signature.tsd-kind-icon { - padding-left: 30px; -} -.tsd-signature.tsd-kind-icon:before { - top: 10px; - left: 10px; -} -.tsd-panel > .tsd-signature { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; -} -.tsd-panel > .tsd-signature.tsd-kind-icon { - padding-left: 40px; -} -.tsd-panel > .tsd-signature.tsd-kind-icon:before { - left: 20px; -} - -.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; - border: 1px solid var(--color-panel-divider); -} -.tsd-signatures .tsd-signature { - margin: 0; - border-width: 1px 0 0 0; - transition: background-color 0.1s; -} -.tsd-signatures .tsd-signature:first-child { - border-top-width: 0; -} -.tsd-signatures .tsd-signature.current { - background-color: var(--color-panel-divider); -} -.tsd-signatures.active > .tsd-signature { - cursor: pointer; -} -.tsd-panel > .tsd-signatures { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; -} -.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { - padding-left: 40px; -} -.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { - left: 20px; -} -.tsd-panel > a.anchor + .tsd-signatures { - border-top-width: 0; - margin-top: -20px; -} - -ul.tsd-descriptions { - position: relative; - overflow: hidden; - padding: 0; - list-style: none; -} -ul.tsd-descriptions.active > .tsd-description { - display: none; -} -ul.tsd-descriptions.active > .tsd-description.current { - display: block; -} -ul.tsd-descriptions.active > .tsd-description.fade-in { - animation: fade-in-delayed 0.3s; -} -ul.tsd-descriptions.active > .tsd-description.fade-out { - animation: fade-out-delayed 0.3s; - position: absolute; - display: block; - top: 0; - left: 0; - right: 0; - opacity: 0; - visibility: hidden; -} -ul.tsd-descriptions h4, -ul.tsd-descriptions .tsd-index-panel h3, -.tsd-index-panel ul.tsd-descriptions h3 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} - -ul.tsd-parameters, -ul.tsd-type-parameters { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameters > li.tsd-parameter-signature, -ul.tsd-type-parameters > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameters h5, -ul.tsd-type-parameters h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -ul.tsd-parameters .tsd-comment, -ul.tsd-type-parameters .tsd-comment { - margin-top: -0.5em; -} - -.tsd-sources { - font-size: 14px; - color: var(--color-text-aside); - margin: 0 0 1em 0; -} -.tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; -} -.tsd-sources ul, -.tsd-sources p { - margin: 0 !important; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: fixed; - z-index: 1; - top: 0; - left: 0; - width: 100%; - height: 40px; - color: var(--color-toolbar-text); - background: var(--color-toolbar); - border-bottom: 1px solid var(--color-panel-divider); - transition: transform 0.3s linear; -} -.tsd-page-toolbar a { - color: var(--color-toolbar-text); - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .table-wrap { - display: table; - width: 100%; - height: 40px; -} -.tsd-page-toolbar .table-cell { - display: table-cell; - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} - -.tsd-page-toolbar--hide { - transform: translateY(-100%); -} - -.tsd-select .tsd-select-list li:before, -.tsd-select .tsd-select-label:before, -.tsd-widget:before { - content: ""; - display: inline-block; - width: 40px; - height: 40px; - margin: 0 -8px 0 0; - background-image: url(./widgets.png); - background-repeat: no-repeat; - text-indent: -1024px; - vertical-align: bottom; - filter: var(--icon-filter); -} -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-select .tsd-select-list li:before, - .tsd-select .tsd-select-label:before, - .tsd-widget:before { - background-image: url(./widgets@2x.png); - background-size: 320px 40px; - } -} - -.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-panel-divider); -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} -.tsd-widget.search:before { - background-position: 0 0; -} -.tsd-widget.menu:before { - background-position: -40px 0; -} -.tsd-widget.options:before { - background-position: -80px 0; -} -.tsd-widget.options, -.tsd-widget.menu { - display: none; -} -@media (max-width: 900px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; - } -} -input[type="checkbox"] + .tsd-widget:before { - background-position: -120px 0; -} -input[type="checkbox"]:checked + .tsd-widget:before { - background-position: -160px 0; -} - -.tsd-select { - position: relative; - display: inline-block; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-select .tsd-select-label { - opacity: 0.6; - transition: opacity 0.2s; -} -.tsd-select .tsd-select-label:before { - background-position: -240px 0; -} -.tsd-select.active .tsd-select-label { - opacity: 0.8; -} -.tsd-select.active .tsd-select-list { - visibility: visible; - opacity: 1; - transition-delay: 0s; -} -.tsd-select .tsd-select-list { - position: absolute; - visibility: hidden; - top: 40px; - left: 0; - margin: 0; - padding: 0; - opacity: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - transition: visibility 0s 0.2s, opacity 0.2s; -} -.tsd-select .tsd-select-list li { - padding: 0 20px 0 0; - background-color: var(--color-background); -} -.tsd-select .tsd-select-list li:before { - background-position: 40px 0; -} -.tsd-select .tsd-select-list li:nth-child(even) { - background-color: var(--color-panel); -} -.tsd-select .tsd-select-list li:hover { - background-color: var(--color-panel-divider); -} -.tsd-select .tsd-select-list li.selected:before { - background-position: -200px 0; -} -@media (max-width: 900px) { - .tsd-select .tsd-select-list { - top: 0; - left: auto; - right: 100%; - margin-right: -5px; - } - .tsd-select .tsd-select-label:before { - background-position: -280px 0; - } -} - -img { - max-width: 100%; -} - -.tsd-anchor-icon { - margin-left: 10px; - 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; -} diff --git a/docs/public/multi-provider/assets/widgets.png b/docs/public/multi-provider/assets/widgets.png deleted file mode 100644 index c738053..0000000 Binary files a/docs/public/multi-provider/assets/widgets.png and /dev/null differ diff --git a/docs/public/multi-provider/assets/widgets@2x.png b/docs/public/multi-provider/assets/widgets@2x.png deleted file mode 100644 index 4bbbd57..0000000 Binary files a/docs/public/multi-provider/assets/widgets@2x.png and /dev/null differ diff --git a/docs/public/multi-provider/classes/Contracts.html b/docs/public/multi-provider/classes/Contracts.html deleted file mode 100644 index 145c1cf..0000000 --- a/docs/public/multi-provider/classes/Contracts.html +++ /dev/null @@ -1,5 +0,0 @@ -Contracts | @nomad-xyz/multi-provider
Options
All
  • Public
  • Public/Protected
  • All
Menu
-

Abstract class for managing collections of contracts

-

Hierarchy

  • Contracts

Index

Constructors

Properties

Methods

Constructors

Properties

args: any[]

Methods

  • connect(signer: Signer): void

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Protected property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/multi-provider/classes/MultiProvider.html b/docs/public/multi-provider/classes/MultiProvider.html deleted file mode 100644 index bb8ba7e..0000000 --- a/docs/public/multi-provider/classes/MultiProvider.html +++ /dev/null @@ -1,132 +0,0 @@ -MultiProvider | @nomad-xyz/multi-provider
Options
All
  • Public
  • Public/Protected
  • All
Menu
-

The MultiProvider manages a collection of Domains and allows -developers to enroll ethers Providers and Signers for each domain. It is -intended to enable faster multi-chain development by housing all chain -connections under a single roof.

-

Generally, we intend developers inherit the MultiProvider. Which is to say, -the expected usage pattern is class AppContext<T> extends MultiProvider<T>. -This way, the MultiProvider registration methods are available on the app -context.

-

However, the multiprovider also works well as a property on a Context -class. E.g. class AppContext<T> { protected provider: MultiProvider<T> }

-

The Domain type parameter to the MultiProvider specifies an internal data -carrier that describes chains. This can be as simple as a name and a number. -This is the logical place to insert app-specific chain information. E.g. if -your application needs to know the blocktime of a chain, it should be on the -Domain type.

-
example

import { MultiProvider, Domain } from '@nomad-xyz/multi-provider'; -const myApp = new MultiProvider(); -myApp.registerDomain({name: 'polygon', id: 50}); -myApp.registerDomain({name: 'ethereum', id: 1}); -myApp.registerRpcProvider('celo', 'https://forno.celo.org'); -myApp.registerRpcProvider('ethereum', '...'); -myApp.registerSigner('ethereum', someSigner); -myApp.registerSigner('polygon', someSigner);

-

Type parameters

Hierarchy

  • MultiProvider

Index

Constructors

Properties

domains: Map<string, T>
providers: Map<string, Provider>
signers: Map<string, Signer>

Accessors

  • get domainNames(): string[]
  • get domainNumbers(): number[]
  • get missingProviders(): string[]
  • get registeredDomains(): Readonly<T>[]

Methods

  • clearSigners(): void
  • -

    Clear all signers from all registered domains.

    -

    Returns void

  • getAddress(nameOrDomain: string | number): Promise<undefined | string>
  • -

    Resolves the address of a Signer on a domain (or undefined, if no Signer)

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns Promise<undefined | string>

    A Promise for the address of the registered signer (if any)

    -
  • getConnection(nameOrDomain: string | number): undefined | Provider | Signer
  • -

    Returns the most privileged connection registered to a domain. E.g. -this function will attempt to return a Signer, then attempt to return the -Provider (if no Signer is registered). If neither Signer nor Provider is -registered for a domain, it will return undefined

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns undefined | Provider | Signer

    A Signer (if any), otherwise a Provider (if any), otherwise - undefined

    -
  • getDomain(nameOrDomain: string | number): undefined | Domain
  • -

    Get the registered Domain object (if any)

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns undefined | Domain

    A Domain (if the domain has been registered)

    -
  • getProvider(nameOrDomain: string | number): undefined | Provider
  • -

    Get the Provider associated with a doman (if any)

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns undefined | Provider

    The currently registered Provider (or none)

    -
  • getSigner(nameOrDomain: string | number): undefined | Signer
  • -

    Return the signer registered to a domain (if any).

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns undefined | Signer

    The registered signer (or undefined)

    -
  • knownDomain(nameOrDomain: string | number): boolean
  • -

    Check whether the MultiProvider is aware of a domain.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns boolean

    true if the Domain has been registered, else false.

    -
  • mustGetConnection(nameOrDomain: string | number): Provider | Signer
  • -

    Get the Connection associated with a doman (or error)

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns Provider | Signer

    A Signer

    -
  • mustGetDomain(nameOrDomain: string | number): Domain
  • -

    Get the registered Domain object (or error)

    -
    throws

    if the domain has not been registered

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns Domain

    A Domain

    -
  • mustGetProvider(nameOrDomain: string | number): Provider
  • -

    Get the Provider associated with a doman (or error)

    -
    throws

    If no provider has been registered for the specified domain

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns Provider

    A Provider

    -
  • mustGetSigner(nameOrDomain: string | number): Signer
  • -

    Get the Signer associated with a doman (or error)

    -
    throws

    If no provider has been registered for the specified domain

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns Signer

    A Signer

    -
  • registerDomain(domain: T): void
  • -

    Resgister a domain with the MultiProvider. This allows the multiprovider -to resolves tha domain info, and reference it by name or number.

    -

    Parameters

    • domain: T
      -

      The Domain object to register.

      -

    Returns void

  • registerProvider(nameOrDomain: string | number, provider: Provider): void
  • -

    Register an ethers Provider for a specified domain.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -
    • provider: Provider
      -

      An ethers Provider to be used by requests to that domain.

      -

    Returns void

  • registerRpcProvider(nameOrDomain: string | number, rpc: string): void
  • -

    Shortcut to register a provider by its HTTP RPC URL.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -
    • rpc: string
      -

      The HTTP RPC Url

      -

    Returns void

  • registerSigner(nameOrDomain: string | number, signer: Signer): void
  • -

    Register an ethers Signer for a specified domain.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -
    • signer: Signer
      -

      An ethers Signer to be used by requests to that domain.

      -

    Returns void

  • registerWalletSigner(nameOrDomain: string | number, privkey: string): void
  • -

    A shortcut for registering a basic local privkey signer on a domain.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -
    • privkey: string
      -

      A private key string passed to ethers.Wallet

      -

    Returns void

  • resolveDomain(nameOrDomain: string | number): number
  • -

    Resolve a domain name (or number) to the canonical number.

    -

    This function is used extensively to disambiguate domains.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns number

    The canonical domain number.

    -
  • resolveDomainName(nameOrDomain: string | number): string
  • -

    Resolve the name of a registered Domain, from its name or number.

    -

    Similar to resolveDomain.

    -
    throws

    If the domain is unknown

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns string

    The name

    -
  • unregisterSigner(nameOrDomain: string | number): void
  • -

    Remove the registered ethers Signer from a domain. This function will -attempt to preserve any Provider that was previously connected to this -domain.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Protected property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/multi-provider/index.html b/docs/public/multi-provider/index.html deleted file mode 100644 index 85177b5..0000000 --- a/docs/public/multi-provider/index.html +++ /dev/null @@ -1,22 +0,0 @@ -@nomad-xyz/multi-provider
Options
All
  • Public
  • Public/Protected
  • All
Menu

@nomad-xyz/multi-provider

- -

MultiProvider

-
-

The MultiProvider is a management system for -ethers.js providers and signers that helps -developers connect to multiple networks simultaneously. It is part -of the Nomad project, but may -be useful to other multi-chain systems.

- - -

Intended Usage

-
-
import { MultiProvider, Domain } from '@nomad-xyz/multi-provider';
const myApp = new MultiProvider<Domain>();

myApp.registerDomain({ name: 'polygon', id: 50 });
myApp.registerDomain({ name: 'ethereum', id: 1 });
myApp.registerRpcProvider('ethereum', 'https://...');
myApp.registerRpcProvider('polygon', 'https://...');
myApp.registerSigner('ethereum', someSigner);
myApp.registerSigner('polygon', someSigner); -
- - -

Building

-
-
yarn build
-
-

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Protected property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/multi-provider/interfaces/Domain.html b/docs/public/multi-provider/interfaces/Domain.html deleted file mode 100644 index 51aefb4..0000000 --- a/docs/public/multi-provider/interfaces/Domain.html +++ /dev/null @@ -1,5 +0,0 @@ -Domain | @nomad-xyz/multi-provider
Options
All
  • Public
  • Public/Protected
  • All
Menu
-

A Domain (and its characteristics). This interface is deliberately vague. -We inted MultiProvider users to supply their own defintion of a Domain -object with any relevant properties.

-

Hierarchy

  • Domain

Index

Properties

domain: number
name: string
paginate?: Pagination

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Protected property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/multi-provider/interfaces/Pagination.html b/docs/public/multi-provider/interfaces/Pagination.html deleted file mode 100644 index dbbfc88..0000000 --- a/docs/public/multi-provider/interfaces/Pagination.html +++ /dev/null @@ -1,3 +0,0 @@ -Pagination | @nomad-xyz/multi-provider
Options
All
  • Public
  • Public/Protected
  • All
Menu
-

RPC Pagination information for Polygon

-

Hierarchy

  • Pagination

Index

Properties

Properties

blocks: number
from: number

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Protected property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/multi-provider/modules.html b/docs/public/multi-provider/modules.html deleted file mode 100644 index 3e0a9ed..0000000 --- a/docs/public/multi-provider/modules.html +++ /dev/null @@ -1 +0,0 @@ -@nomad-xyz/multi-provider
Options
All
  • Public
  • Public/Protected
  • All
Menu

@nomad-xyz/multi-provider

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Protected property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/multi-provider/modules/utils.html b/docs/public/multi-provider/modules/utils.html deleted file mode 100644 index b559e40..0000000 --- a/docs/public/multi-provider/modules/utils.html +++ /dev/null @@ -1,53 +0,0 @@ -utils | @nomad-xyz/multi-provider
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

Address: string

Functions

  • canonizeId(data?: BytesLike): Uint8Array
  • -

    Converts a 20-byte (or other length) ID to a 32-byte ID. -Ensures that a bytes-like is 32 long. left-padding with 0s if not.

    -
    throws

    if the input is undefined, or not exactly 20 or 32 bytes long

    -

    Parameters

    • Optional data: BytesLike
      -

      A string or array of bytes to canonize

      -

    Returns Uint8Array

    A Uint8Array of length 32

    -
  • chainIdToDomain(chainId: number): number
  • -

    Converts a chain id (listed at at chainlist.org) to a Nomad domain.

    -

    Parameters

    • chainId: number
      -

      A chain id number

      -

    Returns number

    A Nomad domain number in decimal

    -
  • delay(ms: number): Promise<void>
  • -

    Sleep async for some time.

    -

    Parameters

    • ms: number
      -

      the number of milliseconds to sleep

      -

    Returns Promise<void>

    A delay promise

    -
  • equalIds(left: BytesLike, right: BytesLike): boolean
  • -

    Equality for the NomadIdentifier

    -
    throws

    if either side is not a valid 20 or 32 byte nomad identifier

    -

    Parameters

    • left: BytesLike
      -

      Lhs of equality

      -
    • right: BytesLike
      -

      Rhs of equality

      -

    Returns boolean

    true if equal, else false

    -
  • -

    Converts an Nomad ID of 20 or 32 bytes to the corresponding EVM Address.

    -

    For 32-byte IDs this enforces the EVM convention of using the LAST 20 bytes.

    -
    throws

    if the data is not 20 or 32 bytes

    -

    Parameters

    • data: BytesLike
      -

      The data to truncate

      -

    Returns Address

    A 20-byte, 0x-prepended hex string representing the EVM Address

    -
  • getDomainFromString(name: string): number
  • -

    Converts a string (e.g. "eth" for Ethereum) to a decimal formatted Nomad -domain.

    -
    dev

    Interprets string bytes as int.

    -

    Parameters

    • name: string
      -

      The chain string

      -

    Returns number

    A Nomad domain number in decimal

    -
  • getHexDomainFromString(name: string): string
  • -

    Converts a string (e.g. "eth" for Ethereum) to a Nomad domain displayed as -a hex string.

    -
    dev

    Interprets string bytes as int.

    -

    Parameters

    • name: string
      -

      The chain string

      -

    Returns string

    A 0x prefixed Nomad domain in hex (string)

    -
  • parseInt(input: string | number): number
  • -

    Parse a number or string into an integer number

    -
    throws

    If the number is larger than MAX_SAFE_INTEGER

    -

    Parameters

    • input: string | number
      -

      A number, decimal string, or hex string

      -

    Returns number

    The integer it represents

    -

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Protected property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/nomad-brand-assets.zip b/docs/public/nomad-brand-assets.zip deleted file mode 100644 index dfc0873..0000000 Binary files a/docs/public/nomad-brand-assets.zip and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-evmos/change-dest-1.png b/docs/public/partner-assets/ethereum-to-evmos/change-dest-1.png deleted file mode 100644 index 80a856e..0000000 Binary files a/docs/public/partner-assets/ethereum-to-evmos/change-dest-1.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-evmos/change-dest-2.png b/docs/public/partner-assets/ethereum-to-evmos/change-dest-2.png deleted file mode 100644 index ebf8512..0000000 Binary files a/docs/public/partner-assets/ethereum-to-evmos/change-dest-2.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-evmos/check-connext.png b/docs/public/partner-assets/ethereum-to-evmos/check-connext.png deleted file mode 100644 index f877d59..0000000 Binary files a/docs/public/partner-assets/ethereum-to-evmos/check-connext.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-evmos/complete-transfer.png b/docs/public/partner-assets/ethereum-to-evmos/complete-transfer.png deleted file mode 100644 index dcacc5f..0000000 Binary files a/docs/public/partner-assets/ethereum-to-evmos/complete-transfer.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-evmos/connect-metamask.png b/docs/public/partner-assets/ethereum-to-evmos/connect-metamask.png deleted file mode 100644 index 94f1115..0000000 Binary files a/docs/public/partner-assets/ethereum-to-evmos/connect-metamask.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-evmos/connext-claim.png b/docs/public/partner-assets/ethereum-to-evmos/connext-claim.png deleted file mode 100644 index 5bb5610..0000000 Binary files a/docs/public/partner-assets/ethereum-to-evmos/connext-claim.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-evmos/expand-status.png b/docs/public/partner-assets/ethereum-to-evmos/expand-status.png deleted file mode 100644 index 3d1f1fc..0000000 Binary files a/docs/public/partner-assets/ethereum-to-evmos/expand-status.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-evmos/input-data.png b/docs/public/partner-assets/ethereum-to-evmos/input-data.png deleted file mode 100644 index 1193033..0000000 Binary files a/docs/public/partner-assets/ethereum-to-evmos/input-data.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-evmos/review.png b/docs/public/partner-assets/ethereum-to-evmos/review.png deleted file mode 100644 index dd4dc25..0000000 Binary files a/docs/public/partner-assets/ethereum-to-evmos/review.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-evmos/search-transfer.png b/docs/public/partner-assets/ethereum-to-evmos/search-transfer.png deleted file mode 100644 index d4a7e5a..0000000 Binary files a/docs/public/partner-assets/ethereum-to-evmos/search-transfer.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-evmos/select-networks.png b/docs/public/partner-assets/ethereum-to-evmos/select-networks.png deleted file mode 100644 index fe157c7..0000000 Binary files a/docs/public/partner-assets/ethereum-to-evmos/select-networks.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-evmos/select-token.png b/docs/public/partner-assets/ethereum-to-evmos/select-token.png deleted file mode 100644 index 9a54f6c..0000000 Binary files a/docs/public/partner-assets/ethereum-to-evmos/select-token.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-evmos/sending.png b/docs/public/partner-assets/ethereum-to-evmos/sending.png deleted file mode 100644 index 1cebc95..0000000 Binary files a/docs/public/partner-assets/ethereum-to-evmos/sending.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-evmos/transfer-complete.png b/docs/public/partner-assets/ethereum-to-evmos/transfer-complete.png deleted file mode 100644 index 1aa1d5e..0000000 Binary files a/docs/public/partner-assets/ethereum-to-evmos/transfer-complete.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-evmos/transfer-pending.png b/docs/public/partner-assets/ethereum-to-evmos/transfer-pending.png deleted file mode 100644 index 479f0c3..0000000 Binary files a/docs/public/partner-assets/ethereum-to-evmos/transfer-pending.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-milkomeda/change-dest-1.png b/docs/public/partner-assets/ethereum-to-milkomeda/change-dest-1.png deleted file mode 100644 index 80a856e..0000000 Binary files a/docs/public/partner-assets/ethereum-to-milkomeda/change-dest-1.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-milkomeda/change-dest-2.png b/docs/public/partner-assets/ethereum-to-milkomeda/change-dest-2.png deleted file mode 100644 index ebf8512..0000000 Binary files a/docs/public/partner-assets/ethereum-to-milkomeda/change-dest-2.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-milkomeda/check-connext.png b/docs/public/partner-assets/ethereum-to-milkomeda/check-connext.png deleted file mode 100644 index b7d1353..0000000 Binary files a/docs/public/partner-assets/ethereum-to-milkomeda/check-connext.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-milkomeda/complete-transfer.png b/docs/public/partner-assets/ethereum-to-milkomeda/complete-transfer.png deleted file mode 100644 index 7181d48..0000000 Binary files a/docs/public/partner-assets/ethereum-to-milkomeda/complete-transfer.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-milkomeda/connect-metamask.png b/docs/public/partner-assets/ethereum-to-milkomeda/connect-metamask.png deleted file mode 100644 index 94f1115..0000000 Binary files a/docs/public/partner-assets/ethereum-to-milkomeda/connect-metamask.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-milkomeda/connext-claim.png b/docs/public/partner-assets/ethereum-to-milkomeda/connext-claim.png deleted file mode 100644 index e05598a..0000000 Binary files a/docs/public/partner-assets/ethereum-to-milkomeda/connext-claim.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-milkomeda/expand-status.png b/docs/public/partner-assets/ethereum-to-milkomeda/expand-status.png deleted file mode 100644 index 3d1f1fc..0000000 Binary files a/docs/public/partner-assets/ethereum-to-milkomeda/expand-status.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-milkomeda/input-data.png b/docs/public/partner-assets/ethereum-to-milkomeda/input-data.png deleted file mode 100644 index fa94361..0000000 Binary files a/docs/public/partner-assets/ethereum-to-milkomeda/input-data.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-milkomeda/review.png b/docs/public/partner-assets/ethereum-to-milkomeda/review.png deleted file mode 100644 index aa0260c..0000000 Binary files a/docs/public/partner-assets/ethereum-to-milkomeda/review.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-milkomeda/search-transfer.png b/docs/public/partner-assets/ethereum-to-milkomeda/search-transfer.png deleted file mode 100644 index d4a7e5a..0000000 Binary files a/docs/public/partner-assets/ethereum-to-milkomeda/search-transfer.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-milkomeda/select-networks.png b/docs/public/partner-assets/ethereum-to-milkomeda/select-networks.png deleted file mode 100644 index d2839db..0000000 Binary files a/docs/public/partner-assets/ethereum-to-milkomeda/select-networks.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-milkomeda/select-token.png b/docs/public/partner-assets/ethereum-to-milkomeda/select-token.png deleted file mode 100644 index 9a54f6c..0000000 Binary files a/docs/public/partner-assets/ethereum-to-milkomeda/select-token.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-milkomeda/sending.png b/docs/public/partner-assets/ethereum-to-milkomeda/sending.png deleted file mode 100644 index 1cebc95..0000000 Binary files a/docs/public/partner-assets/ethereum-to-milkomeda/sending.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-milkomeda/transfer-complete.png b/docs/public/partner-assets/ethereum-to-milkomeda/transfer-complete.png deleted file mode 100644 index 1da6f02..0000000 Binary files a/docs/public/partner-assets/ethereum-to-milkomeda/transfer-complete.png and /dev/null differ diff --git a/docs/public/partner-assets/ethereum-to-milkomeda/transfer-pending.png b/docs/public/partner-assets/ethereum-to-milkomeda/transfer-pending.png deleted file mode 100644 index 899c3ab..0000000 Binary files a/docs/public/partner-assets/ethereum-to-milkomeda/transfer-pending.png and /dev/null differ diff --git a/docs/public/partner-assets/overview/connext-architecture.png b/docs/public/partner-assets/overview/connext-architecture.png deleted file mode 100644 index 1177489..0000000 Binary files a/docs/public/partner-assets/overview/connext-architecture.png and /dev/null differ diff --git a/docs/public/partner-assets/overview/connext-highlevel-flow.png b/docs/public/partner-assets/overview/connext-highlevel-flow.png deleted file mode 100644 index 0360b6a..0000000 Binary files a/docs/public/partner-assets/overview/connext-highlevel-flow.png and /dev/null differ diff --git a/docs/public/sdk-bridge/.nojekyll b/docs/public/sdk-bridge/.nojekyll deleted file mode 100644 index e2ac661..0000000 --- a/docs/public/sdk-bridge/.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/public/sdk-bridge/assets/highlight.css b/docs/public/sdk-bridge/assets/highlight.css deleted file mode 100644 index 5b3bce0..0000000 --- a/docs/public/sdk-bridge/assets/highlight.css +++ /dev/null @@ -1,36 +0,0 @@ -:root { - --light-hl-0: #001080; - --dark-hl-0: #9CDCFE; - --light-hl-1: #000000; - --dark-hl-1: #D4D4D4; - --light-code-background: #F5F5F5; - --dark-code-background: #1E1E1E; -} - -@media (prefers-color-scheme: light) { :root { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --code-background: var(--light-code-background); -} } - -@media (prefers-color-scheme: dark) { :root { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --code-background: var(--dark-code-background); -} } - -body.light { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --code-background: var(--light-code-background); -} - -body.dark { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --code-background: var(--dark-code-background); -} - -.hl-0 { color: var(--hl-0); } -.hl-1 { color: var(--hl-1); } -pre, code { background: var(--code-background); } diff --git a/docs/public/sdk-bridge/assets/icons.css b/docs/public/sdk-bridge/assets/icons.css deleted file mode 100644 index 776a356..0000000 --- a/docs/public/sdk-bridge/assets/icons.css +++ /dev/null @@ -1,1043 +0,0 @@ -.tsd-kind-icon { - display: block; - position: relative; - padding-left: 20px; - text-indent: -20px; -} -.tsd-kind-icon:before { - content: ""; - display: inline-block; - vertical-align: middle; - width: 17px; - height: 17px; - margin: 0 3px 2px 0; - background-image: url(./icons.png); -} -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-kind-icon:before { - background-image: url(./icons@2x.png); - background-size: 238px 204px; - } -} - -.tsd-signature.tsd-kind-icon:before { - background-position: 0 -153px; -} - -.tsd-kind-object-literal > .tsd-kind-icon:before { - background-position: 0px -17px; -} -.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -17px; -} -.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -17px; -} - -.tsd-kind-class > .tsd-kind-icon:before { - background-position: 0px -34px; -} -.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -34px; -} -.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -34px; -} - -.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -51px; -} -.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -17px -51px; -} -.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -51px; -} - -.tsd-kind-interface > .tsd-kind-icon:before { - background-position: 0px -68px; -} -.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -68px; -} -.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -68px; -} - -.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -85px; -} -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -17px -85px; -} -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private - > .tsd-kind-icon:before { - background-position: -34px -85px; -} - -.tsd-kind-namespace > .tsd-kind-icon:before { - background-position: 0px -102px; -} -.tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; -} -.tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; -} - -.tsd-kind-module > .tsd-kind-icon:before { - background-position: 0px -102px; -} -.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; -} -.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; -} - -.tsd-kind-enum > .tsd-kind-icon:before { - background-position: 0px -119px; -} -.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -119px; -} -.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -119px; -} - -.tsd-kind-enum-member > .tsd-kind-icon:before { - background-position: 0px -136px; -} -.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -136px; -} -.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -136px; -} - -.tsd-kind-signature > .tsd-kind-icon:before { - background-position: 0px -153px; -} -.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -153px; -} -.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -153px; -} - -.tsd-kind-type-alias > .tsd-kind-icon:before { - background-position: 0px -170px; -} -.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -170px; -} -.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -170px; -} - -.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -187px; -} -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -17px -187px; -} -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private - > .tsd-kind-icon:before { - background-position: -34px -187px; -} - -.tsd-kind-variable > .tsd-kind-icon:before { - background-position: -136px -0px; -} -.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; -} -.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; -} -.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -0px; -} - -.tsd-kind-property > .tsd-kind-icon:before { - background-position: -136px -0px; -} -.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; -} -.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; -} -.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -0px; -} - -.tsd-kind-get-signature > .tsd-kind-icon:before { - background-position: -136px -17px; -} -.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -17px; -} -.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -17px; -} - -.tsd-kind-set-signature > .tsd-kind-icon:before { - background-position: -136px -34px; -} -.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -34px; -} -.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -34px; -} - -.tsd-kind-accessor > .tsd-kind-icon:before { - background-position: -136px -51px; -} -.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -51px; -} -.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -51px; -} - -.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -153px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class - > .tsd-kind-icon:before { - background-position: -51px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum - > .tsd-kind-icon:before { - background-position: -170px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -85px; -} - -.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -153px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class - > .tsd-kind-icon:before { - background-position: -51px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum - > .tsd-kind-icon:before { - background-position: -170px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -85px; -} - -.tsd-kind-constructor > .tsd-kind-icon:before { - background-position: -136px -102px; -} -.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; -} -.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -102px; -} - -.tsd-kind-constructor-signature > .tsd-kind-icon:before { - background-position: -136px -102px; -} -.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; -} -.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -102px; -} - -.tsd-kind-index-signature > .tsd-kind-icon:before { - background-position: -136px -119px; -} -.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -119px; -} -.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -119px; -} - -.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -136px; -} -.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -136px; -} -.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -136px; -} -.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -136px; -} - -.tsd-is-static > .tsd-kind-icon:before { - background-position: -136px -153px; -} -.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -153px; -} -.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -153px; -} -.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -153px; -} -.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -153px; -} -.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -153px; -} - -.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class - > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum - > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -187px; -} diff --git a/docs/public/sdk-bridge/assets/icons.png b/docs/public/sdk-bridge/assets/icons.png deleted file mode 100644 index 3836d5f..0000000 Binary files a/docs/public/sdk-bridge/assets/icons.png and /dev/null differ diff --git a/docs/public/sdk-bridge/assets/icons@2x.png b/docs/public/sdk-bridge/assets/icons@2x.png deleted file mode 100644 index 5a209e2..0000000 Binary files a/docs/public/sdk-bridge/assets/icons@2x.png and /dev/null differ diff --git a/docs/public/sdk-bridge/assets/main.js b/docs/public/sdk-bridge/assets/main.js deleted file mode 100644 index 54869f4..0000000 --- a/docs/public/sdk-bridge/assets/main.js +++ /dev/null @@ -1,52 +0,0 @@ -(()=>{var Ce=Object.create;var J=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,_e=Object.prototype.hasOwnProperty;var Me=t=>J(t,"__esModule",{value:!0});var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!_e.call(t,i)&&(r||i!=="default")&&J(t,i,{get:()=>e[i],enumerable:!(n=Pe(e,i))||n.enumerable});return t},Ae=(t,e)=>De(Me(J(t!=null?Ce(Re(t)):{},"default",!e&&t&&t.__esModule?{get:()=>t.default,enumerable:!0}:{value:t,enumerable:!0})),t);var de=Fe((ce,he)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var h=t.utils.clone(r)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(n.slice(a,o),h))}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,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ou?h+=2:a==u&&(r+=n[l+1]*i[h+1],l+=2,h+=2);return r},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),r=1,n=0;r0){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 u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,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 l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),p=s.str.charAt(1),v;p in s.node.edges?v=s.node.edges[p]:(v=new t.TokenSet,s.node.edges[p]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.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(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},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,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<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 r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,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 r=e.peekLexeme();if(r!=null)switch(r.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 n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.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 r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.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 '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;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 r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;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,r){typeof define=="function"&&define.amd?define(r):typeof ce=="object"?he.exports=r():e.lunr=r()}(this,function(){return t})})()});var le=[];function N(t,e){le.push({selector:e,constructor:t})}var X=class{constructor(){this.createComponents(document.body)}createComponents(e){le.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n}),n.dataset.hasInstance=String(!0))})})}};var Q=class{constructor(e){this.el=e.el}};var Z=class{constructor(){this.listeners={}}addEventListener(e,r){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(r)}removeEventListener(e,r){if(!(e in this.listeners))return;let n=this.listeners[e];for(let i=0,s=n.length;i{let r=Date.now();return(...n)=>{r+e-Date.now()<0&&(t(...n),r=Date.now())}};var ee=class extends Z{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.secondaryNav=document.querySelector(".tsd-navigation.secondary"),window.addEventListener("scroll",K(()=>this.onScroll(),10)),window.addEventListener("resize",K(()=>this.onResize(),10)),this.onResize(),this.onScroll()}triggerResize(){let e=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(e)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let e=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(e)}onScroll(){this.scrollTop=window.scrollY||0;let e=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(e),this.hideShowToolbar()}hideShowToolbar(){var r;let e=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0,e!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),(r=this.secondaryNav)==null||r.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop}},I=ee;I.instance=new ee;var te=class extends Q{constructor(e){super(e);this.anchors=[];this.index=-1;I.instance.addEventListener("resize",()=>this.onResize()),I.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let e=window.location.href;e.indexOf("#")!=-1&&(e=e.substr(0,e.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let n=r.href;if(n.indexOf("#")==-1||n.substr(0,e.length)!=e)return;let i=n.substr(n.indexOf("#")+1),s=document.querySelector("a.tsd-anchor[name="+i+"]"),o=r.parentNode;!s||!o||this.anchors.push({link:o,anchor:s,position:0})}),this.onResize()}onResize(){let e;for(let n=0,i=this.anchors.length;nn.position-i.position);let r=new CustomEvent("scroll",{detail:{scrollTop:I.instance.scrollTop}});this.onScroll(r)}onScroll(e){let r=e.detail.scrollTop+5,n=this.anchors,i=n.length-1,s=this.index;for(;s>-1&&n[s].position>r;)s-=1;for(;s-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=s,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let r;return(...n)=>{clearTimeout(r),r=setTimeout(()=>t(n),e)}};var me=Ae(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Ve(t,n,r,s)}function Ve(t,e,r,n){r.addEventListener("input",ue(()=>{ze(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ne(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?fe(e,-1):s.key==="ArrowDown"?fe(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function He(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function ze(t,e,r,n){if(He(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=n.index.search(`*${i}*`);for(let o=0,a=Math.min(10,s.length);o${pe(u.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=u.classes;let p=document.createElement("a");p.href=n.base+u.url,p.classList.add("tsd-kind-icon"),p.innerHTML=l,h.append(p),e.appendChild(h)}}function fe(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Ne(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function pe(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(re(t.substring(s,o)),`${re(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(re(t.substring(s))),i.join("")}var je={"&":"&","<":"<",">":">","'":"'",'"':"""};function re(t){return t.replace(/[&<>"'"]/g,e=>je[e])}var ge=class{constructor(e,r){this.signature=e,this.description=r}addClass(e){return this.signature.classList.add(e),this.description.classList.add(e),this}removeClass(e){return this.signature.classList.remove(e),this.description.classList.remove(e),this}},ne=class extends Q{constructor(e){super(e);this.groups=[];this.index=-1;this.createGroups(),this.container&&(this.el.classList.add("active"),Array.from(this.el.children).forEach(r=>{r.addEventListener("touchstart",n=>this.onClick(n)),r.addEventListener("click",n=>this.onClick(n))}),this.container.classList.add("active"),this.setIndex(0))}setIndex(e){if(e<0&&(e=0),e>this.groups.length-1&&(e=this.groups.length-1),this.index==e)return;let r=this.groups[e];if(this.index>-1){let n=this.groups[this.index];n.removeClass("current").addClass("fade-out"),r.addClass("current"),r.addClass("fade-in"),I.instance.triggerResize(),setTimeout(()=>{n.removeClass("fade-out"),r.removeClass("fade-in")},300)}else r.addClass("current"),I.instance.triggerResize();this.index=e}createGroups(){let e=this.el.children;if(e.length<2)return;this.container=this.el.nextElementSibling;let r=this.container.children;this.groups=[];for(let n=0;n{r.signature===e.currentTarget&&this.setIndex(n)})}};var C="mousedown",xe="mousemove",_="mouseup",G={x:0,y:0},ye=!1,ie=!1,Be=!1,A=!1,Le=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Le?"is-mobile":"not-mobile");Le&&"ontouchstart"in document.documentElement&&(Be=!0,C="touchstart",xe="touchmove",_="touchend");document.addEventListener(C,t=>{ie=!0,A=!1;let e=C=="touchstart"?t.targetTouches[0]:t;G.y=e.pageY||0,G.x=e.pageX||0});document.addEventListener(xe,t=>{if(!!ie&&!A){let e=C=="touchstart"?t.targetTouches[0]:t,r=G.x-(e.pageX||0),n=G.y-(e.pageY||0);A=Math.sqrt(r*r+n*n)>10}});document.addEventListener(_,()=>{ie=!1});document.addEventListener("click",t=>{ye&&(t.preventDefault(),t.stopImmediatePropagation(),ye=!1)});var se=class extends Q{constructor(e){super(e);this.className=this.el.dataset.toggle||"",this.el.addEventListener(_,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(C,r=>this.onDocumentPointerDown(r)),document.addEventListener(_,r=>this.onDocumentPointerUp(r))}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 r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(e){A||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!A&&this.active&&e.target.closest(".col-menu")){let r=e.target.closest("a");if(r){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substr(0,n.indexOf("#"))),r.href.substr(0,n.length)==n&&setTimeout(()=>this.setActive(!1),250)}}}};var ae=class{constructor(e,r){this.key=e,this.value=r,this.defaultValue=r,this.initialize(),window.localStorage[this.key]&&this.setValue(this.fromLocalStorage(window.localStorage[this.key]))}initialize(){}setValue(e){if(this.value==e)return;let r=this.value;this.value=e,window.localStorage[this.key]=this.toLocalStorage(e),this.handleValueChange(r,e)}},oe=class extends ae{initialize(){let e=document.querySelector("#tsd-filter-"+this.key);!e||(this.checkbox=e,this.checkbox.addEventListener("change",()=>{this.setValue(this.checkbox.checked)}))}handleValueChange(e,r){!this.checkbox||(this.checkbox.checked=this.value,document.documentElement.classList.toggle("toggle-"+this.key,this.value!=this.defaultValue))}fromLocalStorage(e){return e=="true"}toLocalStorage(e){return e?"true":"false"}},Ee=class extends ae{initialize(){document.documentElement.classList.add("toggle-"+this.key+this.value);let e=document.querySelector("#tsd-filter-"+this.key);if(!e)return;this.select=e;let r=()=>{this.select.classList.add("active")},n=()=>{this.select.classList.remove("active")};this.select.addEventListener(C,r),this.select.addEventListener("mouseover",r),this.select.addEventListener("mouseleave",n),this.select.querySelectorAll("li").forEach(i=>{i.addEventListener(_,s=>{e.classList.remove("active"),this.setValue(s.target.dataset.value||"")})}),document.addEventListener(C,i=>{this.select.contains(i.target)||this.select.classList.remove("active")})}handleValueChange(e,r){this.select.querySelectorAll("li.selected").forEach(s=>{s.classList.remove("selected")});let n=this.select.querySelector('li[data-value="'+r+'"]'),i=this.select.querySelector(".tsd-select-label");n&&i&&(n.classList.add("selected"),i.textContent=n.textContent),document.documentElement.classList.remove("toggle-"+e),document.documentElement.classList.add("toggle-"+r)}fromLocalStorage(e){return e}toLocalStorage(e){return e}},Y=class extends Q{constructor(e){super(e);this.optionVisibility=new Ee("visibility","private"),this.optionInherited=new oe("inherited",!0),this.optionExternals=new oe("externals",!0)}static isSupported(){try{return typeof window.localStorage!="undefined"}catch{return!1}}};function we(t){let e=localStorage.getItem("tsd-theme")||"os";t.value=e,be(e),t.addEventListener("change",()=>{localStorage.setItem("tsd-theme",t.value),be(t.value)})}function be(t){switch(t){case"os":document.body.classList.remove("light","dark");break;case"light":document.body.classList.remove("dark"),document.body.classList.add("light");break;case"dark":document.body.classList.remove("light"),document.body.classList.add("dark");break}}ve();N(te,".menu-highlight");N(ne,".tsd-signatures");N(se,"a[data-toggle]");Y.isSupported()?N(Y,"#tsd-filter"):document.documentElement.classList.add("no-filter");var Te=document.getElementById("theme");Te&&we(Te);var qe=new X;Object.defineProperty(window,"app",{value:qe});})(); -/*! - * lunr.Builder - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Index - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Pipeline - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Set - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.TokenSet - * 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.tokenizer - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.trimmer - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.utils - * Copyright (C) 2020 Oliver Nightingale - */ -/** - * 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 - */ diff --git a/docs/public/sdk-bridge/assets/search.js b/docs/public/sdk-bridge/assets/search.js deleted file mode 100644 index cd4a6ba..0000000 --- a/docs/public/sdk-bridge/assets/search.js +++ /dev/null @@ -1 +0,0 @@ -window.searchData = JSON.parse("{\"kinds\":{\"4\":\"Namespace\",\"32\":\"Variable\",\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"262144\":\"Accessor\",\"4194304\":\"Type alias\"},\"rows\":[{\"id\":0,\"kind\":128,\"name\":\"BridgeContracts\",\"url\":\"classes/BridgeContracts.html\",\"classes\":\"tsd-kind-class\"},{\"id\":1,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BridgeContracts.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite\",\"parent\":\"BridgeContracts\"},{\"id\":2,\"kind\":1024,\"name\":\"domain\",\"url\":\"classes/BridgeContracts.html#domain\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"BridgeContracts\"},{\"id\":3,\"kind\":1024,\"name\":\"deployHeight\",\"url\":\"classes/BridgeContracts.html#deployHeight\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"BridgeContracts\"},{\"id\":4,\"kind\":1024,\"name\":\"conf\",\"url\":\"classes/BridgeContracts.html#conf\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"BridgeContracts\"},{\"id\":5,\"kind\":1024,\"name\":\"providerOrSigner\",\"url\":\"classes/BridgeContracts.html#providerOrSigner\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"BridgeContracts\"},{\"id\":6,\"kind\":262144,\"name\":\"bridgeRouter\",\"url\":\"classes/BridgeContracts.html#bridgeRouter\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"BridgeContracts\"},{\"id\":7,\"kind\":262144,\"name\":\"tokenRegistry\",\"url\":\"classes/BridgeContracts.html#tokenRegistry\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"BridgeContracts\"},{\"id\":8,\"kind\":262144,\"name\":\"ethHelper\",\"url\":\"classes/BridgeContracts.html#ethHelper\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"BridgeContracts\"},{\"id\":9,\"kind\":2048,\"name\":\"connect\",\"url\":\"classes/BridgeContracts.html#connect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite\",\"parent\":\"BridgeContracts\"},{\"id\":10,\"kind\":4,\"name\":\"bridgeEvents\",\"url\":\"modules/bridgeEvents.html\",\"classes\":\"tsd-kind-namespace\"},{\"id\":11,\"kind\":4194304,\"name\":\"SendTypes\",\"url\":\"modules/bridgeEvents.html#SendTypes\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-namespace\",\"parent\":\"bridgeEvents\"},{\"id\":12,\"kind\":4194304,\"name\":\"SendArgs\",\"url\":\"modules/bridgeEvents.html#SendArgs\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-namespace\",\"parent\":\"bridgeEvents\"},{\"id\":13,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/bridgeEvents.html#SendArgs.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"bridgeEvents.SendArgs\"},{\"id\":14,\"kind\":1024,\"name\":\"token\",\"url\":\"modules/bridgeEvents.html#SendArgs.__type.token\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"bridgeEvents.SendArgs.__type\"},{\"id\":15,\"kind\":1024,\"name\":\"from\",\"url\":\"modules/bridgeEvents.html#SendArgs.__type.from\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"bridgeEvents.SendArgs.__type\"},{\"id\":16,\"kind\":1024,\"name\":\"toDomain\",\"url\":\"modules/bridgeEvents.html#SendArgs.__type.toDomain\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"bridgeEvents.SendArgs.__type\"},{\"id\":17,\"kind\":1024,\"name\":\"toId\",\"url\":\"modules/bridgeEvents.html#SendArgs.__type.toId\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"bridgeEvents.SendArgs.__type\"},{\"id\":18,\"kind\":1024,\"name\":\"amount\",\"url\":\"modules/bridgeEvents.html#SendArgs.__type.amount\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"bridgeEvents.SendArgs.__type\"},{\"id\":19,\"kind\":4194304,\"name\":\"SendEvent\",\"url\":\"modules/bridgeEvents.html#SendEvent\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-namespace\",\"parent\":\"bridgeEvents\"},{\"id\":20,\"kind\":4194304,\"name\":\"TokenDeployedTypes\",\"url\":\"modules/bridgeEvents.html#TokenDeployedTypes\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-namespace\",\"parent\":\"bridgeEvents\"},{\"id\":21,\"kind\":4194304,\"name\":\"TokenDeployedArgs\",\"url\":\"modules/bridgeEvents.html#TokenDeployedArgs\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-namespace\",\"parent\":\"bridgeEvents\"},{\"id\":22,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/bridgeEvents.html#TokenDeployedArgs.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"bridgeEvents.TokenDeployedArgs\"},{\"id\":23,\"kind\":1024,\"name\":\"domain\",\"url\":\"modules/bridgeEvents.html#TokenDeployedArgs.__type-1.domain\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"bridgeEvents.TokenDeployedArgs.__type\"},{\"id\":24,\"kind\":1024,\"name\":\"id\",\"url\":\"modules/bridgeEvents.html#TokenDeployedArgs.__type-1.id\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"bridgeEvents.TokenDeployedArgs.__type\"},{\"id\":25,\"kind\":1024,\"name\":\"representation\",\"url\":\"modules/bridgeEvents.html#TokenDeployedArgs.__type-1.representation\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"bridgeEvents.TokenDeployedArgs.__type\"},{\"id\":26,\"kind\":4194304,\"name\":\"TokenDeployedEvent\",\"url\":\"modules/bridgeEvents.html#TokenDeployedEvent\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-namespace\",\"parent\":\"bridgeEvents\"},{\"id\":27,\"kind\":4194304,\"name\":\"AnnotatedSend\",\"url\":\"modules/bridgeEvents.html#AnnotatedSend\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-namespace\",\"parent\":\"bridgeEvents\"},{\"id\":28,\"kind\":4194304,\"name\":\"AnnotatedTokenDeployed\",\"url\":\"modules/bridgeEvents.html#AnnotatedTokenDeployed\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-namespace\",\"parent\":\"bridgeEvents\"},{\"id\":29,\"kind\":256,\"name\":\"TokenIdentifier\",\"url\":\"interfaces/TokenIdentifier.html\",\"classes\":\"tsd-kind-interface\"},{\"id\":30,\"kind\":1024,\"name\":\"domain\",\"url\":\"interfaces/TokenIdentifier.html#domain\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"TokenIdentifier\"},{\"id\":31,\"kind\":1024,\"name\":\"id\",\"url\":\"interfaces/TokenIdentifier.html#id\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"TokenIdentifier\"},{\"id\":32,\"kind\":4194304,\"name\":\"SendTypes\",\"url\":\"modules.html#SendTypes\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":33,\"kind\":4194304,\"name\":\"SendArgs\",\"url\":\"modules.html#SendArgs\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":34,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules.html#SendArgs.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"SendArgs\"},{\"id\":35,\"kind\":1024,\"name\":\"token\",\"url\":\"modules.html#SendArgs.__type.token\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"SendArgs.__type\"},{\"id\":36,\"kind\":1024,\"name\":\"from\",\"url\":\"modules.html#SendArgs.__type.from\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"SendArgs.__type\"},{\"id\":37,\"kind\":1024,\"name\":\"toDomain\",\"url\":\"modules.html#SendArgs.__type.toDomain\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"SendArgs.__type\"},{\"id\":38,\"kind\":1024,\"name\":\"toId\",\"url\":\"modules.html#SendArgs.__type.toId\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"SendArgs.__type\"},{\"id\":39,\"kind\":1024,\"name\":\"amount\",\"url\":\"modules.html#SendArgs.__type.amount\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"SendArgs.__type\"},{\"id\":40,\"kind\":4194304,\"name\":\"SendEvent\",\"url\":\"modules.html#SendEvent\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":41,\"kind\":4194304,\"name\":\"TokenDeployedTypes\",\"url\":\"modules.html#TokenDeployedTypes\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":42,\"kind\":4194304,\"name\":\"TokenDeployedArgs\",\"url\":\"modules.html#TokenDeployedArgs\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":43,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules.html#TokenDeployedArgs.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"TokenDeployedArgs\"},{\"id\":44,\"kind\":1024,\"name\":\"domain\",\"url\":\"modules.html#TokenDeployedArgs.__type.domain\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"TokenDeployedArgs.__type\"},{\"id\":45,\"kind\":1024,\"name\":\"id\",\"url\":\"modules.html#TokenDeployedArgs.__type.id\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"TokenDeployedArgs.__type\"},{\"id\":46,\"kind\":1024,\"name\":\"representation\",\"url\":\"modules.html#TokenDeployedArgs.__type.representation\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"TokenDeployedArgs.__type\"},{\"id\":47,\"kind\":4194304,\"name\":\"TokenDeployedEvent\",\"url\":\"modules.html#TokenDeployedEvent\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":48,\"kind\":4194304,\"name\":\"AnnotatedSend\",\"url\":\"modules.html#AnnotatedSend\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":49,\"kind\":4194304,\"name\":\"AnnotatedTokenDeployed\",\"url\":\"modules.html#AnnotatedTokenDeployed\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":50,\"kind\":128,\"name\":\"BridgeContext\",\"url\":\"classes/BridgeContext.html\",\"classes\":\"tsd-kind-class\"},{\"id\":51,\"kind\":2048,\"name\":\"fromNomadContext\",\"url\":\"classes/BridgeContext.html#fromNomadContext\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-static\",\"parent\":\"BridgeContext\"},{\"id\":52,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BridgeContext.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite\",\"parent\":\"BridgeContext\"},{\"id\":53,\"kind\":1024,\"name\":\"bridges\",\"url\":\"classes/BridgeContext.html#bridges\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"BridgeContext\"},{\"id\":54,\"kind\":2048,\"name\":\"reconnect\",\"url\":\"classes/BridgeContext.html#reconnect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected\",\"parent\":\"BridgeContext\"},{\"id\":55,\"kind\":2048,\"name\":\"getBridge\",\"url\":\"classes/BridgeContext.html#getBridge\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"BridgeContext\"},{\"id\":56,\"kind\":2048,\"name\":\"mustGetBridge\",\"url\":\"classes/BridgeContext.html#mustGetBridge\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"BridgeContext\"},{\"id\":57,\"kind\":2048,\"name\":\"resolveRepresentation\",\"url\":\"classes/BridgeContext.html#resolveRepresentation\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"BridgeContext\"},{\"id\":58,\"kind\":2048,\"name\":\"resolveRepresentations\",\"url\":\"classes/BridgeContext.html#resolveRepresentations\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"BridgeContext\"},{\"id\":59,\"kind\":2048,\"name\":\"resolveCanonicalIdentifier\",\"url\":\"classes/BridgeContext.html#resolveCanonicalIdentifier\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"BridgeContext\"},{\"id\":60,\"kind\":2048,\"name\":\"resolveCanonicalToken\",\"url\":\"classes/BridgeContext.html#resolveCanonicalToken\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"BridgeContext\"},{\"id\":61,\"kind\":2048,\"name\":\"send\",\"url\":\"classes/BridgeContext.html#send\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"BridgeContext\"},{\"id\":62,\"kind\":2048,\"name\":\"sendNative\",\"url\":\"classes/BridgeContext.html#sendNative\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"BridgeContext\"},{\"id\":63,\"kind\":64,\"name\":\"parseBody\",\"url\":\"modules.html#parseBody\",\"classes\":\"tsd-kind-function\"},{\"id\":64,\"kind\":4194304,\"name\":\"Action\",\"url\":\"modules.html#Action\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":65,\"kind\":4194304,\"name\":\"ParsedBridgeMessage\",\"url\":\"modules.html#ParsedBridgeMessage\",\"classes\":\"tsd-kind-type-alias tsd-has-type-parameter\"},{\"id\":66,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules.html#ParsedBridgeMessage.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"ParsedBridgeMessage\"},{\"id\":67,\"kind\":1024,\"name\":\"token\",\"url\":\"modules.html#ParsedBridgeMessage.__type.token\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ParsedBridgeMessage.__type\"},{\"id\":68,\"kind\":1024,\"name\":\"action\",\"url\":\"modules.html#ParsedBridgeMessage.__type.action\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ParsedBridgeMessage.__type\"},{\"id\":69,\"kind\":4194304,\"name\":\"AnyBridgeMessage\",\"url\":\"modules.html#AnyBridgeMessage\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":70,\"kind\":4194304,\"name\":\"ParsedTransferMessage\",\"url\":\"modules.html#ParsedTransferMessage\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":71,\"kind\":128,\"name\":\"BridgeMessage\",\"url\":\"classes/BridgeMessage.html\",\"classes\":\"tsd-kind-class\"},{\"id\":72,\"kind\":2048,\"name\":\"fromNomadMessage\",\"url\":\"classes/BridgeMessage.html#fromNomadMessage\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-static\",\"parent\":\"BridgeMessage\"},{\"id\":73,\"kind\":2048,\"name\":\"fromReceipt\",\"url\":\"classes/BridgeMessage.html#fromReceipt\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-static\",\"parent\":\"BridgeMessage\"},{\"id\":74,\"kind\":2048,\"name\":\"singleFromReceipt\",\"url\":\"classes/BridgeMessage.html#singleFromReceipt\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-static\",\"parent\":\"BridgeMessage\"},{\"id\":75,\"kind\":2048,\"name\":\"fromTransactionHash\",\"url\":\"classes/BridgeMessage.html#fromTransactionHash\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-static\",\"parent\":\"BridgeMessage\"},{\"id\":76,\"kind\":2048,\"name\":\"singleFromTransactionHash\",\"url\":\"classes/BridgeMessage.html#singleFromTransactionHash\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-static\",\"parent\":\"BridgeMessage\"},{\"id\":77,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BridgeMessage.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite\",\"parent\":\"BridgeMessage\"},{\"id\":78,\"kind\":1024,\"name\":\"token\",\"url\":\"classes/BridgeMessage.html#token\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"BridgeMessage\"},{\"id\":79,\"kind\":1024,\"name\":\"fromBridge\",\"url\":\"classes/BridgeMessage.html#fromBridge\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"BridgeMessage\"},{\"id\":80,\"kind\":1024,\"name\":\"toBridge\",\"url\":\"classes/BridgeMessage.html#toBridge\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"BridgeMessage\"},{\"id\":81,\"kind\":2048,\"name\":\"asset\",\"url\":\"classes/BridgeMessage.html#asset\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"BridgeMessage\"},{\"id\":82,\"kind\":2048,\"name\":\"assetAtOrigin\",\"url\":\"classes/BridgeMessage.html#assetAtOrigin\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"BridgeMessage\"},{\"id\":83,\"kind\":2048,\"name\":\"assetAtDestination\",\"url\":\"classes/BridgeMessage.html#assetAtDestination\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"BridgeMessage\"},{\"id\":84,\"kind\":128,\"name\":\"TransferMessage\",\"url\":\"classes/TransferMessage.html\",\"classes\":\"tsd-kind-class\"},{\"id\":85,\"kind\":2048,\"name\":\"fromNomadMessage\",\"url\":\"classes/TransferMessage.html#fromNomadMessage\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static\",\"parent\":\"TransferMessage\"},{\"id\":86,\"kind\":2048,\"name\":\"fromReceipt\",\"url\":\"classes/TransferMessage.html#fromReceipt\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static\",\"parent\":\"TransferMessage\"},{\"id\":87,\"kind\":2048,\"name\":\"singleFromReceipt\",\"url\":\"classes/TransferMessage.html#singleFromReceipt\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static\",\"parent\":\"TransferMessage\"},{\"id\":88,\"kind\":2048,\"name\":\"fromTransactionHash\",\"url\":\"classes/TransferMessage.html#fromTransactionHash\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static\",\"parent\":\"TransferMessage\"},{\"id\":89,\"kind\":2048,\"name\":\"singleFromTransactionHash\",\"url\":\"classes/TransferMessage.html#singleFromTransactionHash\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static\",\"parent\":\"TransferMessage\"},{\"id\":90,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/TransferMessage.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite\",\"parent\":\"TransferMessage\"},{\"id\":91,\"kind\":1024,\"name\":\"action\",\"url\":\"classes/TransferMessage.html#action\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"TransferMessage\"},{\"id\":92,\"kind\":2048,\"name\":\"currentlyPrefilled\",\"url\":\"classes/TransferMessage.html#currentlyPrefilled\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"TransferMessage\"},{\"id\":93,\"kind\":262144,\"name\":\"amount\",\"url\":\"classes/TransferMessage.html#amount\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"TransferMessage\"},{\"id\":94,\"kind\":262144,\"name\":\"to\",\"url\":\"classes/TransferMessage.html#to\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"TransferMessage\"},{\"id\":95,\"kind\":262144,\"name\":\"prefillId\",\"url\":\"classes/TransferMessage.html#prefillId\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"TransferMessage\"},{\"id\":96,\"kind\":1024,\"name\":\"token\",\"url\":\"classes/TransferMessage.html#token\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"TransferMessage\"},{\"id\":97,\"kind\":1024,\"name\":\"fromBridge\",\"url\":\"classes/TransferMessage.html#fromBridge\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"TransferMessage\"},{\"id\":98,\"kind\":1024,\"name\":\"toBridge\",\"url\":\"classes/TransferMessage.html#toBridge\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"TransferMessage\"},{\"id\":99,\"kind\":2048,\"name\":\"asset\",\"url\":\"classes/TransferMessage.html#asset\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"TransferMessage\"},{\"id\":100,\"kind\":2048,\"name\":\"assetAtOrigin\",\"url\":\"classes/TransferMessage.html#assetAtOrigin\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"TransferMessage\"},{\"id\":101,\"kind\":2048,\"name\":\"assetAtDestination\",\"url\":\"classes/TransferMessage.html#assetAtDestination\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"TransferMessage\"},{\"id\":102,\"kind\":4194304,\"name\":\"ResolvedTokenInfo\",\"url\":\"modules.html#ResolvedTokenInfo\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":103,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules.html#ResolvedTokenInfo.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"ResolvedTokenInfo\"},{\"id\":104,\"kind\":1024,\"name\":\"domain\",\"url\":\"modules.html#ResolvedTokenInfo.__type.domain\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ResolvedTokenInfo.__type\"},{\"id\":105,\"kind\":1024,\"name\":\"id\",\"url\":\"modules.html#ResolvedTokenInfo.__type.id\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ResolvedTokenInfo.__type\"},{\"id\":106,\"kind\":1024,\"name\":\"tokens\",\"url\":\"modules.html#ResolvedTokenInfo.__type.tokens\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ResolvedTokenInfo.__type\"},{\"id\":107,\"kind\":32,\"name\":\"tokens\",\"url\":\"modules.html#tokens\",\"classes\":\"tsd-kind-variable\"},{\"id\":108,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules.html#tokens.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"parent\":\"tokens\"},{\"id\":109,\"kind\":1024,\"name\":\"Sushi\",\"url\":\"modules.html#tokens.__type.Sushi\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"tokens.__type\"},{\"id\":110,\"kind\":1024,\"name\":\"Weth\",\"url\":\"modules.html#tokens.__type.Weth\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"tokens.__type\"},{\"id\":111,\"kind\":1024,\"name\":\"WBTC\",\"url\":\"modules.html#tokens.__type.WBTC\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"tokens.__type\"},{\"id\":112,\"kind\":1024,\"name\":\"UNI\",\"url\":\"modules.html#tokens.__type.UNI\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"tokens.__type\"},{\"id\":113,\"kind\":1024,\"name\":\"LINK\",\"url\":\"modules.html#tokens.__type.LINK\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"tokens.__type\"},{\"id\":114,\"kind\":1024,\"name\":\"USDC\",\"url\":\"modules.html#tokens.__type.USDC\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"tokens.__type\"},{\"id\":115,\"kind\":1024,\"name\":\"USDT\",\"url\":\"modules.html#tokens.__type.USDT\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"tokens.__type\"},{\"id\":116,\"kind\":1024,\"name\":\"Celo\",\"url\":\"modules.html#tokens.__type.Celo\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"tokens.__type\"},{\"id\":117,\"kind\":1024,\"name\":\"cUSD\",\"url\":\"modules.html#tokens.__type.cUSD\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"tokens.__type\"},{\"id\":118,\"kind\":1024,\"name\":\"cEUR\",\"url\":\"modules.html#tokens.__type.cEUR\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"tokens.__type\"},{\"id\":119,\"kind\":1024,\"name\":\"WMATIC\",\"url\":\"modules.html#tokens.__type.WMATIC\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"tokens.__type\"},{\"id\":120,\"kind\":32,\"name\":\"testnetTokens\",\"url\":\"modules.html#testnetTokens\",\"classes\":\"tsd-kind-variable\"},{\"id\":121,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules.html#testnetTokens.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"parent\":\"testnetTokens\"},{\"id\":122,\"kind\":1024,\"name\":\"Alfajores\",\"url\":\"modules.html#testnetTokens.__type.Alfajores\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"testnetTokens.__type\"},{\"id\":123,\"kind\":1024,\"name\":\"Kovan\",\"url\":\"modules.html#testnetTokens.__type.Kovan\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"testnetTokens.__type\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"parent\"],\"fieldVectors\":[[\"name/0\",[0,24.769]],[\"parent/0\",[]],[\"name/1\",[1,33.242]],[\"parent/1\",[0,2.276]],[\"name/2\",[2,31.236]],[\"parent/2\",[0,2.276]],[\"name/3\",[3,44.228]],[\"parent/3\",[0,2.276]],[\"name/4\",[4,44.228]],[\"parent/4\",[0,2.276]],[\"name/5\",[5,44.228]],[\"parent/5\",[0,2.276]],[\"name/6\",[6,44.228]],[\"parent/6\",[0,2.276]],[\"name/7\",[7,44.228]],[\"parent/7\",[0,2.276]],[\"name/8\",[8,44.228]],[\"parent/8\",[0,2.276]],[\"name/9\",[9,44.228]],[\"parent/9\",[0,2.276]],[\"name/10\",[10,25.77]],[\"parent/10\",[]],[\"name/11\",[11,39.12]],[\"parent/11\",[10,2.368]],[\"name/12\",[12,35.756]],[\"parent/12\",[10,2.368]],[\"name/13\",[13,26.882]],[\"parent/13\",[14,4.064]],[\"name/14\",[15,31.236]],[\"parent/14\",[16,2.87]],[\"name/15\",[17,39.12]],[\"parent/15\",[16,2.87]],[\"name/16\",[18,39.12]],[\"parent/16\",[16,2.87]],[\"name/17\",[19,39.12]],[\"parent/17\",[16,2.87]],[\"name/18\",[20,35.756]],[\"parent/18\",[16,2.87]],[\"name/19\",[21,39.12]],[\"parent/19\",[10,2.368]],[\"name/20\",[22,39.12]],[\"parent/20\",[10,2.368]],[\"name/21\",[23,35.756]],[\"parent/21\",[10,2.368]],[\"name/22\",[13,26.882]],[\"parent/22\",[24,4.064]],[\"name/23\",[2,31.236]],[\"parent/23\",[25,3.286]],[\"name/24\",[26,33.242]],[\"parent/24\",[25,3.286]],[\"name/25\",[27,39.12]],[\"parent/25\",[25,3.286]],[\"name/26\",[28,39.12]],[\"parent/26\",[10,2.368]],[\"name/27\",[29,39.12]],[\"parent/27\",[10,2.368]],[\"name/28\",[30,39.12]],[\"parent/28\",[10,2.368]],[\"name/29\",[31,35.756]],[\"parent/29\",[]],[\"name/30\",[2,31.236]],[\"parent/30\",[31,3.286]],[\"name/31\",[26,33.242]],[\"parent/31\",[31,3.286]],[\"name/32\",[11,39.12]],[\"parent/32\",[]],[\"name/33\",[12,35.756]],[\"parent/33\",[]],[\"name/34\",[13,26.882]],[\"parent/34\",[12,3.286]],[\"name/35\",[15,31.236]],[\"parent/35\",[32,2.87]],[\"name/36\",[17,39.12]],[\"parent/36\",[32,2.87]],[\"name/37\",[18,39.12]],[\"parent/37\",[32,2.87]],[\"name/38\",[19,39.12]],[\"parent/38\",[32,2.87]],[\"name/39\",[20,35.756]],[\"parent/39\",[32,2.87]],[\"name/40\",[21,39.12]],[\"parent/40\",[]],[\"name/41\",[22,39.12]],[\"parent/41\",[]],[\"name/42\",[23,35.756]],[\"parent/42\",[]],[\"name/43\",[13,26.882]],[\"parent/43\",[23,3.286]],[\"name/44\",[2,31.236]],[\"parent/44\",[33,3.286]],[\"name/45\",[26,33.242]],[\"parent/45\",[33,3.286]],[\"name/46\",[27,39.12]],[\"parent/46\",[33,3.286]],[\"name/47\",[28,39.12]],[\"parent/47\",[]],[\"name/48\",[29,39.12]],[\"parent/48\",[]],[\"name/49\",[30,39.12]],[\"parent/49\",[]],[\"name/50\",[34,22.256]],[\"parent/50\",[]],[\"name/51\",[35,44.228]],[\"parent/51\",[34,2.045]],[\"name/52\",[1,33.242]],[\"parent/52\",[34,2.045]],[\"name/53\",[36,44.228]],[\"parent/53\",[34,2.045]],[\"name/54\",[37,44.228]],[\"parent/54\",[34,2.045]],[\"name/55\",[38,44.228]],[\"parent/55\",[34,2.045]],[\"name/56\",[39,44.228]],[\"parent/56\",[34,2.045]],[\"name/57\",[40,44.228]],[\"parent/57\",[34,2.045]],[\"name/58\",[41,44.228]],[\"parent/58\",[34,2.045]],[\"name/59\",[42,44.228]],[\"parent/59\",[34,2.045]],[\"name/60\",[43,44.228]],[\"parent/60\",[34,2.045]],[\"name/61\",[44,44.228]],[\"parent/61\",[34,2.045]],[\"name/62\",[45,44.228]],[\"parent/62\",[34,2.045]],[\"name/63\",[46,44.228]],[\"parent/63\",[]],[\"name/64\",[47,35.756]],[\"parent/64\",[]],[\"name/65\",[48,39.12]],[\"parent/65\",[]],[\"name/66\",[13,26.882]],[\"parent/66\",[48,3.595]],[\"name/67\",[15,31.236]],[\"parent/67\",[49,3.595]],[\"name/68\",[47,35.756]],[\"parent/68\",[49,3.595]],[\"name/69\",[50,44.228]],[\"parent/69\",[]],[\"name/70\",[51,44.228]],[\"parent/70\",[]],[\"name/71\",[52,22.256]],[\"parent/71\",[]],[\"name/72\",[53,39.12]],[\"parent/72\",[52,2.045]],[\"name/73\",[54,39.12]],[\"parent/73\",[52,2.045]],[\"name/74\",[55,39.12]],[\"parent/74\",[52,2.045]],[\"name/75\",[56,39.12]],[\"parent/75\",[52,2.045]],[\"name/76\",[57,39.12]],[\"parent/76\",[52,2.045]],[\"name/77\",[1,33.242]],[\"parent/77\",[52,2.045]],[\"name/78\",[15,31.236]],[\"parent/78\",[52,2.045]],[\"name/79\",[58,39.12]],[\"parent/79\",[52,2.045]],[\"name/80\",[59,39.12]],[\"parent/80\",[52,2.045]],[\"name/81\",[60,39.12]],[\"parent/81\",[52,2.045]],[\"name/82\",[61,39.12]],[\"parent/82\",[52,2.045]],[\"name/83\",[62,39.12]],[\"parent/83\",[52,2.045]],[\"name/84\",[63,19.105]],[\"parent/84\",[]],[\"name/85\",[53,39.12]],[\"parent/85\",[63,1.756]],[\"name/86\",[54,39.12]],[\"parent/86\",[63,1.756]],[\"name/87\",[55,39.12]],[\"parent/87\",[63,1.756]],[\"name/88\",[56,39.12]],[\"parent/88\",[63,1.756]],[\"name/89\",[57,39.12]],[\"parent/89\",[63,1.756]],[\"name/90\",[1,33.242]],[\"parent/90\",[63,1.756]],[\"name/91\",[47,35.756]],[\"parent/91\",[63,1.756]],[\"name/92\",[64,44.228]],[\"parent/92\",[63,1.756]],[\"name/93\",[20,35.756]],[\"parent/93\",[63,1.756]],[\"name/94\",[65,44.228]],[\"parent/94\",[63,1.756]],[\"name/95\",[66,44.228]],[\"parent/95\",[63,1.756]],[\"name/96\",[15,31.236]],[\"parent/96\",[63,1.756]],[\"name/97\",[58,39.12]],[\"parent/97\",[63,1.756]],[\"name/98\",[59,39.12]],[\"parent/98\",[63,1.756]],[\"name/99\",[60,39.12]],[\"parent/99\",[63,1.756]],[\"name/100\",[61,39.12]],[\"parent/100\",[63,1.756]],[\"name/101\",[62,39.12]],[\"parent/101\",[63,1.756]],[\"name/102\",[67,39.12]],[\"parent/102\",[]],[\"name/103\",[13,26.882]],[\"parent/103\",[67,3.595]],[\"name/104\",[2,31.236]],[\"parent/104\",[68,3.286]],[\"name/105\",[26,33.242]],[\"parent/105\",[68,3.286]],[\"name/106\",[69,35.756]],[\"parent/106\",[68,3.286]],[\"name/107\",[69,35.756]],[\"parent/107\",[]],[\"name/108\",[13,26.882]],[\"parent/108\",[69,3.286]],[\"name/109\",[70,44.228]],[\"parent/109\",[71,2.193]],[\"name/110\",[72,44.228]],[\"parent/110\",[71,2.193]],[\"name/111\",[73,44.228]],[\"parent/111\",[71,2.193]],[\"name/112\",[74,44.228]],[\"parent/112\",[71,2.193]],[\"name/113\",[75,44.228]],[\"parent/113\",[71,2.193]],[\"name/114\",[76,44.228]],[\"parent/114\",[71,2.193]],[\"name/115\",[77,44.228]],[\"parent/115\",[71,2.193]],[\"name/116\",[78,44.228]],[\"parent/116\",[71,2.193]],[\"name/117\",[79,44.228]],[\"parent/117\",[71,2.193]],[\"name/118\",[80,44.228]],[\"parent/118\",[71,2.193]],[\"name/119\",[81,44.228]],[\"parent/119\",[71,2.193]],[\"name/120\",[82,39.12]],[\"parent/120\",[]],[\"name/121\",[13,26.882]],[\"parent/121\",[82,3.595]],[\"name/122\",[83,44.228]],[\"parent/122\",[84,3.595]],[\"name/123\",[85,44.228]],[\"parent/123\",[84,3.595]]],\"invertedIndex\":[[\"__type\",{\"_index\":13,\"name\":{\"13\":{},\"22\":{},\"34\":{},\"43\":{},\"66\":{},\"103\":{},\"108\":{},\"121\":{}},\"parent\":{}}],[\"action\",{\"_index\":47,\"name\":{\"64\":{},\"68\":{},\"91\":{}},\"parent\":{}}],[\"alfajores\",{\"_index\":83,\"name\":{\"122\":{}},\"parent\":{}}],[\"amount\",{\"_index\":20,\"name\":{\"18\":{},\"39\":{},\"93\":{}},\"parent\":{}}],[\"annotatedsend\",{\"_index\":29,\"name\":{\"27\":{},\"48\":{}},\"parent\":{}}],[\"annotatedtokendeployed\",{\"_index\":30,\"name\":{\"28\":{},\"49\":{}},\"parent\":{}}],[\"anybridgemessage\",{\"_index\":50,\"name\":{\"69\":{}},\"parent\":{}}],[\"asset\",{\"_index\":60,\"name\":{\"81\":{},\"99\":{}},\"parent\":{}}],[\"assetatdestination\",{\"_index\":62,\"name\":{\"83\":{},\"101\":{}},\"parent\":{}}],[\"assetatorigin\",{\"_index\":61,\"name\":{\"82\":{},\"100\":{}},\"parent\":{}}],[\"bridgecontext\",{\"_index\":34,\"name\":{\"50\":{}},\"parent\":{\"51\":{},\"52\":{},\"53\":{},\"54\":{},\"55\":{},\"56\":{},\"57\":{},\"58\":{},\"59\":{},\"60\":{},\"61\":{},\"62\":{}}}],[\"bridgecontracts\",{\"_index\":0,\"name\":{\"0\":{}},\"parent\":{\"1\":{},\"2\":{},\"3\":{},\"4\":{},\"5\":{},\"6\":{},\"7\":{},\"8\":{},\"9\":{}}}],[\"bridgeevents\",{\"_index\":10,\"name\":{\"10\":{}},\"parent\":{\"11\":{},\"12\":{},\"19\":{},\"20\":{},\"21\":{},\"26\":{},\"27\":{},\"28\":{}}}],[\"bridgeevents.sendargs\",{\"_index\":14,\"name\":{},\"parent\":{\"13\":{}}}],[\"bridgeevents.sendargs.__type\",{\"_index\":16,\"name\":{},\"parent\":{\"14\":{},\"15\":{},\"16\":{},\"17\":{},\"18\":{}}}],[\"bridgeevents.tokendeployedargs\",{\"_index\":24,\"name\":{},\"parent\":{\"22\":{}}}],[\"bridgeevents.tokendeployedargs.__type\",{\"_index\":25,\"name\":{},\"parent\":{\"23\":{},\"24\":{},\"25\":{}}}],[\"bridgemessage\",{\"_index\":52,\"name\":{\"71\":{}},\"parent\":{\"72\":{},\"73\":{},\"74\":{},\"75\":{},\"76\":{},\"77\":{},\"78\":{},\"79\":{},\"80\":{},\"81\":{},\"82\":{},\"83\":{}}}],[\"bridgerouter\",{\"_index\":6,\"name\":{\"6\":{}},\"parent\":{}}],[\"bridges\",{\"_index\":36,\"name\":{\"53\":{}},\"parent\":{}}],[\"celo\",{\"_index\":78,\"name\":{\"116\":{}},\"parent\":{}}],[\"ceur\",{\"_index\":80,\"name\":{\"118\":{}},\"parent\":{}}],[\"conf\",{\"_index\":4,\"name\":{\"4\":{}},\"parent\":{}}],[\"connect\",{\"_index\":9,\"name\":{\"9\":{}},\"parent\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{},\"52\":{},\"77\":{},\"90\":{}},\"parent\":{}}],[\"currentlyprefilled\",{\"_index\":64,\"name\":{\"92\":{}},\"parent\":{}}],[\"cusd\",{\"_index\":79,\"name\":{\"117\":{}},\"parent\":{}}],[\"deployheight\",{\"_index\":3,\"name\":{\"3\":{}},\"parent\":{}}],[\"domain\",{\"_index\":2,\"name\":{\"2\":{},\"23\":{},\"30\":{},\"44\":{},\"104\":{}},\"parent\":{}}],[\"ethhelper\",{\"_index\":8,\"name\":{\"8\":{}},\"parent\":{}}],[\"from\",{\"_index\":17,\"name\":{\"15\":{},\"36\":{}},\"parent\":{}}],[\"frombridge\",{\"_index\":58,\"name\":{\"79\":{},\"97\":{}},\"parent\":{}}],[\"fromnomadcontext\",{\"_index\":35,\"name\":{\"51\":{}},\"parent\":{}}],[\"fromnomadmessage\",{\"_index\":53,\"name\":{\"72\":{},\"85\":{}},\"parent\":{}}],[\"fromreceipt\",{\"_index\":54,\"name\":{\"73\":{},\"86\":{}},\"parent\":{}}],[\"fromtransactionhash\",{\"_index\":56,\"name\":{\"75\":{},\"88\":{}},\"parent\":{}}],[\"getbridge\",{\"_index\":38,\"name\":{\"55\":{}},\"parent\":{}}],[\"id\",{\"_index\":26,\"name\":{\"24\":{},\"31\":{},\"45\":{},\"105\":{}},\"parent\":{}}],[\"kovan\",{\"_index\":85,\"name\":{\"123\":{}},\"parent\":{}}],[\"link\",{\"_index\":75,\"name\":{\"113\":{}},\"parent\":{}}],[\"mustgetbridge\",{\"_index\":39,\"name\":{\"56\":{}},\"parent\":{}}],[\"parsebody\",{\"_index\":46,\"name\":{\"63\":{}},\"parent\":{}}],[\"parsedbridgemessage\",{\"_index\":48,\"name\":{\"65\":{}},\"parent\":{\"66\":{}}}],[\"parsedbridgemessage.__type\",{\"_index\":49,\"name\":{},\"parent\":{\"67\":{},\"68\":{}}}],[\"parsedtransfermessage\",{\"_index\":51,\"name\":{\"70\":{}},\"parent\":{}}],[\"prefillid\",{\"_index\":66,\"name\":{\"95\":{}},\"parent\":{}}],[\"providerorsigner\",{\"_index\":5,\"name\":{\"5\":{}},\"parent\":{}}],[\"reconnect\",{\"_index\":37,\"name\":{\"54\":{}},\"parent\":{}}],[\"representation\",{\"_index\":27,\"name\":{\"25\":{},\"46\":{}},\"parent\":{}}],[\"resolvecanonicalidentifier\",{\"_index\":42,\"name\":{\"59\":{}},\"parent\":{}}],[\"resolvecanonicaltoken\",{\"_index\":43,\"name\":{\"60\":{}},\"parent\":{}}],[\"resolvedtokeninfo\",{\"_index\":67,\"name\":{\"102\":{}},\"parent\":{\"103\":{}}}],[\"resolvedtokeninfo.__type\",{\"_index\":68,\"name\":{},\"parent\":{\"104\":{},\"105\":{},\"106\":{}}}],[\"resolverepresentation\",{\"_index\":40,\"name\":{\"57\":{}},\"parent\":{}}],[\"resolverepresentations\",{\"_index\":41,\"name\":{\"58\":{}},\"parent\":{}}],[\"send\",{\"_index\":44,\"name\":{\"61\":{}},\"parent\":{}}],[\"sendargs\",{\"_index\":12,\"name\":{\"12\":{},\"33\":{}},\"parent\":{\"34\":{}}}],[\"sendargs.__type\",{\"_index\":32,\"name\":{},\"parent\":{\"35\":{},\"36\":{},\"37\":{},\"38\":{},\"39\":{}}}],[\"sendevent\",{\"_index\":21,\"name\":{\"19\":{},\"40\":{}},\"parent\":{}}],[\"sendnative\",{\"_index\":45,\"name\":{\"62\":{}},\"parent\":{}}],[\"sendtypes\",{\"_index\":11,\"name\":{\"11\":{},\"32\":{}},\"parent\":{}}],[\"singlefromreceipt\",{\"_index\":55,\"name\":{\"74\":{},\"87\":{}},\"parent\":{}}],[\"singlefromtransactionhash\",{\"_index\":57,\"name\":{\"76\":{},\"89\":{}},\"parent\":{}}],[\"sushi\",{\"_index\":70,\"name\":{\"109\":{}},\"parent\":{}}],[\"testnettokens\",{\"_index\":82,\"name\":{\"120\":{}},\"parent\":{\"121\":{}}}],[\"testnettokens.__type\",{\"_index\":84,\"name\":{},\"parent\":{\"122\":{},\"123\":{}}}],[\"to\",{\"_index\":65,\"name\":{\"94\":{}},\"parent\":{}}],[\"tobridge\",{\"_index\":59,\"name\":{\"80\":{},\"98\":{}},\"parent\":{}}],[\"todomain\",{\"_index\":18,\"name\":{\"16\":{},\"37\":{}},\"parent\":{}}],[\"toid\",{\"_index\":19,\"name\":{\"17\":{},\"38\":{}},\"parent\":{}}],[\"token\",{\"_index\":15,\"name\":{\"14\":{},\"35\":{},\"67\":{},\"78\":{},\"96\":{}},\"parent\":{}}],[\"tokendeployedargs\",{\"_index\":23,\"name\":{\"21\":{},\"42\":{}},\"parent\":{\"43\":{}}}],[\"tokendeployedargs.__type\",{\"_index\":33,\"name\":{},\"parent\":{\"44\":{},\"45\":{},\"46\":{}}}],[\"tokendeployedevent\",{\"_index\":28,\"name\":{\"26\":{},\"47\":{}},\"parent\":{}}],[\"tokendeployedtypes\",{\"_index\":22,\"name\":{\"20\":{},\"41\":{}},\"parent\":{}}],[\"tokenidentifier\",{\"_index\":31,\"name\":{\"29\":{}},\"parent\":{\"30\":{},\"31\":{}}}],[\"tokenregistry\",{\"_index\":7,\"name\":{\"7\":{}},\"parent\":{}}],[\"tokens\",{\"_index\":69,\"name\":{\"106\":{},\"107\":{}},\"parent\":{\"108\":{}}}],[\"tokens.__type\",{\"_index\":71,\"name\":{},\"parent\":{\"109\":{},\"110\":{},\"111\":{},\"112\":{},\"113\":{},\"114\":{},\"115\":{},\"116\":{},\"117\":{},\"118\":{},\"119\":{}}}],[\"transfermessage\",{\"_index\":63,\"name\":{\"84\":{}},\"parent\":{\"85\":{},\"86\":{},\"87\":{},\"88\":{},\"89\":{},\"90\":{},\"91\":{},\"92\":{},\"93\":{},\"94\":{},\"95\":{},\"96\":{},\"97\":{},\"98\":{},\"99\":{},\"100\":{},\"101\":{}}}],[\"uni\",{\"_index\":74,\"name\":{\"112\":{}},\"parent\":{}}],[\"usdc\",{\"_index\":76,\"name\":{\"114\":{}},\"parent\":{}}],[\"usdt\",{\"_index\":77,\"name\":{\"115\":{}},\"parent\":{}}],[\"wbtc\",{\"_index\":73,\"name\":{\"111\":{}},\"parent\":{}}],[\"weth\",{\"_index\":72,\"name\":{\"110\":{}},\"parent\":{}}],[\"wmatic\",{\"_index\":81,\"name\":{\"119\":{}},\"parent\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/public/sdk-bridge/assets/style.css b/docs/public/sdk-bridge/assets/style.css deleted file mode 100644 index a16ed02..0000000 --- a/docs/public/sdk-bridge/assets/style.css +++ /dev/null @@ -1,1413 +0,0 @@ -@import url("./icons.css"); - -:root { - /* Light */ - --light-color-background: #fcfcfc; - --light-color-secondary-background: #fff; - --light-color-text: #222; - --light-color-text-aside: #707070; - --light-color-link: #4da6ff; - --light-color-menu-divider: #eee; - --light-color-menu-divider-focus: #000; - --light-color-menu-label: #707070; - --light-color-panel: var(--light-color-secondary-background); - --light-color-panel-divider: #eee; - --light-color-comment-tag: #707070; - --light-color-comment-tag-text: #fff; - --light-color-ts: #9600ff; - --light-color-ts-interface: #647f1b; - --light-color-ts-enum: #937210; - --light-color-ts-class: #0672de; - --light-color-ts-private: #707070; - --light-color-toolbar: #fff; - --light-color-toolbar-text: #333; - --light-icon-filter: invert(0); - --light-external-icon: url("data:image/svg+xml;utf8,"); - - /* Dark */ - --dark-color-background: #36393f; - --dark-color-secondary-background: #2f3136; - --dark-color-text: #ffffff; - --dark-color-text-aside: #e6e4e4; - --dark-color-link: #00aff4; - --dark-color-menu-divider: #eee; - --dark-color-menu-divider-focus: #000; - --dark-color-menu-label: #707070; - --dark-color-panel: var(--dark-color-secondary-background); - --dark-color-panel-divider: #818181; - --dark-color-comment-tag: #dcddde; - --dark-color-comment-tag-text: #2f3136; - --dark-color-ts: #c97dff; - --dark-color-ts-interface: #9cbe3c; - --dark-color-ts-enum: #d6ab29; - --dark-color-ts-class: #3695f3; - --dark-color-ts-private: #e2e2e2; - --dark-color-toolbar: #34373c; - --dark-color-toolbar-text: #ffffff; - --dark-icon-filter: invert(1); - --dark-external-icon: url("data:image/svg+xml;utf8,"); -} - -@media (prefers-color-scheme: light) { - :root { - --color-background: var(--light-color-background); - --color-secondary-background: var(--light-color-secondary-background); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - --color-menu-divider: var(--light-color-menu-divider); - --color-menu-divider-focus: var(--light-color-menu-divider-focus); - --color-menu-label: var(--light-color-menu-label); - --color-panel: var(--light-color-panel); - --color-panel-divider: var(--light-color-panel-divider); - --color-comment-tag: var(--light-color-comment-tag); - --color-comment-tag-text: var(--light-color-comment-tag-text); - --color-ts: var(--light-color-ts); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-class: var(--light-color-ts-class); - --color-ts-private: var(--light-color-ts-private); - --color-toolbar: var(--light-color-toolbar); - --color-toolbar-text: var(--light-color-toolbar-text); - --icon-filter: var(--light-icon-filter); - --external-icon: var(--light-external-icon); - } -} - -@media (prefers-color-scheme: dark) { - :root { - --color-background: var(--dark-color-background); - --color-secondary-background: var(--dark-color-secondary-background); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - --color-menu-divider: var(--dark-color-menu-divider); - --color-menu-divider-focus: var(--dark-color-menu-divider-focus); - --color-menu-label: var(--dark-color-menu-label); - --color-panel: var(--dark-color-panel); - --color-panel-divider: var(--dark-color-panel-divider); - --color-comment-tag: var(--dark-color-comment-tag); - --color-comment-tag-text: var(--dark-color-comment-tag-text); - --color-ts: var(--dark-color-ts); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-private: var(--dark-color-ts-private); - --color-toolbar: var(--dark-color-toolbar); - --color-toolbar-text: var(--dark-color-toolbar-text); - --icon-filter: var(--dark-icon-filter); - --external-icon: var(--dark-external-icon); - } -} - -body { - margin: 0; -} - -body.light { - --color-background: var(--light-color-background); - --color-secondary-background: var(--light-color-secondary-background); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - --color-menu-divider: var(--light-color-menu-divider); - --color-menu-divider-focus: var(--light-color-menu-divider-focus); - --color-menu-label: var(--light-color-menu-label); - --color-panel: var(--light-color-panel); - --color-panel-divider: var(--light-color-panel-divider); - --color-comment-tag: var(--light-color-comment-tag); - --color-comment-tag-text: var(--light-color-comment-tag-text); - --color-ts: var(--light-color-ts); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-class: var(--light-color-ts-class); - --color-ts-private: var(--light-color-ts-private); - --color-toolbar: var(--light-color-toolbar); - --color-toolbar-text: var(--light-color-toolbar-text); - --icon-filter: var(--light-icon-filter); - --external-icon: var(--light-external-icon); -} - -body.dark { - --color-background: var(--dark-color-background); - --color-secondary-background: var(--dark-color-secondary-background); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - --color-menu-divider: var(--dark-color-menu-divider); - --color-menu-divider-focus: var(--dark-color-menu-divider-focus); - --color-menu-label: var(--dark-color-menu-label); - --color-panel: var(--dark-color-panel); - --color-panel-divider: var(--dark-color-panel-divider); - --color-comment-tag: var(--dark-color-comment-tag); - --color-comment-tag-text: var(--dark-color-comment-tag-text); - --color-ts: var(--dark-color-ts); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-private: var(--dark-color-ts-private); - --color-toolbar: var(--dark-color-toolbar); - --color-toolbar-text: var(--dark-color-toolbar-text); - --icon-filter: var(--dark-icon-filter); - --external-icon: var(--dark-external-icon); -} - -h1, -h2, -h3, -h4, -h5, -h6 { - line-height: 1.2; -} - -h1 { - font-size: 2em; - margin: 0.67em 0; -} - -h2 { - font-size: 1.5em; - margin: 0.83em 0; -} - -h3 { - font-size: 1.17em; - margin: 1em 0; -} - -h4, -.tsd-index-panel h3 { - font-size: 1em; - margin: 1.33em 0; -} - -h5 { - font-size: 0.83em; - margin: 1.67em 0; -} - -h6 { - font-size: 0.67em; - margin: 2.33em 0; -} - -pre { - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; -} - -dl, -menu, -ol, -ul { - margin: 1em 0; -} - -dd { - margin: 0 0 0 40px; -} - -.container { - max-width: 1200px; - margin: 0 auto; - padding: 0 40px; -} -@media (max-width: 640px) { - .container { - padding: 0 20px; - } -} - -.container-main { - padding-bottom: 200px; -} - -.row { - display: flex; - position: relative; - margin: 0 -10px; -} -.row:after { - visibility: hidden; - display: block; - content: ""; - clear: both; - height: 0; -} - -.col-4, -.col-8 { - box-sizing: border-box; - float: left; - padding: 0 10px; -} - -.col-4 { - width: 33.3333333333%; -} -.col-8 { - width: 66.6666666667%; -} - -ul.tsd-descriptions > li > :first-child, -.tsd-panel > :first-child, -.col-8 > :first-child, -.col-4 > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child, -.tsd-panel > :first-child > :first-child, -.col-8 > :first-child > :first-child, -.col-4 > :first-child > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child > :first-child, -.tsd-panel > :first-child > :first-child > :first-child, -.col-8 > :first-child > :first-child > :first-child, -.col-4 > :first-child > :first-child > :first-child { - margin-top: 0; -} -ul.tsd-descriptions > li > :last-child, -.tsd-panel > :last-child, -.col-8 > :last-child, -.col-4 > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child, -.tsd-panel > :last-child > :last-child, -.col-8 > :last-child > :last-child, -.col-4 > :last-child > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child > :last-child, -.tsd-panel > :last-child > :last-child > :last-child, -.col-8 > :last-child > :last-child > :last-child, -.col-4 > :last-child > :last-child > :last-child { - margin-bottom: 0; -} - -@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 shift-to-left { - from { - transform: translate(0, 0); - } - to { - transform: translate(-25%, 0); - } -} -@keyframes unshift-to-left { - from { - transform: translate(-25%, 0); - } - to { - transform: translate(0, 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: 14px; -} - -pre { - padding: 10px; -} -pre code { - padding: 0; - font-size: 100%; -} - -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 h4, -.tsd-typography .tsd-index-panel h3, -.tsd-index-panel .tsd-typography h3, -.tsd-typography h5, -.tsd-typography h6 { - font-size: 1em; - margin: 0; -} -.tsd-typography h5, -.tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, -.tsd-typography ul, -.tsd-typography ol { - margin: 1em 0; -} - -@media (min-width: 901px) and (max-width: 1024px) { - html .col-content { - width: 72%; - } - html .col-menu { - width: 28%; - } - html .tsd-navigation { - padding-left: 10px; - } -} -@media (max-width: 900px) { - html .col-content { - float: none; - width: 100%; - } - html .col-menu { - position: fixed !important; - overflow: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - width: 100%; - padding: 20px 20px 0 0; - max-width: 450px; - visibility: hidden; - background-color: var(--color-panel); - transform: translate(100%, 0); - } - html .col-menu > *: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 :is(header, footer, .col-content) { - animation: shift-to-left 0.4s; - } - - .to-has-menu .col-menu { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu :is(header, footer, .col-content) { - animation: unshift-to-left 0.4s; - } - - .from-has-menu .col-menu { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu :is(header, footer, .col-content) { - transform: translate(-25%, 0); - } - .has-menu .col-menu { - visibility: visible; - transform: translate(0, 0); - display: grid; - grid-template-rows: auto 1fr; - max-height: 100vh; - } - .has-menu .tsd-navigation { - max-height: 100%; - } -} - -.tsd-page-title { - padding: 70px 0 20px 0; - margin: 0 0 40px 0; - background: var(--color-panel); - box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); -} -.tsd-page-title h1 { - margin: 0; -} - -.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: " / "; -} - -dl.tsd-comment-tags { - overflow: hidden; -} -dl.tsd-comment-tags dt { - float: left; - padding: 1px 5px; - margin: 0 10px 0 0; - border-radius: 4px; - border: 1px solid var(--color-comment-tag); - color: var(--color-comment-tag); - font-size: 0.8em; - font-weight: normal; -} -dl.tsd-comment-tags dd { - margin: 0 0 10px 0; -} -dl.tsd-comment-tags dd:before, -dl.tsd-comment-tags dd:after { - display: table; - content: " "; -} -dl.tsd-comment-tags dd pre, -dl.tsd-comment-tags dd:after { - clear: both; -} -dl.tsd-comment-tags 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; -} - -.toggle-protected .tsd-is-private { - display: none; -} - -.toggle-public .tsd-is-private, -.toggle-public .tsd-is-protected, -.toggle-public .tsd-is-private-protected { - display: none; -} - -.toggle-inherited .tsd-is-inherited { - display: none; -} - -.toggle-externals .tsd-is-external { - display: none; -} - -#tsd-filter { - position: relative; - display: inline-block; - height: 40px; - vertical-align: bottom; -} -.no-filter #tsd-filter { - display: none; -} -#tsd-filter .tsd-filter-group { - display: inline-block; - height: 40px; - vertical-align: bottom; - white-space: nowrap; -} -#tsd-filter input { - display: none; -} -@media (max-width: 900px) { - #tsd-filter .tsd-filter-group { - display: block; - position: absolute; - top: 40px; - right: 20px; - height: auto; - background-color: var(--color-panel); - visibility: hidden; - transform: translate(50%, 0); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - } - .has-options #tsd-filter .tsd-filter-group { - visibility: visible; - } - .to-has-options #tsd-filter .tsd-filter-group { - animation: fade-in 0.2s; - } - .from-has-options #tsd-filter .tsd-filter-group { - animation: fade-out 0.2s; - } - #tsd-filter label, - #tsd-filter .tsd-select { - display: block; - padding-right: 20px; - } -} - -footer { - border-top: 1px solid var(--color-panel-divider); - background-color: var(--color-panel); -} -footer:after { - content: ""; - display: table; -} -footer.with-border-bottom { - border-bottom: 1px solid var(--color-panel-divider); -} -footer .tsd-legend-group { - font-size: 0; -} -footer .tsd-legend { - display: inline-block; - width: 25%; - padding: 0; - font-size: 16px; - list-style: none; - line-height: 1.333em; - vertical-align: top; -} -@media (max-width: 900px) { - footer .tsd-legend { - width: 50%; - } -} - -.tsd-hierarchy { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} - -.tsd-index-panel .tsd-index-content { - margin-bottom: -30px !important; -} -.tsd-index-panel .tsd-index-section { - margin-bottom: 30px !important; -} -.tsd-index-panel h3 { - margin: 0 -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 3; - -moz-column-count: 3; - -ms-column-count: 3; - -o-column-count: 3; - column-count: 3; - -webkit-column-gap: 20px; - -moz-column-gap: 20px; - -ms-column-gap: 20px; - -o-column-gap: 20px; - column-gap: 20px; - padding: 0; - list-style: none; - line-height: 1.333em; -} -@media (max-width: 900px) { - .tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 1; - -moz-column-count: 1; - -ms-column-count: 1; - -o-column-count: 1; - column-count: 1; - } -} -@media (min-width: 901px) and (max-width: 1024px) { - .tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 2; - -moz-column-count: 2; - -ms-column-count: 2; - -o-column-count: 2; - column-count: 2; - } -} -.tsd-index-panel ul.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-index-panel a, -.tsd-index-panel .tsd-parent-kind-module a { - color: var(--color-ts); -} -.tsd-index-panel .tsd-parent-kind-interface a { - color: var(--color-ts-interface); -} -.tsd-index-panel .tsd-parent-kind-enum a { - color: var(--color-ts-enum); -} -.tsd-index-panel .tsd-parent-kind-class a { - color: var(--color-ts-class); -} -.tsd-index-panel .tsd-kind-module a { - color: var(--color-ts); -} -.tsd-index-panel .tsd-kind-interface a { - color: var(--color-ts-interface); -} -.tsd-index-panel .tsd-kind-enum a { - color: var(--color-ts-enum); -} -.tsd-index-panel .tsd-kind-class a { - color: var(--color-ts-class); -} -.tsd-index-panel .tsd-is-private a { - color: var(--color-ts-private); -} - -.tsd-flag { - display: inline-block; - padding: 1px 5px; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 14px; - font-weight: normal; -} - -.tsd-anchor { - position: absolute; - top: -100px; -} - -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} -.tsd-member [data-tsd-kind] { - color: var(--color-ts); -} -.tsd-member [data-tsd-kind="Interface"] { - color: var(--color-ts-interface); -} -.tsd-member [data-tsd-kind="Enum"] { - color: var(--color-ts-enum); -} -.tsd-member [data-tsd-kind="Class"] { - color: var(--color-ts-class); -} -.tsd-member [data-tsd-kind="Private"] { - color: var(--color-ts-private); -} - -.tsd-navigation { - margin: 0 0 0 40px; -} -.tsd-navigation a { - display: block; - padding-top: 2px; - padding-bottom: 2px; - border-left: 2px solid transparent; - color: var(--color-text); - text-decoration: none; - transition: border-left-color 0.1s; -} -.tsd-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul { - margin: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li { - padding: 0; -} - -.tsd-navigation.primary { - padding-bottom: 40px; -} -.tsd-navigation.primary a { - display: block; - padding-top: 6px; - padding-bottom: 6px; -} -.tsd-navigation.primary ul li a { - padding-left: 5px; -} -.tsd-navigation.primary ul li li a { - padding-left: 25px; -} -.tsd-navigation.primary ul li li li a { - padding-left: 45px; -} -.tsd-navigation.primary ul li li li li a { - padding-left: 65px; -} -.tsd-navigation.primary ul li li li li li a { - padding-left: 85px; -} -.tsd-navigation.primary ul li li li li li li a { - padding-left: 105px; -} -.tsd-navigation.primary > ul { - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-navigation.primary li { - border-top: 1px solid var(--color-panel-divider); -} -.tsd-navigation.primary li.current > a { - font-weight: bold; -} -.tsd-navigation.primary li.label span { - display: block; - padding: 20px 0 6px 5px; - color: var(--color-menu-label); -} -.tsd-navigation.primary li.globals + li > span, -.tsd-navigation.primary li.globals + li > a { - padding-top: 20px; -} - -.tsd-navigation.secondary { - max-height: calc(100vh - 1rem - 40px); - overflow: auto; - position: sticky; - top: calc(0.5rem + 40px); - transition: 0.3s; -} -.tsd-navigation.secondary.tsd-navigation--toolbar-hide { - max-height: calc(100vh - 1rem); - top: 0.5rem; -} -.tsd-navigation.secondary ul { - transition: opacity 0.2s; -} -.tsd-navigation.secondary ul li a { - padding-left: 25px; -} -.tsd-navigation.secondary ul li li a { - padding-left: 45px; -} -.tsd-navigation.secondary ul li li li a { - padding-left: 65px; -} -.tsd-navigation.secondary ul li li li li a { - padding-left: 85px; -} -.tsd-navigation.secondary ul li li li li li a { - padding-left: 105px; -} -.tsd-navigation.secondary ul li li li li li li a { - padding-left: 125px; -} -.tsd-navigation.secondary ul.current a { - border-left-color: var(--color-panel-divider); -} -.tsd-navigation.secondary li.focus > a, -.tsd-navigation.secondary ul.current li.focus > a { - border-left-color: var(--color-menu-divider-focus); -} -.tsd-navigation.secondary li.current { - margin-top: 20px; - margin-bottom: 20px; - border-left-color: var(--color-panel-divider); -} -.tsd-navigation.secondary li.current > a { - font-weight: bold; -} - -@media (min-width: 901px) { - .menu-sticky-wrap { - position: static; - } -} - -.tsd-panel { - margin: 20px 0; - padding: 20px; - background-color: var(--color-panel); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, -.tsd-panel > h2, -.tsd-panel > h3 { - margin: 1.5em -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-panel > h1.tsd-before-signature, -.tsd-panel > h2.tsd-before-signature, -.tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: 0; -} -.tsd-panel table { - display: block; - width: 100%; - overflow: auto; - margin-top: 10px; - word-break: normal; - word-break: keep-all; - border-collapse: collapse; -} -.tsd-panel table th { - font-weight: bold; -} -.tsd-panel table th, -.tsd-panel table td { - padding: 6px 13px; - border: 1px solid var(--color-panel-divider); -} -.tsd-panel table tr { - background: var(--color-background); -} -.tsd-panel table tr:nth-child(even) { - background: var(--color-secondary-background); -} - -.tsd-panel-group { - margin: 60px 0; -} -.tsd-panel-group > h1, -.tsd-panel-group > h2, -.tsd-panel-group > h3 { - padding-left: 20px; - padding-right: 20px; -} - -#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: 40px; - height: 40px; -} -#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 { - 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 { - padding: 0 10px; - background-color: var(--color-background); -} -#tsd-search .results li:nth-child(even) { - background-color: var(--color-panel); -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current, -#tsd-search .results li:hover { - background-color: var(--color-panel-divider); -} -#tsd-search .results a { - display: block; -} -#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-panel-divider); -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title { - 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-signature { - margin: 0 0 1em 0; - padding: 10px; - border: 1px solid var(--color-panel-divider); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; -} -.tsd-signature.tsd-kind-icon { - padding-left: 30px; -} -.tsd-signature.tsd-kind-icon:before { - top: 10px; - left: 10px; -} -.tsd-panel > .tsd-signature { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; -} -.tsd-panel > .tsd-signature.tsd-kind-icon { - padding-left: 40px; -} -.tsd-panel > .tsd-signature.tsd-kind-icon:before { - left: 20px; -} - -.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; - border: 1px solid var(--color-panel-divider); -} -.tsd-signatures .tsd-signature { - margin: 0; - border-width: 1px 0 0 0; - transition: background-color 0.1s; -} -.tsd-signatures .tsd-signature:first-child { - border-top-width: 0; -} -.tsd-signatures .tsd-signature.current { - background-color: var(--color-panel-divider); -} -.tsd-signatures.active > .tsd-signature { - cursor: pointer; -} -.tsd-panel > .tsd-signatures { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; -} -.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { - padding-left: 40px; -} -.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { - left: 20px; -} -.tsd-panel > a.anchor + .tsd-signatures { - border-top-width: 0; - margin-top: -20px; -} - -ul.tsd-descriptions { - position: relative; - overflow: hidden; - padding: 0; - list-style: none; -} -ul.tsd-descriptions.active > .tsd-description { - display: none; -} -ul.tsd-descriptions.active > .tsd-description.current { - display: block; -} -ul.tsd-descriptions.active > .tsd-description.fade-in { - animation: fade-in-delayed 0.3s; -} -ul.tsd-descriptions.active > .tsd-description.fade-out { - animation: fade-out-delayed 0.3s; - position: absolute; - display: block; - top: 0; - left: 0; - right: 0; - opacity: 0; - visibility: hidden; -} -ul.tsd-descriptions h4, -ul.tsd-descriptions .tsd-index-panel h3, -.tsd-index-panel ul.tsd-descriptions h3 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} - -ul.tsd-parameters, -ul.tsd-type-parameters { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameters > li.tsd-parameter-signature, -ul.tsd-type-parameters > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameters h5, -ul.tsd-type-parameters h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -ul.tsd-parameters .tsd-comment, -ul.tsd-type-parameters .tsd-comment { - margin-top: -0.5em; -} - -.tsd-sources { - font-size: 14px; - color: var(--color-text-aside); - margin: 0 0 1em 0; -} -.tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; -} -.tsd-sources ul, -.tsd-sources p { - margin: 0 !important; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: fixed; - z-index: 1; - top: 0; - left: 0; - width: 100%; - height: 40px; - color: var(--color-toolbar-text); - background: var(--color-toolbar); - border-bottom: 1px solid var(--color-panel-divider); - transition: transform 0.3s linear; -} -.tsd-page-toolbar a { - color: var(--color-toolbar-text); - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .table-wrap { - display: table; - width: 100%; - height: 40px; -} -.tsd-page-toolbar .table-cell { - display: table-cell; - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} - -.tsd-page-toolbar--hide { - transform: translateY(-100%); -} - -.tsd-select .tsd-select-list li:before, -.tsd-select .tsd-select-label:before, -.tsd-widget:before { - content: ""; - display: inline-block; - width: 40px; - height: 40px; - margin: 0 -8px 0 0; - background-image: url(./widgets.png); - background-repeat: no-repeat; - text-indent: -1024px; - vertical-align: bottom; - filter: var(--icon-filter); -} -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-select .tsd-select-list li:before, - .tsd-select .tsd-select-label:before, - .tsd-widget:before { - background-image: url(./widgets@2x.png); - background-size: 320px 40px; - } -} - -.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-panel-divider); -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} -.tsd-widget.search:before { - background-position: 0 0; -} -.tsd-widget.menu:before { - background-position: -40px 0; -} -.tsd-widget.options:before { - background-position: -80px 0; -} -.tsd-widget.options, -.tsd-widget.menu { - display: none; -} -@media (max-width: 900px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; - } -} -input[type="checkbox"] + .tsd-widget:before { - background-position: -120px 0; -} -input[type="checkbox"]:checked + .tsd-widget:before { - background-position: -160px 0; -} - -.tsd-select { - position: relative; - display: inline-block; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-select .tsd-select-label { - opacity: 0.6; - transition: opacity 0.2s; -} -.tsd-select .tsd-select-label:before { - background-position: -240px 0; -} -.tsd-select.active .tsd-select-label { - opacity: 0.8; -} -.tsd-select.active .tsd-select-list { - visibility: visible; - opacity: 1; - transition-delay: 0s; -} -.tsd-select .tsd-select-list { - position: absolute; - visibility: hidden; - top: 40px; - left: 0; - margin: 0; - padding: 0; - opacity: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - transition: visibility 0s 0.2s, opacity 0.2s; -} -.tsd-select .tsd-select-list li { - padding: 0 20px 0 0; - background-color: var(--color-background); -} -.tsd-select .tsd-select-list li:before { - background-position: 40px 0; -} -.tsd-select .tsd-select-list li:nth-child(even) { - background-color: var(--color-panel); -} -.tsd-select .tsd-select-list li:hover { - background-color: var(--color-panel-divider); -} -.tsd-select .tsd-select-list li.selected:before { - background-position: -200px 0; -} -@media (max-width: 900px) { - .tsd-select .tsd-select-list { - top: 0; - left: auto; - right: 100%; - margin-right: -5px; - } - .tsd-select .tsd-select-label:before { - background-position: -280px 0; - } -} - -img { - max-width: 100%; -} - -.tsd-anchor-icon { - margin-left: 10px; - 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; -} diff --git a/docs/public/sdk-bridge/assets/widgets.png b/docs/public/sdk-bridge/assets/widgets.png deleted file mode 100644 index c738053..0000000 Binary files a/docs/public/sdk-bridge/assets/widgets.png and /dev/null differ diff --git a/docs/public/sdk-bridge/assets/widgets@2x.png b/docs/public/sdk-bridge/assets/widgets@2x.png deleted file mode 100644 index 4bbbd57..0000000 Binary files a/docs/public/sdk-bridge/assets/widgets@2x.png and /dev/null differ diff --git a/docs/public/sdk-bridge/classes/BridgeContext.html b/docs/public/sdk-bridge/classes/BridgeContext.html deleted file mode 100644 index d921e7e..0000000 --- a/docs/public/sdk-bridge/classes/BridgeContext.html +++ /dev/null @@ -1,236 +0,0 @@ -BridgeContext | @nomad-xyz/sdk-bridge
Options
All
  • Public
  • Public/Protected
  • All
Menu
-

The BridgeContext manages connections to Nomad Bridge contracts. -It inherits from the {@link MultiProvider} and {@link NomadContext} and -ensures that its contracts always use the latest registered providers and -signers.

-

Hierarchy

  • NomadContext
    • BridgeContext

Index

Constructors

  • new BridgeContext(environment?: string | NomadConfig): BridgeContext

Properties

_blacklist: Set<number>
bridges: Map<string, BridgeContracts>
conf: NomadConfig
cores: Map<string, CoreContracts>
domains: Map<string, Domain>
providers: Map<string, Provider>
signers: Map<string, Signer>

Accessors

  • get domainNames(): string[]
  • Returns string[]

  • get domainNumbers(): number[]
  • Returns number[]

  • get governor(): NomadLocator
  • Returns NomadLocator

  • get missingProviders(): string[]
  • Returns string[]

  • get registeredDomains(): Readonly<T>[]
  • Returns Readonly<T>[]

Methods

  • blacklist(): Set<number>
  • Returns Set<number>

  • checkHome(nameOrDomain: string | number): Promise<void>
  • Parameters

    • nameOrDomain: string | number

    Returns Promise<void>

  • checkHomes(networks: (string | number)[]): Promise<void>
  • Parameters

    • networks: (string | number)[]

    Returns Promise<void>

  • clearSigners(): void
  • -

    Clear all signers from all registered domains.

    -

    Returns void

  • getAddress(nameOrDomain: string | number): Promise<undefined | string>
  • -

    Resolves the address of a Signer on a domain (or undefined, if no Signer)

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns Promise<undefined | string>

    A Promise for the address of the registered signer (if any)

    -
  • getConnection(nameOrDomain: string | number): undefined | Provider | Signer
  • -

    Returns the most privileged connection registered to a domain. E.g. -this function will attempt to return a Signer, then attempt to return the -Provider (if no Signer is registered). If neither Signer nor Provider is -registered for a domain, it will return undefined

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns undefined | Provider | Signer

    A Signer (if any), otherwise a Provider (if any), otherwise - undefined

    -
  • getCore(nameOrDomain: string | number): undefined | CoreContracts
  • -

    Get the {@link CoreContracts} for a given domain (or undefined)

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns undefined | CoreContracts

    a {@link CoreContracts} object (or undefined)

    -
  • getDomain(nameOrDomain: string | number): undefined | Domain
  • -

    Get the registered {@link Domain} object (if any)

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns undefined | Domain

    A {@link Domain} (if the domain has been registered)

    -
  • getProvider(nameOrDomain: string | number): undefined | Provider
  • -

    Get the Provider associated with a doman (if any)

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns undefined | Provider

    The currently registered Provider (or none)

    -
  • getReplicaFor(home: string | number, remote: string | number): undefined | Replica
  • -

    Resolve the replica for the Home domain on the Remote domain (if any).

    -

    WARNING: do not hold references to this contract, as it will not be -reconnected in the event the chain connection changes.

    -

    Parameters

    • home: string | number
      -

      the sending domain

      -
    • remote: string | number
      -

      the receiving domain

      -

    Returns undefined | Replica

    An interface for the Replica (if any)

    -
  • getSigner(nameOrDomain: string | number): undefined | Signer
  • -

    Return the signer registered to a domain (if any).

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns undefined | Signer

    The registered signer (or undefined)

    -
  • governorCore(): Promise<CoreContracts>
  • -

    Discovers the governor domain of this nomad deployment and returns the -associated Core.

    -

    Returns Promise<CoreContracts>

    The identifier of the governing domain

    -
  • knownDomain(nameOrDomain: string | number): boolean
  • -

    Check whether the {@link MultiProvider} is aware of a domain.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns boolean

    true if the {@link Domain} has been registered, else false.

    -
  • mustGetConnection(nameOrDomain: string | number): Provider | Signer
  • -

    Get the Connection associated with a doman (or error)

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns Provider | Signer

    A Signer

    -
  • mustGetCore(nameOrDomain: string | number): CoreContracts
  • -

    Get the {@link CoreContracts} for a given domain (or throw an error)

    -
    throws

    if no {@link CoreContracts} object exists on that domain.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns CoreContracts

    a {@link CoreContracts} object

    -
  • mustGetDomain(nameOrDomain: string | number): Domain
  • -

    Get the registered {@link Domain} object (or error)

    -
    throws

    if the domain has not been registered

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns Domain

    A {@link Domain}

    -
  • mustGetProvider(nameOrDomain: string | number): Provider
  • -

    Get the Provider associated with a doman (or error)

    -
    throws

    If no provider has been registered for the specified domain

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns Provider

    A Provider

    -
  • mustGetReplicaFor(home: string | number, remote: string | number): Replica
  • -

    Resolve the replica for the Home domain on the Remote domain (or throws).

    -

    WARNING: do not hold references to this contract, as it will not be -reconnected in the event the chain connection changes.

    -
    throws

    If no replica is found.

    -

    Parameters

    • home: string | number
      -

      the sending domain

      -
    • remote: string | number
      -

      the receiving domain

      -

    Returns Replica

    An interface for the Replica

    -
  • mustGetSigner(nameOrDomain: string | number): Signer
  • -

    Get the Signer associated with a doman (or error)

    -
    throws

    If no provider has been registered for the specified domain

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns Signer

    A Signer

    -
  • reconnect(nameOrDomain: string | number): void
  • -

    Ensure that the contracts on a given domain are connected to the -currently-registered signer or provider.

    -

    Parameters

    • nameOrDomain: string | number

    Returns void

  • registerDomain(domain: Domain): void
  • -

    Resgister a domain with the MultiProvider. This allows the multiprovider -to resolves tha domain info, and reference it by name or number.

    -

    Parameters

    • domain: Domain
      -

      The Domain object to register.

      -

    Returns void

  • registerProvider(nameOrDomain: string | number, provider: Provider): void
  • -

    Register an ethers Provider for a specified domain.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -
    • provider: Provider
      -

      An ethers Provider to be used by requests to that domain.

      -

    Returns void

  • registerRpcProvider(nameOrDomain: string | number, rpc: string): void
  • -

    Shortcut to register a provider by its HTTP RPC URL.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -
    • rpc: string
      -

      The HTTP RPC Url

      -

    Returns void

  • registerSigner(nameOrDomain: string | number, signer: Signer): void
  • -

    Register an ethers Signer for a specified domain.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -
    • signer: Signer
      -

      An ethers Signer to be used by requests to that domain.

      -

    Returns void

  • registerWalletSigner(nameOrDomain: string | number, privkey: string): void
  • -

    A shortcut for registering a basic local privkey signer on a domain.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -
    • privkey: string
      -

      A private key string passed to ethers.Wallet

      -

    Returns void

  • resolveCanonicalIdentifier(nameOrDomain: string | number, representation: string): Promise<TokenIdentifier>
  • -

    Resolve the canonical domain and identifier for a representation on some -domain.

    -
    throws

    If the token is unknown to the bridge router on its domain.

    -

    Parameters

    • nameOrDomain: string | number
      -

      The domain hosting the representation

      -
    • representation: string
      -

      The address of the representation on that domain

      -

    Returns Promise<TokenIdentifier>

    The domain and ID for the canonical token

    -
  • resolveCanonicalToken(nameOrDomain: string | number, representation: string): Promise<BridgeToken>
  • -

    Resolve an interface for the canonical token corresponding to a -representation on some domain.

    -
    throws

    If the token is unknown to the bridge router on its domain.

    -

    Parameters

    • nameOrDomain: string | number
      -

      The domain hosting the representation

      -
    • representation: string
      -

      The address of the representation on that domain

      -

    Returns Promise<BridgeToken>

    An interface for that token

    -
  • resolveDomain(nameOrDomain: string | number): number
  • -

    Resolve a domain name (or number) to the canonical number.

    -

    This function is used extensively to disambiguate domains.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns number

    The canonical domain number.

    -
  • resolveDomainName(nameOrDomain: string | number): string
  • -

    Resolve the name of a registered {@link Domain}, from its name or number.

    -

    Similar to resolveDomain.

    -
    throws

    If the domain is unknown

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns string

    The name

    -
  • resolveRepresentation(nameOrDomain: string | number, token: TokenIdentifier): Promise<undefined | BridgeToken>
  • -

    Resolve the local representation of a token on some domain. E.g. find the -deployed Celo address of Ethereum's Sushi Token.

    -

    WARNING: do not hold references to this contract, as it will not be -reconnected in the event the chain connection changes.

    -

    Parameters

    • nameOrDomain: string | number
      -

      the target domain, which hosts the representation

      -
    • token: TokenIdentifier
      -

      The token to locate on that domain

      -

    Returns Promise<undefined | BridgeToken>

    An interface for that token (if it has been deployed on that -domain)

    -
  • -

    Resolve the local representation of a token on ALL known domain. E.g. -find ALL deployed addresses of Ethereum's Sushi Token, on all registered -domains.

    -

    WARNING: do not hold references to these contracts, as they will not be -reconnected in the event the chain connection changes.

    -

    Parameters

    Returns Promise<ResolvedTokenInfo>

    A ResolvedTokenInfo object with representation addresses

    -
  • send(from: string | number, to: string | number, token: TokenIdentifier, amount: BigNumberish, recipient: string, enableFast?: boolean, overrides?: Overrides): Promise<TransferMessage>
  • -

    Send tokens from one domain to another. Approves the bridge if necessary.

    -
    throws

    On missing signers, missing tokens, tx issues, etc.

    -

    Parameters

    • from: string | number
      -

      The domain to send from

      -
    • to: string | number
      -

      The domain to send to

      -
    • token: TokenIdentifier
      -

      The canonical token to send (details from originating chain)

      -
    • amount: BigNumberish
      -

      The amount (in smallest unit) to send

      -
    • recipient: string
      -

      The identifier to send to on the to domain

      -
    • enableFast: boolean = false
      -

      TRUE to enable fast liquidity; FALSE to require no fast liquidity

      -
    • overrides: Overrides = {}
      -

      Any tx overrides (e.g. gas price)

      -

    Returns Promise<TransferMessage>

    a TransferMessage object representing the in-flight - transfer

    -
  • sendNative(from: string | number, to: string | number, amount: BigNumberish, recipient: string, enableFast?: boolean, overrides?: PayableOverrides): Promise<TransferMessage>
  • -

    Send a chain's native asset from one chain to another using the -EthHelper contract.

    -
    throws

    On missing signers, tx issues, etc.

    -

    Parameters

    • from: string | number
      -

      The domain to send from

      -
    • to: string | number
      -

      The domain to send to

      -
    • amount: BigNumberish
      -

      The amount (in smallest unit) to send

      -
    • recipient: string
      -

      The identifier to send to on the to domain

      -
    • enableFast: boolean = false
      -

      TRUE to enable fast liquidity; FALSE to require no fast liquidity

      -
    • overrides: PayableOverrides = {}
      -

      Any tx overrides (e.g. gas price)

      -

    Returns Promise<TransferMessage>

    a TransferMessage object representing the in-flight - transfer

    -
  • unregisterSigner(nameOrDomain: string | number): void
  • -

    Remove the registered ethers Signer from a domain. This function will -attempt to preserve any Provider that was previously connected to this -domain.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Protected property
  • Protected method
  • Property
  • Private property
  • Static method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk-bridge/classes/BridgeContracts.html b/docs/public/sdk-bridge/classes/BridgeContracts.html deleted file mode 100644 index 9b4c2c6..0000000 --- a/docs/public/sdk-bridge/classes/BridgeContracts.html +++ /dev/null @@ -1 +0,0 @@ -BridgeContracts | @nomad-xyz/sdk-bridge
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Contracts
    • BridgeContracts

Index

Constructors

  • new BridgeContracts(domain: string, conf: EvmBridgeContracts, providerOrSigner?: Provider | Signer): BridgeContracts

Properties

args: any[]
conf: EvmBridgeContracts
deployHeight: number
domain: string
providerOrSigner?: Provider | Signer

Accessors

  • get bridgeRouter(): BridgeRouter
  • get ethHelper(): undefined | ETHHelper
  • get tokenRegistry(): TokenRegistry

Methods

  • connect(providerOrSigner: Provider | Signer): void

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Protected property
  • Protected method
  • Property
  • Private property
  • Static method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk-bridge/classes/BridgeMessage.html b/docs/public/sdk-bridge/classes/BridgeMessage.html deleted file mode 100644 index a817e52..0000000 --- a/docs/public/sdk-bridge/classes/BridgeMessage.html +++ /dev/null @@ -1,180 +0,0 @@ -BridgeMessage | @nomad-xyz/sdk-bridge
Options
All
  • Public
  • Public/Protected
  • All
Menu
-

The BridgeMessage extends {@link nomadMessage} with Bridge-specific -functionality.

-

Hierarchy

Index

Constructors

Properties

cache: EventCache
context: BridgeContext
dispatch: AnnotatedDispatch
fromBridge: BridgeContracts
home: Home
message: ParsedMessage
replica: Replica
toBridge: BridgeContracts

Accessors

  • get body(): string
  • -

    The message body

    -

    Returns string

  • get bodyHash(): string
  • -

    The keccak256 hash of the message body

    -

    Returns string

  • get committedRoot(): string
  • -

    The committed root when this message was dispatched.

    -

    Returns string

  • get destination(): number
  • -

    The destination domain for this message

    -

    Returns number

  • get destinationAndNonce(): BigNumber
  • -

    The destination and nonceof this message.

    -

    Returns BigNumber

  • get from(): number
  • -

    The domain from which the message was sent

    -

    Returns number

  • get leaf(): string
  • -

    The messageHash committed to the tree in the Home contract.

    -

    Returns string

  • get leafIndex(): BigNumber
  • -

    The index of the leaf in the contract.

    -

    Returns BigNumber

  • get nonce(): number
  • -

    The domain nonce for this message

    -

    Returns number

  • get origin(): number
  • -

    The domain from which the message was sent. Alias for from

    -

    Returns number

  • get receipt(): TransactionReceipt
  • -

    The receipt of the TX that dispatched this message

    -

    Returns TransactionReceipt

  • get recipient(): string
  • -

    The identifer for the recipient for this message

    -

    Returns string

  • get sender(): string
  • -

    The identifier for the sender of this message

    -

    Returns string

  • get transactionHash(): string
  • -

    The hash of the transaction that dispatched this message

    -

    Returns string

Methods

  • assetAtDestination(): Promise<undefined | ERC20>
  • -

    Resolves an interface for the asset that is being transfered on the chain -TO WHICH it is being transferred

    -

    WARNING: do not hold references to this contract, as it will not be -reconnected in the event the chain connection changes.

    -

    Returns Promise<undefined | ERC20>

    The resolved token interface.

    -
  • assetAtOrigin(): Promise<undefined | ERC20>
  • -

    Resolves an interface for the asset that is being transfered on the chain -FROM WHICH it is being transferred

    -

    WARNING: do not hold references to this contract, as it will not be -reconnected in the event the chain connection changes.

    -

    Returns Promise<undefined | ERC20>

    The resolved token interface.

    -
  • confirmAt(): Promise<BigNumber>
  • -

    Returns the timestamp after which it is possible to process this message.

    -

    Note: return the timestamp after which it is possible to process messages -within an Update. The timestamp is most relevant during the time AFTER the -Update has been Relayed to the Replica and BEFORE the message in question -has been Processed.

    -

    Considerations:

    -
      -
    • the timestamp will be 0 if the Update has not been relayed to the Replica
    • -
    • after the Update has been relayed to the Replica, the timestamp will be -non-zero forever (even after all messages in the Update have been -processed)
    • -
    • if the timestamp is in the future, the challenge period has not elapsed -yet; messages in the Update cannot be processed yet
    • -
    • if the timestamp is in the past, this does not necessarily mean that all -messages in the Update have been processed
    • -
    -

    Returns Promise<BigNumber>

    The timestamp at which a message can confirm

    -
  • delivered(): Promise<boolean>
  • -

    Checks whether the message has been delivered.

    -

    Returns Promise<boolean>

    true if processed, else false.

    -
  • events(): Promise<NomadStatus>
  • -

    Get all lifecycle events associated with this message

    -

    Returns Promise<NomadStatus>

    An array of {@link AnnotatedLifecycleEvent} objects

    -
  • getHomeUpdate(): Promise<undefined | AnnotatedUpdate>
  • -

    Get the Home Update event associated with this message (if any)

    -

    Returns Promise<undefined | AnnotatedUpdate>

    An {@link AnnotatedUpdate} (if any)

    -
  • getProcess(): Promise<undefined | AnnotatedProcess>
  • -

    Get the Replica Process event associated with this message (if any)

    -

    Returns Promise<undefined | AnnotatedProcess>

    An {@link AnnotatedProcess} (if any)

    -
  • getReplicaUpdate(): Promise<undefined | AnnotatedUpdate>
  • -

    Get the Replica Update event associated with this message (if any)

    -

    Returns Promise<undefined | AnnotatedUpdate>

    An {@link AnnotatedUpdate} (if any)

    -
  • replicaStatus(): Promise<ReplicaMessageStatus>
  • -

    Retrieve the replica status of this message.

    -

    Returns Promise<ReplicaMessageStatus>

    The {@link ReplicaMessageStatus} corresponding to the solidity -status of the message.

    -
  • wait(opts?: { pollTime?: number }): Promise<void>
  • -

    Returns a promise that resolves when the message has been delivered.

    -

    WARNING: May never resolve. Oftern takes hours to resolve.

    -

    Parameters

    • Optional opts: { pollTime?: number }
      -

      Polling options.

      -
      • Optional pollTime?: number

    Returns Promise<void>

  • baseFromReceipt<T>(context: T, nameOrDomain: string | number, receipt: TransactionReceipt): NomadMessage<T>[]
  • -

    Instantiate one or more messages from a receipt.

    -

    Type parameters

    • T: NomadContext<T>

    Parameters

    • context: T
      -

      the {@link NomadContext} object to use

      -
    • nameOrDomain: string | number
      -

      the domain on which the receipt was logged

      -
    • receipt: TransactionReceipt
      -

      the receipt

      -

    Returns NomadMessage<T>[]

    an array of {@link NomadMessage} objects

    -
  • baseFromTransactionHash<T>(context: T, nameOrDomain: string | number, transactionHash: string): Promise<NomadMessage<T>[]>
  • -

    Instantiate one or more messages from a tx hash.

    -
    throws

    if there is no receipt for the TX

    -

    Type parameters

    • T: NomadContext<T>

    Parameters

    • context: T
      -

      the {@link NomadContext} object to use

      -
    • nameOrDomain: string | number
      -

      the domain on which the receipt was logged

      -
    • transactionHash: string

    Returns Promise<NomadMessage<T>[]>

    an array of {@link NomadMessage} objects

    -
  • baseSingleFromReceipt<T>(context: T, nameOrDomain: string | number, receipt: TransactionReceipt): NomadMessage<T>
  • -

    Instantiate EXACTLY one message from a receipt.

    -
    throws

    if there is not EXACTLY 1 dispatch in the receipt

    -

    Type parameters

    • T: NomadContext<T>

    Parameters

    • context: T
      -

      the {@link NomadContext} object to use

      -
    • nameOrDomain: string | number
      -

      the domain on which the receipt was logged

      -
    • receipt: TransactionReceipt
      -

      the receipt

      -

    Returns NomadMessage<T>

    an array of {@link NomadMessage} objects

    -
  • baseSingleFromTransactionHash<T>(context: T, nameOrDomain: string | number, transactionHash: string): Promise<NomadMessage<T>>
  • -

    Instantiate EXACTLY one message from a transaction has.

    -
    throws

    if there is no receipt for the TX, or if not EXACTLY 1 dispatch in - the receipt

    -

    Type parameters

    • T: NomadContext<T>

    Parameters

    • context: T
      -

      the {@link NomadContext} object to use

      -
    • nameOrDomain: string | number
      -

      the domain on which the receipt was logged

      -
    • transactionHash: string

    Returns Promise<NomadMessage<T>>

    an array of {@link NomadMessage} objects

    -
  • -

    Attempt to instantiate some BridgeMessages from a transaction receipt

    -
    throws

    if any message cannot be parsed as a bridge message

    -

    Parameters

    • context: BridgeContext
      -

      The {@link NomadContext} to use.

      -
    • nameOrDomain: string | number
      -

      the domain on which the receipt was logged

      -
    • receipt: TransactionReceipt
      -

      The receipt

      -

    Returns TransferMessage[]

    an array of BridgeMessage objects

    -
  • -

    Attempt to instantiate some BridgeMessages from a transaction hash by -retrieving and parsing the receipt.

    -
    throws

    if any message cannot be parsed as a bridge message

    -

    Parameters

    • context: BridgeContext
      -

      The {@link NomadContext} to use.

      -
    • nameOrDomain: string | number
      -

      the domain on which the receipt was logged

      -
    • transactionHash: string
      -

      The transaction hash

      -

    Returns Promise<TransferMessage[]>

    an array of BridgeMessage objects

    -
  • -

    Attempt to instantiate EXACTLY one BridgeMessage from a transaction receipt

    -
    throws

    if any message cannot be parsed as a bridge message, or if there - is not EXACTLY 1 BridgeMessage in the receipt

    -

    Parameters

    • context: BridgeContext
      -

      The BridgeContext to use.

      -
    • nameOrDomain: string | number
      -

      the domain on which the receipt was logged

      -
    • receipt: TransactionReceipt
      -

      The receipt

      -

    Returns TransferMessage

    an array of BridgeMessage objects

    -
  • -

    Attempt to instantiate EXACTLY one BridgeMessages from a transaction hash -by retrieving and parsing the receipt.

    -
    throws

    if any message cannot be parsed as a bridge message, or if there is - not EXACTLY one such message

    -

    Parameters

    • context: BridgeContext
      -

      The {@link NomadContext} to use.

      -
    • nameOrDomain: string | number
      -

      the domain on which the receipt was logged

      -
    • transactionHash: string
      -

      The transaction hash

      -

    Returns Promise<TransferMessage>

    an array of BridgeMessage objects

    -

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Protected property
  • Protected method
  • Property
  • Private property
  • Static method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk-bridge/classes/TransferMessage.html b/docs/public/sdk-bridge/classes/TransferMessage.html deleted file mode 100644 index d2303ce..0000000 --- a/docs/public/sdk-bridge/classes/TransferMessage.html +++ /dev/null @@ -1,189 +0,0 @@ -TransferMessage | @nomad-xyz/sdk-bridge
Options
All
  • Public
  • Public/Protected
  • All
Menu
-

A TransferMessage extends the BridgeMessage with transfer-specific -functionality.

-

Hierarchy

Index

Constructors

Properties

action: Transfer
cache: EventCache
context: BridgeContext
dispatch: AnnotatedDispatch
fromBridge: BridgeContracts
home: Home
message: ParsedMessage
replica: Replica
toBridge: BridgeContracts

Accessors

  • get amount(): BigNumber
  • get body(): string
  • -

    The message body

    -

    Returns string

  • get bodyHash(): string
  • -

    The keccak256 hash of the message body

    -

    Returns string

  • get committedRoot(): string
  • -

    The committed root when this message was dispatched.

    -

    Returns string

  • get destination(): number
  • -

    The destination domain for this message

    -

    Returns number

  • get destinationAndNonce(): BigNumber
  • -

    The destination and nonceof this message.

    -

    Returns BigNumber

  • get from(): number
  • -

    The domain from which the message was sent

    -

    Returns number

  • get leaf(): string
  • -

    The messageHash committed to the tree in the Home contract.

    -

    Returns string

  • get leafIndex(): BigNumber
  • -

    The index of the leaf in the contract.

    -

    Returns BigNumber

  • get nonce(): number
  • -

    The domain nonce for this message

    -

    Returns number

  • get origin(): number
  • -

    The domain from which the message was sent. Alias for from

    -

    Returns number

  • get prefillId(): string
  • get receipt(): TransactionReceipt
  • -

    The receipt of the TX that dispatched this message

    -

    Returns TransactionReceipt

  • get recipient(): string
  • -

    The identifer for the recipient for this message

    -

    Returns string

  • get sender(): string
  • -

    The identifier for the sender of this message

    -

    Returns string

  • get to(): string
  • get transactionHash(): string
  • -

    The hash of the transaction that dispatched this message

    -

    Returns string

Methods

  • assetAtDestination(): Promise<undefined | ERC20>
  • -

    Resolves an interface for the asset that is being transfered on the chain -TO WHICH it is being transferred

    -

    WARNING: do not hold references to this contract, as it will not be -reconnected in the event the chain connection changes.

    -

    Returns Promise<undefined | ERC20>

    The resolved token interface.

    -
  • assetAtOrigin(): Promise<undefined | ERC20>
  • -

    Resolves an interface for the asset that is being transfered on the chain -FROM WHICH it is being transferred

    -

    WARNING: do not hold references to this contract, as it will not be -reconnected in the event the chain connection changes.

    -

    Returns Promise<undefined | ERC20>

    The resolved token interface.

    -
  • confirmAt(): Promise<BigNumber>
  • -

    Returns the timestamp after which it is possible to process this message.

    -

    Note: return the timestamp after which it is possible to process messages -within an Update. The timestamp is most relevant during the time AFTER the -Update has been Relayed to the Replica and BEFORE the message in question -has been Processed.

    -

    Considerations:

    -
      -
    • the timestamp will be 0 if the Update has not been relayed to the Replica
    • -
    • after the Update has been relayed to the Replica, the timestamp will be -non-zero forever (even after all messages in the Update have been -processed)
    • -
    • if the timestamp is in the future, the challenge period has not elapsed -yet; messages in the Update cannot be processed yet
    • -
    • if the timestamp is in the past, this does not necessarily mean that all -messages in the Update have been processed
    • -
    -

    Returns Promise<BigNumber>

    The timestamp at which a message can confirm

    -
  • currentlyPrefilled(): Promise<boolean>
  • delivered(): Promise<boolean>
  • -

    Checks whether the message has been delivered.

    -

    Returns Promise<boolean>

    true if processed, else false.

    -
  • events(): Promise<NomadStatus>
  • -

    Get all lifecycle events associated with this message

    -

    Returns Promise<NomadStatus>

    An array of {@link AnnotatedLifecycleEvent} objects

    -
  • getHomeUpdate(): Promise<undefined | AnnotatedUpdate>
  • -

    Get the Home Update event associated with this message (if any)

    -

    Returns Promise<undefined | AnnotatedUpdate>

    An {@link AnnotatedUpdate} (if any)

    -
  • getProcess(): Promise<undefined | AnnotatedProcess>
  • -

    Get the Replica Process event associated with this message (if any)

    -

    Returns Promise<undefined | AnnotatedProcess>

    An {@link AnnotatedProcess} (if any)

    -
  • getReplicaUpdate(): Promise<undefined | AnnotatedUpdate>
  • -

    Get the Replica Update event associated with this message (if any)

    -

    Returns Promise<undefined | AnnotatedUpdate>

    An {@link AnnotatedUpdate} (if any)

    -
  • replicaStatus(): Promise<ReplicaMessageStatus>
  • -

    Retrieve the replica status of this message.

    -

    Returns Promise<ReplicaMessageStatus>

    The {@link ReplicaMessageStatus} corresponding to the solidity -status of the message.

    -
  • wait(opts?: { pollTime?: number }): Promise<void>
  • -

    Returns a promise that resolves when the message has been delivered.

    -

    WARNING: May never resolve. Oftern takes hours to resolve.

    -

    Parameters

    • Optional opts: { pollTime?: number }
      -

      Polling options.

      -
      • Optional pollTime?: number

    Returns Promise<void>

  • baseFromReceipt<T>(context: T, nameOrDomain: string | number, receipt: TransactionReceipt): NomadMessage<T>[]
  • -

    Instantiate one or more messages from a receipt.

    -

    Type parameters

    • T: NomadContext<T>

    Parameters

    • context: T
      -

      the {@link NomadContext} object to use

      -
    • nameOrDomain: string | number
      -

      the domain on which the receipt was logged

      -
    • receipt: TransactionReceipt
      -

      the receipt

      -

    Returns NomadMessage<T>[]

    an array of {@link NomadMessage} objects

    -
  • baseFromTransactionHash<T>(context: T, nameOrDomain: string | number, transactionHash: string): Promise<NomadMessage<T>[]>
  • -

    Instantiate one or more messages from a tx hash.

    -
    throws

    if there is no receipt for the TX

    -

    Type parameters

    • T: NomadContext<T>

    Parameters

    • context: T
      -

      the {@link NomadContext} object to use

      -
    • nameOrDomain: string | number
      -

      the domain on which the receipt was logged

      -
    • transactionHash: string

    Returns Promise<NomadMessage<T>[]>

    an array of {@link NomadMessage} objects

    -
  • baseSingleFromReceipt<T>(context: T, nameOrDomain: string | number, receipt: TransactionReceipt): NomadMessage<T>
  • -

    Instantiate EXACTLY one message from a receipt.

    -
    throws

    if there is not EXACTLY 1 dispatch in the receipt

    -

    Type parameters

    • T: NomadContext<T>

    Parameters

    • context: T
      -

      the {@link NomadContext} object to use

      -
    • nameOrDomain: string | number
      -

      the domain on which the receipt was logged

      -
    • receipt: TransactionReceipt
      -

      the receipt

      -

    Returns NomadMessage<T>

    an array of {@link NomadMessage} objects

    -
  • baseSingleFromTransactionHash<T>(context: T, nameOrDomain: string | number, transactionHash: string): Promise<NomadMessage<T>>
  • -

    Instantiate EXACTLY one message from a transaction has.

    -
    throws

    if there is no receipt for the TX, or if not EXACTLY 1 dispatch in - the receipt

    -

    Type parameters

    • T: NomadContext<T>

    Parameters

    • context: T
      -

      the {@link NomadContext} object to use

      -
    • nameOrDomain: string | number
      -

      the domain on which the receipt was logged

      -
    • transactionHash: string

    Returns Promise<NomadMessage<T>>

    an array of {@link NomadMessage} objects

    -

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Protected property
  • Protected method
  • Property
  • Private property
  • Static method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk-bridge/index.html b/docs/public/sdk-bridge/index.html deleted file mode 100644 index 8aa7ffd..0000000 --- a/docs/public/sdk-bridge/index.html +++ /dev/null @@ -1,15 +0,0 @@ -@nomad-xyz/sdk-bridge
Options
All
  • Public
  • Public/Protected
  • All
Menu

@nomad-xyz/sdk-bridge

- -

Nomad Bridge SDK

-
-

This package includes the BridgeContext, a management system for Nomad core -contracts, which inherits from the MultiProvider. BridgeContext allows -developers to easily interact with the Nomad Token Bridge on any number of -networks.

- - -

Building

-
-
yarn build
-
-

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Protected property
  • Protected method
  • Property
  • Private property
  • Static method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk-bridge/interfaces/TokenIdentifier.html b/docs/public/sdk-bridge/interfaces/TokenIdentifier.html deleted file mode 100644 index d022131..0000000 --- a/docs/public/sdk-bridge/interfaces/TokenIdentifier.html +++ /dev/null @@ -1 +0,0 @@ -TokenIdentifier | @nomad-xyz/sdk-bridge
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TokenIdentifier

Hierarchy

  • TokenIdentifier

Index

Properties

Properties

domain: string | number
id: BytesLike

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Protected property
  • Protected method
  • Property
  • Private property
  • Static method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk-bridge/modules.html b/docs/public/sdk-bridge/modules.html deleted file mode 100644 index aabe29c..0000000 --- a/docs/public/sdk-bridge/modules.html +++ /dev/null @@ -1 +0,0 @@ -@nomad-xyz/sdk-bridge
Options
All
  • Public
  • Public/Protected
  • All
Menu

@nomad-xyz/sdk-bridge

Index

Type aliases

Action: Transfer
AnnotatedSend: Annotated<bridgeEvents.SendTypes, bridgeEvents.SendEvent>
AnyBridgeMessage: TransferMessage
ParsedBridgeMessage<T>: { action: T; token: TokenIdentifier }

Type parameters

Type declaration

ParsedTransferMessage: ParsedBridgeMessage<Transfer>
ResolvedTokenInfo: { domain: number; id: BytesLike; tokens: Map<number, bridge.BridgeToken> }

Type declaration

  • domain: number
  • id: BytesLike
  • tokens: Map<number, bridge.BridgeToken>
SendArgs: { amount: BigNumber; from: string; toDomain: number; toId: string; token: string }

Type declaration

  • amount: BigNumber
  • from: string
  • toDomain: number
  • toId: string
  • token: string
SendEvent: TypedEvent<bridgeEvents.SendTypes & bridgeEvents.SendArgs>
SendTypes: [string, string, number, string, BigNumber]
TokenDeployedArgs: { domain: number; id: string; representation: string }

Type declaration

  • domain: number
  • id: string
  • representation: string
TokenDeployedTypes: [number, string, string]

Variables

testnetTokens: { Alfajores: TokenIdentifier; Kovan: TokenIdentifier } = testnetWellKnown

Type declaration

tokens: { Celo: TokenIdentifier; LINK: TokenIdentifier; Sushi: TokenIdentifier; UNI: TokenIdentifier; USDC: TokenIdentifier; USDT: TokenIdentifier; WBTC: TokenIdentifier; WMATIC: TokenIdentifier; Weth: TokenIdentifier; cEUR: TokenIdentifier; cUSD: TokenIdentifier } = wellKnown

Functions

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Protected property
  • Protected method
  • Property
  • Private property
  • Static method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk-bridge/modules/bridgeEvents.html b/docs/public/sdk-bridge/modules/bridgeEvents.html deleted file mode 100644 index 246d530..0000000 --- a/docs/public/sdk-bridge/modules/bridgeEvents.html +++ /dev/null @@ -1 +0,0 @@ -bridgeEvents | @nomad-xyz/sdk-bridge
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace bridgeEvents

Index

Type aliases

AnnotatedSend: Annotated<bridgeEvents.SendTypes, bridgeEvents.SendEvent>
SendArgs: { amount: BigNumber; from: string; toDomain: number; toId: string; token: string }

Type declaration

  • amount: BigNumber
  • from: string
  • toDomain: number
  • toId: string
  • token: string
SendEvent: TypedEvent<bridgeEvents.SendTypes & bridgeEvents.SendArgs>
SendTypes: [string, string, number, string, BigNumber]
TokenDeployedArgs: { domain: number; id: string; representation: string }

Type declaration

  • domain: number
  • id: string
  • representation: string
TokenDeployedTypes: [number, string, string]

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Protected property
  • Protected method
  • Property
  • Private property
  • Static method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk-govern/.nojekyll b/docs/public/sdk-govern/.nojekyll deleted file mode 100644 index e2ac661..0000000 --- a/docs/public/sdk-govern/.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/public/sdk-govern/assets/highlight.css b/docs/public/sdk-govern/assets/highlight.css deleted file mode 100644 index 5b3bce0..0000000 --- a/docs/public/sdk-govern/assets/highlight.css +++ /dev/null @@ -1,36 +0,0 @@ -:root { - --light-hl-0: #001080; - --dark-hl-0: #9CDCFE; - --light-hl-1: #000000; - --dark-hl-1: #D4D4D4; - --light-code-background: #F5F5F5; - --dark-code-background: #1E1E1E; -} - -@media (prefers-color-scheme: light) { :root { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --code-background: var(--light-code-background); -} } - -@media (prefers-color-scheme: dark) { :root { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --code-background: var(--dark-code-background); -} } - -body.light { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --code-background: var(--light-code-background); -} - -body.dark { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --code-background: var(--dark-code-background); -} - -.hl-0 { color: var(--hl-0); } -.hl-1 { color: var(--hl-1); } -pre, code { background: var(--code-background); } diff --git a/docs/public/sdk-govern/assets/icons.css b/docs/public/sdk-govern/assets/icons.css deleted file mode 100644 index 776a356..0000000 --- a/docs/public/sdk-govern/assets/icons.css +++ /dev/null @@ -1,1043 +0,0 @@ -.tsd-kind-icon { - display: block; - position: relative; - padding-left: 20px; - text-indent: -20px; -} -.tsd-kind-icon:before { - content: ""; - display: inline-block; - vertical-align: middle; - width: 17px; - height: 17px; - margin: 0 3px 2px 0; - background-image: url(./icons.png); -} -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-kind-icon:before { - background-image: url(./icons@2x.png); - background-size: 238px 204px; - } -} - -.tsd-signature.tsd-kind-icon:before { - background-position: 0 -153px; -} - -.tsd-kind-object-literal > .tsd-kind-icon:before { - background-position: 0px -17px; -} -.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -17px; -} -.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -17px; -} - -.tsd-kind-class > .tsd-kind-icon:before { - background-position: 0px -34px; -} -.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -34px; -} -.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -34px; -} - -.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -51px; -} -.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -17px -51px; -} -.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -51px; -} - -.tsd-kind-interface > .tsd-kind-icon:before { - background-position: 0px -68px; -} -.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -68px; -} -.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -68px; -} - -.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -85px; -} -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -17px -85px; -} -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private - > .tsd-kind-icon:before { - background-position: -34px -85px; -} - -.tsd-kind-namespace > .tsd-kind-icon:before { - background-position: 0px -102px; -} -.tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; -} -.tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; -} - -.tsd-kind-module > .tsd-kind-icon:before { - background-position: 0px -102px; -} -.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; -} -.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; -} - -.tsd-kind-enum > .tsd-kind-icon:before { - background-position: 0px -119px; -} -.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -119px; -} -.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -119px; -} - -.tsd-kind-enum-member > .tsd-kind-icon:before { - background-position: 0px -136px; -} -.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -136px; -} -.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -136px; -} - -.tsd-kind-signature > .tsd-kind-icon:before { - background-position: 0px -153px; -} -.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -153px; -} -.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -153px; -} - -.tsd-kind-type-alias > .tsd-kind-icon:before { - background-position: 0px -170px; -} -.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -170px; -} -.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -170px; -} - -.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -187px; -} -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -17px -187px; -} -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private - > .tsd-kind-icon:before { - background-position: -34px -187px; -} - -.tsd-kind-variable > .tsd-kind-icon:before { - background-position: -136px -0px; -} -.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; -} -.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; -} -.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -0px; -} - -.tsd-kind-property > .tsd-kind-icon:before { - background-position: -136px -0px; -} -.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; -} -.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; -} -.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -0px; -} - -.tsd-kind-get-signature > .tsd-kind-icon:before { - background-position: -136px -17px; -} -.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -17px; -} -.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -17px; -} - -.tsd-kind-set-signature > .tsd-kind-icon:before { - background-position: -136px -34px; -} -.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -34px; -} -.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -34px; -} - -.tsd-kind-accessor > .tsd-kind-icon:before { - background-position: -136px -51px; -} -.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -51px; -} -.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -51px; -} - -.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -153px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class - > .tsd-kind-icon:before { - background-position: -51px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum - > .tsd-kind-icon:before { - background-position: -170px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -85px; -} - -.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -153px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class - > .tsd-kind-icon:before { - background-position: -51px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum - > .tsd-kind-icon:before { - background-position: -170px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -85px; -} - -.tsd-kind-constructor > .tsd-kind-icon:before { - background-position: -136px -102px; -} -.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; -} -.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -102px; -} - -.tsd-kind-constructor-signature > .tsd-kind-icon:before { - background-position: -136px -102px; -} -.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; -} -.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -102px; -} - -.tsd-kind-index-signature > .tsd-kind-icon:before { - background-position: -136px -119px; -} -.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -119px; -} -.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -119px; -} - -.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -136px; -} -.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -136px; -} -.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -136px; -} -.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -136px; -} - -.tsd-is-static > .tsd-kind-icon:before { - background-position: -136px -153px; -} -.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -153px; -} -.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -153px; -} -.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -153px; -} -.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -153px; -} -.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -153px; -} - -.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class - > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum - > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -187px; -} diff --git a/docs/public/sdk-govern/assets/icons.png b/docs/public/sdk-govern/assets/icons.png deleted file mode 100644 index 3836d5f..0000000 Binary files a/docs/public/sdk-govern/assets/icons.png and /dev/null differ diff --git a/docs/public/sdk-govern/assets/icons@2x.png b/docs/public/sdk-govern/assets/icons@2x.png deleted file mode 100644 index 5a209e2..0000000 Binary files a/docs/public/sdk-govern/assets/icons@2x.png and /dev/null differ diff --git a/docs/public/sdk-govern/assets/main.js b/docs/public/sdk-govern/assets/main.js deleted file mode 100644 index 54869f4..0000000 --- a/docs/public/sdk-govern/assets/main.js +++ /dev/null @@ -1,52 +0,0 @@ -(()=>{var Ce=Object.create;var J=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,_e=Object.prototype.hasOwnProperty;var Me=t=>J(t,"__esModule",{value:!0});var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!_e.call(t,i)&&(r||i!=="default")&&J(t,i,{get:()=>e[i],enumerable:!(n=Pe(e,i))||n.enumerable});return t},Ae=(t,e)=>De(Me(J(t!=null?Ce(Re(t)):{},"default",!e&&t&&t.__esModule?{get:()=>t.default,enumerable:!0}:{value:t,enumerable:!0})),t);var de=Fe((ce,he)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var h=t.utils.clone(r)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(n.slice(a,o),h))}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,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ou?h+=2:a==u&&(r+=n[l+1]*i[h+1],l+=2,h+=2);return r},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),r=1,n=0;r0){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 u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,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 l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),p=s.str.charAt(1),v;p in s.node.edges?v=s.node.edges[p]:(v=new t.TokenSet,s.node.edges[p]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.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(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},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,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<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 r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,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 r=e.peekLexeme();if(r!=null)switch(r.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 n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.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 r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.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 '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;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 r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;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,r){typeof define=="function"&&define.amd?define(r):typeof ce=="object"?he.exports=r():e.lunr=r()}(this,function(){return t})})()});var le=[];function N(t,e){le.push({selector:e,constructor:t})}var X=class{constructor(){this.createComponents(document.body)}createComponents(e){le.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n}),n.dataset.hasInstance=String(!0))})})}};var Q=class{constructor(e){this.el=e.el}};var Z=class{constructor(){this.listeners={}}addEventListener(e,r){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(r)}removeEventListener(e,r){if(!(e in this.listeners))return;let n=this.listeners[e];for(let i=0,s=n.length;i{let r=Date.now();return(...n)=>{r+e-Date.now()<0&&(t(...n),r=Date.now())}};var ee=class extends Z{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.secondaryNav=document.querySelector(".tsd-navigation.secondary"),window.addEventListener("scroll",K(()=>this.onScroll(),10)),window.addEventListener("resize",K(()=>this.onResize(),10)),this.onResize(),this.onScroll()}triggerResize(){let e=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(e)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let e=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(e)}onScroll(){this.scrollTop=window.scrollY||0;let e=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(e),this.hideShowToolbar()}hideShowToolbar(){var r;let e=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0,e!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),(r=this.secondaryNav)==null||r.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop}},I=ee;I.instance=new ee;var te=class extends Q{constructor(e){super(e);this.anchors=[];this.index=-1;I.instance.addEventListener("resize",()=>this.onResize()),I.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let e=window.location.href;e.indexOf("#")!=-1&&(e=e.substr(0,e.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let n=r.href;if(n.indexOf("#")==-1||n.substr(0,e.length)!=e)return;let i=n.substr(n.indexOf("#")+1),s=document.querySelector("a.tsd-anchor[name="+i+"]"),o=r.parentNode;!s||!o||this.anchors.push({link:o,anchor:s,position:0})}),this.onResize()}onResize(){let e;for(let n=0,i=this.anchors.length;nn.position-i.position);let r=new CustomEvent("scroll",{detail:{scrollTop:I.instance.scrollTop}});this.onScroll(r)}onScroll(e){let r=e.detail.scrollTop+5,n=this.anchors,i=n.length-1,s=this.index;for(;s>-1&&n[s].position>r;)s-=1;for(;s-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=s,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let r;return(...n)=>{clearTimeout(r),r=setTimeout(()=>t(n),e)}};var me=Ae(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Ve(t,n,r,s)}function Ve(t,e,r,n){r.addEventListener("input",ue(()=>{ze(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ne(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?fe(e,-1):s.key==="ArrowDown"?fe(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function He(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function ze(t,e,r,n){if(He(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=n.index.search(`*${i}*`);for(let o=0,a=Math.min(10,s.length);o${pe(u.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=u.classes;let p=document.createElement("a");p.href=n.base+u.url,p.classList.add("tsd-kind-icon"),p.innerHTML=l,h.append(p),e.appendChild(h)}}function fe(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Ne(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function pe(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(re(t.substring(s,o)),`${re(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(re(t.substring(s))),i.join("")}var je={"&":"&","<":"<",">":">","'":"'",'"':"""};function re(t){return t.replace(/[&<>"'"]/g,e=>je[e])}var ge=class{constructor(e,r){this.signature=e,this.description=r}addClass(e){return this.signature.classList.add(e),this.description.classList.add(e),this}removeClass(e){return this.signature.classList.remove(e),this.description.classList.remove(e),this}},ne=class extends Q{constructor(e){super(e);this.groups=[];this.index=-1;this.createGroups(),this.container&&(this.el.classList.add("active"),Array.from(this.el.children).forEach(r=>{r.addEventListener("touchstart",n=>this.onClick(n)),r.addEventListener("click",n=>this.onClick(n))}),this.container.classList.add("active"),this.setIndex(0))}setIndex(e){if(e<0&&(e=0),e>this.groups.length-1&&(e=this.groups.length-1),this.index==e)return;let r=this.groups[e];if(this.index>-1){let n=this.groups[this.index];n.removeClass("current").addClass("fade-out"),r.addClass("current"),r.addClass("fade-in"),I.instance.triggerResize(),setTimeout(()=>{n.removeClass("fade-out"),r.removeClass("fade-in")},300)}else r.addClass("current"),I.instance.triggerResize();this.index=e}createGroups(){let e=this.el.children;if(e.length<2)return;this.container=this.el.nextElementSibling;let r=this.container.children;this.groups=[];for(let n=0;n{r.signature===e.currentTarget&&this.setIndex(n)})}};var C="mousedown",xe="mousemove",_="mouseup",G={x:0,y:0},ye=!1,ie=!1,Be=!1,A=!1,Le=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Le?"is-mobile":"not-mobile");Le&&"ontouchstart"in document.documentElement&&(Be=!0,C="touchstart",xe="touchmove",_="touchend");document.addEventListener(C,t=>{ie=!0,A=!1;let e=C=="touchstart"?t.targetTouches[0]:t;G.y=e.pageY||0,G.x=e.pageX||0});document.addEventListener(xe,t=>{if(!!ie&&!A){let e=C=="touchstart"?t.targetTouches[0]:t,r=G.x-(e.pageX||0),n=G.y-(e.pageY||0);A=Math.sqrt(r*r+n*n)>10}});document.addEventListener(_,()=>{ie=!1});document.addEventListener("click",t=>{ye&&(t.preventDefault(),t.stopImmediatePropagation(),ye=!1)});var se=class extends Q{constructor(e){super(e);this.className=this.el.dataset.toggle||"",this.el.addEventListener(_,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(C,r=>this.onDocumentPointerDown(r)),document.addEventListener(_,r=>this.onDocumentPointerUp(r))}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 r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(e){A||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!A&&this.active&&e.target.closest(".col-menu")){let r=e.target.closest("a");if(r){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substr(0,n.indexOf("#"))),r.href.substr(0,n.length)==n&&setTimeout(()=>this.setActive(!1),250)}}}};var ae=class{constructor(e,r){this.key=e,this.value=r,this.defaultValue=r,this.initialize(),window.localStorage[this.key]&&this.setValue(this.fromLocalStorage(window.localStorage[this.key]))}initialize(){}setValue(e){if(this.value==e)return;let r=this.value;this.value=e,window.localStorage[this.key]=this.toLocalStorage(e),this.handleValueChange(r,e)}},oe=class extends ae{initialize(){let e=document.querySelector("#tsd-filter-"+this.key);!e||(this.checkbox=e,this.checkbox.addEventListener("change",()=>{this.setValue(this.checkbox.checked)}))}handleValueChange(e,r){!this.checkbox||(this.checkbox.checked=this.value,document.documentElement.classList.toggle("toggle-"+this.key,this.value!=this.defaultValue))}fromLocalStorage(e){return e=="true"}toLocalStorage(e){return e?"true":"false"}},Ee=class extends ae{initialize(){document.documentElement.classList.add("toggle-"+this.key+this.value);let e=document.querySelector("#tsd-filter-"+this.key);if(!e)return;this.select=e;let r=()=>{this.select.classList.add("active")},n=()=>{this.select.classList.remove("active")};this.select.addEventListener(C,r),this.select.addEventListener("mouseover",r),this.select.addEventListener("mouseleave",n),this.select.querySelectorAll("li").forEach(i=>{i.addEventListener(_,s=>{e.classList.remove("active"),this.setValue(s.target.dataset.value||"")})}),document.addEventListener(C,i=>{this.select.contains(i.target)||this.select.classList.remove("active")})}handleValueChange(e,r){this.select.querySelectorAll("li.selected").forEach(s=>{s.classList.remove("selected")});let n=this.select.querySelector('li[data-value="'+r+'"]'),i=this.select.querySelector(".tsd-select-label");n&&i&&(n.classList.add("selected"),i.textContent=n.textContent),document.documentElement.classList.remove("toggle-"+e),document.documentElement.classList.add("toggle-"+r)}fromLocalStorage(e){return e}toLocalStorage(e){return e}},Y=class extends Q{constructor(e){super(e);this.optionVisibility=new Ee("visibility","private"),this.optionInherited=new oe("inherited",!0),this.optionExternals=new oe("externals",!0)}static isSupported(){try{return typeof window.localStorage!="undefined"}catch{return!1}}};function we(t){let e=localStorage.getItem("tsd-theme")||"os";t.value=e,be(e),t.addEventListener("change",()=>{localStorage.setItem("tsd-theme",t.value),be(t.value)})}function be(t){switch(t){case"os":document.body.classList.remove("light","dark");break;case"light":document.body.classList.remove("dark"),document.body.classList.add("light");break;case"dark":document.body.classList.remove("light"),document.body.classList.add("dark");break}}ve();N(te,".menu-highlight");N(ne,".tsd-signatures");N(se,"a[data-toggle]");Y.isSupported()?N(Y,"#tsd-filter"):document.documentElement.classList.add("no-filter");var Te=document.getElementById("theme");Te&&we(Te);var qe=new X;Object.defineProperty(window,"app",{value:qe});})(); -/*! - * lunr.Builder - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Index - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Pipeline - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Set - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.TokenSet - * 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.tokenizer - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.trimmer - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.utils - * Copyright (C) 2020 Oliver Nightingale - */ -/** - * 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 - */ diff --git a/docs/public/sdk-govern/assets/search.js b/docs/public/sdk-govern/assets/search.js deleted file mode 100644 index 4109428..0000000 --- a/docs/public/sdk-govern/assets/search.js +++ /dev/null @@ -1 +0,0 @@ -window.searchData = JSON.parse("{\"kinds\":{\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\",\"262144\":\"Accessor\",\"4194304\":\"Type alias\"},\"rows\":[{\"id\":0,\"kind\":4194304,\"name\":\"Address\",\"url\":\"modules.html#Address\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":1,\"kind\":256,\"name\":\"Call\",\"url\":\"interfaces/Call.html\",\"classes\":\"tsd-kind-interface\"},{\"id\":2,\"kind\":1024,\"name\":\"to\",\"url\":\"interfaces/Call.html#to\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Call\"},{\"id\":3,\"kind\":1024,\"name\":\"data\",\"url\":\"interfaces/Call.html#data\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Call\"},{\"id\":4,\"kind\":256,\"name\":\"RemoteContents\",\"url\":\"interfaces/RemoteContents.html\",\"classes\":\"tsd-kind-interface\"},{\"id\":5,\"kind\":256,\"name\":\"CallBatchContents\",\"url\":\"interfaces/CallBatchContents.html\",\"classes\":\"tsd-kind-interface\"},{\"id\":6,\"kind\":1024,\"name\":\"local\",\"url\":\"interfaces/CallBatchContents.html#local\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"CallBatchContents\"},{\"id\":7,\"kind\":1024,\"name\":\"remote\",\"url\":\"interfaces/CallBatchContents.html#remote\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"CallBatchContents\"},{\"id\":8,\"kind\":128,\"name\":\"CallBatch\",\"url\":\"classes/CallBatch.html\",\"classes\":\"tsd-kind-class\"},{\"id\":9,\"kind\":2048,\"name\":\"fromContext\",\"url\":\"classes/CallBatch.html#fromContext\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-static\",\"parent\":\"CallBatch\"},{\"id\":10,\"kind\":2048,\"name\":\"fromJSON\",\"url\":\"classes/CallBatch.html#fromJSON\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-static\",\"parent\":\"CallBatch\"},{\"id\":11,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/CallBatch.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"CallBatch\"},{\"id\":12,\"kind\":1024,\"name\":\"local\",\"url\":\"classes/CallBatch.html#local\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"CallBatch\"},{\"id\":13,\"kind\":1024,\"name\":\"remote\",\"url\":\"classes/CallBatch.html#remote\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"CallBatch\"},{\"id\":14,\"kind\":1024,\"name\":\"governorCore\",\"url\":\"classes/CallBatch.html#governorCore\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"CallBatch\"},{\"id\":15,\"kind\":1024,\"name\":\"context\",\"url\":\"classes/CallBatch.html#context\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"CallBatch\"},{\"id\":16,\"kind\":1024,\"name\":\"built\",\"url\":\"classes/CallBatch.html#built\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"CallBatch\"},{\"id\":17,\"kind\":262144,\"name\":\"domains\",\"url\":\"classes/CallBatch.html#domains\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"CallBatch\"},{\"id\":18,\"kind\":2048,\"name\":\"pushLocal\",\"url\":\"classes/CallBatch.html#pushLocal\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"CallBatch\"},{\"id\":19,\"kind\":2048,\"name\":\"pushRemote\",\"url\":\"classes/CallBatch.html#pushRemote\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"CallBatch\"},{\"id\":20,\"kind\":2048,\"name\":\"build\",\"url\":\"classes/CallBatch.html#build\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"CallBatch\"},{\"id\":21,\"kind\":2048,\"name\":\"batchHash\",\"url\":\"classes/CallBatch.html#batchHash\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"CallBatch\"},{\"id\":22,\"kind\":2048,\"name\":\"sign\",\"url\":\"classes/CallBatch.html#sign\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"CallBatch\"},{\"id\":23,\"kind\":2048,\"name\":\"execute\",\"url\":\"classes/CallBatch.html#execute\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"CallBatch\"},{\"id\":24,\"kind\":2048,\"name\":\"executeDomain\",\"url\":\"classes/CallBatch.html#executeDomain\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"CallBatch\"},{\"id\":25,\"kind\":2048,\"name\":\"waitDomain\",\"url\":\"classes/CallBatch.html#waitDomain\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"CallBatch\"},{\"id\":26,\"kind\":2048,\"name\":\"waitAll\",\"url\":\"classes/CallBatch.html#waitAll\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"CallBatch\"},{\"id\":27,\"kind\":64,\"name\":\"parseAction\",\"url\":\"modules.html#parseAction\",\"classes\":\"tsd-kind-function\"},{\"id\":28,\"kind\":4194304,\"name\":\"Action\",\"url\":\"modules.html#Action\",\"classes\":\"tsd-kind-type-alias\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"parent\"],\"fieldVectors\":[[\"name/0\",[0,29.957]],[\"parent/0\",[]],[\"name/1\",[1,21.484]],[\"parent/1\",[]],[\"name/2\",[2,29.957]],[\"parent/2\",[1,1.901]],[\"name/3\",[3,29.957]],[\"parent/3\",[1,1.901]],[\"name/4\",[4,29.957]],[\"parent/4\",[]],[\"name/5\",[5,21.484]],[\"parent/5\",[]],[\"name/6\",[6,24.849]],[\"parent/6\",[5,1.901]],[\"name/7\",[7,24.849]],[\"parent/7\",[5,1.901]],[\"name/8\",[8,4.308]],[\"parent/8\",[]],[\"name/9\",[9,29.957]],[\"parent/9\",[8,0.381]],[\"name/10\",[10,29.957]],[\"parent/10\",[8,0.381]],[\"name/11\",[11,29.957]],[\"parent/11\",[8,0.381]],[\"name/12\",[6,24.849]],[\"parent/12\",[8,0.381]],[\"name/13\",[7,24.849]],[\"parent/13\",[8,0.381]],[\"name/14\",[12,29.957]],[\"parent/14\",[8,0.381]],[\"name/15\",[13,29.957]],[\"parent/15\",[8,0.381]],[\"name/16\",[14,29.957]],[\"parent/16\",[8,0.381]],[\"name/17\",[15,29.957]],[\"parent/17\",[8,0.381]],[\"name/18\",[16,29.957]],[\"parent/18\",[8,0.381]],[\"name/19\",[17,29.957]],[\"parent/19\",[8,0.381]],[\"name/20\",[18,29.957]],[\"parent/20\",[8,0.381]],[\"name/21\",[19,29.957]],[\"parent/21\",[8,0.381]],[\"name/22\",[20,29.957]],[\"parent/22\",[8,0.381]],[\"name/23\",[21,29.957]],[\"parent/23\",[8,0.381]],[\"name/24\",[22,29.957]],[\"parent/24\",[8,0.381]],[\"name/25\",[23,29.957]],[\"parent/25\",[8,0.381]],[\"name/26\",[24,29.957]],[\"parent/26\",[8,0.381]],[\"name/27\",[25,29.957]],[\"parent/27\",[]],[\"name/28\",[26,29.957]],[\"parent/28\",[]]],\"invertedIndex\":[[\"action\",{\"_index\":26,\"name\":{\"28\":{}},\"parent\":{}}],[\"address\",{\"_index\":0,\"name\":{\"0\":{}},\"parent\":{}}],[\"batchhash\",{\"_index\":19,\"name\":{\"21\":{}},\"parent\":{}}],[\"build\",{\"_index\":18,\"name\":{\"20\":{}},\"parent\":{}}],[\"built\",{\"_index\":14,\"name\":{\"16\":{}},\"parent\":{}}],[\"call\",{\"_index\":1,\"name\":{\"1\":{}},\"parent\":{\"2\":{},\"3\":{}}}],[\"callbatch\",{\"_index\":8,\"name\":{\"8\":{}},\"parent\":{\"9\":{},\"10\":{},\"11\":{},\"12\":{},\"13\":{},\"14\":{},\"15\":{},\"16\":{},\"17\":{},\"18\":{},\"19\":{},\"20\":{},\"21\":{},\"22\":{},\"23\":{},\"24\":{},\"25\":{},\"26\":{}}}],[\"callbatchcontents\",{\"_index\":5,\"name\":{\"5\":{}},\"parent\":{\"6\":{},\"7\":{}}}],[\"constructor\",{\"_index\":11,\"name\":{\"11\":{}},\"parent\":{}}],[\"context\",{\"_index\":13,\"name\":{\"15\":{}},\"parent\":{}}],[\"data\",{\"_index\":3,\"name\":{\"3\":{}},\"parent\":{}}],[\"domains\",{\"_index\":15,\"name\":{\"17\":{}},\"parent\":{}}],[\"execute\",{\"_index\":21,\"name\":{\"23\":{}},\"parent\":{}}],[\"executedomain\",{\"_index\":22,\"name\":{\"24\":{}},\"parent\":{}}],[\"fromcontext\",{\"_index\":9,\"name\":{\"9\":{}},\"parent\":{}}],[\"fromjson\",{\"_index\":10,\"name\":{\"10\":{}},\"parent\":{}}],[\"governorcore\",{\"_index\":12,\"name\":{\"14\":{}},\"parent\":{}}],[\"local\",{\"_index\":6,\"name\":{\"6\":{},\"12\":{}},\"parent\":{}}],[\"parseaction\",{\"_index\":25,\"name\":{\"27\":{}},\"parent\":{}}],[\"pushlocal\",{\"_index\":16,\"name\":{\"18\":{}},\"parent\":{}}],[\"pushremote\",{\"_index\":17,\"name\":{\"19\":{}},\"parent\":{}}],[\"remote\",{\"_index\":7,\"name\":{\"7\":{},\"13\":{}},\"parent\":{}}],[\"remotecontents\",{\"_index\":4,\"name\":{\"4\":{}},\"parent\":{}}],[\"sign\",{\"_index\":20,\"name\":{\"22\":{}},\"parent\":{}}],[\"to\",{\"_index\":2,\"name\":{\"2\":{}},\"parent\":{}}],[\"waitall\",{\"_index\":24,\"name\":{\"26\":{}},\"parent\":{}}],[\"waitdomain\",{\"_index\":23,\"name\":{\"25\":{}},\"parent\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/public/sdk-govern/assets/style.css b/docs/public/sdk-govern/assets/style.css deleted file mode 100644 index a16ed02..0000000 --- a/docs/public/sdk-govern/assets/style.css +++ /dev/null @@ -1,1413 +0,0 @@ -@import url("./icons.css"); - -:root { - /* Light */ - --light-color-background: #fcfcfc; - --light-color-secondary-background: #fff; - --light-color-text: #222; - --light-color-text-aside: #707070; - --light-color-link: #4da6ff; - --light-color-menu-divider: #eee; - --light-color-menu-divider-focus: #000; - --light-color-menu-label: #707070; - --light-color-panel: var(--light-color-secondary-background); - --light-color-panel-divider: #eee; - --light-color-comment-tag: #707070; - --light-color-comment-tag-text: #fff; - --light-color-ts: #9600ff; - --light-color-ts-interface: #647f1b; - --light-color-ts-enum: #937210; - --light-color-ts-class: #0672de; - --light-color-ts-private: #707070; - --light-color-toolbar: #fff; - --light-color-toolbar-text: #333; - --light-icon-filter: invert(0); - --light-external-icon: url("data:image/svg+xml;utf8,"); - - /* Dark */ - --dark-color-background: #36393f; - --dark-color-secondary-background: #2f3136; - --dark-color-text: #ffffff; - --dark-color-text-aside: #e6e4e4; - --dark-color-link: #00aff4; - --dark-color-menu-divider: #eee; - --dark-color-menu-divider-focus: #000; - --dark-color-menu-label: #707070; - --dark-color-panel: var(--dark-color-secondary-background); - --dark-color-panel-divider: #818181; - --dark-color-comment-tag: #dcddde; - --dark-color-comment-tag-text: #2f3136; - --dark-color-ts: #c97dff; - --dark-color-ts-interface: #9cbe3c; - --dark-color-ts-enum: #d6ab29; - --dark-color-ts-class: #3695f3; - --dark-color-ts-private: #e2e2e2; - --dark-color-toolbar: #34373c; - --dark-color-toolbar-text: #ffffff; - --dark-icon-filter: invert(1); - --dark-external-icon: url("data:image/svg+xml;utf8,"); -} - -@media (prefers-color-scheme: light) { - :root { - --color-background: var(--light-color-background); - --color-secondary-background: var(--light-color-secondary-background); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - --color-menu-divider: var(--light-color-menu-divider); - --color-menu-divider-focus: var(--light-color-menu-divider-focus); - --color-menu-label: var(--light-color-menu-label); - --color-panel: var(--light-color-panel); - --color-panel-divider: var(--light-color-panel-divider); - --color-comment-tag: var(--light-color-comment-tag); - --color-comment-tag-text: var(--light-color-comment-tag-text); - --color-ts: var(--light-color-ts); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-class: var(--light-color-ts-class); - --color-ts-private: var(--light-color-ts-private); - --color-toolbar: var(--light-color-toolbar); - --color-toolbar-text: var(--light-color-toolbar-text); - --icon-filter: var(--light-icon-filter); - --external-icon: var(--light-external-icon); - } -} - -@media (prefers-color-scheme: dark) { - :root { - --color-background: var(--dark-color-background); - --color-secondary-background: var(--dark-color-secondary-background); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - --color-menu-divider: var(--dark-color-menu-divider); - --color-menu-divider-focus: var(--dark-color-menu-divider-focus); - --color-menu-label: var(--dark-color-menu-label); - --color-panel: var(--dark-color-panel); - --color-panel-divider: var(--dark-color-panel-divider); - --color-comment-tag: var(--dark-color-comment-tag); - --color-comment-tag-text: var(--dark-color-comment-tag-text); - --color-ts: var(--dark-color-ts); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-private: var(--dark-color-ts-private); - --color-toolbar: var(--dark-color-toolbar); - --color-toolbar-text: var(--dark-color-toolbar-text); - --icon-filter: var(--dark-icon-filter); - --external-icon: var(--dark-external-icon); - } -} - -body { - margin: 0; -} - -body.light { - --color-background: var(--light-color-background); - --color-secondary-background: var(--light-color-secondary-background); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - --color-menu-divider: var(--light-color-menu-divider); - --color-menu-divider-focus: var(--light-color-menu-divider-focus); - --color-menu-label: var(--light-color-menu-label); - --color-panel: var(--light-color-panel); - --color-panel-divider: var(--light-color-panel-divider); - --color-comment-tag: var(--light-color-comment-tag); - --color-comment-tag-text: var(--light-color-comment-tag-text); - --color-ts: var(--light-color-ts); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-class: var(--light-color-ts-class); - --color-ts-private: var(--light-color-ts-private); - --color-toolbar: var(--light-color-toolbar); - --color-toolbar-text: var(--light-color-toolbar-text); - --icon-filter: var(--light-icon-filter); - --external-icon: var(--light-external-icon); -} - -body.dark { - --color-background: var(--dark-color-background); - --color-secondary-background: var(--dark-color-secondary-background); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - --color-menu-divider: var(--dark-color-menu-divider); - --color-menu-divider-focus: var(--dark-color-menu-divider-focus); - --color-menu-label: var(--dark-color-menu-label); - --color-panel: var(--dark-color-panel); - --color-panel-divider: var(--dark-color-panel-divider); - --color-comment-tag: var(--dark-color-comment-tag); - --color-comment-tag-text: var(--dark-color-comment-tag-text); - --color-ts: var(--dark-color-ts); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-private: var(--dark-color-ts-private); - --color-toolbar: var(--dark-color-toolbar); - --color-toolbar-text: var(--dark-color-toolbar-text); - --icon-filter: var(--dark-icon-filter); - --external-icon: var(--dark-external-icon); -} - -h1, -h2, -h3, -h4, -h5, -h6 { - line-height: 1.2; -} - -h1 { - font-size: 2em; - margin: 0.67em 0; -} - -h2 { - font-size: 1.5em; - margin: 0.83em 0; -} - -h3 { - font-size: 1.17em; - margin: 1em 0; -} - -h4, -.tsd-index-panel h3 { - font-size: 1em; - margin: 1.33em 0; -} - -h5 { - font-size: 0.83em; - margin: 1.67em 0; -} - -h6 { - font-size: 0.67em; - margin: 2.33em 0; -} - -pre { - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; -} - -dl, -menu, -ol, -ul { - margin: 1em 0; -} - -dd { - margin: 0 0 0 40px; -} - -.container { - max-width: 1200px; - margin: 0 auto; - padding: 0 40px; -} -@media (max-width: 640px) { - .container { - padding: 0 20px; - } -} - -.container-main { - padding-bottom: 200px; -} - -.row { - display: flex; - position: relative; - margin: 0 -10px; -} -.row:after { - visibility: hidden; - display: block; - content: ""; - clear: both; - height: 0; -} - -.col-4, -.col-8 { - box-sizing: border-box; - float: left; - padding: 0 10px; -} - -.col-4 { - width: 33.3333333333%; -} -.col-8 { - width: 66.6666666667%; -} - -ul.tsd-descriptions > li > :first-child, -.tsd-panel > :first-child, -.col-8 > :first-child, -.col-4 > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child, -.tsd-panel > :first-child > :first-child, -.col-8 > :first-child > :first-child, -.col-4 > :first-child > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child > :first-child, -.tsd-panel > :first-child > :first-child > :first-child, -.col-8 > :first-child > :first-child > :first-child, -.col-4 > :first-child > :first-child > :first-child { - margin-top: 0; -} -ul.tsd-descriptions > li > :last-child, -.tsd-panel > :last-child, -.col-8 > :last-child, -.col-4 > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child, -.tsd-panel > :last-child > :last-child, -.col-8 > :last-child > :last-child, -.col-4 > :last-child > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child > :last-child, -.tsd-panel > :last-child > :last-child > :last-child, -.col-8 > :last-child > :last-child > :last-child, -.col-4 > :last-child > :last-child > :last-child { - margin-bottom: 0; -} - -@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 shift-to-left { - from { - transform: translate(0, 0); - } - to { - transform: translate(-25%, 0); - } -} -@keyframes unshift-to-left { - from { - transform: translate(-25%, 0); - } - to { - transform: translate(0, 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: 14px; -} - -pre { - padding: 10px; -} -pre code { - padding: 0; - font-size: 100%; -} - -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 h4, -.tsd-typography .tsd-index-panel h3, -.tsd-index-panel .tsd-typography h3, -.tsd-typography h5, -.tsd-typography h6 { - font-size: 1em; - margin: 0; -} -.tsd-typography h5, -.tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, -.tsd-typography ul, -.tsd-typography ol { - margin: 1em 0; -} - -@media (min-width: 901px) and (max-width: 1024px) { - html .col-content { - width: 72%; - } - html .col-menu { - width: 28%; - } - html .tsd-navigation { - padding-left: 10px; - } -} -@media (max-width: 900px) { - html .col-content { - float: none; - width: 100%; - } - html .col-menu { - position: fixed !important; - overflow: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - width: 100%; - padding: 20px 20px 0 0; - max-width: 450px; - visibility: hidden; - background-color: var(--color-panel); - transform: translate(100%, 0); - } - html .col-menu > *: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 :is(header, footer, .col-content) { - animation: shift-to-left 0.4s; - } - - .to-has-menu .col-menu { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu :is(header, footer, .col-content) { - animation: unshift-to-left 0.4s; - } - - .from-has-menu .col-menu { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu :is(header, footer, .col-content) { - transform: translate(-25%, 0); - } - .has-menu .col-menu { - visibility: visible; - transform: translate(0, 0); - display: grid; - grid-template-rows: auto 1fr; - max-height: 100vh; - } - .has-menu .tsd-navigation { - max-height: 100%; - } -} - -.tsd-page-title { - padding: 70px 0 20px 0; - margin: 0 0 40px 0; - background: var(--color-panel); - box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); -} -.tsd-page-title h1 { - margin: 0; -} - -.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: " / "; -} - -dl.tsd-comment-tags { - overflow: hidden; -} -dl.tsd-comment-tags dt { - float: left; - padding: 1px 5px; - margin: 0 10px 0 0; - border-radius: 4px; - border: 1px solid var(--color-comment-tag); - color: var(--color-comment-tag); - font-size: 0.8em; - font-weight: normal; -} -dl.tsd-comment-tags dd { - margin: 0 0 10px 0; -} -dl.tsd-comment-tags dd:before, -dl.tsd-comment-tags dd:after { - display: table; - content: " "; -} -dl.tsd-comment-tags dd pre, -dl.tsd-comment-tags dd:after { - clear: both; -} -dl.tsd-comment-tags 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; -} - -.toggle-protected .tsd-is-private { - display: none; -} - -.toggle-public .tsd-is-private, -.toggle-public .tsd-is-protected, -.toggle-public .tsd-is-private-protected { - display: none; -} - -.toggle-inherited .tsd-is-inherited { - display: none; -} - -.toggle-externals .tsd-is-external { - display: none; -} - -#tsd-filter { - position: relative; - display: inline-block; - height: 40px; - vertical-align: bottom; -} -.no-filter #tsd-filter { - display: none; -} -#tsd-filter .tsd-filter-group { - display: inline-block; - height: 40px; - vertical-align: bottom; - white-space: nowrap; -} -#tsd-filter input { - display: none; -} -@media (max-width: 900px) { - #tsd-filter .tsd-filter-group { - display: block; - position: absolute; - top: 40px; - right: 20px; - height: auto; - background-color: var(--color-panel); - visibility: hidden; - transform: translate(50%, 0); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - } - .has-options #tsd-filter .tsd-filter-group { - visibility: visible; - } - .to-has-options #tsd-filter .tsd-filter-group { - animation: fade-in 0.2s; - } - .from-has-options #tsd-filter .tsd-filter-group { - animation: fade-out 0.2s; - } - #tsd-filter label, - #tsd-filter .tsd-select { - display: block; - padding-right: 20px; - } -} - -footer { - border-top: 1px solid var(--color-panel-divider); - background-color: var(--color-panel); -} -footer:after { - content: ""; - display: table; -} -footer.with-border-bottom { - border-bottom: 1px solid var(--color-panel-divider); -} -footer .tsd-legend-group { - font-size: 0; -} -footer .tsd-legend { - display: inline-block; - width: 25%; - padding: 0; - font-size: 16px; - list-style: none; - line-height: 1.333em; - vertical-align: top; -} -@media (max-width: 900px) { - footer .tsd-legend { - width: 50%; - } -} - -.tsd-hierarchy { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} - -.tsd-index-panel .tsd-index-content { - margin-bottom: -30px !important; -} -.tsd-index-panel .tsd-index-section { - margin-bottom: 30px !important; -} -.tsd-index-panel h3 { - margin: 0 -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 3; - -moz-column-count: 3; - -ms-column-count: 3; - -o-column-count: 3; - column-count: 3; - -webkit-column-gap: 20px; - -moz-column-gap: 20px; - -ms-column-gap: 20px; - -o-column-gap: 20px; - column-gap: 20px; - padding: 0; - list-style: none; - line-height: 1.333em; -} -@media (max-width: 900px) { - .tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 1; - -moz-column-count: 1; - -ms-column-count: 1; - -o-column-count: 1; - column-count: 1; - } -} -@media (min-width: 901px) and (max-width: 1024px) { - .tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 2; - -moz-column-count: 2; - -ms-column-count: 2; - -o-column-count: 2; - column-count: 2; - } -} -.tsd-index-panel ul.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-index-panel a, -.tsd-index-panel .tsd-parent-kind-module a { - color: var(--color-ts); -} -.tsd-index-panel .tsd-parent-kind-interface a { - color: var(--color-ts-interface); -} -.tsd-index-panel .tsd-parent-kind-enum a { - color: var(--color-ts-enum); -} -.tsd-index-panel .tsd-parent-kind-class a { - color: var(--color-ts-class); -} -.tsd-index-panel .tsd-kind-module a { - color: var(--color-ts); -} -.tsd-index-panel .tsd-kind-interface a { - color: var(--color-ts-interface); -} -.tsd-index-panel .tsd-kind-enum a { - color: var(--color-ts-enum); -} -.tsd-index-panel .tsd-kind-class a { - color: var(--color-ts-class); -} -.tsd-index-panel .tsd-is-private a { - color: var(--color-ts-private); -} - -.tsd-flag { - display: inline-block; - padding: 1px 5px; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 14px; - font-weight: normal; -} - -.tsd-anchor { - position: absolute; - top: -100px; -} - -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} -.tsd-member [data-tsd-kind] { - color: var(--color-ts); -} -.tsd-member [data-tsd-kind="Interface"] { - color: var(--color-ts-interface); -} -.tsd-member [data-tsd-kind="Enum"] { - color: var(--color-ts-enum); -} -.tsd-member [data-tsd-kind="Class"] { - color: var(--color-ts-class); -} -.tsd-member [data-tsd-kind="Private"] { - color: var(--color-ts-private); -} - -.tsd-navigation { - margin: 0 0 0 40px; -} -.tsd-navigation a { - display: block; - padding-top: 2px; - padding-bottom: 2px; - border-left: 2px solid transparent; - color: var(--color-text); - text-decoration: none; - transition: border-left-color 0.1s; -} -.tsd-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul { - margin: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li { - padding: 0; -} - -.tsd-navigation.primary { - padding-bottom: 40px; -} -.tsd-navigation.primary a { - display: block; - padding-top: 6px; - padding-bottom: 6px; -} -.tsd-navigation.primary ul li a { - padding-left: 5px; -} -.tsd-navigation.primary ul li li a { - padding-left: 25px; -} -.tsd-navigation.primary ul li li li a { - padding-left: 45px; -} -.tsd-navigation.primary ul li li li li a { - padding-left: 65px; -} -.tsd-navigation.primary ul li li li li li a { - padding-left: 85px; -} -.tsd-navigation.primary ul li li li li li li a { - padding-left: 105px; -} -.tsd-navigation.primary > ul { - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-navigation.primary li { - border-top: 1px solid var(--color-panel-divider); -} -.tsd-navigation.primary li.current > a { - font-weight: bold; -} -.tsd-navigation.primary li.label span { - display: block; - padding: 20px 0 6px 5px; - color: var(--color-menu-label); -} -.tsd-navigation.primary li.globals + li > span, -.tsd-navigation.primary li.globals + li > a { - padding-top: 20px; -} - -.tsd-navigation.secondary { - max-height: calc(100vh - 1rem - 40px); - overflow: auto; - position: sticky; - top: calc(0.5rem + 40px); - transition: 0.3s; -} -.tsd-navigation.secondary.tsd-navigation--toolbar-hide { - max-height: calc(100vh - 1rem); - top: 0.5rem; -} -.tsd-navigation.secondary ul { - transition: opacity 0.2s; -} -.tsd-navigation.secondary ul li a { - padding-left: 25px; -} -.tsd-navigation.secondary ul li li a { - padding-left: 45px; -} -.tsd-navigation.secondary ul li li li a { - padding-left: 65px; -} -.tsd-navigation.secondary ul li li li li a { - padding-left: 85px; -} -.tsd-navigation.secondary ul li li li li li a { - padding-left: 105px; -} -.tsd-navigation.secondary ul li li li li li li a { - padding-left: 125px; -} -.tsd-navigation.secondary ul.current a { - border-left-color: var(--color-panel-divider); -} -.tsd-navigation.secondary li.focus > a, -.tsd-navigation.secondary ul.current li.focus > a { - border-left-color: var(--color-menu-divider-focus); -} -.tsd-navigation.secondary li.current { - margin-top: 20px; - margin-bottom: 20px; - border-left-color: var(--color-panel-divider); -} -.tsd-navigation.secondary li.current > a { - font-weight: bold; -} - -@media (min-width: 901px) { - .menu-sticky-wrap { - position: static; - } -} - -.tsd-panel { - margin: 20px 0; - padding: 20px; - background-color: var(--color-panel); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, -.tsd-panel > h2, -.tsd-panel > h3 { - margin: 1.5em -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-panel > h1.tsd-before-signature, -.tsd-panel > h2.tsd-before-signature, -.tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: 0; -} -.tsd-panel table { - display: block; - width: 100%; - overflow: auto; - margin-top: 10px; - word-break: normal; - word-break: keep-all; - border-collapse: collapse; -} -.tsd-panel table th { - font-weight: bold; -} -.tsd-panel table th, -.tsd-panel table td { - padding: 6px 13px; - border: 1px solid var(--color-panel-divider); -} -.tsd-panel table tr { - background: var(--color-background); -} -.tsd-panel table tr:nth-child(even) { - background: var(--color-secondary-background); -} - -.tsd-panel-group { - margin: 60px 0; -} -.tsd-panel-group > h1, -.tsd-panel-group > h2, -.tsd-panel-group > h3 { - padding-left: 20px; - padding-right: 20px; -} - -#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: 40px; - height: 40px; -} -#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 { - 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 { - padding: 0 10px; - background-color: var(--color-background); -} -#tsd-search .results li:nth-child(even) { - background-color: var(--color-panel); -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current, -#tsd-search .results li:hover { - background-color: var(--color-panel-divider); -} -#tsd-search .results a { - display: block; -} -#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-panel-divider); -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title { - 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-signature { - margin: 0 0 1em 0; - padding: 10px; - border: 1px solid var(--color-panel-divider); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; -} -.tsd-signature.tsd-kind-icon { - padding-left: 30px; -} -.tsd-signature.tsd-kind-icon:before { - top: 10px; - left: 10px; -} -.tsd-panel > .tsd-signature { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; -} -.tsd-panel > .tsd-signature.tsd-kind-icon { - padding-left: 40px; -} -.tsd-panel > .tsd-signature.tsd-kind-icon:before { - left: 20px; -} - -.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; - border: 1px solid var(--color-panel-divider); -} -.tsd-signatures .tsd-signature { - margin: 0; - border-width: 1px 0 0 0; - transition: background-color 0.1s; -} -.tsd-signatures .tsd-signature:first-child { - border-top-width: 0; -} -.tsd-signatures .tsd-signature.current { - background-color: var(--color-panel-divider); -} -.tsd-signatures.active > .tsd-signature { - cursor: pointer; -} -.tsd-panel > .tsd-signatures { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; -} -.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { - padding-left: 40px; -} -.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { - left: 20px; -} -.tsd-panel > a.anchor + .tsd-signatures { - border-top-width: 0; - margin-top: -20px; -} - -ul.tsd-descriptions { - position: relative; - overflow: hidden; - padding: 0; - list-style: none; -} -ul.tsd-descriptions.active > .tsd-description { - display: none; -} -ul.tsd-descriptions.active > .tsd-description.current { - display: block; -} -ul.tsd-descriptions.active > .tsd-description.fade-in { - animation: fade-in-delayed 0.3s; -} -ul.tsd-descriptions.active > .tsd-description.fade-out { - animation: fade-out-delayed 0.3s; - position: absolute; - display: block; - top: 0; - left: 0; - right: 0; - opacity: 0; - visibility: hidden; -} -ul.tsd-descriptions h4, -ul.tsd-descriptions .tsd-index-panel h3, -.tsd-index-panel ul.tsd-descriptions h3 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} - -ul.tsd-parameters, -ul.tsd-type-parameters { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameters > li.tsd-parameter-signature, -ul.tsd-type-parameters > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameters h5, -ul.tsd-type-parameters h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -ul.tsd-parameters .tsd-comment, -ul.tsd-type-parameters .tsd-comment { - margin-top: -0.5em; -} - -.tsd-sources { - font-size: 14px; - color: var(--color-text-aside); - margin: 0 0 1em 0; -} -.tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; -} -.tsd-sources ul, -.tsd-sources p { - margin: 0 !important; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: fixed; - z-index: 1; - top: 0; - left: 0; - width: 100%; - height: 40px; - color: var(--color-toolbar-text); - background: var(--color-toolbar); - border-bottom: 1px solid var(--color-panel-divider); - transition: transform 0.3s linear; -} -.tsd-page-toolbar a { - color: var(--color-toolbar-text); - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .table-wrap { - display: table; - width: 100%; - height: 40px; -} -.tsd-page-toolbar .table-cell { - display: table-cell; - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} - -.tsd-page-toolbar--hide { - transform: translateY(-100%); -} - -.tsd-select .tsd-select-list li:before, -.tsd-select .tsd-select-label:before, -.tsd-widget:before { - content: ""; - display: inline-block; - width: 40px; - height: 40px; - margin: 0 -8px 0 0; - background-image: url(./widgets.png); - background-repeat: no-repeat; - text-indent: -1024px; - vertical-align: bottom; - filter: var(--icon-filter); -} -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-select .tsd-select-list li:before, - .tsd-select .tsd-select-label:before, - .tsd-widget:before { - background-image: url(./widgets@2x.png); - background-size: 320px 40px; - } -} - -.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-panel-divider); -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} -.tsd-widget.search:before { - background-position: 0 0; -} -.tsd-widget.menu:before { - background-position: -40px 0; -} -.tsd-widget.options:before { - background-position: -80px 0; -} -.tsd-widget.options, -.tsd-widget.menu { - display: none; -} -@media (max-width: 900px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; - } -} -input[type="checkbox"] + .tsd-widget:before { - background-position: -120px 0; -} -input[type="checkbox"]:checked + .tsd-widget:before { - background-position: -160px 0; -} - -.tsd-select { - position: relative; - display: inline-block; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-select .tsd-select-label { - opacity: 0.6; - transition: opacity 0.2s; -} -.tsd-select .tsd-select-label:before { - background-position: -240px 0; -} -.tsd-select.active .tsd-select-label { - opacity: 0.8; -} -.tsd-select.active .tsd-select-list { - visibility: visible; - opacity: 1; - transition-delay: 0s; -} -.tsd-select .tsd-select-list { - position: absolute; - visibility: hidden; - top: 40px; - left: 0; - margin: 0; - padding: 0; - opacity: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - transition: visibility 0s 0.2s, opacity 0.2s; -} -.tsd-select .tsd-select-list li { - padding: 0 20px 0 0; - background-color: var(--color-background); -} -.tsd-select .tsd-select-list li:before { - background-position: 40px 0; -} -.tsd-select .tsd-select-list li:nth-child(even) { - background-color: var(--color-panel); -} -.tsd-select .tsd-select-list li:hover { - background-color: var(--color-panel-divider); -} -.tsd-select .tsd-select-list li.selected:before { - background-position: -200px 0; -} -@media (max-width: 900px) { - .tsd-select .tsd-select-list { - top: 0; - left: auto; - right: 100%; - margin-right: -5px; - } - .tsd-select .tsd-select-label:before { - background-position: -280px 0; - } -} - -img { - max-width: 100%; -} - -.tsd-anchor-icon { - margin-left: 10px; - 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; -} diff --git a/docs/public/sdk-govern/assets/widgets.png b/docs/public/sdk-govern/assets/widgets.png deleted file mode 100644 index c738053..0000000 Binary files a/docs/public/sdk-govern/assets/widgets.png and /dev/null differ diff --git a/docs/public/sdk-govern/assets/widgets@2x.png b/docs/public/sdk-govern/assets/widgets@2x.png deleted file mode 100644 index 4bbbd57..0000000 Binary files a/docs/public/sdk-govern/assets/widgets@2x.png and /dev/null differ diff --git a/docs/public/sdk-govern/classes/CallBatch.html b/docs/public/sdk-govern/classes/CallBatch.html deleted file mode 100644 index 4190733..0000000 --- a/docs/public/sdk-govern/classes/CallBatch.html +++ /dev/null @@ -1 +0,0 @@ -CallBatch | @nomad-xyz/sdk-govern
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • CallBatch

Index

Constructors

  • new CallBatch(context: NomadContext, governorDomain: number, callerKnowsWhatTheyAreDoing: boolean): CallBatch
  • Parameters

    • context: NomadContext
    • governorDomain: number
    • callerKnowsWhatTheyAreDoing: boolean

    Returns CallBatch

Properties

built?: PopulatedTransaction
context: NomadContext
governorCore: CoreContracts
local: Readonly<Call>[]
remote: Map<number, Readonly<Call>[]>

Accessors

  • get domains(): number[]

Methods

  • batchHash(domain: number): string
  • Parameters

    • domain: number

    Returns string

  • build(): Promise<PopulatedTransaction>
  • Returns Promise<PopulatedTransaction>

  • execute(): Promise<TransactionResponse>
  • executeDomain(domain: number): Promise<TransactionResponse>
  • Parameters

    • domain: number

    Returns Promise<TransactionResponse>

  • pushLocal(call: Partial<Call>): void
  • pushRemote(domain: number, call: Partial<Call>): void
  • Parameters

    • domain: number
    • call: Partial<Call>

    Returns void

  • sign(): Promise<string>
  • waitAll(): Promise<TransactionReceipt[]>
  • Returns Promise<TransactionReceipt[]>

  • waitDomain(domain: number): Promise<TransactionReceipt>
  • Parameters

    • domain: number

    Returns Promise<TransactionReceipt>

  • fromContext(context: NomadContext): Promise<CallBatch>

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Private property
  • Static method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk-govern/index.html b/docs/public/sdk-govern/index.html deleted file mode 100644 index 16f47cf..0000000 --- a/docs/public/sdk-govern/index.html +++ /dev/null @@ -1,15 +0,0 @@ -@nomad-xyz/sdk-govern
Options
All
  • Public
  • Public/Protected
  • All
Menu

@nomad-xyz/sdk-govern

- -

Nomad Govern SDK

-
-

This package includes the CallBatch, a management system for Nomad governance -actions. CallBatch allows developers to easily instruct the Nomad governance -system to interact with contracts on any network. It is intended to be used in -conjunction with a NomadContext object.

- - -

Building

-
-
yarn build
-
-

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Private property
  • Static method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk-govern/interfaces/Call.html b/docs/public/sdk-govern/interfaces/Call.html deleted file mode 100644 index fa07a12..0000000 --- a/docs/public/sdk-govern/interfaces/Call.html +++ /dev/null @@ -1 +0,0 @@ -Call | @nomad-xyz/sdk-govern
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Call

Index

Properties

Properties

data: BytesLike
to: string

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Private property
  • Static method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk-govern/interfaces/CallBatchContents.html b/docs/public/sdk-govern/interfaces/CallBatchContents.html deleted file mode 100644 index fa7dc23..0000000 --- a/docs/public/sdk-govern/interfaces/CallBatchContents.html +++ /dev/null @@ -1 +0,0 @@ -CallBatchContents | @nomad-xyz/sdk-govern
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CallBatchContents

Hierarchy

  • CallBatchContents

Index

Properties

Properties

local: Call[]

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Private property
  • Static method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk-govern/interfaces/RemoteContents.html b/docs/public/sdk-govern/interfaces/RemoteContents.html deleted file mode 100644 index ea545c6..0000000 --- a/docs/public/sdk-govern/interfaces/RemoteContents.html +++ /dev/null @@ -1 +0,0 @@ -RemoteContents | @nomad-xyz/sdk-govern
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RemoteContents

Hierarchy

  • RemoteContents

Indexable

[domain: string]: Call[]

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Private property
  • Static method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk-govern/modules.html b/docs/public/sdk-govern/modules.html deleted file mode 100644 index 92a2274..0000000 --- a/docs/public/sdk-govern/modules.html +++ /dev/null @@ -1 +0,0 @@ -@nomad-xyz/sdk-govern
Options
All
  • Public
  • Public/Protected
  • All
Menu

@nomad-xyz/sdk-govern

Index

Type aliases

Action: Batch | TransferGovernor
Address: string

Functions

  • parseAction(raw: BytesLike): Action

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Private property
  • Static method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk/.nojekyll b/docs/public/sdk/.nojekyll deleted file mode 100644 index e2ac661..0000000 --- a/docs/public/sdk/.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/public/sdk/assets/highlight.css b/docs/public/sdk/assets/highlight.css deleted file mode 100644 index 5b3bce0..0000000 --- a/docs/public/sdk/assets/highlight.css +++ /dev/null @@ -1,36 +0,0 @@ -:root { - --light-hl-0: #001080; - --dark-hl-0: #9CDCFE; - --light-hl-1: #000000; - --dark-hl-1: #D4D4D4; - --light-code-background: #F5F5F5; - --dark-code-background: #1E1E1E; -} - -@media (prefers-color-scheme: light) { :root { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --code-background: var(--light-code-background); -} } - -@media (prefers-color-scheme: dark) { :root { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --code-background: var(--dark-code-background); -} } - -body.light { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --code-background: var(--light-code-background); -} - -body.dark { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --code-background: var(--dark-code-background); -} - -.hl-0 { color: var(--hl-0); } -.hl-1 { color: var(--hl-1); } -pre, code { background: var(--code-background); } diff --git a/docs/public/sdk/assets/icons.css b/docs/public/sdk/assets/icons.css deleted file mode 100644 index 776a356..0000000 --- a/docs/public/sdk/assets/icons.css +++ /dev/null @@ -1,1043 +0,0 @@ -.tsd-kind-icon { - display: block; - position: relative; - padding-left: 20px; - text-indent: -20px; -} -.tsd-kind-icon:before { - content: ""; - display: inline-block; - vertical-align: middle; - width: 17px; - height: 17px; - margin: 0 3px 2px 0; - background-image: url(./icons.png); -} -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-kind-icon:before { - background-image: url(./icons@2x.png); - background-size: 238px 204px; - } -} - -.tsd-signature.tsd-kind-icon:before { - background-position: 0 -153px; -} - -.tsd-kind-object-literal > .tsd-kind-icon:before { - background-position: 0px -17px; -} -.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -17px; -} -.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -17px; -} - -.tsd-kind-class > .tsd-kind-icon:before { - background-position: 0px -34px; -} -.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -34px; -} -.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -34px; -} - -.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -51px; -} -.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -17px -51px; -} -.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -51px; -} - -.tsd-kind-interface > .tsd-kind-icon:before { - background-position: 0px -68px; -} -.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -68px; -} -.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -68px; -} - -.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -85px; -} -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -17px -85px; -} -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private - > .tsd-kind-icon:before { - background-position: -34px -85px; -} - -.tsd-kind-namespace > .tsd-kind-icon:before { - background-position: 0px -102px; -} -.tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; -} -.tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; -} - -.tsd-kind-module > .tsd-kind-icon:before { - background-position: 0px -102px; -} -.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; -} -.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; -} - -.tsd-kind-enum > .tsd-kind-icon:before { - background-position: 0px -119px; -} -.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -119px; -} -.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -119px; -} - -.tsd-kind-enum-member > .tsd-kind-icon:before { - background-position: 0px -136px; -} -.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -136px; -} -.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -136px; -} - -.tsd-kind-signature > .tsd-kind-icon:before { - background-position: 0px -153px; -} -.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -153px; -} -.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -153px; -} - -.tsd-kind-type-alias > .tsd-kind-icon:before { - background-position: 0px -170px; -} -.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -170px; -} -.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -170px; -} - -.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -187px; -} -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -17px -187px; -} -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private - > .tsd-kind-icon:before { - background-position: -34px -187px; -} - -.tsd-kind-variable > .tsd-kind-icon:before { - background-position: -136px -0px; -} -.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; -} -.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; -} -.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -0px; -} - -.tsd-kind-property > .tsd-kind-icon:before { - background-position: -136px -0px; -} -.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; -} -.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; -} -.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -0px; -} - -.tsd-kind-get-signature > .tsd-kind-icon:before { - background-position: -136px -17px; -} -.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -17px; -} -.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -17px; -} - -.tsd-kind-set-signature > .tsd-kind-icon:before { - background-position: -136px -34px; -} -.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -34px; -} -.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -34px; -} - -.tsd-kind-accessor > .tsd-kind-icon:before { - background-position: -136px -51px; -} -.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -51px; -} -.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -51px; -} - -.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -153px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class - > .tsd-kind-icon:before { - background-position: -51px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum - > .tsd-kind-icon:before { - background-position: -170px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -85px; -} - -.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -153px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class - > .tsd-kind-icon:before { - background-position: -51px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum - > .tsd-kind-icon:before { - background-position: -170px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -85px; -} - -.tsd-kind-constructor > .tsd-kind-icon:before { - background-position: -136px -102px; -} -.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; -} -.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -102px; -} - -.tsd-kind-constructor-signature > .tsd-kind-icon:before { - background-position: -136px -102px; -} -.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; -} -.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -102px; -} - -.tsd-kind-index-signature > .tsd-kind-icon:before { - background-position: -136px -119px; -} -.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -119px; -} -.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -119px; -} - -.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -136px; -} -.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -136px; -} -.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -136px; -} -.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -136px; -} - -.tsd-is-static > .tsd-kind-icon:before { - background-position: -136px -153px; -} -.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -153px; -} -.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -153px; -} -.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -153px; -} -.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -153px; -} -.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -153px; -} - -.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class - > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum - > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -187px; -} diff --git a/docs/public/sdk/assets/icons.png b/docs/public/sdk/assets/icons.png deleted file mode 100644 index 3836d5f..0000000 Binary files a/docs/public/sdk/assets/icons.png and /dev/null differ diff --git a/docs/public/sdk/assets/icons@2x.png b/docs/public/sdk/assets/icons@2x.png deleted file mode 100644 index 5a209e2..0000000 Binary files a/docs/public/sdk/assets/icons@2x.png and /dev/null differ diff --git a/docs/public/sdk/assets/main.js b/docs/public/sdk/assets/main.js deleted file mode 100644 index 54869f4..0000000 --- a/docs/public/sdk/assets/main.js +++ /dev/null @@ -1,52 +0,0 @@ -(()=>{var Ce=Object.create;var J=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,_e=Object.prototype.hasOwnProperty;var Me=t=>J(t,"__esModule",{value:!0});var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!_e.call(t,i)&&(r||i!=="default")&&J(t,i,{get:()=>e[i],enumerable:!(n=Pe(e,i))||n.enumerable});return t},Ae=(t,e)=>De(Me(J(t!=null?Ce(Re(t)):{},"default",!e&&t&&t.__esModule?{get:()=>t.default,enumerable:!0}:{value:t,enumerable:!0})),t);var de=Fe((ce,he)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var h=t.utils.clone(r)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(n.slice(a,o),h))}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,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ou?h+=2:a==u&&(r+=n[l+1]*i[h+1],l+=2,h+=2);return r},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),r=1,n=0;r0){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 u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,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 l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),p=s.str.charAt(1),v;p in s.node.edges?v=s.node.edges[p]:(v=new t.TokenSet,s.node.edges[p]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.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(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},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,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<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 r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,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 r=e.peekLexeme();if(r!=null)switch(r.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 n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.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 r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.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 '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;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 r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;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,r){typeof define=="function"&&define.amd?define(r):typeof ce=="object"?he.exports=r():e.lunr=r()}(this,function(){return t})})()});var le=[];function N(t,e){le.push({selector:e,constructor:t})}var X=class{constructor(){this.createComponents(document.body)}createComponents(e){le.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n}),n.dataset.hasInstance=String(!0))})})}};var Q=class{constructor(e){this.el=e.el}};var Z=class{constructor(){this.listeners={}}addEventListener(e,r){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(r)}removeEventListener(e,r){if(!(e in this.listeners))return;let n=this.listeners[e];for(let i=0,s=n.length;i{let r=Date.now();return(...n)=>{r+e-Date.now()<0&&(t(...n),r=Date.now())}};var ee=class extends Z{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.secondaryNav=document.querySelector(".tsd-navigation.secondary"),window.addEventListener("scroll",K(()=>this.onScroll(),10)),window.addEventListener("resize",K(()=>this.onResize(),10)),this.onResize(),this.onScroll()}triggerResize(){let e=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(e)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let e=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(e)}onScroll(){this.scrollTop=window.scrollY||0;let e=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(e),this.hideShowToolbar()}hideShowToolbar(){var r;let e=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0,e!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),(r=this.secondaryNav)==null||r.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop}},I=ee;I.instance=new ee;var te=class extends Q{constructor(e){super(e);this.anchors=[];this.index=-1;I.instance.addEventListener("resize",()=>this.onResize()),I.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let e=window.location.href;e.indexOf("#")!=-1&&(e=e.substr(0,e.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let n=r.href;if(n.indexOf("#")==-1||n.substr(0,e.length)!=e)return;let i=n.substr(n.indexOf("#")+1),s=document.querySelector("a.tsd-anchor[name="+i+"]"),o=r.parentNode;!s||!o||this.anchors.push({link:o,anchor:s,position:0})}),this.onResize()}onResize(){let e;for(let n=0,i=this.anchors.length;nn.position-i.position);let r=new CustomEvent("scroll",{detail:{scrollTop:I.instance.scrollTop}});this.onScroll(r)}onScroll(e){let r=e.detail.scrollTop+5,n=this.anchors,i=n.length-1,s=this.index;for(;s>-1&&n[s].position>r;)s-=1;for(;s-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=s,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let r;return(...n)=>{clearTimeout(r),r=setTimeout(()=>t(n),e)}};var me=Ae(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Ve(t,n,r,s)}function Ve(t,e,r,n){r.addEventListener("input",ue(()=>{ze(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ne(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?fe(e,-1):s.key==="ArrowDown"?fe(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function He(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function ze(t,e,r,n){if(He(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=n.index.search(`*${i}*`);for(let o=0,a=Math.min(10,s.length);o${pe(u.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=u.classes;let p=document.createElement("a");p.href=n.base+u.url,p.classList.add("tsd-kind-icon"),p.innerHTML=l,h.append(p),e.appendChild(h)}}function fe(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Ne(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function pe(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(re(t.substring(s,o)),`${re(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(re(t.substring(s))),i.join("")}var je={"&":"&","<":"<",">":">","'":"'",'"':"""};function re(t){return t.replace(/[&<>"'"]/g,e=>je[e])}var ge=class{constructor(e,r){this.signature=e,this.description=r}addClass(e){return this.signature.classList.add(e),this.description.classList.add(e),this}removeClass(e){return this.signature.classList.remove(e),this.description.classList.remove(e),this}},ne=class extends Q{constructor(e){super(e);this.groups=[];this.index=-1;this.createGroups(),this.container&&(this.el.classList.add("active"),Array.from(this.el.children).forEach(r=>{r.addEventListener("touchstart",n=>this.onClick(n)),r.addEventListener("click",n=>this.onClick(n))}),this.container.classList.add("active"),this.setIndex(0))}setIndex(e){if(e<0&&(e=0),e>this.groups.length-1&&(e=this.groups.length-1),this.index==e)return;let r=this.groups[e];if(this.index>-1){let n=this.groups[this.index];n.removeClass("current").addClass("fade-out"),r.addClass("current"),r.addClass("fade-in"),I.instance.triggerResize(),setTimeout(()=>{n.removeClass("fade-out"),r.removeClass("fade-in")},300)}else r.addClass("current"),I.instance.triggerResize();this.index=e}createGroups(){let e=this.el.children;if(e.length<2)return;this.container=this.el.nextElementSibling;let r=this.container.children;this.groups=[];for(let n=0;n{r.signature===e.currentTarget&&this.setIndex(n)})}};var C="mousedown",xe="mousemove",_="mouseup",G={x:0,y:0},ye=!1,ie=!1,Be=!1,A=!1,Le=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Le?"is-mobile":"not-mobile");Le&&"ontouchstart"in document.documentElement&&(Be=!0,C="touchstart",xe="touchmove",_="touchend");document.addEventListener(C,t=>{ie=!0,A=!1;let e=C=="touchstart"?t.targetTouches[0]:t;G.y=e.pageY||0,G.x=e.pageX||0});document.addEventListener(xe,t=>{if(!!ie&&!A){let e=C=="touchstart"?t.targetTouches[0]:t,r=G.x-(e.pageX||0),n=G.y-(e.pageY||0);A=Math.sqrt(r*r+n*n)>10}});document.addEventListener(_,()=>{ie=!1});document.addEventListener("click",t=>{ye&&(t.preventDefault(),t.stopImmediatePropagation(),ye=!1)});var se=class extends Q{constructor(e){super(e);this.className=this.el.dataset.toggle||"",this.el.addEventListener(_,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(C,r=>this.onDocumentPointerDown(r)),document.addEventListener(_,r=>this.onDocumentPointerUp(r))}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 r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(e){A||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!A&&this.active&&e.target.closest(".col-menu")){let r=e.target.closest("a");if(r){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substr(0,n.indexOf("#"))),r.href.substr(0,n.length)==n&&setTimeout(()=>this.setActive(!1),250)}}}};var ae=class{constructor(e,r){this.key=e,this.value=r,this.defaultValue=r,this.initialize(),window.localStorage[this.key]&&this.setValue(this.fromLocalStorage(window.localStorage[this.key]))}initialize(){}setValue(e){if(this.value==e)return;let r=this.value;this.value=e,window.localStorage[this.key]=this.toLocalStorage(e),this.handleValueChange(r,e)}},oe=class extends ae{initialize(){let e=document.querySelector("#tsd-filter-"+this.key);!e||(this.checkbox=e,this.checkbox.addEventListener("change",()=>{this.setValue(this.checkbox.checked)}))}handleValueChange(e,r){!this.checkbox||(this.checkbox.checked=this.value,document.documentElement.classList.toggle("toggle-"+this.key,this.value!=this.defaultValue))}fromLocalStorage(e){return e=="true"}toLocalStorage(e){return e?"true":"false"}},Ee=class extends ae{initialize(){document.documentElement.classList.add("toggle-"+this.key+this.value);let e=document.querySelector("#tsd-filter-"+this.key);if(!e)return;this.select=e;let r=()=>{this.select.classList.add("active")},n=()=>{this.select.classList.remove("active")};this.select.addEventListener(C,r),this.select.addEventListener("mouseover",r),this.select.addEventListener("mouseleave",n),this.select.querySelectorAll("li").forEach(i=>{i.addEventListener(_,s=>{e.classList.remove("active"),this.setValue(s.target.dataset.value||"")})}),document.addEventListener(C,i=>{this.select.contains(i.target)||this.select.classList.remove("active")})}handleValueChange(e,r){this.select.querySelectorAll("li.selected").forEach(s=>{s.classList.remove("selected")});let n=this.select.querySelector('li[data-value="'+r+'"]'),i=this.select.querySelector(".tsd-select-label");n&&i&&(n.classList.add("selected"),i.textContent=n.textContent),document.documentElement.classList.remove("toggle-"+e),document.documentElement.classList.add("toggle-"+r)}fromLocalStorage(e){return e}toLocalStorage(e){return e}},Y=class extends Q{constructor(e){super(e);this.optionVisibility=new Ee("visibility","private"),this.optionInherited=new oe("inherited",!0),this.optionExternals=new oe("externals",!0)}static isSupported(){try{return typeof window.localStorage!="undefined"}catch{return!1}}};function we(t){let e=localStorage.getItem("tsd-theme")||"os";t.value=e,be(e),t.addEventListener("change",()=>{localStorage.setItem("tsd-theme",t.value),be(t.value)})}function be(t){switch(t){case"os":document.body.classList.remove("light","dark");break;case"light":document.body.classList.remove("dark"),document.body.classList.add("light");break;case"dark":document.body.classList.remove("light"),document.body.classList.add("dark");break}}ve();N(te,".menu-highlight");N(ne,".tsd-signatures");N(se,"a[data-toggle]");Y.isSupported()?N(Y,"#tsd-filter"):document.documentElement.classList.add("no-filter");var Te=document.getElementById("theme");Te&&we(Te);var qe=new X;Object.defineProperty(window,"app",{value:qe});})(); -/*! - * lunr.Builder - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Index - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Pipeline - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Set - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.TokenSet - * 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.tokenizer - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.trimmer - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.utils - * Copyright (C) 2020 Oliver Nightingale - */ -/** - * 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 - */ diff --git a/docs/public/sdk/assets/search.js b/docs/public/sdk/assets/search.js deleted file mode 100644 index f255f7a..0000000 --- a/docs/public/sdk/assets/search.js +++ /dev/null @@ -1 +0,0 @@ -window.searchData = JSON.parse("{\"kinds\":{\"8\":\"Enumeration\",\"16\":\"Enumeration member\",\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"262144\":\"Accessor\",\"4194304\":\"Type alias\"},\"rows\":[{\"id\":0,\"kind\":128,\"name\":\"CoreContracts\",\"url\":\"classes/CoreContracts.html\",\"classes\":\"tsd-kind-class\"},{\"id\":1,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/CoreContracts.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite\",\"parent\":\"CoreContracts\"},{\"id\":2,\"kind\":1024,\"name\":\"domain\",\"url\":\"classes/CoreContracts.html#domain\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"CoreContracts\"},{\"id\":3,\"kind\":1024,\"name\":\"deployHeight\",\"url\":\"classes/CoreContracts.html#deployHeight\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"CoreContracts\"},{\"id\":4,\"kind\":1024,\"name\":\"conf\",\"url\":\"classes/CoreContracts.html#conf\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"CoreContracts\"},{\"id\":5,\"kind\":1024,\"name\":\"_governor\",\"url\":\"classes/CoreContracts.html#_governor\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"CoreContracts\"},{\"id\":6,\"kind\":1024,\"name\":\"providerOrSigner\",\"url\":\"classes/CoreContracts.html#providerOrSigner\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"CoreContracts\"},{\"id\":7,\"kind\":2048,\"name\":\"getReplica\",\"url\":\"classes/CoreContracts.html#getReplica\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"CoreContracts\"},{\"id\":8,\"kind\":262144,\"name\":\"home\",\"url\":\"classes/CoreContracts.html#home\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"CoreContracts\"},{\"id\":9,\"kind\":262144,\"name\":\"governanceRouter\",\"url\":\"classes/CoreContracts.html#governanceRouter\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"CoreContracts\"},{\"id\":10,\"kind\":262144,\"name\":\"xAppConnectionManager\",\"url\":\"classes/CoreContracts.html#xAppConnectionManager\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"CoreContracts\"},{\"id\":11,\"kind\":2048,\"name\":\"governor\",\"url\":\"classes/CoreContracts.html#governor\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"CoreContracts\"},{\"id\":12,\"kind\":2048,\"name\":\"connect\",\"url\":\"classes/CoreContracts.html#connect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite\",\"parent\":\"CoreContracts\"},{\"id\":13,\"kind\":4194304,\"name\":\"AnnotatedLifecycleEvent\",\"url\":\"modules.html#AnnotatedLifecycleEvent\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":14,\"kind\":4194304,\"name\":\"NomadLifecyleEvent\",\"url\":\"modules.html#NomadLifecyleEvent\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":15,\"kind\":128,\"name\":\"FailedHomeError\",\"url\":\"classes/FailedHomeError.html\",\"classes\":\"tsd-kind-class\"},{\"id\":16,\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/FailedHomeError.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-class\",\"parent\":\"FailedHomeError\"},{\"id\":17,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/FailedHomeError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite\",\"parent\":\"FailedHomeError\"},{\"id\":18,\"kind\":128,\"name\":\"NomadContext\",\"url\":\"classes/NomadContext.html\",\"classes\":\"tsd-kind-class\"},{\"id\":19,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NomadContext.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite\",\"parent\":\"NomadContext\"},{\"id\":20,\"kind\":1024,\"name\":\"cores\",\"url\":\"classes/NomadContext.html#cores\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"NomadContext\"},{\"id\":21,\"kind\":1024,\"name\":\"_blacklist\",\"url\":\"classes/NomadContext.html#_blacklist\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"NomadContext\"},{\"id\":22,\"kind\":1024,\"name\":\"conf\",\"url\":\"classes/NomadContext.html#conf\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"NomadContext\"},{\"id\":23,\"kind\":262144,\"name\":\"governor\",\"url\":\"classes/NomadContext.html#governor\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"NomadContext\"},{\"id\":24,\"kind\":2048,\"name\":\"reconnect\",\"url\":\"classes/NomadContext.html#reconnect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected\",\"parent\":\"NomadContext\"},{\"id\":25,\"kind\":2048,\"name\":\"registerProvider\",\"url\":\"classes/NomadContext.html#registerProvider\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite\",\"parent\":\"NomadContext\"},{\"id\":26,\"kind\":2048,\"name\":\"registerSigner\",\"url\":\"classes/NomadContext.html#registerSigner\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite\",\"parent\":\"NomadContext\"},{\"id\":27,\"kind\":2048,\"name\":\"unregisterSigner\",\"url\":\"classes/NomadContext.html#unregisterSigner\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite\",\"parent\":\"NomadContext\"},{\"id\":28,\"kind\":2048,\"name\":\"clearSigners\",\"url\":\"classes/NomadContext.html#clearSigners\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite\",\"parent\":\"NomadContext\"},{\"id\":29,\"kind\":2048,\"name\":\"getCore\",\"url\":\"classes/NomadContext.html#getCore\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NomadContext\"},{\"id\":30,\"kind\":2048,\"name\":\"mustGetCore\",\"url\":\"classes/NomadContext.html#mustGetCore\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NomadContext\"},{\"id\":31,\"kind\":2048,\"name\":\"getReplicaFor\",\"url\":\"classes/NomadContext.html#getReplicaFor\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NomadContext\"},{\"id\":32,\"kind\":2048,\"name\":\"mustGetReplicaFor\",\"url\":\"classes/NomadContext.html#mustGetReplicaFor\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NomadContext\"},{\"id\":33,\"kind\":2048,\"name\":\"governorCore\",\"url\":\"classes/NomadContext.html#governorCore\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NomadContext\"},{\"id\":34,\"kind\":2048,\"name\":\"blacklist\",\"url\":\"classes/NomadContext.html#blacklist\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NomadContext\"},{\"id\":35,\"kind\":2048,\"name\":\"checkHomes\",\"url\":\"classes/NomadContext.html#checkHomes\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NomadContext\"},{\"id\":36,\"kind\":2048,\"name\":\"checkHome\",\"url\":\"classes/NomadContext.html#checkHome\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NomadContext\"},{\"id\":37,\"kind\":64,\"name\":\"parseMessage\",\"url\":\"modules.html#parseMessage\",\"classes\":\"tsd-kind-function\"},{\"id\":38,\"kind\":4194304,\"name\":\"ParsedMessage\",\"url\":\"modules.html#ParsedMessage\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":39,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules.html#ParsedMessage.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"ParsedMessage\"},{\"id\":40,\"kind\":1024,\"name\":\"from\",\"url\":\"modules.html#ParsedMessage.__type.from\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ParsedMessage.__type\"},{\"id\":41,\"kind\":1024,\"name\":\"sender\",\"url\":\"modules.html#ParsedMessage.__type.sender\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ParsedMessage.__type\"},{\"id\":42,\"kind\":1024,\"name\":\"nonce\",\"url\":\"modules.html#ParsedMessage.__type.nonce\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ParsedMessage.__type\"},{\"id\":43,\"kind\":1024,\"name\":\"destination\",\"url\":\"modules.html#ParsedMessage.__type.destination\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ParsedMessage.__type\"},{\"id\":44,\"kind\":1024,\"name\":\"recipient\",\"url\":\"modules.html#ParsedMessage.__type.recipient\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ParsedMessage.__type\"},{\"id\":45,\"kind\":1024,\"name\":\"body\",\"url\":\"modules.html#ParsedMessage.__type.body\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ParsedMessage.__type\"},{\"id\":46,\"kind\":4194304,\"name\":\"NomadStatus\",\"url\":\"modules.html#NomadStatus\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":47,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules.html#NomadStatus.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"NomadStatus\"},{\"id\":48,\"kind\":1024,\"name\":\"status\",\"url\":\"modules.html#NomadStatus.__type.status\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"NomadStatus.__type\"},{\"id\":49,\"kind\":1024,\"name\":\"events\",\"url\":\"modules.html#NomadStatus.__type.events\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"NomadStatus.__type\"},{\"id\":50,\"kind\":8,\"name\":\"MessageStatus\",\"url\":\"enums/MessageStatus.html\",\"classes\":\"tsd-kind-enum\"},{\"id\":51,\"kind\":16,\"name\":\"Dispatched\",\"url\":\"enums/MessageStatus.html#Dispatched\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"MessageStatus\"},{\"id\":52,\"kind\":16,\"name\":\"Included\",\"url\":\"enums/MessageStatus.html#Included\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"MessageStatus\"},{\"id\":53,\"kind\":16,\"name\":\"Relayed\",\"url\":\"enums/MessageStatus.html#Relayed\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"MessageStatus\"},{\"id\":54,\"kind\":16,\"name\":\"Processed\",\"url\":\"enums/MessageStatus.html#Processed\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"MessageStatus\"},{\"id\":55,\"kind\":8,\"name\":\"ReplicaMessageStatus\",\"url\":\"enums/ReplicaMessageStatus.html\",\"classes\":\"tsd-kind-enum\"},{\"id\":56,\"kind\":16,\"name\":\"None\",\"url\":\"enums/ReplicaMessageStatus.html#None\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"ReplicaMessageStatus\"},{\"id\":57,\"kind\":16,\"name\":\"Proven\",\"url\":\"enums/ReplicaMessageStatus.html#Proven\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"ReplicaMessageStatus\"},{\"id\":58,\"kind\":16,\"name\":\"Processed\",\"url\":\"enums/ReplicaMessageStatus.html#Processed\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"ReplicaMessageStatus\"},{\"id\":59,\"kind\":4194304,\"name\":\"EventCache\",\"url\":\"modules.html#EventCache\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":60,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules.html#EventCache.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"EventCache\"},{\"id\":61,\"kind\":1024,\"name\":\"homeUpdate\",\"url\":\"modules.html#EventCache.__type.homeUpdate\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"EventCache.__type\"},{\"id\":62,\"kind\":1024,\"name\":\"replicaUpdate\",\"url\":\"modules.html#EventCache.__type.replicaUpdate\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"EventCache.__type\"},{\"id\":63,\"kind\":1024,\"name\":\"process\",\"url\":\"modules.html#EventCache.__type.process\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"EventCache.__type\"},{\"id\":64,\"kind\":128,\"name\":\"NomadMessage\",\"url\":\"classes/NomadMessage.html\",\"classes\":\"tsd-kind-class tsd-has-type-parameter\"},{\"id\":65,\"kind\":2048,\"name\":\"baseFromReceipt\",\"url\":\"classes/NomadMessage.html#baseFromReceipt\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static\",\"parent\":\"NomadMessage\"},{\"id\":66,\"kind\":2048,\"name\":\"baseSingleFromReceipt\",\"url\":\"classes/NomadMessage.html#baseSingleFromReceipt\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static\",\"parent\":\"NomadMessage\"},{\"id\":67,\"kind\":2048,\"name\":\"baseFromTransactionHash\",\"url\":\"classes/NomadMessage.html#baseFromTransactionHash\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static\",\"parent\":\"NomadMessage\"},{\"id\":68,\"kind\":2048,\"name\":\"baseSingleFromTransactionHash\",\"url\":\"classes/NomadMessage.html#baseSingleFromTransactionHash\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static\",\"parent\":\"NomadMessage\"},{\"id\":69,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/NomadMessage.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"NomadMessage\"},{\"id\":70,\"kind\":1024,\"name\":\"dispatch\",\"url\":\"classes/NomadMessage.html#dispatch\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":71,\"kind\":1024,\"name\":\"message\",\"url\":\"classes/NomadMessage.html#message\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":72,\"kind\":1024,\"name\":\"home\",\"url\":\"classes/NomadMessage.html#home\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":73,\"kind\":1024,\"name\":\"replica\",\"url\":\"classes/NomadMessage.html#replica\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":74,\"kind\":1024,\"name\":\"context\",\"url\":\"classes/NomadMessage.html#context\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":75,\"kind\":1024,\"name\":\"cache\",\"url\":\"classes/NomadMessage.html#cache\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"NomadMessage\"},{\"id\":76,\"kind\":262144,\"name\":\"receipt\",\"url\":\"classes/NomadMessage.html#receipt\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":77,\"kind\":2048,\"name\":\"getHomeUpdate\",\"url\":\"classes/NomadMessage.html#getHomeUpdate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":78,\"kind\":2048,\"name\":\"getReplicaUpdate\",\"url\":\"classes/NomadMessage.html#getReplicaUpdate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":79,\"kind\":2048,\"name\":\"getProcess\",\"url\":\"classes/NomadMessage.html#getProcess\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":80,\"kind\":2048,\"name\":\"events\",\"url\":\"classes/NomadMessage.html#events\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":81,\"kind\":2048,\"name\":\"confirmAt\",\"url\":\"classes/NomadMessage.html#confirmAt\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":82,\"kind\":2048,\"name\":\"replicaStatus\",\"url\":\"classes/NomadMessage.html#replicaStatus\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":83,\"kind\":2048,\"name\":\"delivered\",\"url\":\"classes/NomadMessage.html#delivered\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":84,\"kind\":2048,\"name\":\"wait\",\"url\":\"classes/NomadMessage.html#wait\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":85,\"kind\":262144,\"name\":\"from\",\"url\":\"classes/NomadMessage.html#from\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":86,\"kind\":262144,\"name\":\"origin\",\"url\":\"classes/NomadMessage.html#origin\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":87,\"kind\":262144,\"name\":\"sender\",\"url\":\"classes/NomadMessage.html#sender\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":88,\"kind\":262144,\"name\":\"nonce\",\"url\":\"classes/NomadMessage.html#nonce\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":89,\"kind\":262144,\"name\":\"destination\",\"url\":\"classes/NomadMessage.html#destination\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":90,\"kind\":262144,\"name\":\"recipient\",\"url\":\"classes/NomadMessage.html#recipient\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":91,\"kind\":262144,\"name\":\"body\",\"url\":\"classes/NomadMessage.html#body\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":92,\"kind\":262144,\"name\":\"bodyHash\",\"url\":\"classes/NomadMessage.html#bodyHash\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":93,\"kind\":262144,\"name\":\"transactionHash\",\"url\":\"classes/NomadMessage.html#transactionHash\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":94,\"kind\":262144,\"name\":\"leaf\",\"url\":\"classes/NomadMessage.html#leaf\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":95,\"kind\":262144,\"name\":\"leafIndex\",\"url\":\"classes/NomadMessage.html#leafIndex\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":96,\"kind\":262144,\"name\":\"destinationAndNonce\",\"url\":\"classes/NomadMessage.html#destinationAndNonce\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":97,\"kind\":262144,\"name\":\"committedRoot\",\"url\":\"classes/NomadMessage.html#committedRoot\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"NomadMessage\"},{\"id\":98,\"kind\":128,\"name\":\"Annotated\",\"url\":\"classes/Annotated.html\",\"classes\":\"tsd-kind-class tsd-has-type-parameter\"},{\"id\":99,\"kind\":2048,\"name\":\"fromEvent\",\"url\":\"classes/Annotated.html#fromEvent\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static\",\"parent\":\"Annotated\"},{\"id\":100,\"kind\":2048,\"name\":\"fromEvents\",\"url\":\"classes/Annotated.html#fromEvents\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static\",\"parent\":\"Annotated\"},{\"id\":101,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/Annotated.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"Annotated\"},{\"id\":102,\"kind\":1024,\"name\":\"domain\",\"url\":\"classes/Annotated.html#domain\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Annotated\"},{\"id\":103,\"kind\":1024,\"name\":\"eventName\",\"url\":\"classes/Annotated.html#eventName\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Annotated\"},{\"id\":104,\"kind\":1024,\"name\":\"event\",\"url\":\"classes/Annotated.html#event\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Annotated\"},{\"id\":105,\"kind\":1024,\"name\":\"receipt\",\"url\":\"classes/Annotated.html#receipt\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Annotated\"},{\"id\":106,\"kind\":262144,\"name\":\"contractAddress\",\"url\":\"classes/Annotated.html#contractAddress\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"Annotated\"},{\"id\":107,\"kind\":262144,\"name\":\"transactionHash\",\"url\":\"classes/Annotated.html#transactionHash\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"Annotated\"},{\"id\":108,\"kind\":262144,\"name\":\"blockNumber\",\"url\":\"classes/Annotated.html#blockNumber\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"Annotated\"},{\"id\":109,\"kind\":262144,\"name\":\"blockHash\",\"url\":\"classes/Annotated.html#blockHash\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"Annotated\"},{\"id\":110,\"kind\":4194304,\"name\":\"AnnotatedDispatch\",\"url\":\"modules.html#AnnotatedDispatch\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":111,\"kind\":4194304,\"name\":\"AnnotatedUpdate\",\"url\":\"modules.html#AnnotatedUpdate\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":112,\"kind\":4194304,\"name\":\"AnnotatedProcess\",\"url\":\"modules.html#AnnotatedProcess\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":113,\"kind\":4194304,\"name\":\"DispatchEvent\",\"url\":\"modules.html#DispatchEvent\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":114,\"kind\":4194304,\"name\":\"ProcessEvent\",\"url\":\"modules.html#ProcessEvent\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":115,\"kind\":4194304,\"name\":\"UpdateEvent\",\"url\":\"modules.html#UpdateEvent\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":116,\"kind\":4194304,\"name\":\"UpdateArgs\",\"url\":\"modules.html#UpdateArgs\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":117,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules.html#UpdateArgs.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"UpdateArgs\"},{\"id\":118,\"kind\":1024,\"name\":\"homeDomain\",\"url\":\"modules.html#UpdateArgs.__type.homeDomain\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"UpdateArgs.__type\"},{\"id\":119,\"kind\":1024,\"name\":\"oldRoot\",\"url\":\"modules.html#UpdateArgs.__type.oldRoot\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"UpdateArgs.__type\"},{\"id\":120,\"kind\":1024,\"name\":\"newRoot\",\"url\":\"modules.html#UpdateArgs.__type.newRoot\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"UpdateArgs.__type\"},{\"id\":121,\"kind\":1024,\"name\":\"signature\",\"url\":\"modules.html#UpdateArgs.__type.signature\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"UpdateArgs.__type\"},{\"id\":122,\"kind\":4194304,\"name\":\"UpdateTypes\",\"url\":\"modules.html#UpdateTypes\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":123,\"kind\":4194304,\"name\":\"ProcessArgs\",\"url\":\"modules.html#ProcessArgs\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":124,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules.html#ProcessArgs.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"ProcessArgs\"},{\"id\":125,\"kind\":1024,\"name\":\"messageHash\",\"url\":\"modules.html#ProcessArgs.__type.messageHash\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ProcessArgs.__type\"},{\"id\":126,\"kind\":1024,\"name\":\"success\",\"url\":\"modules.html#ProcessArgs.__type.success\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ProcessArgs.__type\"},{\"id\":127,\"kind\":1024,\"name\":\"returnData\",\"url\":\"modules.html#ProcessArgs.__type.returnData\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"ProcessArgs.__type\"},{\"id\":128,\"kind\":4194304,\"name\":\"ProcessTypes\",\"url\":\"modules.html#ProcessTypes\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":129,\"kind\":4194304,\"name\":\"DispatchArgs\",\"url\":\"modules.html#DispatchArgs\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":130,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules.html#DispatchArgs.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"DispatchArgs\"},{\"id\":131,\"kind\":1024,\"name\":\"messageHash\",\"url\":\"modules.html#DispatchArgs.__type.messageHash\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"DispatchArgs.__type\"},{\"id\":132,\"kind\":1024,\"name\":\"leafIndex\",\"url\":\"modules.html#DispatchArgs.__type.leafIndex\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"DispatchArgs.__type\"},{\"id\":133,\"kind\":1024,\"name\":\"destinationAndNonce\",\"url\":\"modules.html#DispatchArgs.__type.destinationAndNonce\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"DispatchArgs.__type\"},{\"id\":134,\"kind\":1024,\"name\":\"committedRoot\",\"url\":\"modules.html#DispatchArgs.__type.committedRoot\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"DispatchArgs.__type\"},{\"id\":135,\"kind\":1024,\"name\":\"message\",\"url\":\"modules.html#DispatchArgs.__type.message\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"DispatchArgs.__type\"},{\"id\":136,\"kind\":4194304,\"name\":\"DispatchTypes\",\"url\":\"modules.html#DispatchTypes\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":137,\"kind\":64,\"name\":\"queryAnnotatedEvents\",\"url\":\"modules.html#queryAnnotatedEvents\",\"classes\":\"tsd-kind-function tsd-has-type-parameter\"},{\"id\":138,\"kind\":64,\"name\":\"getEvents\",\"url\":\"modules.html#getEvents\",\"classes\":\"tsd-kind-function tsd-has-type-parameter\"},{\"id\":139,\"kind\":256,\"name\":\"TSContract\",\"url\":\"interfaces/TSContract.html\",\"classes\":\"tsd-kind-interface tsd-has-type-parameter\"},{\"id\":140,\"kind\":2048,\"name\":\"queryFilter\",\"url\":\"interfaces/TSContract.html#queryFilter\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"TSContract\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"parent\"],\"fieldVectors\":[[\"name/0\",[0,23.531]],[\"parent/0\",[]],[\"name/1\",[1,32.511]],[\"parent/1\",[0,2.137]],[\"name/2\",[2,40.395]],[\"parent/2\",[0,2.137]],[\"name/3\",[3,45.504]],[\"parent/3\",[0,2.137]],[\"name/4\",[4,40.395]],[\"parent/4\",[0,2.137]],[\"name/5\",[5,45.504]],[\"parent/5\",[0,2.137]],[\"name/6\",[6,45.504]],[\"parent/6\",[0,2.137]],[\"name/7\",[7,45.504]],[\"parent/7\",[0,2.137]],[\"name/8\",[8,40.395]],[\"parent/8\",[0,2.137]],[\"name/9\",[9,45.504]],[\"parent/9\",[0,2.137]],[\"name/10\",[10,45.504]],[\"parent/10\",[0,2.137]],[\"name/11\",[11,40.395]],[\"parent/11\",[0,2.137]],[\"name/12\",[12,45.504]],[\"parent/12\",[0,2.137]],[\"name/13\",[13,45.504]],[\"parent/13\",[]],[\"name/14\",[14,45.504]],[\"parent/14\",[]],[\"name/15\",[15,37.031]],[\"parent/15\",[]],[\"name/16\",[16,29.409]],[\"parent/16\",[15,3.362]],[\"name/17\",[1,32.511]],[\"parent/17\",[15,3.362]],[\"name/18\",[17,19.854]],[\"parent/18\",[]],[\"name/19\",[1,32.511]],[\"parent/19\",[17,1.803]],[\"name/20\",[18,45.504]],[\"parent/20\",[17,1.803]],[\"name/21\",[19,45.504]],[\"parent/21\",[17,1.803]],[\"name/22\",[4,40.395]],[\"parent/22\",[17,1.803]],[\"name/23\",[11,40.395]],[\"parent/23\",[17,1.803]],[\"name/24\",[20,45.504]],[\"parent/24\",[17,1.803]],[\"name/25\",[21,45.504]],[\"parent/25\",[17,1.803]],[\"name/26\",[22,45.504]],[\"parent/26\",[17,1.803]],[\"name/27\",[23,45.504]],[\"parent/27\",[17,1.803]],[\"name/28\",[24,45.504]],[\"parent/28\",[17,1.803]],[\"name/29\",[25,45.504]],[\"parent/29\",[17,1.803]],[\"name/30\",[26,45.504]],[\"parent/30\",[17,1.803]],[\"name/31\",[27,45.504]],[\"parent/31\",[17,1.803]],[\"name/32\",[28,45.504]],[\"parent/32\",[17,1.803]],[\"name/33\",[29,45.504]],[\"parent/33\",[17,1.803]],[\"name/34\",[30,45.504]],[\"parent/34\",[17,1.803]],[\"name/35\",[31,45.504]],[\"parent/35\",[17,1.803]],[\"name/36\",[32,45.504]],[\"parent/36\",[17,1.803]],[\"name/37\",[33,45.504]],[\"parent/37\",[]],[\"name/38\",[34,40.395]],[\"parent/38\",[]],[\"name/39\",[16,29.409]],[\"parent/39\",[34,3.668]],[\"name/40\",[35,40.395]],[\"parent/40\",[36,2.8]],[\"name/41\",[37,40.395]],[\"parent/41\",[36,2.8]],[\"name/42\",[38,40.395]],[\"parent/42\",[36,2.8]],[\"name/43\",[39,40.395]],[\"parent/43\",[36,2.8]],[\"name/44\",[40,40.395]],[\"parent/44\",[36,2.8]],[\"name/45\",[41,40.395]],[\"parent/45\",[36,2.8]],[\"name/46\",[42,40.395]],[\"parent/46\",[]],[\"name/47\",[16,29.409]],[\"parent/47\",[42,3.668]],[\"name/48\",[43,45.504]],[\"parent/48\",[44,3.668]],[\"name/49\",[45,40.395]],[\"parent/49\",[44,3.668]],[\"name/50\",[46,32.511]],[\"parent/50\",[]],[\"name/51\",[47,45.504]],[\"parent/51\",[46,2.952]],[\"name/52\",[48,45.504]],[\"parent/52\",[46,2.952]],[\"name/53\",[49,45.504]],[\"parent/53\",[46,2.952]],[\"name/54\",[50,40.395]],[\"parent/54\",[46,2.952]],[\"name/55\",[51,34.517]],[\"parent/55\",[]],[\"name/56\",[52,45.504]],[\"parent/56\",[51,3.134]],[\"name/57\",[53,45.504]],[\"parent/57\",[51,3.134]],[\"name/58\",[50,40.395]],[\"parent/58\",[51,3.134]],[\"name/59\",[54,40.395]],[\"parent/59\",[]],[\"name/60\",[16,29.409]],[\"parent/60\",[54,3.668]],[\"name/61\",[55,45.504]],[\"parent/61\",[56,3.362]],[\"name/62\",[57,45.504]],[\"parent/62\",[56,3.362]],[\"name/63\",[58,45.504]],[\"parent/63\",[56,3.362]],[\"name/64\",[59,14.149]],[\"parent/64\",[]],[\"name/65\",[60,45.504]],[\"parent/65\",[59,1.285]],[\"name/66\",[61,45.504]],[\"parent/66\",[59,1.285]],[\"name/67\",[62,45.504]],[\"parent/67\",[59,1.285]],[\"name/68\",[63,45.504]],[\"parent/68\",[59,1.285]],[\"name/69\",[1,32.511]],[\"parent/69\",[59,1.285]],[\"name/70\",[64,45.504]],[\"parent/70\",[59,1.285]],[\"name/71\",[65,40.395]],[\"parent/71\",[59,1.285]],[\"name/72\",[8,40.395]],[\"parent/72\",[59,1.285]],[\"name/73\",[66,45.504]],[\"parent/73\",[59,1.285]],[\"name/74\",[67,45.504]],[\"parent/74\",[59,1.285]],[\"name/75\",[68,45.504]],[\"parent/75\",[59,1.285]],[\"name/76\",[69,40.395]],[\"parent/76\",[59,1.285]],[\"name/77\",[70,45.504]],[\"parent/77\",[59,1.285]],[\"name/78\",[71,45.504]],[\"parent/78\",[59,1.285]],[\"name/79\",[72,45.504]],[\"parent/79\",[59,1.285]],[\"name/80\",[45,40.395]],[\"parent/80\",[59,1.285]],[\"name/81\",[73,45.504]],[\"parent/81\",[59,1.285]],[\"name/82\",[74,45.504]],[\"parent/82\",[59,1.285]],[\"name/83\",[75,45.504]],[\"parent/83\",[59,1.285]],[\"name/84\",[76,45.504]],[\"parent/84\",[59,1.285]],[\"name/85\",[35,40.395]],[\"parent/85\",[59,1.285]],[\"name/86\",[77,45.504]],[\"parent/86\",[59,1.285]],[\"name/87\",[37,40.395]],[\"parent/87\",[59,1.285]],[\"name/88\",[38,40.395]],[\"parent/88\",[59,1.285]],[\"name/89\",[39,40.395]],[\"parent/89\",[59,1.285]],[\"name/90\",[40,40.395]],[\"parent/90\",[59,1.285]],[\"name/91\",[41,40.395]],[\"parent/91\",[59,1.285]],[\"name/92\",[78,45.504]],[\"parent/92\",[59,1.285]],[\"name/93\",[79,40.395]],[\"parent/93\",[59,1.285]],[\"name/94\",[80,45.504]],[\"parent/94\",[59,1.285]],[\"name/95\",[81,40.395]],[\"parent/95\",[59,1.285]],[\"name/96\",[82,40.395]],[\"parent/96\",[59,1.285]],[\"name/97\",[83,40.395]],[\"parent/97\",[59,1.285]],[\"name/98\",[84,24.301]],[\"parent/98\",[]],[\"name/99\",[85,45.504]],[\"parent/99\",[84,2.206]],[\"name/100\",[86,45.504]],[\"parent/100\",[84,2.206]],[\"name/101\",[1,32.511]],[\"parent/101\",[84,2.206]],[\"name/102\",[2,40.395]],[\"parent/102\",[84,2.206]],[\"name/103\",[87,45.504]],[\"parent/103\",[84,2.206]],[\"name/104\",[88,45.504]],[\"parent/104\",[84,2.206]],[\"name/105\",[69,40.395]],[\"parent/105\",[84,2.206]],[\"name/106\",[89,45.504]],[\"parent/106\",[84,2.206]],[\"name/107\",[79,40.395]],[\"parent/107\",[84,2.206]],[\"name/108\",[90,45.504]],[\"parent/108\",[84,2.206]],[\"name/109\",[91,45.504]],[\"parent/109\",[84,2.206]],[\"name/110\",[92,45.504]],[\"parent/110\",[]],[\"name/111\",[93,45.504]],[\"parent/111\",[]],[\"name/112\",[94,45.504]],[\"parent/112\",[]],[\"name/113\",[95,45.504]],[\"parent/113\",[]],[\"name/114\",[96,45.504]],[\"parent/114\",[]],[\"name/115\",[97,45.504]],[\"parent/115\",[]],[\"name/116\",[98,40.395]],[\"parent/116\",[]],[\"name/117\",[16,29.409]],[\"parent/117\",[98,3.668]],[\"name/118\",[99,45.504]],[\"parent/118\",[100,3.134]],[\"name/119\",[101,45.504]],[\"parent/119\",[100,3.134]],[\"name/120\",[102,45.504]],[\"parent/120\",[100,3.134]],[\"name/121\",[103,45.504]],[\"parent/121\",[100,3.134]],[\"name/122\",[104,45.504]],[\"parent/122\",[]],[\"name/123\",[105,40.395]],[\"parent/123\",[]],[\"name/124\",[16,29.409]],[\"parent/124\",[105,3.668]],[\"name/125\",[106,40.395]],[\"parent/125\",[107,3.362]],[\"name/126\",[108,45.504]],[\"parent/126\",[107,3.362]],[\"name/127\",[109,45.504]],[\"parent/127\",[107,3.362]],[\"name/128\",[110,45.504]],[\"parent/128\",[]],[\"name/129\",[111,40.395]],[\"parent/129\",[]],[\"name/130\",[16,29.409]],[\"parent/130\",[111,3.668]],[\"name/131\",[106,40.395]],[\"parent/131\",[112,2.952]],[\"name/132\",[81,40.395]],[\"parent/132\",[112,2.952]],[\"name/133\",[82,40.395]],[\"parent/133\",[112,2.952]],[\"name/134\",[83,40.395]],[\"parent/134\",[112,2.952]],[\"name/135\",[65,40.395]],[\"parent/135\",[112,2.952]],[\"name/136\",[113,45.504]],[\"parent/136\",[]],[\"name/137\",[114,45.504]],[\"parent/137\",[]],[\"name/138\",[115,45.504]],[\"parent/138\",[]],[\"name/139\",[116,40.395]],[\"parent/139\",[]],[\"name/140\",[117,45.504]],[\"parent/140\",[116,3.668]]],\"invertedIndex\":[[\"__type\",{\"_index\":16,\"name\":{\"16\":{},\"39\":{},\"47\":{},\"60\":{},\"117\":{},\"124\":{},\"130\":{}},\"parent\":{}}],[\"_blacklist\",{\"_index\":19,\"name\":{\"21\":{}},\"parent\":{}}],[\"_governor\",{\"_index\":5,\"name\":{\"5\":{}},\"parent\":{}}],[\"annotated\",{\"_index\":84,\"name\":{\"98\":{}},\"parent\":{\"99\":{},\"100\":{},\"101\":{},\"102\":{},\"103\":{},\"104\":{},\"105\":{},\"106\":{},\"107\":{},\"108\":{},\"109\":{}}}],[\"annotateddispatch\",{\"_index\":92,\"name\":{\"110\":{}},\"parent\":{}}],[\"annotatedlifecycleevent\",{\"_index\":13,\"name\":{\"13\":{}},\"parent\":{}}],[\"annotatedprocess\",{\"_index\":94,\"name\":{\"112\":{}},\"parent\":{}}],[\"annotatedupdate\",{\"_index\":93,\"name\":{\"111\":{}},\"parent\":{}}],[\"basefromreceipt\",{\"_index\":60,\"name\":{\"65\":{}},\"parent\":{}}],[\"basefromtransactionhash\",{\"_index\":62,\"name\":{\"67\":{}},\"parent\":{}}],[\"basesinglefromreceipt\",{\"_index\":61,\"name\":{\"66\":{}},\"parent\":{}}],[\"basesinglefromtransactionhash\",{\"_index\":63,\"name\":{\"68\":{}},\"parent\":{}}],[\"blacklist\",{\"_index\":30,\"name\":{\"34\":{}},\"parent\":{}}],[\"blockhash\",{\"_index\":91,\"name\":{\"109\":{}},\"parent\":{}}],[\"blocknumber\",{\"_index\":90,\"name\":{\"108\":{}},\"parent\":{}}],[\"body\",{\"_index\":41,\"name\":{\"45\":{},\"91\":{}},\"parent\":{}}],[\"bodyhash\",{\"_index\":78,\"name\":{\"92\":{}},\"parent\":{}}],[\"cache\",{\"_index\":68,\"name\":{\"75\":{}},\"parent\":{}}],[\"checkhome\",{\"_index\":32,\"name\":{\"36\":{}},\"parent\":{}}],[\"checkhomes\",{\"_index\":31,\"name\":{\"35\":{}},\"parent\":{}}],[\"clearsigners\",{\"_index\":24,\"name\":{\"28\":{}},\"parent\":{}}],[\"committedroot\",{\"_index\":83,\"name\":{\"97\":{},\"134\":{}},\"parent\":{}}],[\"conf\",{\"_index\":4,\"name\":{\"4\":{},\"22\":{}},\"parent\":{}}],[\"confirmat\",{\"_index\":73,\"name\":{\"81\":{}},\"parent\":{}}],[\"connect\",{\"_index\":12,\"name\":{\"12\":{}},\"parent\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{},\"17\":{},\"19\":{},\"69\":{},\"101\":{}},\"parent\":{}}],[\"context\",{\"_index\":67,\"name\":{\"74\":{}},\"parent\":{}}],[\"contractaddress\",{\"_index\":89,\"name\":{\"106\":{}},\"parent\":{}}],[\"corecontracts\",{\"_index\":0,\"name\":{\"0\":{}},\"parent\":{\"1\":{},\"2\":{},\"3\":{},\"4\":{},\"5\":{},\"6\":{},\"7\":{},\"8\":{},\"9\":{},\"10\":{},\"11\":{},\"12\":{}}}],[\"cores\",{\"_index\":18,\"name\":{\"20\":{}},\"parent\":{}}],[\"delivered\",{\"_index\":75,\"name\":{\"83\":{}},\"parent\":{}}],[\"deployheight\",{\"_index\":3,\"name\":{\"3\":{}},\"parent\":{}}],[\"destination\",{\"_index\":39,\"name\":{\"43\":{},\"89\":{}},\"parent\":{}}],[\"destinationandnonce\",{\"_index\":82,\"name\":{\"96\":{},\"133\":{}},\"parent\":{}}],[\"dispatch\",{\"_index\":64,\"name\":{\"70\":{}},\"parent\":{}}],[\"dispatchargs\",{\"_index\":111,\"name\":{\"129\":{}},\"parent\":{\"130\":{}}}],[\"dispatchargs.__type\",{\"_index\":112,\"name\":{},\"parent\":{\"131\":{},\"132\":{},\"133\":{},\"134\":{},\"135\":{}}}],[\"dispatched\",{\"_index\":47,\"name\":{\"51\":{}},\"parent\":{}}],[\"dispatchevent\",{\"_index\":95,\"name\":{\"113\":{}},\"parent\":{}}],[\"dispatchtypes\",{\"_index\":113,\"name\":{\"136\":{}},\"parent\":{}}],[\"domain\",{\"_index\":2,\"name\":{\"2\":{},\"102\":{}},\"parent\":{}}],[\"event\",{\"_index\":88,\"name\":{\"104\":{}},\"parent\":{}}],[\"eventcache\",{\"_index\":54,\"name\":{\"59\":{}},\"parent\":{\"60\":{}}}],[\"eventcache.__type\",{\"_index\":56,\"name\":{},\"parent\":{\"61\":{},\"62\":{},\"63\":{}}}],[\"eventname\",{\"_index\":87,\"name\":{\"103\":{}},\"parent\":{}}],[\"events\",{\"_index\":45,\"name\":{\"49\":{},\"80\":{}},\"parent\":{}}],[\"failedhomeerror\",{\"_index\":15,\"name\":{\"15\":{}},\"parent\":{\"16\":{},\"17\":{}}}],[\"from\",{\"_index\":35,\"name\":{\"40\":{},\"85\":{}},\"parent\":{}}],[\"fromevent\",{\"_index\":85,\"name\":{\"99\":{}},\"parent\":{}}],[\"fromevents\",{\"_index\":86,\"name\":{\"100\":{}},\"parent\":{}}],[\"getcore\",{\"_index\":25,\"name\":{\"29\":{}},\"parent\":{}}],[\"getevents\",{\"_index\":115,\"name\":{\"138\":{}},\"parent\":{}}],[\"gethomeupdate\",{\"_index\":70,\"name\":{\"77\":{}},\"parent\":{}}],[\"getprocess\",{\"_index\":72,\"name\":{\"79\":{}},\"parent\":{}}],[\"getreplica\",{\"_index\":7,\"name\":{\"7\":{}},\"parent\":{}}],[\"getreplicafor\",{\"_index\":27,\"name\":{\"31\":{}},\"parent\":{}}],[\"getreplicaupdate\",{\"_index\":71,\"name\":{\"78\":{}},\"parent\":{}}],[\"governancerouter\",{\"_index\":9,\"name\":{\"9\":{}},\"parent\":{}}],[\"governor\",{\"_index\":11,\"name\":{\"11\":{},\"23\":{}},\"parent\":{}}],[\"governorcore\",{\"_index\":29,\"name\":{\"33\":{}},\"parent\":{}}],[\"home\",{\"_index\":8,\"name\":{\"8\":{},\"72\":{}},\"parent\":{}}],[\"homedomain\",{\"_index\":99,\"name\":{\"118\":{}},\"parent\":{}}],[\"homeupdate\",{\"_index\":55,\"name\":{\"61\":{}},\"parent\":{}}],[\"included\",{\"_index\":48,\"name\":{\"52\":{}},\"parent\":{}}],[\"leaf\",{\"_index\":80,\"name\":{\"94\":{}},\"parent\":{}}],[\"leafindex\",{\"_index\":81,\"name\":{\"95\":{},\"132\":{}},\"parent\":{}}],[\"message\",{\"_index\":65,\"name\":{\"71\":{},\"135\":{}},\"parent\":{}}],[\"messagehash\",{\"_index\":106,\"name\":{\"125\":{},\"131\":{}},\"parent\":{}}],[\"messagestatus\",{\"_index\":46,\"name\":{\"50\":{}},\"parent\":{\"51\":{},\"52\":{},\"53\":{},\"54\":{}}}],[\"mustgetcore\",{\"_index\":26,\"name\":{\"30\":{}},\"parent\":{}}],[\"mustgetreplicafor\",{\"_index\":28,\"name\":{\"32\":{}},\"parent\":{}}],[\"newroot\",{\"_index\":102,\"name\":{\"120\":{}},\"parent\":{}}],[\"nomadcontext\",{\"_index\":17,\"name\":{\"18\":{}},\"parent\":{\"19\":{},\"20\":{},\"21\":{},\"22\":{},\"23\":{},\"24\":{},\"25\":{},\"26\":{},\"27\":{},\"28\":{},\"29\":{},\"30\":{},\"31\":{},\"32\":{},\"33\":{},\"34\":{},\"35\":{},\"36\":{}}}],[\"nomadlifecyleevent\",{\"_index\":14,\"name\":{\"14\":{}},\"parent\":{}}],[\"nomadmessage\",{\"_index\":59,\"name\":{\"64\":{}},\"parent\":{\"65\":{},\"66\":{},\"67\":{},\"68\":{},\"69\":{},\"70\":{},\"71\":{},\"72\":{},\"73\":{},\"74\":{},\"75\":{},\"76\":{},\"77\":{},\"78\":{},\"79\":{},\"80\":{},\"81\":{},\"82\":{},\"83\":{},\"84\":{},\"85\":{},\"86\":{},\"87\":{},\"88\":{},\"89\":{},\"90\":{},\"91\":{},\"92\":{},\"93\":{},\"94\":{},\"95\":{},\"96\":{},\"97\":{}}}],[\"nomadstatus\",{\"_index\":42,\"name\":{\"46\":{}},\"parent\":{\"47\":{}}}],[\"nomadstatus.__type\",{\"_index\":44,\"name\":{},\"parent\":{\"48\":{},\"49\":{}}}],[\"nonce\",{\"_index\":38,\"name\":{\"42\":{},\"88\":{}},\"parent\":{}}],[\"none\",{\"_index\":52,\"name\":{\"56\":{}},\"parent\":{}}],[\"oldroot\",{\"_index\":101,\"name\":{\"119\":{}},\"parent\":{}}],[\"origin\",{\"_index\":77,\"name\":{\"86\":{}},\"parent\":{}}],[\"parsedmessage\",{\"_index\":34,\"name\":{\"38\":{}},\"parent\":{\"39\":{}}}],[\"parsedmessage.__type\",{\"_index\":36,\"name\":{},\"parent\":{\"40\":{},\"41\":{},\"42\":{},\"43\":{},\"44\":{},\"45\":{}}}],[\"parsemessage\",{\"_index\":33,\"name\":{\"37\":{}},\"parent\":{}}],[\"process\",{\"_index\":58,\"name\":{\"63\":{}},\"parent\":{}}],[\"processargs\",{\"_index\":105,\"name\":{\"123\":{}},\"parent\":{\"124\":{}}}],[\"processargs.__type\",{\"_index\":107,\"name\":{},\"parent\":{\"125\":{},\"126\":{},\"127\":{}}}],[\"processed\",{\"_index\":50,\"name\":{\"54\":{},\"58\":{}},\"parent\":{}}],[\"processevent\",{\"_index\":96,\"name\":{\"114\":{}},\"parent\":{}}],[\"processtypes\",{\"_index\":110,\"name\":{\"128\":{}},\"parent\":{}}],[\"proven\",{\"_index\":53,\"name\":{\"57\":{}},\"parent\":{}}],[\"providerorsigner\",{\"_index\":6,\"name\":{\"6\":{}},\"parent\":{}}],[\"queryannotatedevents\",{\"_index\":114,\"name\":{\"137\":{}},\"parent\":{}}],[\"queryfilter\",{\"_index\":117,\"name\":{\"140\":{}},\"parent\":{}}],[\"receipt\",{\"_index\":69,\"name\":{\"76\":{},\"105\":{}},\"parent\":{}}],[\"recipient\",{\"_index\":40,\"name\":{\"44\":{},\"90\":{}},\"parent\":{}}],[\"reconnect\",{\"_index\":20,\"name\":{\"24\":{}},\"parent\":{}}],[\"registerprovider\",{\"_index\":21,\"name\":{\"25\":{}},\"parent\":{}}],[\"registersigner\",{\"_index\":22,\"name\":{\"26\":{}},\"parent\":{}}],[\"relayed\",{\"_index\":49,\"name\":{\"53\":{}},\"parent\":{}}],[\"replica\",{\"_index\":66,\"name\":{\"73\":{}},\"parent\":{}}],[\"replicamessagestatus\",{\"_index\":51,\"name\":{\"55\":{}},\"parent\":{\"56\":{},\"57\":{},\"58\":{}}}],[\"replicastatus\",{\"_index\":74,\"name\":{\"82\":{}},\"parent\":{}}],[\"replicaupdate\",{\"_index\":57,\"name\":{\"62\":{}},\"parent\":{}}],[\"returndata\",{\"_index\":109,\"name\":{\"127\":{}},\"parent\":{}}],[\"sender\",{\"_index\":37,\"name\":{\"41\":{},\"87\":{}},\"parent\":{}}],[\"signature\",{\"_index\":103,\"name\":{\"121\":{}},\"parent\":{}}],[\"status\",{\"_index\":43,\"name\":{\"48\":{}},\"parent\":{}}],[\"success\",{\"_index\":108,\"name\":{\"126\":{}},\"parent\":{}}],[\"transactionhash\",{\"_index\":79,\"name\":{\"93\":{},\"107\":{}},\"parent\":{}}],[\"tscontract\",{\"_index\":116,\"name\":{\"139\":{}},\"parent\":{\"140\":{}}}],[\"unregistersigner\",{\"_index\":23,\"name\":{\"27\":{}},\"parent\":{}}],[\"updateargs\",{\"_index\":98,\"name\":{\"116\":{}},\"parent\":{\"117\":{}}}],[\"updateargs.__type\",{\"_index\":100,\"name\":{},\"parent\":{\"118\":{},\"119\":{},\"120\":{},\"121\":{}}}],[\"updateevent\",{\"_index\":97,\"name\":{\"115\":{}},\"parent\":{}}],[\"updatetypes\",{\"_index\":104,\"name\":{\"122\":{}},\"parent\":{}}],[\"wait\",{\"_index\":76,\"name\":{\"84\":{}},\"parent\":{}}],[\"xappconnectionmanager\",{\"_index\":10,\"name\":{\"10\":{}},\"parent\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/public/sdk/assets/style.css b/docs/public/sdk/assets/style.css deleted file mode 100644 index a16ed02..0000000 --- a/docs/public/sdk/assets/style.css +++ /dev/null @@ -1,1413 +0,0 @@ -@import url("./icons.css"); - -:root { - /* Light */ - --light-color-background: #fcfcfc; - --light-color-secondary-background: #fff; - --light-color-text: #222; - --light-color-text-aside: #707070; - --light-color-link: #4da6ff; - --light-color-menu-divider: #eee; - --light-color-menu-divider-focus: #000; - --light-color-menu-label: #707070; - --light-color-panel: var(--light-color-secondary-background); - --light-color-panel-divider: #eee; - --light-color-comment-tag: #707070; - --light-color-comment-tag-text: #fff; - --light-color-ts: #9600ff; - --light-color-ts-interface: #647f1b; - --light-color-ts-enum: #937210; - --light-color-ts-class: #0672de; - --light-color-ts-private: #707070; - --light-color-toolbar: #fff; - --light-color-toolbar-text: #333; - --light-icon-filter: invert(0); - --light-external-icon: url("data:image/svg+xml;utf8,"); - - /* Dark */ - --dark-color-background: #36393f; - --dark-color-secondary-background: #2f3136; - --dark-color-text: #ffffff; - --dark-color-text-aside: #e6e4e4; - --dark-color-link: #00aff4; - --dark-color-menu-divider: #eee; - --dark-color-menu-divider-focus: #000; - --dark-color-menu-label: #707070; - --dark-color-panel: var(--dark-color-secondary-background); - --dark-color-panel-divider: #818181; - --dark-color-comment-tag: #dcddde; - --dark-color-comment-tag-text: #2f3136; - --dark-color-ts: #c97dff; - --dark-color-ts-interface: #9cbe3c; - --dark-color-ts-enum: #d6ab29; - --dark-color-ts-class: #3695f3; - --dark-color-ts-private: #e2e2e2; - --dark-color-toolbar: #34373c; - --dark-color-toolbar-text: #ffffff; - --dark-icon-filter: invert(1); - --dark-external-icon: url("data:image/svg+xml;utf8,"); -} - -@media (prefers-color-scheme: light) { - :root { - --color-background: var(--light-color-background); - --color-secondary-background: var(--light-color-secondary-background); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - --color-menu-divider: var(--light-color-menu-divider); - --color-menu-divider-focus: var(--light-color-menu-divider-focus); - --color-menu-label: var(--light-color-menu-label); - --color-panel: var(--light-color-panel); - --color-panel-divider: var(--light-color-panel-divider); - --color-comment-tag: var(--light-color-comment-tag); - --color-comment-tag-text: var(--light-color-comment-tag-text); - --color-ts: var(--light-color-ts); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-class: var(--light-color-ts-class); - --color-ts-private: var(--light-color-ts-private); - --color-toolbar: var(--light-color-toolbar); - --color-toolbar-text: var(--light-color-toolbar-text); - --icon-filter: var(--light-icon-filter); - --external-icon: var(--light-external-icon); - } -} - -@media (prefers-color-scheme: dark) { - :root { - --color-background: var(--dark-color-background); - --color-secondary-background: var(--dark-color-secondary-background); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - --color-menu-divider: var(--dark-color-menu-divider); - --color-menu-divider-focus: var(--dark-color-menu-divider-focus); - --color-menu-label: var(--dark-color-menu-label); - --color-panel: var(--dark-color-panel); - --color-panel-divider: var(--dark-color-panel-divider); - --color-comment-tag: var(--dark-color-comment-tag); - --color-comment-tag-text: var(--dark-color-comment-tag-text); - --color-ts: var(--dark-color-ts); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-private: var(--dark-color-ts-private); - --color-toolbar: var(--dark-color-toolbar); - --color-toolbar-text: var(--dark-color-toolbar-text); - --icon-filter: var(--dark-icon-filter); - --external-icon: var(--dark-external-icon); - } -} - -body { - margin: 0; -} - -body.light { - --color-background: var(--light-color-background); - --color-secondary-background: var(--light-color-secondary-background); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - --color-menu-divider: var(--light-color-menu-divider); - --color-menu-divider-focus: var(--light-color-menu-divider-focus); - --color-menu-label: var(--light-color-menu-label); - --color-panel: var(--light-color-panel); - --color-panel-divider: var(--light-color-panel-divider); - --color-comment-tag: var(--light-color-comment-tag); - --color-comment-tag-text: var(--light-color-comment-tag-text); - --color-ts: var(--light-color-ts); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-class: var(--light-color-ts-class); - --color-ts-private: var(--light-color-ts-private); - --color-toolbar: var(--light-color-toolbar); - --color-toolbar-text: var(--light-color-toolbar-text); - --icon-filter: var(--light-icon-filter); - --external-icon: var(--light-external-icon); -} - -body.dark { - --color-background: var(--dark-color-background); - --color-secondary-background: var(--dark-color-secondary-background); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - --color-menu-divider: var(--dark-color-menu-divider); - --color-menu-divider-focus: var(--dark-color-menu-divider-focus); - --color-menu-label: var(--dark-color-menu-label); - --color-panel: var(--dark-color-panel); - --color-panel-divider: var(--dark-color-panel-divider); - --color-comment-tag: var(--dark-color-comment-tag); - --color-comment-tag-text: var(--dark-color-comment-tag-text); - --color-ts: var(--dark-color-ts); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-private: var(--dark-color-ts-private); - --color-toolbar: var(--dark-color-toolbar); - --color-toolbar-text: var(--dark-color-toolbar-text); - --icon-filter: var(--dark-icon-filter); - --external-icon: var(--dark-external-icon); -} - -h1, -h2, -h3, -h4, -h5, -h6 { - line-height: 1.2; -} - -h1 { - font-size: 2em; - margin: 0.67em 0; -} - -h2 { - font-size: 1.5em; - margin: 0.83em 0; -} - -h3 { - font-size: 1.17em; - margin: 1em 0; -} - -h4, -.tsd-index-panel h3 { - font-size: 1em; - margin: 1.33em 0; -} - -h5 { - font-size: 0.83em; - margin: 1.67em 0; -} - -h6 { - font-size: 0.67em; - margin: 2.33em 0; -} - -pre { - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; -} - -dl, -menu, -ol, -ul { - margin: 1em 0; -} - -dd { - margin: 0 0 0 40px; -} - -.container { - max-width: 1200px; - margin: 0 auto; - padding: 0 40px; -} -@media (max-width: 640px) { - .container { - padding: 0 20px; - } -} - -.container-main { - padding-bottom: 200px; -} - -.row { - display: flex; - position: relative; - margin: 0 -10px; -} -.row:after { - visibility: hidden; - display: block; - content: ""; - clear: both; - height: 0; -} - -.col-4, -.col-8 { - box-sizing: border-box; - float: left; - padding: 0 10px; -} - -.col-4 { - width: 33.3333333333%; -} -.col-8 { - width: 66.6666666667%; -} - -ul.tsd-descriptions > li > :first-child, -.tsd-panel > :first-child, -.col-8 > :first-child, -.col-4 > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child, -.tsd-panel > :first-child > :first-child, -.col-8 > :first-child > :first-child, -.col-4 > :first-child > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child > :first-child, -.tsd-panel > :first-child > :first-child > :first-child, -.col-8 > :first-child > :first-child > :first-child, -.col-4 > :first-child > :first-child > :first-child { - margin-top: 0; -} -ul.tsd-descriptions > li > :last-child, -.tsd-panel > :last-child, -.col-8 > :last-child, -.col-4 > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child, -.tsd-panel > :last-child > :last-child, -.col-8 > :last-child > :last-child, -.col-4 > :last-child > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child > :last-child, -.tsd-panel > :last-child > :last-child > :last-child, -.col-8 > :last-child > :last-child > :last-child, -.col-4 > :last-child > :last-child > :last-child { - margin-bottom: 0; -} - -@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 shift-to-left { - from { - transform: translate(0, 0); - } - to { - transform: translate(-25%, 0); - } -} -@keyframes unshift-to-left { - from { - transform: translate(-25%, 0); - } - to { - transform: translate(0, 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: 14px; -} - -pre { - padding: 10px; -} -pre code { - padding: 0; - font-size: 100%; -} - -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 h4, -.tsd-typography .tsd-index-panel h3, -.tsd-index-panel .tsd-typography h3, -.tsd-typography h5, -.tsd-typography h6 { - font-size: 1em; - margin: 0; -} -.tsd-typography h5, -.tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, -.tsd-typography ul, -.tsd-typography ol { - margin: 1em 0; -} - -@media (min-width: 901px) and (max-width: 1024px) { - html .col-content { - width: 72%; - } - html .col-menu { - width: 28%; - } - html .tsd-navigation { - padding-left: 10px; - } -} -@media (max-width: 900px) { - html .col-content { - float: none; - width: 100%; - } - html .col-menu { - position: fixed !important; - overflow: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - width: 100%; - padding: 20px 20px 0 0; - max-width: 450px; - visibility: hidden; - background-color: var(--color-panel); - transform: translate(100%, 0); - } - html .col-menu > *: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 :is(header, footer, .col-content) { - animation: shift-to-left 0.4s; - } - - .to-has-menu .col-menu { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu :is(header, footer, .col-content) { - animation: unshift-to-left 0.4s; - } - - .from-has-menu .col-menu { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu :is(header, footer, .col-content) { - transform: translate(-25%, 0); - } - .has-menu .col-menu { - visibility: visible; - transform: translate(0, 0); - display: grid; - grid-template-rows: auto 1fr; - max-height: 100vh; - } - .has-menu .tsd-navigation { - max-height: 100%; - } -} - -.tsd-page-title { - padding: 70px 0 20px 0; - margin: 0 0 40px 0; - background: var(--color-panel); - box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); -} -.tsd-page-title h1 { - margin: 0; -} - -.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: " / "; -} - -dl.tsd-comment-tags { - overflow: hidden; -} -dl.tsd-comment-tags dt { - float: left; - padding: 1px 5px; - margin: 0 10px 0 0; - border-radius: 4px; - border: 1px solid var(--color-comment-tag); - color: var(--color-comment-tag); - font-size: 0.8em; - font-weight: normal; -} -dl.tsd-comment-tags dd { - margin: 0 0 10px 0; -} -dl.tsd-comment-tags dd:before, -dl.tsd-comment-tags dd:after { - display: table; - content: " "; -} -dl.tsd-comment-tags dd pre, -dl.tsd-comment-tags dd:after { - clear: both; -} -dl.tsd-comment-tags 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; -} - -.toggle-protected .tsd-is-private { - display: none; -} - -.toggle-public .tsd-is-private, -.toggle-public .tsd-is-protected, -.toggle-public .tsd-is-private-protected { - display: none; -} - -.toggle-inherited .tsd-is-inherited { - display: none; -} - -.toggle-externals .tsd-is-external { - display: none; -} - -#tsd-filter { - position: relative; - display: inline-block; - height: 40px; - vertical-align: bottom; -} -.no-filter #tsd-filter { - display: none; -} -#tsd-filter .tsd-filter-group { - display: inline-block; - height: 40px; - vertical-align: bottom; - white-space: nowrap; -} -#tsd-filter input { - display: none; -} -@media (max-width: 900px) { - #tsd-filter .tsd-filter-group { - display: block; - position: absolute; - top: 40px; - right: 20px; - height: auto; - background-color: var(--color-panel); - visibility: hidden; - transform: translate(50%, 0); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - } - .has-options #tsd-filter .tsd-filter-group { - visibility: visible; - } - .to-has-options #tsd-filter .tsd-filter-group { - animation: fade-in 0.2s; - } - .from-has-options #tsd-filter .tsd-filter-group { - animation: fade-out 0.2s; - } - #tsd-filter label, - #tsd-filter .tsd-select { - display: block; - padding-right: 20px; - } -} - -footer { - border-top: 1px solid var(--color-panel-divider); - background-color: var(--color-panel); -} -footer:after { - content: ""; - display: table; -} -footer.with-border-bottom { - border-bottom: 1px solid var(--color-panel-divider); -} -footer .tsd-legend-group { - font-size: 0; -} -footer .tsd-legend { - display: inline-block; - width: 25%; - padding: 0; - font-size: 16px; - list-style: none; - line-height: 1.333em; - vertical-align: top; -} -@media (max-width: 900px) { - footer .tsd-legend { - width: 50%; - } -} - -.tsd-hierarchy { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} - -.tsd-index-panel .tsd-index-content { - margin-bottom: -30px !important; -} -.tsd-index-panel .tsd-index-section { - margin-bottom: 30px !important; -} -.tsd-index-panel h3 { - margin: 0 -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 3; - -moz-column-count: 3; - -ms-column-count: 3; - -o-column-count: 3; - column-count: 3; - -webkit-column-gap: 20px; - -moz-column-gap: 20px; - -ms-column-gap: 20px; - -o-column-gap: 20px; - column-gap: 20px; - padding: 0; - list-style: none; - line-height: 1.333em; -} -@media (max-width: 900px) { - .tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 1; - -moz-column-count: 1; - -ms-column-count: 1; - -o-column-count: 1; - column-count: 1; - } -} -@media (min-width: 901px) and (max-width: 1024px) { - .tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 2; - -moz-column-count: 2; - -ms-column-count: 2; - -o-column-count: 2; - column-count: 2; - } -} -.tsd-index-panel ul.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-index-panel a, -.tsd-index-panel .tsd-parent-kind-module a { - color: var(--color-ts); -} -.tsd-index-panel .tsd-parent-kind-interface a { - color: var(--color-ts-interface); -} -.tsd-index-panel .tsd-parent-kind-enum a { - color: var(--color-ts-enum); -} -.tsd-index-panel .tsd-parent-kind-class a { - color: var(--color-ts-class); -} -.tsd-index-panel .tsd-kind-module a { - color: var(--color-ts); -} -.tsd-index-panel .tsd-kind-interface a { - color: var(--color-ts-interface); -} -.tsd-index-panel .tsd-kind-enum a { - color: var(--color-ts-enum); -} -.tsd-index-panel .tsd-kind-class a { - color: var(--color-ts-class); -} -.tsd-index-panel .tsd-is-private a { - color: var(--color-ts-private); -} - -.tsd-flag { - display: inline-block; - padding: 1px 5px; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 14px; - font-weight: normal; -} - -.tsd-anchor { - position: absolute; - top: -100px; -} - -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} -.tsd-member [data-tsd-kind] { - color: var(--color-ts); -} -.tsd-member [data-tsd-kind="Interface"] { - color: var(--color-ts-interface); -} -.tsd-member [data-tsd-kind="Enum"] { - color: var(--color-ts-enum); -} -.tsd-member [data-tsd-kind="Class"] { - color: var(--color-ts-class); -} -.tsd-member [data-tsd-kind="Private"] { - color: var(--color-ts-private); -} - -.tsd-navigation { - margin: 0 0 0 40px; -} -.tsd-navigation a { - display: block; - padding-top: 2px; - padding-bottom: 2px; - border-left: 2px solid transparent; - color: var(--color-text); - text-decoration: none; - transition: border-left-color 0.1s; -} -.tsd-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul { - margin: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li { - padding: 0; -} - -.tsd-navigation.primary { - padding-bottom: 40px; -} -.tsd-navigation.primary a { - display: block; - padding-top: 6px; - padding-bottom: 6px; -} -.tsd-navigation.primary ul li a { - padding-left: 5px; -} -.tsd-navigation.primary ul li li a { - padding-left: 25px; -} -.tsd-navigation.primary ul li li li a { - padding-left: 45px; -} -.tsd-navigation.primary ul li li li li a { - padding-left: 65px; -} -.tsd-navigation.primary ul li li li li li a { - padding-left: 85px; -} -.tsd-navigation.primary ul li li li li li li a { - padding-left: 105px; -} -.tsd-navigation.primary > ul { - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-navigation.primary li { - border-top: 1px solid var(--color-panel-divider); -} -.tsd-navigation.primary li.current > a { - font-weight: bold; -} -.tsd-navigation.primary li.label span { - display: block; - padding: 20px 0 6px 5px; - color: var(--color-menu-label); -} -.tsd-navigation.primary li.globals + li > span, -.tsd-navigation.primary li.globals + li > a { - padding-top: 20px; -} - -.tsd-navigation.secondary { - max-height: calc(100vh - 1rem - 40px); - overflow: auto; - position: sticky; - top: calc(0.5rem + 40px); - transition: 0.3s; -} -.tsd-navigation.secondary.tsd-navigation--toolbar-hide { - max-height: calc(100vh - 1rem); - top: 0.5rem; -} -.tsd-navigation.secondary ul { - transition: opacity 0.2s; -} -.tsd-navigation.secondary ul li a { - padding-left: 25px; -} -.tsd-navigation.secondary ul li li a { - padding-left: 45px; -} -.tsd-navigation.secondary ul li li li a { - padding-left: 65px; -} -.tsd-navigation.secondary ul li li li li a { - padding-left: 85px; -} -.tsd-navigation.secondary ul li li li li li a { - padding-left: 105px; -} -.tsd-navigation.secondary ul li li li li li li a { - padding-left: 125px; -} -.tsd-navigation.secondary ul.current a { - border-left-color: var(--color-panel-divider); -} -.tsd-navigation.secondary li.focus > a, -.tsd-navigation.secondary ul.current li.focus > a { - border-left-color: var(--color-menu-divider-focus); -} -.tsd-navigation.secondary li.current { - margin-top: 20px; - margin-bottom: 20px; - border-left-color: var(--color-panel-divider); -} -.tsd-navigation.secondary li.current > a { - font-weight: bold; -} - -@media (min-width: 901px) { - .menu-sticky-wrap { - position: static; - } -} - -.tsd-panel { - margin: 20px 0; - padding: 20px; - background-color: var(--color-panel); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, -.tsd-panel > h2, -.tsd-panel > h3 { - margin: 1.5em -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-panel > h1.tsd-before-signature, -.tsd-panel > h2.tsd-before-signature, -.tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: 0; -} -.tsd-panel table { - display: block; - width: 100%; - overflow: auto; - margin-top: 10px; - word-break: normal; - word-break: keep-all; - border-collapse: collapse; -} -.tsd-panel table th { - font-weight: bold; -} -.tsd-panel table th, -.tsd-panel table td { - padding: 6px 13px; - border: 1px solid var(--color-panel-divider); -} -.tsd-panel table tr { - background: var(--color-background); -} -.tsd-panel table tr:nth-child(even) { - background: var(--color-secondary-background); -} - -.tsd-panel-group { - margin: 60px 0; -} -.tsd-panel-group > h1, -.tsd-panel-group > h2, -.tsd-panel-group > h3 { - padding-left: 20px; - padding-right: 20px; -} - -#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: 40px; - height: 40px; -} -#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 { - 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 { - padding: 0 10px; - background-color: var(--color-background); -} -#tsd-search .results li:nth-child(even) { - background-color: var(--color-panel); -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current, -#tsd-search .results li:hover { - background-color: var(--color-panel-divider); -} -#tsd-search .results a { - display: block; -} -#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-panel-divider); -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title { - 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-signature { - margin: 0 0 1em 0; - padding: 10px; - border: 1px solid var(--color-panel-divider); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; -} -.tsd-signature.tsd-kind-icon { - padding-left: 30px; -} -.tsd-signature.tsd-kind-icon:before { - top: 10px; - left: 10px; -} -.tsd-panel > .tsd-signature { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; -} -.tsd-panel > .tsd-signature.tsd-kind-icon { - padding-left: 40px; -} -.tsd-panel > .tsd-signature.tsd-kind-icon:before { - left: 20px; -} - -.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; - border: 1px solid var(--color-panel-divider); -} -.tsd-signatures .tsd-signature { - margin: 0; - border-width: 1px 0 0 0; - transition: background-color 0.1s; -} -.tsd-signatures .tsd-signature:first-child { - border-top-width: 0; -} -.tsd-signatures .tsd-signature.current { - background-color: var(--color-panel-divider); -} -.tsd-signatures.active > .tsd-signature { - cursor: pointer; -} -.tsd-panel > .tsd-signatures { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; -} -.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { - padding-left: 40px; -} -.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { - left: 20px; -} -.tsd-panel > a.anchor + .tsd-signatures { - border-top-width: 0; - margin-top: -20px; -} - -ul.tsd-descriptions { - position: relative; - overflow: hidden; - padding: 0; - list-style: none; -} -ul.tsd-descriptions.active > .tsd-description { - display: none; -} -ul.tsd-descriptions.active > .tsd-description.current { - display: block; -} -ul.tsd-descriptions.active > .tsd-description.fade-in { - animation: fade-in-delayed 0.3s; -} -ul.tsd-descriptions.active > .tsd-description.fade-out { - animation: fade-out-delayed 0.3s; - position: absolute; - display: block; - top: 0; - left: 0; - right: 0; - opacity: 0; - visibility: hidden; -} -ul.tsd-descriptions h4, -ul.tsd-descriptions .tsd-index-panel h3, -.tsd-index-panel ul.tsd-descriptions h3 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} - -ul.tsd-parameters, -ul.tsd-type-parameters { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameters > li.tsd-parameter-signature, -ul.tsd-type-parameters > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameters h5, -ul.tsd-type-parameters h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -ul.tsd-parameters .tsd-comment, -ul.tsd-type-parameters .tsd-comment { - margin-top: -0.5em; -} - -.tsd-sources { - font-size: 14px; - color: var(--color-text-aside); - margin: 0 0 1em 0; -} -.tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; -} -.tsd-sources ul, -.tsd-sources p { - margin: 0 !important; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: fixed; - z-index: 1; - top: 0; - left: 0; - width: 100%; - height: 40px; - color: var(--color-toolbar-text); - background: var(--color-toolbar); - border-bottom: 1px solid var(--color-panel-divider); - transition: transform 0.3s linear; -} -.tsd-page-toolbar a { - color: var(--color-toolbar-text); - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .table-wrap { - display: table; - width: 100%; - height: 40px; -} -.tsd-page-toolbar .table-cell { - display: table-cell; - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} - -.tsd-page-toolbar--hide { - transform: translateY(-100%); -} - -.tsd-select .tsd-select-list li:before, -.tsd-select .tsd-select-label:before, -.tsd-widget:before { - content: ""; - display: inline-block; - width: 40px; - height: 40px; - margin: 0 -8px 0 0; - background-image: url(./widgets.png); - background-repeat: no-repeat; - text-indent: -1024px; - vertical-align: bottom; - filter: var(--icon-filter); -} -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-select .tsd-select-list li:before, - .tsd-select .tsd-select-label:before, - .tsd-widget:before { - background-image: url(./widgets@2x.png); - background-size: 320px 40px; - } -} - -.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-panel-divider); -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} -.tsd-widget.search:before { - background-position: 0 0; -} -.tsd-widget.menu:before { - background-position: -40px 0; -} -.tsd-widget.options:before { - background-position: -80px 0; -} -.tsd-widget.options, -.tsd-widget.menu { - display: none; -} -@media (max-width: 900px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; - } -} -input[type="checkbox"] + .tsd-widget:before { - background-position: -120px 0; -} -input[type="checkbox"]:checked + .tsd-widget:before { - background-position: -160px 0; -} - -.tsd-select { - position: relative; - display: inline-block; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-select .tsd-select-label { - opacity: 0.6; - transition: opacity 0.2s; -} -.tsd-select .tsd-select-label:before { - background-position: -240px 0; -} -.tsd-select.active .tsd-select-label { - opacity: 0.8; -} -.tsd-select.active .tsd-select-list { - visibility: visible; - opacity: 1; - transition-delay: 0s; -} -.tsd-select .tsd-select-list { - position: absolute; - visibility: hidden; - top: 40px; - left: 0; - margin: 0; - padding: 0; - opacity: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - transition: visibility 0s 0.2s, opacity 0.2s; -} -.tsd-select .tsd-select-list li { - padding: 0 20px 0 0; - background-color: var(--color-background); -} -.tsd-select .tsd-select-list li:before { - background-position: 40px 0; -} -.tsd-select .tsd-select-list li:nth-child(even) { - background-color: var(--color-panel); -} -.tsd-select .tsd-select-list li:hover { - background-color: var(--color-panel-divider); -} -.tsd-select .tsd-select-list li.selected:before { - background-position: -200px 0; -} -@media (max-width: 900px) { - .tsd-select .tsd-select-list { - top: 0; - left: auto; - right: 100%; - margin-right: -5px; - } - .tsd-select .tsd-select-label:before { - background-position: -280px 0; - } -} - -img { - max-width: 100%; -} - -.tsd-anchor-icon { - margin-left: 10px; - 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; -} diff --git a/docs/public/sdk/assets/widgets.png b/docs/public/sdk/assets/widgets.png deleted file mode 100644 index c738053..0000000 Binary files a/docs/public/sdk/assets/widgets.png and /dev/null differ diff --git a/docs/public/sdk/assets/widgets@2x.png b/docs/public/sdk/assets/widgets@2x.png deleted file mode 100644 index 4bbbd57..0000000 Binary files a/docs/public/sdk/assets/widgets@2x.png and /dev/null differ diff --git a/docs/public/sdk/classes/Annotated.html b/docs/public/sdk/classes/Annotated.html deleted file mode 100644 index 06a3780..0000000 --- a/docs/public/sdk/classes/Annotated.html +++ /dev/null @@ -1 +0,0 @@ -Annotated | @nomad-xyz/sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Annotated<U, T>

Type parameters

  • U: Result

  • T: TypedEvent<U>

Hierarchy

  • Annotated

Index

Constructors

  • new Annotated<U, T>(domain: number, receipt: TransactionReceipt, event: T, callerKnowsWhatTheyAreDoing?: boolean): Annotated<U, T>
  • Type parameters

    • U: Result<U>

    • T: TypedEvent<U, T>

    Parameters

    • domain: number
    • receipt: TransactionReceipt
    • event: T
    • callerKnowsWhatTheyAreDoing: boolean = false

    Returns Annotated<U, T>

Properties

domain: number
event: T
eventName?: string
receipt: TransactionReceipt

Accessors

  • get blockHash(): string
  • get blockNumber(): number
  • get contractAddress(): string
  • get transactionHash(): string

Methods

  • fromEvent<U, T>(domain: number, event: T): Promise<Annotated<U, T>>
  • fromEvents<U, T>(domain: number, events: T[]): Promise<Annotated<U, T>[]>

Legend

  • Constructor
  • Property
  • Method
  • Protected property
  • Protected method
  • Method
  • Private property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk/classes/CoreContracts.html b/docs/public/sdk/classes/CoreContracts.html deleted file mode 100644 index abde7cc..0000000 --- a/docs/public/sdk/classes/CoreContracts.html +++ /dev/null @@ -1 +0,0 @@ -CoreContracts | @nomad-xyz/sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CoreContracts

Hierarchy

  • Contracts
    • CoreContracts

Index

Constructors

  • new CoreContracts(domain: string, conf: EvmCoreContracts, providerOrSigner?: Provider | Signer): CoreContracts

Properties

_governor?: Governor
args: any[]
conf: EvmCoreContracts
deployHeight: number
domain: string
providerOrSigner?: Provider | Signer

Accessors

  • get governanceRouter(): GovernanceRouter
  • get home(): Home
  • get xAppConnectionManager(): XAppConnectionManager

Methods

  • connect(providerOrSigner: Provider | Signer): void
  • Parameters

    • providerOrSigner: Provider | Signer

    Returns void

  • getReplica(domain: string): undefined | Replica
  • governor(): Promise<Governor>

Legend

  • Constructor
  • Property
  • Method
  • Protected property
  • Protected method
  • Method
  • Private property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk/classes/FailedHomeError.html b/docs/public/sdk/classes/FailedHomeError.html deleted file mode 100644 index 556824a..0000000 --- a/docs/public/sdk/classes/FailedHomeError.html +++ /dev/null @@ -1,6 +0,0 @@ -FailedHomeError | @nomad-xyz/sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FailedHomeError

Hierarchy

  • Error
    • FailedHomeError

Index

Constructors

Properties

message: string
name: string
stack?: string
prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

stackTraceLimit: number

Methods

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void
  • -

    Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Protected property
  • Protected method
  • Method
  • Private property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk/classes/NomadContext.html b/docs/public/sdk/classes/NomadContext.html deleted file mode 100644 index 1076f92..0000000 --- a/docs/public/sdk/classes/NomadContext.html +++ /dev/null @@ -1,153 +0,0 @@ -NomadContext | @nomad-xyz/sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NomadContext

-

The NomadContext manages connections to Nomad core and Bridge contracts. -It inherits from the {@link MultiProvider}, and ensures that its contracts -always use the latest registered providers and signers.

-

For convenience, we've pre-constructed contexts for mainnet and testnet -deployments. These can be imported directly.

-
example

// Set up mainnet and then access contracts as below: -let router = mainnet.mustGetBridge('celo').bridgeRouter;

-

Hierarchy

  • MultiProvider<config.Domain>
    • NomadContext

Index

Constructors

  • new NomadContext(environment?: string | NomadConfig): NomadContext

Properties

_blacklist: Set<number>
conf: NomadConfig
cores: Map<string, CoreContracts>
domains: Map<string, Domain>
providers: Map<string, Provider>
signers: Map<string, Signer>

Accessors

  • get domainNames(): string[]
  • Returns string[]

  • get domainNumbers(): number[]
  • Returns number[]

  • get governor(): NomadLocator
  • get missingProviders(): string[]
  • Returns string[]

  • get registeredDomains(): Readonly<T>[]
  • Returns Readonly<T>[]

Methods

  • blacklist(): Set<number>
  • checkHome(nameOrDomain: string | number): Promise<void>
  • checkHomes(networks: (string | number)[]): Promise<void>
  • clearSigners(): void
  • -

    Clear all signers from all registered domains.

    -

    Returns void

  • getAddress(nameOrDomain: string | number): Promise<undefined | string>
  • -

    Resolves the address of a Signer on a domain (or undefined, if no Signer)

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns Promise<undefined | string>

    A Promise for the address of the registered signer (if any)

    -
  • getConnection(nameOrDomain: string | number): undefined | Provider | Signer
  • -

    Returns the most privileged connection registered to a domain. E.g. -this function will attempt to return a Signer, then attempt to return the -Provider (if no Signer is registered). If neither Signer nor Provider is -registered for a domain, it will return undefined

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns undefined | Provider | Signer

    A Signer (if any), otherwise a Provider (if any), otherwise - undefined

    -
  • getCore(nameOrDomain: string | number): undefined | CoreContracts
  • getDomain(nameOrDomain: string | number): undefined | Domain
  • -

    Get the registered {@link Domain} object (if any)

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns undefined | Domain

    A {@link Domain} (if the domain has been registered)

    -
  • getProvider(nameOrDomain: string | number): undefined | Provider
  • -

    Get the Provider associated with a doman (if any)

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns undefined | Provider

    The currently registered Provider (or none)

    -
  • getReplicaFor(home: string | number, remote: string | number): undefined | Replica
  • -

    Resolve the replica for the Home domain on the Remote domain (if any).

    -

    WARNING: do not hold references to this contract, as it will not be -reconnected in the event the chain connection changes.

    -

    Parameters

    • home: string | number
      -

      the sending domain

      -
    • remote: string | number
      -

      the receiving domain

      -

    Returns undefined | Replica

    An interface for the Replica (if any)

    -
  • getSigner(nameOrDomain: string | number): undefined | Signer
  • -

    Return the signer registered to a domain (if any).

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns undefined | Signer

    The registered signer (or undefined)

    -
  • -

    Discovers the governor domain of this nomad deployment and returns the -associated Core.

    -

    Returns Promise<CoreContracts>

    The identifier of the governing domain

    -
  • knownDomain(nameOrDomain: string | number): boolean
  • -

    Check whether the {@link MultiProvider} is aware of a domain.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns boolean

    true if the {@link Domain} has been registered, else false.

    -
  • mustGetConnection(nameOrDomain: string | number): Provider | Signer
  • -

    Get the Connection associated with a doman (or error)

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns Provider | Signer

    A Signer

    -
  • mustGetDomain(nameOrDomain: string | number): Domain
  • -

    Get the registered {@link Domain} object (or error)

    -
    throws

    if the domain has not been registered

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns Domain

    A {@link Domain}

    -
  • mustGetProvider(nameOrDomain: string | number): Provider
  • -

    Get the Provider associated with a doman (or error)

    -
    throws

    If no provider has been registered for the specified domain

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns Provider

    A Provider

    -
  • mustGetReplicaFor(home: string | number, remote: string | number): Replica
  • -

    Resolve the replica for the Home domain on the Remote domain (or throws).

    -

    WARNING: do not hold references to this contract, as it will not be -reconnected in the event the chain connection changes.

    -
    throws

    If no replica is found.

    -

    Parameters

    • home: string | number
      -

      the sending domain

      -
    • remote: string | number
      -

      the receiving domain

      -

    Returns Replica

    An interface for the Replica

    -
  • mustGetSigner(nameOrDomain: string | number): Signer
  • -

    Get the Signer associated with a doman (or error)

    -
    throws

    If no provider has been registered for the specified domain

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns Signer

    A Signer

    -
  • reconnect(nameOrDomain: string | number): void
  • -

    Ensure that the contracts on a given domain are connected to the -currently-registered signer or provider.

    -

    Parameters

    • nameOrDomain: string | number

    Returns void

  • registerDomain(domain: Domain): void
  • -

    Resgister a domain with the MultiProvider. This allows the multiprovider -to resolves tha domain info, and reference it by name or number.

    -

    Parameters

    • domain: Domain
      -

      The Domain object to register.

      -

    Returns void

  • registerProvider(nameOrDomain: string | number, provider: Provider): void
  • -

    Register an ethers Provider for a specified domain.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -
    • provider: Provider
      -

      An ethers Provider to be used by requests to that domain.

      -

    Returns void

  • registerRpcProvider(nameOrDomain: string | number, rpc: string): void
  • -

    Shortcut to register a provider by its HTTP RPC URL.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -
    • rpc: string
      -

      The HTTP RPC Url

      -

    Returns void

  • registerSigner(nameOrDomain: string | number, signer: Signer): void
  • -

    Register an ethers Signer for a specified domain.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -
    • signer: Signer
      -

      An ethers Signer to be used by requests to that domain.

      -

    Returns void

  • registerWalletSigner(nameOrDomain: string | number, privkey: string): void
  • -

    A shortcut for registering a basic local privkey signer on a domain.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -
    • privkey: string
      -

      A private key string passed to ethers.Wallet

      -

    Returns void

  • resolveDomain(nameOrDomain: string | number): number
  • -

    Resolve a domain name (or number) to the canonical number.

    -

    This function is used extensively to disambiguate domains.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns number

    The canonical domain number.

    -
  • resolveDomainName(nameOrDomain: string | number): string
  • -

    Resolve the name of a registered {@link Domain}, from its name or number.

    -

    Similar to resolveDomain.

    -
    throws

    If the domain is unknown

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns string

    The name

    -
  • unregisterSigner(nameOrDomain: string | number): void
  • -

    Remove the registered ethers Signer from a domain. This function will -attempt to preserve any Provider that was previously connected to this -domain.

    -

    Parameters

    • nameOrDomain: string | number
      -

      A domain name or number.

      -

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Protected property
  • Protected method
  • Method
  • Private property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk/classes/NomadMessage.html b/docs/public/sdk/classes/NomadMessage.html deleted file mode 100644 index d6cd2b0..0000000 --- a/docs/public/sdk/classes/NomadMessage.html +++ /dev/null @@ -1,109 +0,0 @@ -NomadMessage | @nomad-xyz/sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NomadMessage<T>

-

A deserialized Nomad message.

-

Type parameters

Hierarchy

  • NomadMessage

Index

Constructors

Properties

cache: EventCache
context: T
home: Home
message: ParsedMessage
replica: Replica

Accessors

  • get body(): string
  • get bodyHash(): string
  • get committedRoot(): string
  • get destination(): number
  • get destinationAndNonce(): BigNumber
  • get from(): number
  • get leaf(): string
  • get leafIndex(): BigNumber
  • get nonce(): number
  • get origin(): number
  • get receipt(): TransactionReceipt
  • get recipient(): string
  • get sender(): string
  • get transactionHash(): string

Methods

  • confirmAt(): Promise<BigNumber>
  • -

    Returns the timestamp after which it is possible to process this message.

    -

    Note: return the timestamp after which it is possible to process messages -within an Update. The timestamp is most relevant during the time AFTER the -Update has been Relayed to the Replica and BEFORE the message in question -has been Processed.

    -

    Considerations:

    -
      -
    • the timestamp will be 0 if the Update has not been relayed to the Replica
    • -
    • after the Update has been relayed to the Replica, the timestamp will be -non-zero forever (even after all messages in the Update have been -processed)
    • -
    • if the timestamp is in the future, the challenge period has not elapsed -yet; messages in the Update cannot be processed yet
    • -
    • if the timestamp is in the past, this does not necessarily mean that all -messages in the Update have been processed
    • -
    -

    Returns Promise<BigNumber>

    The timestamp at which a message can confirm

    -
  • delivered(): Promise<boolean>
  • wait(opts?: { pollTime?: number }): Promise<void>
  • -

    Returns a promise that resolves when the message has been delivered.

    -

    WARNING: May never resolve. Oftern takes hours to resolve.

    -

    Parameters

    • Optional opts: { pollTime?: number }
      -

      Polling options.

      -
      • Optional pollTime?: number

    Returns Promise<void>

  • baseFromReceipt<T>(context: T, nameOrDomain: string | number, receipt: TransactionReceipt): NomadMessage<T>[]
  • baseFromTransactionHash<T>(context: T, nameOrDomain: string | number, transactionHash: string): Promise<NomadMessage<T>[]>
  • baseSingleFromReceipt<T>(context: T, nameOrDomain: string | number, receipt: TransactionReceipt): NomadMessage<T>
  • -

    Instantiate EXACTLY one message from a receipt.

    -
    throws

    if there is not EXACTLY 1 dispatch in the receipt

    -

    Type parameters

    Parameters

    • context: T
      -

      the NomadContext object to use

      -
    • nameOrDomain: string | number
      -

      the domain on which the receipt was logged

      -
    • receipt: TransactionReceipt
      -

      the receipt

      -

    Returns NomadMessage<T>

    an array of NomadMessage objects

    -
  • baseSingleFromTransactionHash<T>(context: T, nameOrDomain: string | number, transactionHash: string): Promise<NomadMessage<T>>
  • -

    Instantiate EXACTLY one message from a transaction has.

    -
    throws

    if there is no receipt for the TX, or if not EXACTLY 1 dispatch in - the receipt

    -

    Type parameters

    Parameters

    • context: T
      -

      the NomadContext object to use

      -
    • nameOrDomain: string | number
      -

      the domain on which the receipt was logged

      -
    • transactionHash: string

    Returns Promise<NomadMessage<T>>

    an array of NomadMessage objects

    -

Legend

  • Constructor
  • Property
  • Method
  • Protected property
  • Protected method
  • Method
  • Private property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk/enums/MessageStatus.html b/docs/public/sdk/enums/MessageStatus.html deleted file mode 100644 index 9996cbf..0000000 --- a/docs/public/sdk/enums/MessageStatus.html +++ /dev/null @@ -1 +0,0 @@ -MessageStatus | @nomad-xyz/sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration MessageStatus

Index

Enumeration members

Dispatched = 0
Included = 1
Processed = 3
Relayed = 2

Legend

  • Constructor
  • Property
  • Method
  • Protected property
  • Protected method
  • Method
  • Private property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk/enums/ReplicaMessageStatus.html b/docs/public/sdk/enums/ReplicaMessageStatus.html deleted file mode 100644 index 27b3d95..0000000 --- a/docs/public/sdk/enums/ReplicaMessageStatus.html +++ /dev/null @@ -1 +0,0 @@ -ReplicaMessageStatus | @nomad-xyz/sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration ReplicaMessageStatus

Index

Enumeration members

Enumeration members

None = 0
Processed = 2
Proven = 1

Legend

  • Constructor
  • Property
  • Method
  • Protected property
  • Protected method
  • Method
  • Private property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk/index.html b/docs/public/sdk/index.html deleted file mode 100644 index 40489e5..0000000 --- a/docs/public/sdk/index.html +++ /dev/null @@ -1,14 +0,0 @@ -@nomad-xyz/sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

@nomad-xyz/sdk

Legend

  • Constructor
  • Property
  • Method
  • Protected property
  • Protected method
  • Method
  • Private property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk/interfaces/TSContract.html b/docs/public/sdk/interfaces/TSContract.html deleted file mode 100644 index a36dd0f..0000000 --- a/docs/public/sdk/interfaces/TSContract.html +++ /dev/null @@ -1 +0,0 @@ -TSContract | @nomad-xyz/sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TSContract<T, U>

Type parameters

  • T: Result

  • U

Hierarchy

  • TSContract

Index

Methods

  • queryFilter(event: TypedEventFilter<T, U>, fromBlockOrBlockhash?: string | number, toBlock?: string | number): Promise<TypedEvent<T & U>[]>
  • Parameters

    • event: TypedEventFilter<T, U>
    • Optional fromBlockOrBlockhash: string | number
    • Optional toBlock: string | number

    Returns Promise<TypedEvent<T & U>[]>

Legend

  • Constructor
  • Property
  • Method
  • Protected property
  • Protected method
  • Method
  • Private property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/sdk/modules.html b/docs/public/sdk/modules.html deleted file mode 100644 index 3baf094..0000000 --- a/docs/public/sdk/modules.html +++ /dev/null @@ -1,3 +0,0 @@ -@nomad-xyz/sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

@nomad-xyz/sdk

Index

Type aliases

AnnotatedProcess: Annotated<ProcessTypes, ProcessEvent>
AnnotatedUpdate: Annotated<UpdateTypes, UpdateEvent>
DispatchArgs: { committedRoot: string; destinationAndNonce: BigNumber; leafIndex: BigNumber; message: string; messageHash: string }

Type declaration

  • committedRoot: string
  • destinationAndNonce: BigNumber
  • leafIndex: BigNumber
  • message: string
  • messageHash: string
DispatchEvent: TypedEvent<DispatchTypes & DispatchArgs>
DispatchTypes: [string, BigNumber, BigNumber, string, string]
EventCache: { homeUpdate?: AnnotatedUpdate; process?: AnnotatedProcess; replicaUpdate?: AnnotatedUpdate }

Type declaration

NomadLifecyleEvent: ProcessEvent | UpdateEvent | DispatchEvent
NomadStatus: { events: AnnotatedLifecycleEvent[]; status: MessageStatus }

Type declaration

ParsedMessage: { body: string; destination: number; from: number; nonce: number; recipient: string; sender: string }

Type declaration

  • body: string
  • destination: number
  • from: number
  • nonce: number
  • recipient: string
  • sender: string
ProcessArgs: { messageHash: string; returnData: string; success: boolean }

Type declaration

  • messageHash: string
  • returnData: string
  • success: boolean
ProcessEvent: TypedEvent<ProcessTypes & ProcessArgs>
ProcessTypes: [string, boolean, string]
UpdateArgs: { homeDomain: number; newRoot: string; oldRoot: string; signature: string }

Type declaration

  • homeDomain: number
  • newRoot: string
  • oldRoot: string
  • signature: string
UpdateEvent: TypedEvent<UpdateTypes & UpdateArgs>
UpdateTypes: [number, string, string, string]

Functions

  • getEvents<T, U>(context: NomadContext, nameOrDomain: string | number, contract: TSContract<T, U>, filter: TypedEventFilter<T, U>, startBlock?: number, endBlock?: number): Promise<TypedEvent<T & U>[]>
  • Type parameters

    • T: Result<T>

    • U

    Parameters

    • context: NomadContext
    • nameOrDomain: string | number
    • contract: TSContract<T, U>
    • filter: TypedEventFilter<T, U>
    • Optional startBlock: number
    • Optional endBlock: number

    Returns Promise<TypedEvent<T & U>[]>

  • queryAnnotatedEvents<T, U>(context: NomadContext, nameOrDomain: string | number, contract: TSContract<T, U>, filter: TypedEventFilter<T, U>, startBlock?: number, endBlock?: number): Promise<Annotated<T, TypedEvent<T & U>>[]>
  • Type parameters

    • T: Result<T>

    • U

    Parameters

    • context: NomadContext
    • nameOrDomain: string | number
    • contract: TSContract<T, U>
    • filter: TypedEventFilter<T, U>
    • Optional startBlock: number
    • Optional endBlock: number

    Returns Promise<Annotated<T, TypedEvent<T & U>>[]>

Legend

  • Constructor
  • Property
  • Method
  • Protected property
  • Protected method
  • Method
  • Private property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/public/tutorials/bridge-gui/change-dest-1.png b/docs/public/tutorials/bridge-gui/change-dest-1.png deleted file mode 100644 index 80a856e..0000000 Binary files a/docs/public/tutorials/bridge-gui/change-dest-1.png and /dev/null differ diff --git a/docs/public/tutorials/bridge-gui/change-dest-2.png b/docs/public/tutorials/bridge-gui/change-dest-2.png deleted file mode 100644 index ebf8512..0000000 Binary files a/docs/public/tutorials/bridge-gui/change-dest-2.png and /dev/null differ diff --git a/docs/public/tutorials/bridge-gui/check-connext.png b/docs/public/tutorials/bridge-gui/check-connext.png deleted file mode 100644 index b0e85eb..0000000 Binary files a/docs/public/tutorials/bridge-gui/check-connext.png and /dev/null differ diff --git a/docs/public/tutorials/bridge-gui/complete-transfer.png b/docs/public/tutorials/bridge-gui/complete-transfer.png deleted file mode 100644 index ba601f5..0000000 Binary files a/docs/public/tutorials/bridge-gui/complete-transfer.png and /dev/null differ diff --git a/docs/public/tutorials/bridge-gui/connect-metamask.png b/docs/public/tutorials/bridge-gui/connect-metamask.png deleted file mode 100644 index 94f1115..0000000 Binary files a/docs/public/tutorials/bridge-gui/connect-metamask.png and /dev/null differ diff --git a/docs/public/tutorials/bridge-gui/connext-claim.png b/docs/public/tutorials/bridge-gui/connext-claim.png deleted file mode 100644 index c26d48a..0000000 Binary files a/docs/public/tutorials/bridge-gui/connext-claim.png and /dev/null differ diff --git a/docs/public/tutorials/bridge-gui/expand-status.png b/docs/public/tutorials/bridge-gui/expand-status.png deleted file mode 100644 index 3d1f1fc..0000000 Binary files a/docs/public/tutorials/bridge-gui/expand-status.png and /dev/null differ diff --git a/docs/public/tutorials/bridge-gui/input-data.png b/docs/public/tutorials/bridge-gui/input-data.png deleted file mode 100644 index 7281b0e..0000000 Binary files a/docs/public/tutorials/bridge-gui/input-data.png and /dev/null differ diff --git a/docs/public/tutorials/bridge-gui/review.png b/docs/public/tutorials/bridge-gui/review.png deleted file mode 100644 index e2a641a..0000000 Binary files a/docs/public/tutorials/bridge-gui/review.png and /dev/null differ diff --git a/docs/public/tutorials/bridge-gui/search-transfer.png b/docs/public/tutorials/bridge-gui/search-transfer.png deleted file mode 100644 index d4a7e5a..0000000 Binary files a/docs/public/tutorials/bridge-gui/search-transfer.png and /dev/null differ diff --git a/docs/public/tutorials/bridge-gui/select-networks.png b/docs/public/tutorials/bridge-gui/select-networks.png deleted file mode 100644 index 0b4743c..0000000 Binary files a/docs/public/tutorials/bridge-gui/select-networks.png and /dev/null differ diff --git a/docs/public/tutorials/bridge-gui/select-token.png b/docs/public/tutorials/bridge-gui/select-token.png deleted file mode 100644 index 9a54f6c..0000000 Binary files a/docs/public/tutorials/bridge-gui/select-token.png and /dev/null differ diff --git a/docs/public/tutorials/bridge-gui/sending.png b/docs/public/tutorials/bridge-gui/sending.png deleted file mode 100644 index 1cebc95..0000000 Binary files a/docs/public/tutorials/bridge-gui/sending.png and /dev/null differ diff --git a/docs/public/tutorials/bridge-gui/transfer-complete.png b/docs/public/tutorials/bridge-gui/transfer-complete.png deleted file mode 100644 index 30441db..0000000 Binary files a/docs/public/tutorials/bridge-gui/transfer-complete.png and /dev/null differ diff --git a/docs/public/tutorials/bridge-gui/transfer-pending.png b/docs/public/tutorials/bridge-gui/transfer-pending.png deleted file mode 100644 index a63be67..0000000 Binary files a/docs/public/tutorials/bridge-gui/transfer-pending.png and /dev/null differ diff --git a/docs/public/tutorials/debug-agents/agents-no-zoom.png b/docs/public/tutorials/debug-agents/agents-no-zoom.png deleted file mode 100644 index 5e46f7f..0000000 Binary files a/docs/public/tutorials/debug-agents/agents-no-zoom.png and /dev/null differ diff --git a/docs/public/tutorials/debug-agents/agents-regression-zoom.png b/docs/public/tutorials/debug-agents/agents-regression-zoom.png deleted file mode 100644 index bbadd69..0000000 Binary files a/docs/public/tutorials/debug-agents/agents-regression-zoom.png and /dev/null differ diff --git a/docs/public/tutorials/debug-agents/agents-timestamp-paste.png b/docs/public/tutorials/debug-agents/agents-timestamp-paste.png deleted file mode 100644 index 367f10b..0000000 Binary files a/docs/public/tutorials/debug-agents/agents-timestamp-paste.png and /dev/null differ diff --git a/docs/public/tutorials/debug-agents/bridge-health-overview.png b/docs/public/tutorials/debug-agents/bridge-health-overview.png deleted file mode 100644 index 2e59f28..0000000 Binary files a/docs/public/tutorials/debug-agents/bridge-health-overview.png and /dev/null differ diff --git a/docs/public/tutorials/debug-agents/enter-agent-pod-and-timestamp.png b/docs/public/tutorials/debug-agents/enter-agent-pod-and-timestamp.png deleted file mode 100644 index d285cfc..0000000 Binary files a/docs/public/tutorials/debug-agents/enter-agent-pod-and-timestamp.png and /dev/null differ diff --git a/docs/public/tutorials/debug-agents/find-bridge-health.png b/docs/public/tutorials/debug-agents/find-bridge-health.png deleted file mode 100644 index 47398fd..0000000 Binary files a/docs/public/tutorials/debug-agents/find-bridge-health.png and /dev/null differ diff --git a/docs/public/tutorials/debug-agents/find-dashboards.png b/docs/public/tutorials/debug-agents/find-dashboards.png deleted file mode 100644 index e715097..0000000 Binary files a/docs/public/tutorials/debug-agents/find-dashboards.png and /dev/null differ diff --git a/docs/public/tutorials/debug-agents/find-explore.png b/docs/public/tutorials/debug-agents/find-explore.png deleted file mode 100644 index 15fd7a7..0000000 Binary files a/docs/public/tutorials/debug-agents/find-explore.png and /dev/null differ diff --git a/docs/public/tutorials/debug-agents/identify-regression.png b/docs/public/tutorials/debug-agents/identify-regression.png deleted file mode 100644 index e96f126..0000000 Binary files a/docs/public/tutorials/debug-agents/identify-regression.png and /dev/null differ diff --git a/docs/public/tutorials/debug-agents/log-errors.png b/docs/public/tutorials/debug-agents/log-errors.png deleted file mode 100644 index a12151b..0000000 Binary files a/docs/public/tutorials/debug-agents/log-errors.png and /dev/null differ diff --git a/docs/public/tutorials/debug-agents/zoom-in-regression.png b/docs/public/tutorials/debug-agents/zoom-in-regression.png deleted file mode 100644 index e51c68c..0000000 Binary files a/docs/public/tutorials/debug-agents/zoom-in-regression.png and /dev/null differ diff --git a/docs/public/tutorials/governance-signer/approve-on-device.png b/docs/public/tutorials/governance-signer/approve-on-device.png deleted file mode 100644 index 8bb8fb8..0000000 Binary files a/docs/public/tutorials/governance-signer/approve-on-device.png and /dev/null differ diff --git a/docs/public/tutorials/governance-signer/approve-on-metamask.png b/docs/public/tutorials/governance-signer/approve-on-metamask.png deleted file mode 100644 index 39bccd0..0000000 Binary files a/docs/public/tutorials/governance-signer/approve-on-metamask.png and /dev/null differ diff --git a/docs/public/tutorials/governance-signer/confirm-address.png b/docs/public/tutorials/governance-signer/confirm-address.png deleted file mode 100644 index 09db685..0000000 Binary files a/docs/public/tutorials/governance-signer/confirm-address.png and /dev/null differ diff --git a/docs/public/tutorials/governance-signer/connect-to-metamask.png b/docs/public/tutorials/governance-signer/connect-to-metamask.png deleted file mode 100644 index f6364ae..0000000 Binary files a/docs/public/tutorials/governance-signer/connect-to-metamask.png and /dev/null differ diff --git a/docs/public/tutorials/governance-signer/select-wallet.png b/docs/public/tutorials/governance-signer/select-wallet.png deleted file mode 100644 index 35df814..0000000 Binary files a/docs/public/tutorials/governance-signer/select-wallet.png and /dev/null differ diff --git a/docs/public/tutorials/governance-signer/sign-message.png b/docs/public/tutorials/governance-signer/sign-message.png deleted file mode 100644 index 80828c4..0000000 Binary files a/docs/public/tutorials/governance-signer/sign-message.png and /dev/null differ diff --git a/docs/public/tutorials/governance-signer/signature-success.png b/docs/public/tutorials/governance-signer/signature-success.png deleted file mode 100644 index 84fdb9b..0000000 Binary files a/docs/public/tutorials/governance-signer/signature-success.png and /dev/null differ diff --git a/docs/reference/contracts-bridge.md b/docs/reference/contracts-bridge.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference/contracts-core.md b/docs/reference/contracts-core.md new file mode 100644 index 0000000..8da56b2 --- /dev/null +++ b/docs/reference/contracts-core.md @@ -0,0 +1 @@ +# Contracts-Core diff --git a/docs/resources/audits.md b/docs/resources/audits.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/resources/deployed-contracts.md b/docs/resources/deployed-contracts.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/resources/faq.md b/docs/resources/faq.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/token-bridge/nomad-connext.md b/docs/token-bridge/nomad-connext.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/token-bridge/overview.md b/docs/token-bridge/overview.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/tutorials/governance-onboarding.md b/docs/tutorials/governance-onboarding.md deleted file mode 100644 index ec52f5f..0000000 --- a/docs/tutorials/governance-onboarding.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -title: Governance Signer Onboarding -lang: en-US ---- - -# Governance Signer Onboarding - -We are so excited to introduce Nomad's novel cross-chain governance system to the inaugural Nomad Community. As a decentralized interoperability protocol with connections to a growing set of new and established blockchain networks, the Nomad Core Team's goal is to establish a progressive shared ownership with as many stakeholders as possible. - -If you are here and reading this, chances are you have been asked to be a Governance key-holder. Congratulations and thank you in advance for your service! - -At a high level, there are several steps you must complete in order to be fully enrolled and established publicly as a key-holder: - -- Generate a new address on a hardware wallet -- Sign a message with your newly-generated address -- Share your address, message signature, and contact information with the Nomad Core Team -- Share your message signature with the community via a public channel - -## Generate an Address - -Depending on your hardware wallet, the steps could be slightly different. Here's some quick links for various common wallets: -- Ledger: [Add Your Accounts](https://support.ledger.com/hc/en-us/articles/4404389482641-Add-your-accounts?docs=true) -- Trezor: [User Guide](https://wiki.trezor.io/User_manual) - -## Sign a Message - -Next, in order to signal your ownership and control over your Governance Signer, we're asking all key-holders to sign their choice from a list of provided messages and share it with the community for manual verification. - -### Message Options - -You are free to choose your favorite Nomad-related message from the below list. Nothing here suit your fancy? Reach out to your Point of Contact on the Nomad Core Team and we'd be happy to facilitate the use of a personalized message. - -- I am a #MadLad! -- I am a #MadLass! -- u #mad? - -### Signing with MyCrypto.com - -There are many options when it comes to ways of signing messages with your hardware wallet, we recommend using MyCrypto.com for ease of use. - -The direct link to the Message Sign tool is [here](https://app.mycrypto.com/sign-message). - -**Steps:** - -1. Connect a wallet to the MyCrypto UI - -NOTE: The direct ledger integration on MyCrypto.com's Message Signature tool is outdated, we recommend using the Metamask + Hardware Wallet integration. - -Select a wallet: - -![Wallet Selection Modal](../public/tutorials/governance-signer/select-wallet.png) - -Connect to Metamask: - -![Connect to Metamask](../public/tutorials/governance-signer/connect-to-metamask.png) - -Confirm Address: - -![Connect to Metamask](../public/tutorials/governance-signer/confirm-address.png) - -2. Sign Message - -Now that your wallet is connected, we can use the MyCrypto UI to sign your choice of message from the above options. - -![Sign a Message](../public/tutorials/governance-signer/sign-message.png) - -Approve the signature in Metamask: - -![Approve Signature in Metamask](../public/tutorials/governance-signer/approve-on-metamask.png) - -Approve the Signature on your Device: - -![Approve Signature on Wallet](../public/tutorials/governance-signer/approve-on-device.png) - -Nice! You should now have a successful signature output in the MyCrypto UI: - -![Signature Success](../public/tutorials/governance-signer/signature-success.png) - -Here's what the output of your signature should look like: - -```json -{ - "address": "
", - "msg": "I am a #MadLad!", - "sig": "", - "version": "2" -} -``` - -## Share with the Nomad Core Team - -Great! You've signed the message with your new governance signer key, now it's time to share this data with the Nomad Core Team. We will be publishing all of the signatures as well as information that identifies each signer in order to bolster confidence that the Nomad protocol governance is in good hands. - -We request the following information: -- Twitter Handle -- Telegram Handle -- Governance Signer Address -- Raw Message Signature output from MyCrypto.com - -Please email this information to [gm@nomad.xyz](mailto:gm@nomad.xyz). - -## Greet the #MadLad Community! - -Now for the fun part! Share your message and signature with the Nomad Community via an established public channel that you control. We have a strong preference for Twitter, as the crypto community almost exclusively lives there. - -If you don't have Twitter, or have an alternative channel you would like to publish on, please discuss that with your Point of Contact on the Nomad Core Team and we'd be happy to work with you. - -Example Tweet Thread: - -> I am excited to be a Governance Key Holder for @nomadxyz_'s Governor Multisig on Ethereum! Nomad is a new interoperability protocol that enables the construction of asyncronous cross-chain smart contract applications. - -Reply: - -> Message: I am a #MadLad! -> -> Address: 0xf288ea0dEcb5686d67973221680548a8E7b914d4 -> -> Signature: 0xfda3370fdb3b8e59e8b68bf6de3066f2e54d0a9a43be46f464520c10fb0a504d12a88fb5a14945ac468db0bd17521b34900ecf1af039eb36f7031dc8e6ba1d4b00 - -Reply: - -> Verify my message on Etherscan! -> https://etherscan.io/verifySig \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js new file mode 100644 index 0000000..7d9cc45 --- /dev/null +++ b/docusaurus.config.js @@ -0,0 +1,150 @@ +/** @type {import('@docusaurus/types').DocusaurusConfig} */ + +const lightCodeTheme = require('prism-react-renderer/themes/github'); +const darkCodeTheme = require('prism-react-renderer/themes/dracula'); + +const config = { + title: 'Nomad Docs', + tagline: 'The Future of Cross-Chain is Optimistic. Here you will find documentation, guides and reference material for not only using the Nomad Bridge, but also building on the Nomad Protocol', + url: 'https://docs.nomad.xyz', + baseUrl: '/', + onBrokenLinks: 'throw', + onBrokenMarkdownLinks: 'warn', + favicon: 'img/favicon.ico', + organizationName: 'nomad-xyz', + projectName: 'monorepo', + i18n: { + defaultLocale: 'en', + locales: ['en'], + }, + themeConfig: { + image: 'img/nomad-hero.png', + prism: { + theme: lightCodeTheme, + darkTheme: darkCodeTheme, + }, + algolia: { + appId: 'YOUR_APP_ID', + apiKey: 'YOUR_SEARCH_API_KEY', + indexName: 'YOUR_INDEX_NAME', + contextualSearch: true, + searchParameters: {}, + searchPagePath: 'search', + }, + docs: { + sidebar: { + "hideable": true + } + }, + navbar: { + title: 'Learn', + logo: { + alt: 'Nomad Logo', + src: 'img/logob.svg', + srcDark: 'img/logow.svg' + }, + items: [ + { + type: 'doc', + docId: 'docs', + position: 'left', + label: 'Docs', + }, + { + to: '/guides/', + position: 'left', + label: 'Guides', + }, + { + to: 'https://discord.gg/nomadxyz', + position: 'left', + label: 'Discord', + }, + { + href: 'https://github.com/nomad-xyz', + position: 'right', + className: 'header-github-link', + 'aria-label': 'GitHub', + }, + ], + }, + footer: { + style: 'dark', + links: [ + { + title: 'Nomad', + items: [ + { + label: 'Nomad.xyz', + to: 'https://nomad.xyz', + }, + { + label: 'Nomad Token Bridge', + to: 'https://app.nomad.xyz', + }, + ], + }, + { + title: 'Resources', + items: [ + { + label: 'Learn', + to: '/', + }, + { + label: 'Blog', + to: 'https://https://blog.nomad.xyz/', + }, + ], + }, + { + title: 'Community', + items: [ + { + label: 'Discord', + to: 'https://discord.gg/nomadxyz', + }, + { + label: 'Forums', + to: 'https://forums.nomad.xyz', + }, + ], + }, + ], + copyright: `Built with Immaculate Vibes. Copyright © ${new Date().getFullYear()} Illusory Systems, Inc.`, + }, + }, + plugins: [ + 'docusaurus-tailwindcss-loader', + [ + '@docusaurus/plugin-content-docs', + { + id: 'guides', + sidebarPath: require.resolve('./src/data/sidebar-guides.js'), + path: './guides', + routeBasePath: 'guides', + include: ['**/*.md', '**/*.mdx'], + }, + ], + ], + presets: [ + [ + '@docusaurus/preset-classic', + { + docs: { + sidebarPath: require.resolve('./sidebars.js'), + showLastUpdateTime: true, + }, + theme: { + customCss: [require.resolve('./src/css/custom.css')], + }, + }, + ], + ], + stylesheets: [ + ], + scripts: [ + ], +}; + +module.exports = config; diff --git a/guides/develop/how-to-build-simple-xapp.mdx b/guides/develop/how-to-build-simple-xapp.mdx new file mode 100644 index 0000000..4e85228 --- /dev/null +++ b/guides/develop/how-to-build-simple-xapp.mdx @@ -0,0 +1,14 @@ +--- +title: How to build a cross-chain app for beginners +description: "Build a simple cross-chain application using the Nomad Protocol" +image: static/logob.svg +custom_edit_url: https://github.com/nomad-xyz/learn/edit/master/docs/guides/develop/how-to-build-xapp-101.md +--- +import Callout from '../../src/components/Callout.js' + +# Title + + + Notice Callout + + diff --git a/netlify.toml b/netlify.toml new file mode 100644 index 0000000..281804b --- /dev/null +++ b/netlify.toml @@ -0,0 +1,3 @@ +[build] + environment = { NPM_VERSION = "7.10.0", NODE_VERSION = "16.15.0", NETLIFY_USE_YARN = "true" } + diff --git a/package-lock.json b/package-lock.json deleted file mode 100644 index 3c7db48..0000000 --- a/package-lock.json +++ /dev/null @@ -1,875 +0,0 @@ -{ - "name": "docs", - "version": "1.0.0", - "lockfileVersion": 2, - "requires": true, - "packages": { - "": { - "name": "docs", - "version": "1.0.0", - "license": "Apache 2.0", - "dependencies": { - "vitepress": "^0.20.1" - } - }, - "node_modules/@algolia/cache-browser-local-storage": { - "version": "4.11.0", - "license": "MIT", - "dependencies": { - "@algolia/cache-common": "4.11.0" - } - }, - "node_modules/@algolia/cache-common": { - "version": "4.11.0", - "license": "MIT" - }, - "node_modules/@algolia/cache-in-memory": { - "version": "4.11.0", - "license": "MIT", - "dependencies": { - "@algolia/cache-common": "4.11.0" - } - }, - "node_modules/@algolia/client-account": { - "version": "4.11.0", - "license": "MIT", - "dependencies": { - "@algolia/client-common": "4.11.0", - "@algolia/client-search": "4.11.0", - "@algolia/transporter": "4.11.0" - } - }, - "node_modules/@algolia/client-analytics": { - "version": "4.11.0", - "license": "MIT", - "dependencies": { - "@algolia/client-common": "4.11.0", - "@algolia/client-search": "4.11.0", - "@algolia/requester-common": "4.11.0", - "@algolia/transporter": "4.11.0" - } - }, - "node_modules/@algolia/client-common": { - "version": "4.11.0", - "license": "MIT", - "dependencies": { - "@algolia/requester-common": "4.11.0", - "@algolia/transporter": "4.11.0" - } - }, - "node_modules/@algolia/client-personalization": { - "version": "4.11.0", - "license": "MIT", - "dependencies": { - "@algolia/client-common": "4.11.0", - "@algolia/requester-common": "4.11.0", - "@algolia/transporter": "4.11.0" - } - }, - "node_modules/@algolia/client-search": { - "version": "4.11.0", - "license": "MIT", - "dependencies": { - "@algolia/client-common": "4.11.0", - "@algolia/requester-common": "4.11.0", - "@algolia/transporter": "4.11.0" - } - }, - "node_modules/@algolia/logger-common": { - "version": "4.11.0", - "license": "MIT" - }, - "node_modules/@algolia/logger-console": { - "version": "4.11.0", - "license": "MIT", - "dependencies": { - "@algolia/logger-common": "4.11.0" - } - }, - "node_modules/@algolia/requester-browser-xhr": { - "version": "4.11.0", - "license": "MIT", - "dependencies": { - "@algolia/requester-common": "4.11.0" - } - }, - "node_modules/@algolia/requester-common": { - "version": "4.11.0", - "license": "MIT" - }, - "node_modules/@algolia/requester-node-http": { - "version": "4.11.0", - "license": "MIT", - "dependencies": { - "@algolia/requester-common": "4.11.0" - } - }, - "node_modules/@algolia/transporter": { - "version": "4.11.0", - "license": "MIT", - "dependencies": { - "@algolia/cache-common": "4.11.0", - "@algolia/logger-common": "4.11.0", - "@algolia/requester-common": "4.11.0" - } - }, - "node_modules/@babel/parser": { - "version": "7.16.3", - "license": "MIT", - "bin": { - "parser": "bin/babel-parser.js" - }, - "engines": { - "node": ">=6.0.0" - } - }, - "node_modules/@docsearch/css": { - "version": "1.0.0-alpha.28", - "license": "MIT" - }, - "node_modules/@docsearch/js": { - "version": "1.0.0-alpha.28", - "license": "MIT", - "dependencies": { - "@docsearch/react": "^1.0.0-alpha.28", - "preact": "^10.0.0" - } - }, - "node_modules/@docsearch/react": { - "version": "1.0.0-alpha.28", - "license": "MIT", - "dependencies": { - "@docsearch/css": "^1.0.0-alpha.28", - "@francoischalifour/autocomplete-core": "^1.0.0-alpha.28", - "@francoischalifour/autocomplete-preset-algolia": "^1.0.0-alpha.28", - "algoliasearch": "^4.0.0" - }, - "peerDependencies": { - "react": "^16.8.0", - "react-dom": "^16.8.0" - } - }, - "node_modules/@francoischalifour/autocomplete-core": { - "version": "1.0.0-alpha.28", - "license": "MIT" - }, - "node_modules/@francoischalifour/autocomplete-preset-algolia": { - "version": "1.0.0-alpha.28", - "license": "MIT" - }, - "node_modules/@vitejs/plugin-vue": { - "version": "1.9.4", - "license": "MIT", - "engines": { - "node": ">=12.0.0" - }, - "peerDependencies": { - "vite": "^2.5.10" - } - }, - "node_modules/@vue/compiler-core": { - "version": "3.2.21", - "license": "MIT", - "dependencies": { - "@babel/parser": "^7.15.0", - "@vue/shared": "3.2.21", - "estree-walker": "^2.0.2", - "source-map": "^0.6.1" - } - }, - "node_modules/@vue/compiler-dom": { - "version": "3.2.21", - "license": "MIT", - "dependencies": { - "@vue/compiler-core": "3.2.21", - "@vue/shared": "3.2.21" - } - }, - "node_modules/@vue/compiler-sfc": { - "version": "3.2.21", - "license": "MIT", - "dependencies": { - "@babel/parser": "^7.15.0", - "@vue/compiler-core": "3.2.21", - "@vue/compiler-dom": "3.2.21", - "@vue/compiler-ssr": "3.2.21", - "@vue/ref-transform": "3.2.21", - "@vue/shared": "3.2.21", - "estree-walker": "^2.0.2", - "magic-string": "^0.25.7", - "postcss": "^8.1.10", - "source-map": "^0.6.1" - } - }, - "node_modules/@vue/compiler-ssr": { - "version": "3.2.21", - "license": "MIT", - "dependencies": { - "@vue/compiler-dom": "3.2.21", - "@vue/shared": "3.2.21" - } - }, - "node_modules/@vue/reactivity": { - "version": "3.2.21", - "license": "MIT", - "dependencies": { - "@vue/shared": "3.2.21" - } - }, - "node_modules/@vue/ref-transform": { - "version": "3.2.21", - "license": "MIT", - "dependencies": { - "@babel/parser": "^7.15.0", - "@vue/compiler-core": "3.2.21", - "@vue/shared": "3.2.21", - "estree-walker": "^2.0.2", - "magic-string": "^0.25.7" - } - }, - "node_modules/@vue/runtime-core": { - "version": "3.2.21", - "license": "MIT", - "dependencies": { - "@vue/reactivity": "3.2.21", - "@vue/shared": "3.2.21" - } - }, - "node_modules/@vue/runtime-dom": { - "version": "3.2.21", - "license": "MIT", - "dependencies": { - "@vue/runtime-core": "3.2.21", - "@vue/shared": "3.2.21", - "csstype": "^2.6.8" - } - }, - "node_modules/@vue/server-renderer": { - "version": "3.2.21", - "license": "MIT", - "dependencies": { - "@vue/compiler-ssr": "3.2.21", - "@vue/shared": "3.2.21" - }, - "peerDependencies": { - "vue": "3.2.21" - } - }, - "node_modules/@vue/shared": { - "version": "3.2.21", - "license": "MIT" - }, - "node_modules/algoliasearch": { - "version": "4.11.0", - "license": "MIT", - "dependencies": { - "@algolia/cache-browser-local-storage": "4.11.0", - "@algolia/cache-common": "4.11.0", - "@algolia/cache-in-memory": "4.11.0", - "@algolia/client-account": "4.11.0", - "@algolia/client-analytics": "4.11.0", - "@algolia/client-common": "4.11.0", - "@algolia/client-personalization": "4.11.0", - "@algolia/client-search": "4.11.0", - "@algolia/logger-common": "4.11.0", - "@algolia/logger-console": "4.11.0", - "@algolia/requester-browser-xhr": "4.11.0", - "@algolia/requester-common": "4.11.0", - "@algolia/requester-node-http": "4.11.0", - "@algolia/transporter": "4.11.0" - } - }, - "node_modules/csstype": { - "version": "2.6.18", - "license": "MIT" - }, - "node_modules/esbuild": { - "version": "0.13.13", - "hasInstallScript": true, - "license": "MIT", - "bin": { - "esbuild": "bin/esbuild" - }, - "optionalDependencies": { - "esbuild-android-arm64": "0.13.13", - "esbuild-darwin-64": "0.13.13", - "esbuild-darwin-arm64": "0.13.13", - "esbuild-freebsd-64": "0.13.13", - "esbuild-freebsd-arm64": "0.13.13", - "esbuild-linux-32": "0.13.13", - "esbuild-linux-64": "0.13.13", - "esbuild-linux-arm": "0.13.13", - "esbuild-linux-arm64": "0.13.13", - "esbuild-linux-mips64le": "0.13.13", - "esbuild-linux-ppc64le": "0.13.13", - "esbuild-netbsd-64": "0.13.13", - "esbuild-openbsd-64": "0.13.13", - "esbuild-sunos-64": "0.13.13", - "esbuild-windows-32": "0.13.13", - "esbuild-windows-64": "0.13.13", - "esbuild-windows-arm64": "0.13.13" - } - }, - "node_modules/esbuild-darwin-64": { - "version": "0.13.13", - "cpu": [ - "x64" - ], - "license": "MIT", - "optional": true, - "os": [ - "darwin" - ] - }, - "node_modules/estree-walker": { - "version": "2.0.2", - "license": "MIT" - }, - "node_modules/fsevents": { - "version": "2.3.2", - "license": "MIT", - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": "^8.16.0 || ^10.6.0 || >=11.0.0" - } - }, - "node_modules/function-bind": { - "version": "1.1.1", - "license": "MIT" - }, - "node_modules/has": { - "version": "1.0.3", - "license": "MIT", - "dependencies": { - "function-bind": "^1.1.1" - }, - "engines": { - "node": ">= 0.4.0" - } - }, - "node_modules/is-core-module": { - "version": "2.8.0", - "license": "MIT", - "dependencies": { - "has": "^1.0.3" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/magic-string": { - "version": "0.25.7", - "license": "MIT", - "dependencies": { - "sourcemap-codec": "^1.4.4" - } - }, - "node_modules/nanoid": { - "version": "3.1.30", - "license": "MIT", - "bin": { - "nanoid": "bin/nanoid.cjs" - }, - "engines": { - "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" - } - }, - "node_modules/path-parse": { - "version": "1.0.7", - "license": "MIT" - }, - "node_modules/picocolors": { - "version": "1.0.0", - "license": "ISC" - }, - "node_modules/postcss": { - "version": "8.3.11", - "license": "MIT", - "dependencies": { - "nanoid": "^3.1.30", - "picocolors": "^1.0.0", - "source-map-js": "^0.6.2" - }, - "engines": { - "node": "^10 || ^12 || >=14" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/postcss/" - } - }, - "node_modules/preact": { - "version": "10.5.15", - "license": "MIT", - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/preact" - } - }, - "node_modules/prismjs": { - "version": "1.25.0", - "license": "MIT" - }, - "node_modules/resolve": { - "version": "1.20.0", - "license": "MIT", - "dependencies": { - "is-core-module": "^2.2.0", - "path-parse": "^1.0.6" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/rollup": { - "version": "2.59.0", - "license": "MIT", - "bin": { - "rollup": "dist/bin/rollup" - }, - "engines": { - "node": ">=10.0.0" - }, - "optionalDependencies": { - "fsevents": "~2.3.2" - } - }, - "node_modules/source-map": { - "version": "0.6.1", - "license": "BSD-3-Clause", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/source-map-js": { - "version": "0.6.2", - "license": "BSD-3-Clause", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/sourcemap-codec": { - "version": "1.4.8", - "license": "MIT" - }, - "node_modules/vite": { - "version": "2.6.14", - "license": "MIT", - "dependencies": { - "esbuild": "^0.13.2", - "postcss": "^8.3.8", - "resolve": "^1.20.0", - "rollup": "^2.57.0" - }, - "bin": { - "vite": "bin/vite.js" - }, - "engines": { - "node": ">=12.2.0" - }, - "optionalDependencies": { - "fsevents": "~2.3.2" - }, - "peerDependencies": { - "less": "*", - "sass": "*", - "stylus": "*" - }, - "peerDependenciesMeta": { - "less": { - "optional": true - }, - "sass": { - "optional": true - }, - "stylus": { - "optional": true - } - } - }, - "node_modules/vitepress": { - "version": "0.20.1", - "license": "MIT", - "dependencies": { - "@docsearch/css": "^1.0.0-alpha.28", - "@docsearch/js": "^1.0.0-alpha.28", - "@vitejs/plugin-vue": "^1.9.0", - "prismjs": "^1.25.0", - "vite": "^2.6.5", - "vue": "^3.2.19" - }, - "bin": { - "vitepress": "bin/vitepress.js" - }, - "engines": { - "node": ">=12.0.0" - } - }, - "node_modules/vue": { - "version": "3.2.21", - "license": "MIT", - "dependencies": { - "@vue/compiler-dom": "3.2.21", - "@vue/compiler-sfc": "3.2.21", - "@vue/runtime-dom": "3.2.21", - "@vue/server-renderer": "3.2.21", - "@vue/shared": "3.2.21" - } - } - }, - "dependencies": { - "@algolia/cache-browser-local-storage": { - "version": "4.11.0", - "requires": { - "@algolia/cache-common": "4.11.0" - } - }, - "@algolia/cache-common": { - "version": "4.11.0" - }, - "@algolia/cache-in-memory": { - "version": "4.11.0", - "requires": { - "@algolia/cache-common": "4.11.0" - } - }, - "@algolia/client-account": { - "version": "4.11.0", - "requires": { - "@algolia/client-common": "4.11.0", - "@algolia/client-search": "4.11.0", - "@algolia/transporter": "4.11.0" - } - }, - "@algolia/client-analytics": { - "version": "4.11.0", - "requires": { - "@algolia/client-common": "4.11.0", - "@algolia/client-search": "4.11.0", - "@algolia/requester-common": "4.11.0", - "@algolia/transporter": "4.11.0" - } - }, - "@algolia/client-common": { - "version": "4.11.0", - "requires": { - "@algolia/requester-common": "4.11.0", - "@algolia/transporter": "4.11.0" - } - }, - "@algolia/client-personalization": { - "version": "4.11.0", - "requires": { - "@algolia/client-common": "4.11.0", - "@algolia/requester-common": "4.11.0", - "@algolia/transporter": "4.11.0" - } - }, - "@algolia/client-search": { - "version": "4.11.0", - "requires": { - "@algolia/client-common": "4.11.0", - "@algolia/requester-common": "4.11.0", - "@algolia/transporter": "4.11.0" - } - }, - "@algolia/logger-common": { - "version": "4.11.0" - }, - "@algolia/logger-console": { - "version": "4.11.0", - "requires": { - "@algolia/logger-common": "4.11.0" - } - }, - "@algolia/requester-browser-xhr": { - "version": "4.11.0", - "requires": { - "@algolia/requester-common": "4.11.0" - } - }, - "@algolia/requester-common": { - "version": "4.11.0" - }, - "@algolia/requester-node-http": { - "version": "4.11.0", - "requires": { - "@algolia/requester-common": "4.11.0" - } - }, - "@algolia/transporter": { - "version": "4.11.0", - "requires": { - "@algolia/cache-common": "4.11.0", - "@algolia/logger-common": "4.11.0", - "@algolia/requester-common": "4.11.0" - } - }, - "@babel/parser": { - "version": "7.16.3" - }, - "@docsearch/css": { - "version": "1.0.0-alpha.28" - }, - "@docsearch/js": { - "version": "1.0.0-alpha.28", - "requires": { - "@docsearch/react": "^1.0.0-alpha.28", - "preact": "^10.0.0" - } - }, - "@docsearch/react": { - "version": "1.0.0-alpha.28", - "requires": { - "@docsearch/css": "^1.0.0-alpha.28", - "@francoischalifour/autocomplete-core": "^1.0.0-alpha.28", - "@francoischalifour/autocomplete-preset-algolia": "^1.0.0-alpha.28", - "algoliasearch": "^4.0.0" - } - }, - "@francoischalifour/autocomplete-core": { - "version": "1.0.0-alpha.28" - }, - "@francoischalifour/autocomplete-preset-algolia": { - "version": "1.0.0-alpha.28" - }, - "@vitejs/plugin-vue": { - "version": "1.9.4", - "requires": {} - }, - "@vue/compiler-core": { - "version": "3.2.21", - "requires": { - "@babel/parser": "^7.15.0", - "@vue/shared": "3.2.21", - "estree-walker": "^2.0.2", - "source-map": "^0.6.1" - } - }, - "@vue/compiler-dom": { - "version": "3.2.21", - "requires": { - "@vue/compiler-core": "3.2.21", - "@vue/shared": "3.2.21" - } - }, - "@vue/compiler-sfc": { - "version": "3.2.21", - "requires": { - "@babel/parser": "^7.15.0", - "@vue/compiler-core": "3.2.21", - "@vue/compiler-dom": "3.2.21", - "@vue/compiler-ssr": "3.2.21", - "@vue/ref-transform": "3.2.21", - "@vue/shared": "3.2.21", - "estree-walker": "^2.0.2", - "magic-string": "^0.25.7", - "postcss": "^8.1.10", - "source-map": "^0.6.1" - } - }, - "@vue/compiler-ssr": { - "version": "3.2.21", - "requires": { - "@vue/compiler-dom": "3.2.21", - "@vue/shared": "3.2.21" - } - }, - "@vue/reactivity": { - "version": "3.2.21", - "requires": { - "@vue/shared": "3.2.21" - } - }, - "@vue/ref-transform": { - "version": "3.2.21", - "requires": { - "@babel/parser": "^7.15.0", - "@vue/compiler-core": "3.2.21", - "@vue/shared": "3.2.21", - "estree-walker": "^2.0.2", - "magic-string": "^0.25.7" - } - }, - "@vue/runtime-core": { - "version": "3.2.21", - "requires": { - "@vue/reactivity": "3.2.21", - "@vue/shared": "3.2.21" - } - }, - "@vue/runtime-dom": { - "version": "3.2.21", - "requires": { - "@vue/runtime-core": "3.2.21", - "@vue/shared": "3.2.21", - "csstype": "^2.6.8" - } - }, - "@vue/server-renderer": { - "version": "3.2.21", - "requires": { - "@vue/compiler-ssr": "3.2.21", - "@vue/shared": "3.2.21" - } - }, - "@vue/shared": { - "version": "3.2.21" - }, - "algoliasearch": { - "version": "4.11.0", - "requires": { - "@algolia/cache-browser-local-storage": "4.11.0", - "@algolia/cache-common": "4.11.0", - "@algolia/cache-in-memory": "4.11.0", - "@algolia/client-account": "4.11.0", - "@algolia/client-analytics": "4.11.0", - "@algolia/client-common": "4.11.0", - "@algolia/client-personalization": "4.11.0", - "@algolia/client-search": "4.11.0", - "@algolia/logger-common": "4.11.0", - "@algolia/logger-console": "4.11.0", - "@algolia/requester-browser-xhr": "4.11.0", - "@algolia/requester-common": "4.11.0", - "@algolia/requester-node-http": "4.11.0", - "@algolia/transporter": "4.11.0" - } - }, - "csstype": { - "version": "2.6.18" - }, - "esbuild": { - "version": "0.13.13", - "requires": { - "esbuild-android-arm64": "0.13.13", - "esbuild-darwin-64": "0.13.13", - "esbuild-darwin-arm64": "0.13.13", - "esbuild-freebsd-64": "0.13.13", - "esbuild-freebsd-arm64": "0.13.13", - "esbuild-linux-32": "0.13.13", - "esbuild-linux-64": "0.13.13", - "esbuild-linux-arm": "0.13.13", - "esbuild-linux-arm64": "0.13.13", - "esbuild-linux-mips64le": "0.13.13", - "esbuild-linux-ppc64le": "0.13.13", - "esbuild-netbsd-64": "0.13.13", - "esbuild-openbsd-64": "0.13.13", - "esbuild-sunos-64": "0.13.13", - "esbuild-windows-32": "0.13.13", - "esbuild-windows-64": "0.13.13", - "esbuild-windows-arm64": "0.13.13" - } - }, - "esbuild-darwin-64": { - "version": "0.13.13", - "optional": true - }, - "estree-walker": { - "version": "2.0.2" - }, - "fsevents": { - "version": "2.3.2", - "optional": true - }, - "function-bind": { - "version": "1.1.1" - }, - "has": { - "version": "1.0.3", - "requires": { - "function-bind": "^1.1.1" - } - }, - "is-core-module": { - "version": "2.8.0", - "requires": { - "has": "^1.0.3" - } - }, - "magic-string": { - "version": "0.25.7", - "requires": { - "sourcemap-codec": "^1.4.4" - } - }, - "nanoid": { - "version": "3.1.30" - }, - "path-parse": { - "version": "1.0.7" - }, - "picocolors": { - "version": "1.0.0" - }, - "postcss": { - "version": "8.3.11", - "requires": { - "nanoid": "^3.1.30", - "picocolors": "^1.0.0", - "source-map-js": "^0.6.2" - } - }, - "preact": { - "version": "10.5.15" - }, - "prismjs": { - "version": "1.25.0" - }, - "resolve": { - "version": "1.20.0", - "requires": { - "is-core-module": "^2.2.0", - "path-parse": "^1.0.6" - } - }, - "rollup": { - "version": "2.59.0", - "requires": { - "fsevents": "~2.3.2" - } - }, - "source-map": { - "version": "0.6.1" - }, - "source-map-js": { - "version": "0.6.2" - }, - "sourcemap-codec": { - "version": "1.4.8" - }, - "vite": { - "version": "2.6.14", - "requires": { - "esbuild": "^0.13.2", - "fsevents": "~2.3.2", - "postcss": "^8.3.8", - "resolve": "^1.20.0", - "rollup": "^2.57.0" - } - }, - "vitepress": { - "version": "0.20.1", - "requires": { - "@docsearch/css": "^1.0.0-alpha.28", - "@docsearch/js": "^1.0.0-alpha.28", - "@vitejs/plugin-vue": "^1.9.0", - "prismjs": "^1.25.0", - "vite": "^2.6.5", - "vue": "^3.2.19" - } - }, - "vue": { - "version": "3.2.21", - "requires": { - "@vue/compiler-dom": "3.2.21", - "@vue/compiler-sfc": "3.2.21", - "@vue/runtime-dom": "3.2.21", - "@vue/server-renderer": "3.2.21", - "@vue/shared": "3.2.21" - } - } - } -} diff --git a/package.json b/package.json index 13c17c1..5fce091 100644 --- a/package.json +++ b/package.json @@ -1,17 +1,57 @@ { - "name": "docs", - "version": "1.0.0", - "description": "", - "main": "index.js", + "name": "nomad-learn", + "version": "0.1.0", + "private": true, + "author": "Odysseas.eth", "scripts": { - "docs:dev": "vitepress dev docs", - "docs:build": "vitepress build docs", - "docs:serve": "vitepress serve --port 8000 docs" + "docusaurus": "docusaurus", + "start": "docusaurus start", + "docs:build": "docusaurus build --out-dir ./docs/.vitepress/dist", + "build": "docusaurus build ", + "swizzle": "docusaurus swizzle", + "deploy": "docusaurus deploy", + "clear": "docusaurus clear", + "serve": "docusaurus serve", + "write-translations": "docusaurus write-translations", + "write-heading-ids": "docusaurus write-heading-ids" }, - "author": "Erin Hales", - "license": "Apache 2.0", - "homepage": "https://github.com/nomad-xyz/nomad-monorepo", "dependencies": { - "vitepress": "^0.20.1" + "@docusaurus/core": "v2.0.0-beta.21", + "@docusaurus/preset-classic": "v2.0.0-beta.21", + "@mdx-js/react": "^1.6.21", + "@tailwindcss/typography": "0.4.0", + "clsx": "^1.1.1", + "docusaurus-tailwindcss-loader": "file:plugins/docusaurus-tailwindcss-loader", + "dotenv": "^8.2.0", + "postcss": "^8.4.14", + "postcss-import": "^12.0.0", + "postcss-nesting": "^8.0.1", + "react": "^17.0.2", + "react-dom": "^17.0.2", + "react-icons": "^4.2.0", + "react-inlinesvg": "^2.2.2", + "react-player": "^2.10.0" + }, + "devDependencies": { + "autoprefixer": "^10.4.7", + "mdx-loader": "^3.0.2", + "postcss-loader": "^5.2.0", + "postcss-preset-env": "^6.7.0", + "tailwindcss": "^2.2.2" + }, + "resolutions": { + "trim": "^0.0.3" + }, + "browserslist": { + "production": [ + ">0.5%", + "not dead", + "not op_mini all" + ], + "development": [ + "last 1 chrome version", + "last 1 firefox version", + "last 1 safari version" + ] } } diff --git a/plugins/docusaurus-tailwindcss-loader/index.js b/plugins/docusaurus-tailwindcss-loader/index.js new file mode 100644 index 0000000..ff247bf --- /dev/null +++ b/plugins/docusaurus-tailwindcss-loader/index.js @@ -0,0 +1,20 @@ +module.exports = function (context, options) { + return { + name: 'postcss-tailwindcss-loader', + configurePostCss(postcssOptions) { + // Appends new PostCSS plugin. + postcssOptions.plugins.push( + require('postcss-import'), + require('tailwindcss'), + require('postcss-nesting'), + require('postcss-preset-env')({ + autoprefixer: { + flexbox: 'no-2009', + }, + stage: 4, + }), + ) + return postcssOptions + }, + } +} diff --git a/sidebars.js b/sidebars.js new file mode 100644 index 0000000..784afc0 --- /dev/null +++ b/sidebars.js @@ -0,0 +1,176 @@ +module.exports = { + sidebar: [ + { + type: 'category', + label: 'Nomad', + collapsed: false, + items: [ + 'docs', + { + type: 'category', + label: 'Overview', + items: [ + { + type: 'doc', + id: 'overview/what-is-nomad', + label: 'What is Nomad', + }, + { + type: 'doc', + label: 'Why Nomad', + id: 'overview/why-nomad', + }, + { + type: 'doc', + id: 'overview/nomad-vs-the-world', + label: 'Nomad\'s design vs others' + }], + }, + { + type: 'category', + label: 'Nomad Protocol', + items: [ + { + type: 'doc', + id: 'protocol/overview', + label: 'Overview of the Protocol', + }, + { + type: 'doc', + id: 'protocol/messaging', + label: 'Messaging', + }, + { + type: 'doc', + id: 'protocol/security', + label: 'Nomad\'s Security', + }, + { + type: 'doc', + id: 'protocol/governance', + label: 'Nomad\'s protocol governance', + }, + { + type: 'doc', + id: 'protocol/agents', + label: 'Offline Agents', + } + ], + }, + { + type: 'category', + label: 'Token Bridge', + items: [ + { + type: 'doc', + id: 'token-bridge/overview', + label: 'What is the token bridge', + }, + { + type: 'doc', + id: 'token-bridge/nomad-connext', + label: 'Nomad + Connext', + }, + ], + }, + { + type: 'category', + label: 'Build on Nomad', + items: [ + { + type: 'doc', + id: 'build/overview', + label: 'What is the token bridge', + }, + { + type: 'doc', + id: 'build/checklist', + label: 'Everything you need to do', + }, + { + type: 'doc', + id: 'build/invariants', + label: 'Nomad Invariants', + }, + { + type: 'doc', + id: 'build/smart-contracts', + label: 'Interact with the Smart Contracts', + }, + { + type: 'doc', + id: 'build/agents', + label: 'Interact with the Nomad Agents', + }, + { + type: 'doc', + id: 'build/sdk', + label: 'Nomad SDK', + }, + ], + }, + { + type: 'category', + label: 'Operate Nomad Agents', + items: [ + { + type: 'doc', + id: 'agents/overview', + label: 'Running Agents overview', + }, + { + type: 'doc', + id: 'agents/watcher', + label: 'Run a Watcher', + }, + { + type: 'doc', + id: 'agents/processor', + label: 'Run a Processor', + }, + { + type: 'doc', + id: 'agents/relayer', + label: 'Run a Relayer', + }, + { + type: 'doc', + id: 'agents/updater', + label: 'Run a Relayer', + }, + ], + },{ + type: 'category', + label: 'Resources', + items: [ + { + type: 'doc', + id: 'resources/faq', + label: 'Nomad FAQ', + }, + { + type: 'doc', + id: 'resources/audits', + label: 'Nomad Protocol Audit Reports', + }, + { + type: 'doc', + id: 'resources/deployed-contracts', + label: 'Deployed Smart Contracts', + }]} + + + ] + },{ + type: 'category', + label: 'Reference', + collapsed: false, + items: [ + { + type: 'autogenerated', + dirName: 'reference', // generate sidebar from the docs folder (or versioned_docs/) + }, + ] + } +] +}; diff --git a/src/components/Callout.js b/src/components/Callout.js new file mode 100644 index 0000000..285cb17 --- /dev/null +++ b/src/components/Callout.js @@ -0,0 +1,45 @@ +import React from 'react' +import { RiLightbulbFlashLine, RiAlarmWarningLine } from 'react-icons/ri'; + +// Basic usage: +// +// +// text goes here +// +// + +// This component offers a few options for `type`, which changes on the color +// and emoji/symbol used. +// +// `notice`: Light green color, lightbulb symbol. Should be used when calling +// attention to an important piece of information. +// +// `warning`: Light red color, warning symbol. Should be used to caution users +// about a certain task. + +const Callout = ({ type, children }) => { + const types = { + notice: { + icon: RiLightbulbFlashLine, + color: 'white' + }, + warning: { + icon: RiAlarmWarningLine, + color: 'red' + } + } + + const TypeIcon = types[type][`icon`] + const TypeColor = types[type][`color`] + + return ( +
+ +
+ {children} +
+
+ ) +} + +export default Callout diff --git a/src/components/Grid.js b/src/components/Grid.js new file mode 100644 index 0000000..7c7c875 --- /dev/null +++ b/src/components/Grid.js @@ -0,0 +1,81 @@ +import React from 'react'; +import Link from '@docusaurus/Link'; + +import { RiExternalLinkLine } from 'react-icons/ri'; + +export const Grid = ({ className, columns, children }) => { + return ( + // I really don't like hardcoding the `columns`, but I can't figure out how + // to have PurgeCSS not purse the classes because they're created with + // string concatenation. + // https://tailwindcss.com/docs/optimizing-for-production#writing-purgeable-html +
+ {children} +
+ ); +}; + +export const Box = ({ className, to, title, cta, image, children }) => { + // If there's a `to` prop, then we make this Box into a `Link`. Otherwise, + // it's a `div` to avoid nested `a` elements. + const Element = to ? Link : `div`; + + return ( + +

+ {title} +

+
+ {children} +
+ {cta && ( + + )} + +
+ ); +}; + +export const BoxList = ({ children }) => ( +
{children}
+); + +export const BoxListItem = ({ to, title, separator }) => ( +
+ {!separator ? ( + + {title} + {to.startsWith('http') && ( + + )} + + ) : ( + + )} +
+); diff --git a/src/css/custom.css b/src/css/custom.css new file mode 100644 index 0000000..76a089b --- /dev/null +++ b/src/css/custom.css @@ -0,0 +1,268 @@ +/* stylelint-disable docusaurus/copyright-header */ +/** + * Any CSS included here will be global. The classic template + * bundles Infima by default. Infima is a CSS framework designed to + * work well for content-centric websites. + */ + +/* + * Tailwind +*/ + +@tailwind base; +@tailwind components; +@tailwind utilities; + +@responsive { + .text-shadow { + text-shadow: 0 2px 4px rgba(0, 0, 0, 0.1); + } + + .text-shadow-md { + text-shadow: 0 4px 8px rgba(0, 0, 0, 0.12), 0 2px 4px rgba(0, 0, 0, 0.08); + } + + .text-shadow-lg { + text-shadow: 0 15px 30px rgba(0, 0, 0, 0.11), 0 5px 15px rgba(0, 0, 0, 0.08); + } + + .text-shadow-none { + text-shadow: none; + } +} + +/* + * Fonts +*/ + +@import url('https://fonts.googleapis.com/css2?family=Inter:wght@200;400&display=swap'); +/* + * Structure +*/ + +.body { + @apply font-sans text-text bg-white; +} + +.container { + @apply max-w-screen-lg lg:max-w-screen-xl px-6; + max-width: 1280px !important; +} + +a:hover { + text-decoration: none; +} + +/* + * Navbar +*/ + +.navbar__brand { + @apply pr-4; +} + +.navbar__brand strong { + @apply font-medium; +} + +.navbar__brand:hover { + @apply text-blue-light; +} + +.navbar__logo { + @apply h-6 mr-2; +} + +.navbar__link { + @apply font-normal; +} + +.header-github-link::before { + background: url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='%23fff' d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") + no-repeat; + content: ''; + display: flex; + height: 24px; + width: 24px; +} + +.react-toggle .react-toggle-track { + @apply bg-gray; +} + +/* + * Navbar / mobile +*/ + +.navbar__toggle { + @apply text-white; +} + +.navbar-sidebar .menu .menu__link { + @apply text-xl text-white py-2; +} + +/* + * Search +*/ + +.SearchModal { + max-height: calc(100vh - 12rem); +} + +.sui-layout .sui-sorting, +.sui-layout .sui-result, +.sui-layout .sui-paging-info, +.sui-layout .sui-results-per-page { + @apply font-sans; +} + +.sui-layout .sui-layout-body { + @apply bg-gray-200 dark:bg-gray-800; +} + +.sui-layout .sui-layout-body::after { + background: none; + @apply dark:bg-gray-800; +} + +.sui-layout .sui-search-box__text-input { + @apply text-lg text-text dark:text-gray-100 border-gray-200 bg-white dark:bg-gray-900 rounded focus:border-white; +} + +.sui-layout .sui-search-box__submit { + @apply relative text-base text-text dark:text-gray-100 border-gray-200 rounded; + background: none; +} + +.sui-layout .sui-search-box__submit:hover { + background: none; +} + +.sui-layout .sui-layout-main-header { + @apply mb-6; +} + +.sui-layout .sui-paging-info, +.sui-layout .sui-results-per-page__label { + @apply dark:text-gray-100; +} + +.sui-layout .sui-result { + @apply dark:bg-gray-800; +} + +.sui-layout .sui-result__header { + @apply px-6 mb-4; +} + +.sui-layout .sui-result__title { + @apply text-xl text-white hover:text-blue; +} + +.sui-layout .sui-result__body { + @apply text-sm px-6 dark:text-gray-100; +} + +.sui-layout .sui-result em { + @apply dark:text-blue-lighter; +} + +/* + * Markdown/prose +*/ + +/*Tailwind prose styles the text; dark:prose-dark is needed to correctly render dark mode. */ +.markdown { + @apply prose max-w-none; +} + +h1 { + @apply font-bold; +} + +.markdown a { + @apply hover:text-gray; +} + +.dark .markdown a { + @apply hover:text-blue; +} + +.markdown a code { + @apply transition text-gray hover:text-blue; +} + +.markdown p > img { + @apply block mx-auto rounded shadow-lg; +} + +.markdown p > img[src*='icon/assets/'], +.markdown p > img.img__inline { + @apply inline-block m-0 rounded dark:bg-black; +} + +.markdown blockquote p:before, +.markdown blockquote p:after { + content: none !important; +} + +/* + * Sidebar +*/ + +.menu .menu__link { + @apply text-sm font-normal; +} + +.menu .menu__link.active { + @apply bg-gray-100 text-gray-600 dark:bg-gray-500 dark:text-gray-200; +} + +/* + * Infima +*/ + +:root { + --ifm-color-primary: #1a1b1c; + --ifm-color-primary-dark: #171819; + --ifm-color-primary-darker: #161718; + --ifm-color-primary-darkest: #121314; + --ifm-color-primary-light: #1d1e1f; + --ifm-color-primary-lighter: #1e1f20; + --ifm-color-primary-lightest: #222324; +} + +/* For readability concerns, you should choose a lighter palette in dark mode. */ +html[data-theme='dark']:root { + --ifm-color-primary: #ffffff; + --ifm-color-primary-dark: #e6e6e6; + --ifm-color-primary-darker: #d9d9d9; + --ifm-color-primary-darkest: #b3b3b3; + --ifm-color-primary-light: #ffffff; + --ifm-color-primary-lighter: #ffffff; + --ifm-color-primary-lightest: #ffffff; +} + + +/* + * Etc +*/ + +.docusaurus-highlight-code-line { + background-color: rgb(72, 77, 91); + display: block; + margin: 0 calc(-1 * var(--ifm-pre-padding)); + padding: 0 var(--ifm-pre-padding); +} + +#timeline { + background: #1A1B1C; + background: linear-gradient( + 180deg, + rgba(217, 217, 217, 0) 0%, + rgba(217, 217, 217, 0.65) 10%, + rgba(217, 217, 217, 0.65) 90%, + rgba(217, 217, 217, 0.65) 100% + ); +} diff --git a/src/data/News.js b/src/data/News.js new file mode 100644 index 0000000..12dfc6d --- /dev/null +++ b/src/data/News.js @@ -0,0 +1,43 @@ +import React from 'react'; + +export const MonorepoReleaseVersion = '1.0.0-rc.2'; +export const MonorepoReleaseDate = 'March 01, 2022'; +export const MonorepoReleaseNotes = [ + 'Removed root ordering from the protocol', + 'Introduced Foundry solidity-based testing for the smart contracts', +]; + +export const AgentsReleaseVersion = '1.0.0-rc.2'; +export const AgentsReleaseDate= 'March 01, 2022'; +export const AgentsReleaseNotes = [ + 'Removed root ordering from the protocol', + 'Introduced Foundry solidity-based testing for the smart contracts', +]; + + + +export const News = [ + { + title: <>Nomad's first Audit is OUT!, + href: '/docs/resources/audits', + date: 'May 31, 2022', + type: 'Doc', + description: ( + <> + We are excited to share with you the first official Audit of the Nomad Protocol, by Quantstamp. We are super excited to have worked with them on the audit, imporving the protocol and documentation along the way. + + ), + }, + { + title: <>Nomad's new Education Portal, + href: '/', + date: 'May 31, 2022', + type: 'Doc', + description: ( + <> + We just launched our new learning portal. You can find here all the information you need to use, build and operate the Nomad Protocol. The future of cross-chain communication is optimistic + and we want you to be part of it. + + ), + } +]; diff --git a/src/data/sidebar-guides.js b/src/data/sidebar-guides.js new file mode 100644 index 0000000..8acb221 --- /dev/null +++ b/src/data/sidebar-guides.js @@ -0,0 +1,18 @@ +module.exports = { + learn: [ + { + type: 'category', + label: 'Guides', + collapsed: true, + items: [ + { + type: 'category', + label: 'Getting started with Nomad', + items: [ + 'develop/how-to-build-simple-xapp', + ], + }, + ], + }, + ], +}; diff --git a/src/pages/guides.js b/src/pages/guides.js new file mode 100644 index 0000000..605cb97 --- /dev/null +++ b/src/pages/guides.js @@ -0,0 +1,175 @@ +import React, {useState} from 'react' +import Layout from '@theme/Layout' +import Head from '@docusaurus/Head' +import Link from '@docusaurus/Link' +import {Grid, Box} from '@site/src/components/Grid' + +const GuideItems = [ + { + title: <>Nomad 101: How to build a cross-chain app, + href: '/guides/develop/how-to-build-simple-xapp', + category: 'develop', + description: ( + <> + How to build a simple cross-chain application on top of the Nomad Protocol + + ) + }, +] + +const GuideCategories = [ + { + label: 'develop', + title: 'Develop on Nomad', + description: <>Learn about building cross-chain applications using the Nomad Protocol, + }, +] + +export default function Guides() { + let itemsFiltered = GuideItems; + let categoriesFiltered = GuideCategories; + + const [searchTerm, setSearchTerm] = useState(null); + + if (searchTerm) { + let searchTerms = searchTerm.split(" "); + itemsFiltered = itemsFiltered.filter(item => { + let content = `${item.title.props.children.toLowerCase()} ${item.category.toLowerCase()}`; + return searchTerms.every(term => { + return content.includes(term.toLowerCase()) + }) + }) + + if (itemsFiltered.length) { + categoriesFiltered = GuideCategories.filter(category => { + let match = itemsFiltered.filter(item => { + return category.label.includes(item.category) + }) + + if (match.length) { + return true + } + }) + } else { + categoriesFiltered = [] + } + } + + return ( + <> + + + + +
+
+
+

Guides

+

Thoughtful guides to help you learn more about building cross-chain applications with Nomad.

+ setSearchTerm(event.currentTarget.value)} + placeholder="🔍 Search Nomad's guides..." /> +
+
+
+
+ {categoriesFiltered.map((props, idx) => ( + <> +
+
+

{props.title}

+

{props.description}

+
+
+ + {itemsFiltered.filter(item => item.category.includes(props.label)).map((props, idx) => ( + +

{props.description}

+
+ ))} +
+ + ))} + + {itemsFiltered.length == 0 && +
+
+

¯\_(ツ)_/¯ There is no guide matching matching your search.

+
+
+ } +
+
+ + ); +} + + +function Home() { + const {siteConfig} = useDocusaurusContext(); + + return ( + + +
+ + + Install the open-source monitoring agent on physical/virtual systems running most Linux distributions (Ubuntu, Debian, CentOS, and more), container platforms (Kubernetes clusters, Docker), and many other operating systems, with no sudo required. + + + Solution- and action-based docs for Nomad's many features and capabilities. Your table of contents to becoming an expert in using and building on Nomad. + + + Thoughtful guides to walk you through using the Nomad apps, building on the Nomad protocol and operating Nomad's Agents + + +
+

What's new at Nomad?

+
+
+
+
+
+
+
    + {News.map((props, idx) => ( +
  • + +
    +

    {props.title}

    +

    {props.description}

    +
    +
    +
    + +
    + +
  • + ))} +
+
+
+
+
+ ); +} diff --git a/src/pages/index.js b/src/pages/index.js new file mode 100644 index 0000000..b4d74a5 --- /dev/null +++ b/src/pages/index.js @@ -0,0 +1,170 @@ +import React from 'react'; +import Layout from '@theme/Layout'; +import Link from '@docusaurus/Link'; +import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; +import { Grid, Box } from '@site/src/components/Grid'; +import { + News, + MonorepoReleaseVersion, + MonorepoReleaseDate, + MonorepoReleaseNotes, + AgentsReleaseVersion, + AgentsReleaseDate, + AgentsReleaseNotes, +} from '@site/src/data/News'; + +function HomepageHeader() { + const { siteConfig } = useDocusaurusContext(); + return ( +
+
+
+

+ {siteConfig.title} +

+

+ {siteConfig.tagline} +

+
+
+
+ ); +} +export default function Home() { + const { siteConfig } = useDocusaurusContext(); + + return ( + + +
+ + + The premier optimistic bridging solution + + + High security cross-chain governance made simple + + + + Learn all about developing cross-chain applications with Nomad + + + A tour inside the protocol, it's security assumptions and the system components + + +
+
+

+ What's new at Nomad? +

+
+
+
+
+
    + {News.map((props, idx) => ( +
  • + +
    +

    + {props.title} +

    +

    {props.description}

    +
    +
    +
    + +
    + +
  • + ))} +
+
+
+

+ Latest major release +

+

+ Monorepo + + {MonorepoReleaseVersion} + + + +

    + {MonorepoReleaseNotes.map((props, idx) => ( +
  • + ))} +
+

+ Read the{' '} + + release notes + {' '} + . +

+

+ Rust Agents + + {AgentsReleaseVersion} + + + +

+
    + {AgentsReleaseNotes.map((props, idx) => ( +
  • + ))} +
+

+ Read the{' '} + + release notes + {' '} + . +

+
+
+
+
+ ); +} diff --git a/src/theme/DocItem/index.js b/src/theme/DocItem/index.js new file mode 100644 index 0000000..c2ee0a6 --- /dev/null +++ b/src/theme/DocItem/index.js @@ -0,0 +1,371 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ +import React, { useState, useEffect } from 'react'; +import clsx from 'clsx'; +import DocPaginator from '@theme/DocPaginator'; +import DocVersionBanner from '@theme/DocVersionBanner'; +import DocVersionBadge from '@theme/DocVersionBadge'; +import DocItemFooter from '@theme/DocItemFooter'; +import TOC from '@theme/TOC'; +import TOCCollapsible from '@theme/TOCCollapsible'; +import Heading from '@theme/Heading'; +import styles from './styles.module.css'; +import { + PageMetadata, + HtmlClassNameProvider, + ThemeClassNames, + useWindowSize, +} from '@docusaurus/theme-common'; +import DocBreadcrumbs from '@theme/DocBreadcrumbs'; +import MDXContent from '@theme/MDXContent'; + +// Imports that we need for custom code: +import Seo from '@theme/Seo'; +import Link from '@docusaurus/Link'; +import { GoThumbsup, GoThumbsdown } from 'react-icons/go'; + +// This function is the source code that renders the metadata for each documentation page +function DocItemMetadata(props) { + const { content: DocContent } = props; + const { metadata, frontMatter, assets } = DocContent; + const { keywords } = frontMatter; + const { description, title } = metadata; + const image = assets.image ?? frontMatter.image; + return ( + + ); +} + +// This function is the source code that renders each documentation page +function DocItemContent(props) { + const { content: DocContent } = props; + const { metadata, frontMatter } = DocContent; + const { + image, + keywords, + hide_title: hideTitle, + hide_table_of_contents: hideTableOfContents, + toc_min_heading_level: tocMinHeadingLevel, + toc_max_heading_level: tocMaxHeadingLevel, + } = frontMatter; + const { description, title } = metadata; // We only add a title if: + // - user asks to hide it with front matter + // - the markdown content does not already contain a top-level h1 heading + + const shouldAddTitle = + !hideTitle && typeof DocContent.contentTitle === 'undefined'; + const windowSize = useWindowSize(); + const canRenderTOC = + !hideTableOfContents && DocContent.toc && DocContent.toc.length > 0; + const renderTocDesktop = + canRenderTOC && (windowSize === 'desktop' || windowSize === 'ssr'); + // Variables for the Netlify Feedback forms + + const [feedback, setFeedback] = useState(false); + useEffect(() => { + if (window.location.search.includes('feedback=true')) { + setFeedback(true); + } + }, []); + + const encode = (data) => { + return Object.keys(data) + .map( + (key) => encodeURIComponent(key) + '=' + encodeURIComponent(data[key]) + ) + .join('&'); + }; + const [formData, setFormData] = useState({ + thumb: null, + feedback: '', + url: metadata.permalink, + }); + + const handleSubmit = (e) => { + e.preventDefault(); + const { botfield, ...rest } = formData; + + if (botfield) { + setFeedback(true); + return; + } + + fetch('/', { + method: 'POST', + headers: { 'Content-Type': 'application/x-www-form-urlencoded' }, + body: encode({ 'form-name': 'docs-feedback', ...rest }), + }) + .then(() => setFeedback(true)) + .catch(() => setFeedback(true)); + }; + //Checks if feedback has been submitted. If not, the form will be rendered: + const feedbackForm = (feedback) => { + return feedback ? ( +

+ Thanks for contributing feedback about our docs! +

+ ) : ( +
+ + + + +
+ + +
+ +
+ +