From 53936421752952b1e64d3b7625993bc4de8162bb Mon Sep 17 00:00:00 2001 From: agoralabs-bot Date: Wed, 11 Sep 2024 09:15:57 +0000 Subject: [PATCH] deploy: 0ad2131dc74719f6d04dc8fd4e16ccba46a07396 --- 404.html | 12 ++--- api-reference.html | 14 +++--- api-reference/avm-web-client.html | 14 +++--- api-reference/avm-web-provider.html | 14 +++--- api-reference/errors.html | 14 +++--- api-reference/types.html | 14 +++--- ...tyles.28514799.css => styles.79972309.css} | 2 +- assets/js/05942345.ca688560.js | 1 + assets/js/078f4f1e.ac253693.js | 1 + assets/js/0e7a43e4.10b7a6db.js | 1 + assets/js/0e7a43e4.acd7a0df.js | 1 - assets/js/12607efb.6f9fdd0d.js | 1 + assets/js/12607efb.81e2cb7b.js | 1 - assets/js/17896441.6972c889.js | 1 + assets/js/17896441.f69b5bba.js | 1 - assets/js/18891827.985a9374.js | 1 - assets/js/18891827.cf368c64.js | 1 + assets/js/2237.9db9b32d.js | 1 + assets/js/22dd74f7.0257e7cd.js | 1 + assets/js/23353e13.0a783292.js | 1 + assets/js/27d136a3.f4b1ae3d.js | 1 + assets/js/27d136a3.ff91a66c.js | 1 - assets/js/29d4e771.586f8e44.js | 1 + assets/js/2c8567d4.b56cad1a.js | 1 + assets/js/2f03465d.063e0da1.js | 1 - assets/js/2f03465d.36e85508.js | 1 + assets/js/2f412085.4256d459.js | 1 - assets/js/2f412085.d100aad1.js | 1 + assets/js/32595feb.9df10cb7.js | 1 + assets/js/3833126f.0eba1aeb.js | 1 + assets/js/3833126f.6e894d8b.js | 1 - assets/js/38e469bb.67c6d5ae.js | 1 + assets/js/3cb43a65.c6a3d251.js | 1 + assets/js/424.31d24e27.js | 1 - assets/js/473ff9eb.8634bca6.js | 1 + assets/js/5e5255c2.eaab8306.js | 1 + assets/js/5e5255c2.eb6ba710.js | 1 - assets/js/5e95c892.4e75dd8e.js | 1 + assets/js/5e95c892.ea587653.js | 1 - assets/js/5eb8ced3.3d2bd6cc.js | 1 + assets/js/5eb8ced3.4516c77b.js | 1 - assets/js/61bb475c.31f3d3af.js | 1 + assets/js/61bb475c.e7bda565.js | 1 - assets/js/68adac10.ae927104.js | 1 + assets/js/6b50e60a.18354e6a.js | 1 + assets/js/6b50e60a.b0f76db3.js | 1 - assets/js/7c31b11d.4e2e1af3.js | 1 + assets/js/7c31b11d.d6cd7baf.js | 1 - assets/js/872f12d1.b618229c.js | 1 - assets/js/892d9cd8.00c67ecd.js | 1 + assets/js/892d9cd8.a2b3a932.js | 1 - assets/js/8d3cc82e.0c1766aa.js | 1 - assets/js/8d3cc82e.cf470963.js | 1 + assets/js/8e32cf85.3fd43ea6.js | 1 + assets/js/8e32cf85.b68b6e34.js | 1 - assets/js/935f2afb.baa4da37.js | 1 - assets/js/9d373472.530e9f8c.js | 1 + assets/js/a78de39e.0cf3d8aa.js | 1 + assets/js/a7bd4aaa.00577d43.js | 1 + assets/js/a7bd4aaa.e11f91fb.js | 1 - assets/js/a94703ab.09c8a325.js | 1 + assets/js/a94703ab.fb0cf4b4.js | 1 - assets/js/aba21aa0.d16e9080.js | 1 + assets/js/acfcbc0b.c1d8cadb.js | 1 + assets/js/acfcbc0b.ce4c60ca.js | 1 - assets/js/b3622e55.0dcaf325.js | 1 + assets/js/b3622e55.c91436f2.js | 1 - assets/js/bfff9bcb.52e40d5a.js | 1 + assets/js/c69dfc92.7ee51c5c.js | 1 + assets/js/c69dfc92.f4bb5f7d.js | 1 - assets/js/c7a7be94.a54b0005.js | 1 - assets/js/c7a7be94.cbd8770f.js | 1 + assets/js/cf854aeb.079ca638.js | 1 + assets/js/common.22832a68.js | 1 - assets/js/common.89d696fc.js | 1 + assets/js/d109ed11.45c27a47.js | 1 + assets/js/d109ed11.821d9578.js | 1 - assets/js/d1e6c657.8467ce0b.js | 1 + assets/js/d947b455.1d12cc91.js | 1 + assets/js/d947b455.74ba6a9a.js | 1 - assets/js/da384a5e.9dc7054b.js | 1 + assets/js/dbeba81a.18746d29.js | 1 + assets/js/dbeba81a.a5a19fec.js | 1 - assets/js/e703b53e.07bc2d1f.js | 1 + assets/js/f1f3f6b8.c0c8bb89.js | 1 + assets/js/f1f3f6b8.c1cad1ff.js | 1 - assets/js/f2da1fd8.0e7667cd.js | 1 + assets/js/f2da1fd8.b0566923.js | 1 - assets/js/f3d834a5.ee178eb5.js | 1 + assets/js/f40f6140.e9fd29f4.js | 1 + assets/js/f7793a5d.dad87a10.js | 1 - assets/js/f7793a5d.e83144c3.js | 1 + assets/js/fc225bb3.323c1754.js | 1 + assets/js/fc225bb3.58e6b682.js | 1 - assets/js/fe3501f1.9b64b777.js | 1 + assets/js/fe6aabe8.1ed8a01a.js | 1 - assets/js/fe6aabe8.d1300160.js | 1 + assets/js/main.075ca466.js | 2 + ...CENSE.txt => main.075ca466.js.LICENSE.txt} | 0 assets/js/main.f88ee4c6.js | 2 - assets/js/runtime~main.8cf69c52.js | 1 - assets/js/runtime~main.afd49300.js | 1 + clients.html | 14 +++--- clients/disabling-a-client.html | 14 +++--- clients/discover-providers.html | 14 +++--- clients/enabling-a-client.html | 14 +++--- clients/getting-started.html | 14 +++--- clients/posting-transactions.html | 14 +++--- clients/signing-a-message.html | 14 +++--- clients/signing-and-posting-transactions.html | 14 +++--- clients/signing-transactions.html | 14 +++--- index.html | 15 +++--- providers.html | 14 +++--- providers/getting-started.html | 14 +++--- providers/responding-to-disable-requests.html | 32 ++++++------ .../responding-to-discover-requests.html | 23 ++++----- providers/responding-to-enable-requests.html | 27 +++++----- ...ponding-to-post-transactions-requests.html | 16 +++--- ...o-sign-and-post-transactions-requests.html | 16 +++--- .../responding-to-sign-message-requests.html | 16 +++--- ...ponding-to-sign-transactions-requests.html | 16 +++--- providers/throwing-an-error.html | 14 +++--- sitemap.xml | 2 +- supported-wallets.html | 14 +++--- terminology.html | 14 +++--- usage.html | 21 ++++++++ usage/clients.html | 27 ++++++++++ usage/clients/disabling-a-client.html | 32 ++++++++++++ usage/clients/discover-providers.html | 27 ++++++++++ usage/clients/enabling-a-client.html | 37 ++++++++++++++ usage/clients/getting-started.html | 29 +++++++++++ usage/clients/posting-transactions.html | 25 ++++++++++ usage/clients/signing-a-message.html | 24 +++++++++ .../signing-and-posting-transactions.html | 27 ++++++++++ usage/clients/signing-transactions.html | 49 +++++++++++++++++++ usage/providers.html | 28 +++++++++++ usage/providers/getting-started.html | 30 ++++++++++++ .../responding-to-disable-requests.html | 33 +++++++++++++ .../responding-to-discover-requests.html | 23 +++++++++ .../responding-to-enable-requests.html | 28 +++++++++++ ...ponding-to-post-transactions-requests.html | 27 ++++++++++ ...o-sign-and-post-transactions-requests.html | 27 ++++++++++ .../responding-to-sign-message-requests.html | 23 +++++++++ ...ponding-to-sign-transactions-requests.html | 24 +++++++++ usage/providers/throwing-an-error.html | 23 +++++++++ 145 files changed, 842 insertions(+), 261 deletions(-) rename assets/css/{styles.28514799.css => styles.79972309.css} (55%) create mode 100644 assets/js/05942345.ca688560.js create mode 100644 assets/js/078f4f1e.ac253693.js create mode 100644 assets/js/0e7a43e4.10b7a6db.js delete mode 100644 assets/js/0e7a43e4.acd7a0df.js create mode 100644 assets/js/12607efb.6f9fdd0d.js delete mode 100644 assets/js/12607efb.81e2cb7b.js create mode 100644 assets/js/17896441.6972c889.js delete mode 100644 assets/js/17896441.f69b5bba.js delete mode 100644 assets/js/18891827.985a9374.js create mode 100644 assets/js/18891827.cf368c64.js create mode 100644 assets/js/2237.9db9b32d.js create mode 100644 assets/js/22dd74f7.0257e7cd.js create mode 100644 assets/js/23353e13.0a783292.js create mode 100644 assets/js/27d136a3.f4b1ae3d.js delete mode 100644 assets/js/27d136a3.ff91a66c.js create mode 100644 assets/js/29d4e771.586f8e44.js create mode 100644 assets/js/2c8567d4.b56cad1a.js delete mode 100644 assets/js/2f03465d.063e0da1.js create mode 100644 assets/js/2f03465d.36e85508.js delete mode 100644 assets/js/2f412085.4256d459.js create mode 100644 assets/js/2f412085.d100aad1.js create mode 100644 assets/js/32595feb.9df10cb7.js create mode 100644 assets/js/3833126f.0eba1aeb.js delete mode 100644 assets/js/3833126f.6e894d8b.js create mode 100644 assets/js/38e469bb.67c6d5ae.js create mode 100644 assets/js/3cb43a65.c6a3d251.js delete mode 100644 assets/js/424.31d24e27.js create mode 100644 assets/js/473ff9eb.8634bca6.js create mode 100644 assets/js/5e5255c2.eaab8306.js delete mode 100644 assets/js/5e5255c2.eb6ba710.js create mode 100644 assets/js/5e95c892.4e75dd8e.js delete mode 100644 assets/js/5e95c892.ea587653.js create mode 100644 assets/js/5eb8ced3.3d2bd6cc.js delete mode 100644 assets/js/5eb8ced3.4516c77b.js create mode 100644 assets/js/61bb475c.31f3d3af.js delete mode 100644 assets/js/61bb475c.e7bda565.js create mode 100644 assets/js/68adac10.ae927104.js create mode 100644 assets/js/6b50e60a.18354e6a.js delete mode 100644 assets/js/6b50e60a.b0f76db3.js create mode 100644 assets/js/7c31b11d.4e2e1af3.js delete mode 100644 assets/js/7c31b11d.d6cd7baf.js delete mode 100644 assets/js/872f12d1.b618229c.js create mode 100644 assets/js/892d9cd8.00c67ecd.js delete mode 100644 assets/js/892d9cd8.a2b3a932.js delete mode 100644 assets/js/8d3cc82e.0c1766aa.js create mode 100644 assets/js/8d3cc82e.cf470963.js create mode 100644 assets/js/8e32cf85.3fd43ea6.js delete mode 100644 assets/js/8e32cf85.b68b6e34.js delete mode 100644 assets/js/935f2afb.baa4da37.js create mode 100644 assets/js/9d373472.530e9f8c.js create mode 100644 assets/js/a78de39e.0cf3d8aa.js create mode 100644 assets/js/a7bd4aaa.00577d43.js delete mode 100644 assets/js/a7bd4aaa.e11f91fb.js create mode 100644 assets/js/a94703ab.09c8a325.js delete mode 100644 assets/js/a94703ab.fb0cf4b4.js create mode 100644 assets/js/aba21aa0.d16e9080.js create mode 100644 assets/js/acfcbc0b.c1d8cadb.js delete mode 100644 assets/js/acfcbc0b.ce4c60ca.js create mode 100644 assets/js/b3622e55.0dcaf325.js delete mode 100644 assets/js/b3622e55.c91436f2.js create mode 100644 assets/js/bfff9bcb.52e40d5a.js create mode 100644 assets/js/c69dfc92.7ee51c5c.js delete mode 100644 assets/js/c69dfc92.f4bb5f7d.js delete mode 100644 assets/js/c7a7be94.a54b0005.js create mode 100644 assets/js/c7a7be94.cbd8770f.js create mode 100644 assets/js/cf854aeb.079ca638.js delete mode 100644 assets/js/common.22832a68.js create mode 100644 assets/js/common.89d696fc.js create mode 100644 assets/js/d109ed11.45c27a47.js delete mode 100644 assets/js/d109ed11.821d9578.js create mode 100644 assets/js/d1e6c657.8467ce0b.js create mode 100644 assets/js/d947b455.1d12cc91.js delete mode 100644 assets/js/d947b455.74ba6a9a.js create mode 100644 assets/js/da384a5e.9dc7054b.js create mode 100644 assets/js/dbeba81a.18746d29.js delete mode 100644 assets/js/dbeba81a.a5a19fec.js create mode 100644 assets/js/e703b53e.07bc2d1f.js create mode 100644 assets/js/f1f3f6b8.c0c8bb89.js delete mode 100644 assets/js/f1f3f6b8.c1cad1ff.js create mode 100644 assets/js/f2da1fd8.0e7667cd.js delete mode 100644 assets/js/f2da1fd8.b0566923.js create mode 100644 assets/js/f3d834a5.ee178eb5.js create mode 100644 assets/js/f40f6140.e9fd29f4.js delete mode 100644 assets/js/f7793a5d.dad87a10.js create mode 100644 assets/js/f7793a5d.e83144c3.js create mode 100644 assets/js/fc225bb3.323c1754.js delete mode 100644 assets/js/fc225bb3.58e6b682.js create mode 100644 assets/js/fe3501f1.9b64b777.js delete mode 100644 assets/js/fe6aabe8.1ed8a01a.js create mode 100644 assets/js/fe6aabe8.d1300160.js create mode 100644 assets/js/main.075ca466.js rename assets/js/{main.f88ee4c6.js.LICENSE.txt => main.075ca466.js.LICENSE.txt} (100%) delete mode 100644 assets/js/main.f88ee4c6.js delete mode 100644 assets/js/runtime~main.8cf69c52.js create mode 100644 assets/js/runtime~main.afd49300.js create mode 100644 usage.html create mode 100644 usage/clients.html create mode 100644 usage/clients/disabling-a-client.html create mode 100644 usage/clients/discover-providers.html create mode 100644 usage/clients/enabling-a-client.html create mode 100644 usage/clients/getting-started.html create mode 100644 usage/clients/posting-transactions.html create mode 100644 usage/clients/signing-a-message.html create mode 100644 usage/clients/signing-and-posting-transactions.html create mode 100644 usage/clients/signing-transactions.html create mode 100644 usage/providers.html create mode 100644 usage/providers/getting-started.html create mode 100644 usage/providers/responding-to-disable-requests.html create mode 100644 usage/providers/responding-to-discover-requests.html create mode 100644 usage/providers/responding-to-enable-requests.html create mode 100644 usage/providers/responding-to-post-transactions-requests.html create mode 100644 usage/providers/responding-to-sign-and-post-transactions-requests.html create mode 100644 usage/providers/responding-to-sign-message-requests.html create mode 100644 usage/providers/responding-to-sign-transactions-requests.html create mode 100644 usage/providers/throwing-an-error.html diff --git a/404.html b/404.html index cf6897d..6096520 100644 --- a/404.html +++ b/404.html @@ -2,15 +2,15 @@ - -AVM Web Provider - - + +AVM Web Provider + + -
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

Docs
More
+

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

diff --git a/api-reference.html b/api-reference.html index 6850592..b4c9434 100644 --- a/api-reference.html +++ b/api-reference.html @@ -2,21 +2,21 @@ - -API Reference | AVM Web Provider - - + +API Reference | AVM Web Provider + + -

API Reference

+

API Reference

  • AVMWebClient - initialized by clients, such as dApps, and allows a client to interact with provider(s).
  • AVMWebProvider - initialized by a providers, such as wallets, and allows a provider to interact the client.
  • Errors - various error responses that can be thrown.
  • Types - various types used by the client and providers.
    • -
diff --git a/api-reference/avm-web-client.html b/api-reference/avm-web-client.html index 0b0f2e3..67ead84 100644 --- a/api-reference/avm-web-client.html +++ b/api-reference/avm-web-client.html @@ -2,13 +2,13 @@ - -AVMWebClient | AVM Web Provider - - + +AVMWebClient | AVM Web Provider + + -

AVMWebClient

+

AVMWebClient

Static Methods​

init([options])​

@@ -149,9 +149,9 @@

Parameters​

NameTypeRequiredDefaultDescription
paramsISignTransactionsParamsyes-Params that specify the unsigned transactions and the provider.

Returns​

-
TypeDescription
stringthe ID of the request message.
diff --git a/api-reference/avm-web-provider.html b/api-reference/avm-web-provider.html index b874c2a..31df229 100644 --- a/api-reference/avm-web-provider.html +++ b/api-reference/avm-web-provider.html @@ -2,13 +2,13 @@ - -AVMWebProvider | AVM Web Provider - - + +AVMWebProvider | AVM Web Provider + + -

AVMWebProvider

+

AVMWebProvider

Static Methods​

init([options])​

@@ -93,9 +93,9 @@

remov

Parameters​

NameTypeRequiredDefaultDescription
idstringyes-The listener ID to remove.

Returns​

-
TypeDescription
void-

diff --git a/api-reference/errors.html b/api-reference/errors.html index 10d1942..c0e53b7 100644 --- a/api-reference/errors.html +++ b/api-reference/errors.html @@ -2,13 +2,13 @@ - -Errors | AVM Web Provider - - + +Errors | AVM Web Provider + + -

Errors

+

Errors

Summary​

CodeNameSummary
4000UnknownErrorThe default error response, usually indicates something is not quite right.
4001MethodCanceledErrorWhen a user has rejected the method.
4003MethodNotSupportedErrorThe specified provider does not exist.
4004NetworkNotSupportedErrorNetworks not supported.
4100UnauthorizedSignerErrorThe provider has not given permission to use a specified signer.
4200InvalidInputErrorThe input for signing transactions is malformed.
4201InvalidGroupIdErrorThe computed group ID of the atomic transactions is different from the assigned group ID.
4300FailedToPostSomeTransactionsErrorWhen some transactions were not sent properly.

UnknownError​

@@ -42,9 +42,9 @@

PropertiesFailedToPostSomeTransactionsError​

This error is thrown when some transactions failed to be posted to the network.

Properties​

-
NameTypeValueDescription
codenumber4300A canonical code for this error.
messagestring-A human readable message.
successTxnIDs(string | null)[]-This will correspond to the stxns list sent in postTxns and will contain the ID of those transactions that were successfully committed to the blockchain, or null if they failed.
Docs
More
+
NameTypeValueDescription
codenumber4300A canonical code for this error.
messagestring-A human readable message.
successTxnIDs(string | null)[]-This will correspond to the stxns list sent in postTxns and will contain the ID of those transactions that were successfully committed to the blockchain, or null if they failed.
diff --git a/api-reference/types.html b/api-reference/types.html index 1587bb2..3e8d5c3 100644 --- a/api-reference/types.html +++ b/api-reference/types.html @@ -2,13 +2,13 @@ - -Types | AVM Web Provider - - + +Types | AVM Web Provider + + -

Types

+

Types

IARC0001Transaction​

NameTypeRequiredDefaultDescription
authAddrstringno-The auth address if the sender has rekeyed.
msigMultisigMetadatano-Extra metadata needed when sending multisig transactions.
signersstring[]no-A list of addresses to sign with (defaults to the sender in the transaction).
stxnstringno-If this is part of a group of transactions, some of which are already signed you must also provide these signed transactions and the signers array MUST be undefined or empty, as per ARC-0001.
txnstringyes-The base64 encoded unsigned transaction.
@@ -54,9 +54,9 @@

ISi

ISignTransactionsParams​

NameTypeRequiredDefaultDescription
providerIdstringno-The ID of the provider.
txnsIARC0001Transaction[]yes-A list of transactions to be signed by providers.

ISignTransactionsResult​

-
NameTypeRequiredDefaultDescription
providerIdstringyes-The ID of the provider.
stxns(string | null)[]yes-The list of base64 encoded signed transactions that is ready to be posted to the network. If any of the transactions were not signed by the wallet, and no stxns were supplied, then null will be in the place of the signed transaction.

Docs
More
+
NameTypeRequiredDefaultDescription
providerIdstringyes-The ID of the provider.
stxns(string | null)[]yes-The list of base64 encoded signed transactions that is ready to be posted to the network. If any of the transactions were not signed by the wallet, and no stxns were supplied, then null will be in the place of the signed transaction.
diff --git a/assets/css/styles.28514799.css b/assets/css/styles.79972309.css similarity index 55% rename from assets/css/styles.28514799.css rename to assets/css/styles.79972309.css index 31c65ea..9ff248e 100644 --- a/assets/css/styles.28514799.css +++ b/assets/css/styles.79972309.css @@ -1 +1 @@ -.col,.container{padding:0 var(--ifm-spacing-horizontal);width:100%}.markdown>h2,.markdown>h3,.markdown>h4,.markdown>h5,.markdown>h6{margin-bottom:calc(var(--ifm-heading-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown li,body{word-wrap:break-word}body,ol ol,ol ul,ul ol,ul ul{margin:0}pre,table{overflow:auto}blockquote,pre{margin:0 0 var(--ifm-spacing-vertical)}.button,code{vertical-align:middle}.button--outline.button--active,.button--outline:active,.button--outline:hover,:root{--ifm-button-color:var(--ifm-font-color-base-inverse)}.navbar--dark,:root{--ifm-navbar-link-hover-color:var(--ifm-color-primary)}.menu,.navbar-sidebar{overflow-x:hidden}:root,html[data-theme=dark]{--ifm-color-emphasis-500:var(--ifm-color-gray-500)}.avatar--vertical,.avatar__intro,.card,.footer__copyright-container{-webkit-box-orient:vertical;-moz-box-orient:vertical}.avatar--vertical,.avatar__intro,.card,.footer__copyright-container,.footer__icon-container{-webkit-box-direction:normal;-moz-box-direction:normal}.toggleButton_gllP,html{-webkit-tap-highlight-color:transparent}.clean-list,.containsTaskList_mC6p,.details_lb9f>summary,.dropdown__menu,.menu__list{list-style:none}:root{--ifm-color-scheme:light;--ifm-dark-value:10%;--ifm-darker-value:15%;--ifm-darkest-value:30%;--ifm-light-value:15%;--ifm-lighter-value:30%;--ifm-lightest-value:50%;--ifm-contrast-background-value:90%;--ifm-contrast-foreground-value:70%;--ifm-contrast-background-dark-value:70%;--ifm-contrast-foreground-dark-value:90%;--ifm-color-primary:#3578e5;--ifm-color-secondary:#ebedf0;--ifm-color-success:#00a400;--ifm-color-info:#54c7ec;--ifm-color-warning:#ffba00;--ifm-color-danger:#fa383e;--ifm-color-primary-dark:#306cce;--ifm-color-primary-darker:#2d66c3;--ifm-color-primary-darkest:#2554a0;--ifm-color-primary-light:#538ce9;--ifm-color-primary-lighter:#72a1ed;--ifm-color-primary-lightest:#9abcf2;--ifm-color-primary-contrast-background:#ebf2fc;--ifm-color-primary-contrast-foreground:#102445;--ifm-color-secondary-dark:#d4d5d8;--ifm-color-secondary-darker:#c8c9cc;--ifm-color-secondary-darkest:#a4a6a8;--ifm-color-secondary-light:#eef0f2;--ifm-color-secondary-lighter:#f1f2f5;--ifm-color-secondary-lightest:#f5f6f8;--ifm-color-secondary-contrast-background:#fdfdfe;--ifm-color-secondary-contrast-foreground:#474748;--ifm-color-success-dark:#009400;--ifm-color-success-darker:#008b00;--ifm-color-success-darkest:#007300;--ifm-color-success-light:#26b226;--ifm-color-success-lighter:#4dbf4d;--ifm-color-success-lightest:#80d280;--ifm-color-success-contrast-background:#e6f6e6;--ifm-color-success-contrast-foreground:#003100;--ifm-color-info-dark:#4cb3d4;--ifm-color-info-darker:#47a9c9;--ifm-color-info-darkest:#3b8ba5;--ifm-color-info-light:#6ecfef;--ifm-color-info-lighter:#87d8f2;--ifm-color-info-lightest:#aae3f6;--ifm-color-info-contrast-background:#eef9fd;--ifm-color-info-contrast-foreground:#193c47;--ifm-color-warning-dark:#e6a700;--ifm-color-warning-darker:#d99e00;--ifm-color-warning-darkest:#b38200;--ifm-color-warning-light:#ffc426;--ifm-color-warning-lighter:#ffcf4d;--ifm-color-warning-lightest:#ffdd80;--ifm-color-warning-contrast-background:#fff8e6;--ifm-color-warning-contrast-foreground:#4d3800;--ifm-color-danger-dark:#e13238;--ifm-color-danger-darker:#d53035;--ifm-color-danger-darkest:#af272b;--ifm-color-danger-light:#fb565b;--ifm-color-danger-lighter:#fb7478;--ifm-color-danger-lightest:#fd9c9f;--ifm-color-danger-contrast-background:#ffebec;--ifm-color-danger-contrast-foreground:#4b1113;--ifm-color-white:#fff;--ifm-color-black:#000;--ifm-color-gray-0:var(--ifm-color-white);--ifm-color-gray-100:#f5f6f7;--ifm-color-gray-200:#ebedf0;--ifm-color-gray-300:#dadde1;--ifm-color-gray-400:#ccd0d5;--ifm-color-gray-500:#bec3c9;--ifm-color-gray-600:#8d949e;--ifm-color-gray-700:#606770;--ifm-color-gray-800:#444950;--ifm-color-gray-900:#1c1e21;--ifm-color-gray-1000:var(--ifm-color-black);--ifm-color-emphasis-0:var(--ifm-color-gray-0);--ifm-color-emphasis-100:var(--ifm-color-gray-100);--ifm-color-emphasis-200:var(--ifm-color-gray-200);--ifm-color-emphasis-300:var(--ifm-color-gray-300);--ifm-color-emphasis-400:var(--ifm-color-gray-400);--ifm-color-emphasis-600:var(--ifm-color-gray-600);--ifm-color-emphasis-700:var(--ifm-color-gray-700);--ifm-color-emphasis-800:var(--ifm-color-gray-800);--ifm-color-emphasis-900:var(--ifm-color-gray-900);--ifm-color-emphasis-1000:var(--ifm-color-gray-1000);--ifm-color-content:var(--ifm-color-emphasis-900);--ifm-color-content-inverse:var(--ifm-color-emphasis-0);--ifm-color-content-secondary:#525860;--ifm-background-color:transparent;--ifm-background-surface-color:var(--ifm-color-content-inverse);--ifm-global-border-width:1px;--ifm-global-radius:0.4rem;--ifm-hover-overlay:rgba(0,0,0,.05);--ifm-font-color-base:var(--ifm-color-content);--ifm-font-color-base-inverse:var(--ifm-color-content-inverse);--ifm-font-color-secondary:var(--ifm-color-content-secondary);--ifm-font-family-base:system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";--ifm-font-family-monospace:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;--ifm-font-size-base:100%;--ifm-font-weight-light:300;--ifm-font-weight-normal:400;--ifm-font-weight-semibold:500;--ifm-font-weight-bold:700;--ifm-font-weight-base:var(--ifm-font-weight-normal);--ifm-line-height-base:1.65;--ifm-global-spacing:1rem;--ifm-spacing-vertical:var(--ifm-global-spacing);--ifm-spacing-horizontal:var(--ifm-global-spacing);--ifm-transition-fast:200ms;--ifm-transition-slow:400ms;--ifm-transition-timing-default:cubic-bezier(0.08,0.52,0.52,1);--ifm-global-shadow-lw:0 1px 2px 0 rgba(0,0,0,.1);--ifm-global-shadow-md:0 5px 40px rgba(0,0,0,.2);--ifm-global-shadow-tl:0 12px 28px 0 rgba(0,0,0,.2),0 2px 4px 0 rgba(0,0,0,.1);--ifm-z-index-dropdown:100;--ifm-z-index-fixed:200;--ifm-z-index-overlay:400;--ifm-container-width:1140px;--ifm-container-width-xl:1320px;--ifm-code-background:#f6f7f8;--ifm-code-border-radius:var(--ifm-global-radius);--ifm-code-font-size:90%;--ifm-code-padding-horizontal:0.1rem;--ifm-code-padding-vertical:0.1rem;--ifm-pre-background:var(--ifm-code-background);--ifm-pre-border-radius:var(--ifm-code-border-radius);--ifm-pre-color:inherit;--ifm-pre-line-height:1.45;--ifm-pre-padding:1rem;--ifm-heading-color:inherit;--ifm-heading-margin-top:0;--ifm-heading-margin-bottom:var(--ifm-spacing-vertical);--ifm-heading-font-family:var(--ifm-font-family-base);--ifm-heading-font-weight:var(--ifm-font-weight-bold);--ifm-heading-line-height:1.25;--ifm-h1-font-size:2rem;--ifm-h2-font-size:1.5rem;--ifm-h3-font-size:1.25rem;--ifm-h4-font-size:1rem;--ifm-h5-font-size:0.875rem;--ifm-h6-font-size:0.85rem;--ifm-image-alignment-padding:1.25rem;--ifm-leading-desktop:1.25;--ifm-leading:calc(var(--ifm-leading-desktop)*1rem);--ifm-list-left-padding:2rem;--ifm-list-margin:1rem;--ifm-list-item-margin:0.25rem;--ifm-list-paragraph-margin:1rem;--ifm-table-cell-padding:0.75rem;--ifm-table-background:transparent;--ifm-table-stripe-background:rgba(0,0,0,.03);--ifm-table-border-width:1px;--ifm-table-border-color:var(--ifm-color-emphasis-300);--ifm-table-head-background:inherit;--ifm-table-head-color:inherit;--ifm-table-head-font-weight:var(--ifm-font-weight-bold);--ifm-table-cell-color:inherit;--ifm-link-color:var(--ifm-color-primary);--ifm-link-decoration:none;--ifm-link-hover-color:var(--ifm-link-color);--ifm-link-hover-decoration:underline;--ifm-paragraph-margin-bottom:var(--ifm-leading);--ifm-blockquote-font-size:var(--ifm-font-size-base);--ifm-blockquote-border-left-width:2px;--ifm-blockquote-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-blockquote-padding-vertical:0;--ifm-blockquote-shadow:none;--ifm-blockquote-color:var(--ifm-color-emphasis-800);--ifm-blockquote-border-color:var(--ifm-color-emphasis-300);--ifm-hr-background-color:var(--ifm-color-emphasis-500);--ifm-hr-height:1px;--ifm-hr-margin-vertical:1.5rem;--ifm-scrollbar-size:7px;--ifm-scrollbar-track-background-color:#f1f1f1;--ifm-scrollbar-thumb-background-color:silver;--ifm-scrollbar-thumb-hover-background-color:#a7a7a7;--ifm-alert-background-color:inherit;--ifm-alert-border-color:inherit;--ifm-alert-border-radius:var(--ifm-global-radius);--ifm-alert-border-width:0px;--ifm-alert-border-left-width:5px;--ifm-alert-color:var(--ifm-font-color-base);--ifm-alert-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-alert-padding-vertical:var(--ifm-spacing-vertical);--ifm-alert-shadow:var(--ifm-global-shadow-lw);--ifm-avatar-intro-margin:1rem;--ifm-avatar-intro-alignment:inherit;--ifm-avatar-photo-size:3rem;--ifm-badge-background-color:inherit;--ifm-badge-border-color:inherit;--ifm-badge-border-radius:var(--ifm-global-radius);--ifm-badge-border-width:var(--ifm-global-border-width);--ifm-badge-color:var(--ifm-color-white);--ifm-badge-padding-horizontal:calc(var(--ifm-spacing-horizontal)*0.5);--ifm-badge-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-breadcrumb-border-radius:1.5rem;--ifm-breadcrumb-spacing:0.5rem;--ifm-breadcrumb-color-active:var(--ifm-color-primary);--ifm-breadcrumb-item-background-active:var(--ifm-hover-overlay);--ifm-breadcrumb-padding-horizontal:0.8rem;--ifm-breadcrumb-padding-vertical:0.4rem;--ifm-breadcrumb-size-multiplier:1;--ifm-breadcrumb-separator:url('data:image/svg+xml;utf8,');--ifm-breadcrumb-separator-filter:none;--ifm-breadcrumb-separator-size:0.5rem;--ifm-breadcrumb-separator-size-multiplier:1.25;--ifm-button-background-color:inherit;--ifm-button-border-color:var(--ifm-button-background-color);--ifm-button-border-width:var(--ifm-global-border-width);--ifm-button-font-weight:var(--ifm-font-weight-bold);--ifm-button-padding-horizontal:1.5rem;--ifm-button-padding-vertical:0.375rem;--ifm-button-size-multiplier:1;--ifm-button-transition-duration:var(--ifm-transition-fast);--ifm-button-border-radius:calc(var(--ifm-global-radius)*var(--ifm-button-size-multiplier));--ifm-button-group-spacing:2px;--ifm-card-background-color:var(--ifm-background-surface-color);--ifm-card-border-radius:calc(var(--ifm-global-radius)*2);--ifm-card-horizontal-spacing:var(--ifm-global-spacing);--ifm-card-vertical-spacing:var(--ifm-global-spacing);--ifm-toc-border-color:var(--ifm-color-emphasis-300);--ifm-toc-link-color:var(--ifm-color-content-secondary);--ifm-toc-padding-vertical:0.5rem;--ifm-toc-padding-horizontal:0.5rem;--ifm-dropdown-background-color:var(--ifm-background-surface-color);--ifm-dropdown-font-weight:var(--ifm-font-weight-semibold);--ifm-dropdown-link-color:var(--ifm-font-color-base);--ifm-dropdown-hover-background-color:var(--ifm-hover-overlay);--ifm-footer-background-color:var(--ifm-color-emphasis-100);--ifm-footer-color:inherit;--ifm-footer-link-color:var(--ifm-color-emphasis-700);--ifm-footer-link-hover-color:var(--ifm-color-primary);--ifm-footer-link-horizontal-spacing:0.5rem;--ifm-footer-padding-horizontal:calc(var(--ifm-spacing-horizontal)*2);--ifm-footer-padding-vertical:calc(var(--ifm-spacing-vertical)*2);--ifm-footer-title-color:inherit;--ifm-footer-logo-max-width:min(30rem,90vw);--ifm-hero-background-color:var(--ifm-background-surface-color);--ifm-hero-text-color:var(--ifm-color-emphasis-800);--ifm-menu-color:var(--ifm-color-emphasis-700);--ifm-menu-color-active:var(--ifm-color-primary);--ifm-menu-color-background-active:var(--ifm-hover-overlay);--ifm-menu-color-background-hover:var(--ifm-hover-overlay);--ifm-menu-link-padding-horizontal:0.75rem;--ifm-menu-link-padding-vertical:0.375rem;--ifm-menu-link-sublist-icon:url('data:image/svg+xml;utf8,');--ifm-menu-link-sublist-icon-filter:none;--ifm-navbar-background-color:var(--ifm-background-surface-color);--ifm-navbar-height:3.75rem;--ifm-navbar-item-padding-horizontal:0.75rem;--ifm-navbar-item-padding-vertical:0.25rem;--ifm-navbar-link-color:var(--ifm-font-color-base);--ifm-navbar-link-active-color:var(--ifm-link-color);--ifm-navbar-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-navbar-padding-vertical:calc(var(--ifm-spacing-vertical)*0.5);--ifm-navbar-shadow:var(--ifm-global-shadow-lw);--ifm-navbar-search-input-background-color:var(--ifm-color-emphasis-200);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-800);--ifm-navbar-search-input-placeholder-color:var(--ifm-color-emphasis-500);--ifm-navbar-search-input-icon:url('data:image/svg+xml;utf8,');--ifm-navbar-sidebar-width:83vw;--ifm-pagination-border-radius:var(--ifm-global-radius);--ifm-pagination-color-active:var(--ifm-color-primary);--ifm-pagination-font-size:1rem;--ifm-pagination-item-active-background:var(--ifm-hover-overlay);--ifm-pagination-page-spacing:0.2em;--ifm-pagination-padding-horizontal:calc(var(--ifm-spacing-horizontal)*1);--ifm-pagination-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-pagination-nav-border-radius:var(--ifm-global-radius);--ifm-pagination-nav-color-hover:var(--ifm-color-primary);--ifm-pills-color-active:var(--ifm-color-primary);--ifm-pills-color-background-active:var(--ifm-hover-overlay);--ifm-pills-spacing:0.125rem;--ifm-tabs-color:var(--ifm-font-color-secondary);--ifm-tabs-color-active:var(--ifm-color-primary);--ifm-tabs-color-active-border:var(--ifm-tabs-color-active);--ifm-tabs-padding-horizontal:1rem;--ifm-tabs-padding-vertical:1rem;--docusaurus-progress-bar-color:var(--ifm-color-primary);--agl-primary-color-dark-50:#abddba;--agl-primary-color-dark-100:#99d6ad;--agl-primary-color-dark-200:#87cf9f;--agl-primary-color-dark-300:#74c892;--agl-primary-color-dark-400:#5fc184;--agl-primary-color-dark-500:#48ba77;--agl-primary-color-dark-600:#3da167;--agl-primary-color-dark-700:#338957;--agl-primary-color-dark-800:#297247;--agl-primary-color-dark-900:#1f5c38;--agl-primary-color-light-50:#a1d8af;--agl-primary-color-light-100:#8ed0a0;--agl-primary-color-light-200:#79c890;--agl-primary-color-light-300:#63c080;--agl-primary-color-light-400:#4bb771;--agl-primary-color-light-500:#2aaf61;--agl-primary-color-light-600:#1c8146;--agl-primary-color-light-700:#166b39;--agl-primary-color-light-800:#10562d;--agl-primary-color-light-900:#0a4121;--ifm-color-primary:var(--agl-primary-color-light-500);--ifm-color-primary-dark:var(--agl-primary-color-light-600);--ifm-color-primary-darker:var(--agl-primary-color-light-700);--ifm-color-primary-darkest:var(--agl-primary-color-light-800);--ifm-color-primary-light:var(--agl-primary-color-light-400);--ifm-color-primary-lighter:var(--agl-primary-color-light-300);--ifm-color-primary-lightest:var(--agl-primary-color-light-200);--docusaurus-announcement-bar-height:auto;--docusaurus-tag-list-border:var(--ifm-color-emphasis-300);--docusaurus-collapse-button-bg:transparent;--docusaurus-collapse-button-bg-hover:rgba(0,0,0,.1);--doc-sidebar-width:300px;--doc-sidebar-hidden-width:30px}.badge--danger,.badge--info,.badge--primary,.badge--secondary,.badge--success,.badge--warning{--ifm-badge-border-color:var(--ifm-badge-background-color)}.button--link,.button--outline{--ifm-button-background-color:transparent}*{-moz-box-sizing:border-box;box-sizing:border-box}html{-webkit-font-smoothing:antialiased;-webkit-text-size-adjust:100%;-moz-text-size-adjust:100%;-ms-text-size-adjust:100%;text-size-adjust:100%;background-color:var(--ifm-background-color);color:var(--ifm-font-color-base);color-scheme:var(--ifm-color-scheme);font:var(--ifm-font-size-base)/var(--ifm-line-height-base) var(--ifm-font-family-base);text-rendering:optimizelegibility}iframe{border:0;color-scheme:auto}.container{margin:0 auto;max-width:var(--ifm-container-width)}.container--fluid{max-width:inherit}.row{display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;-webkit-flex-wrap:wrap;flex-wrap:wrap;margin:0 calc(var(--ifm-spacing-horizontal)*-1)}.margin-bottom--none,.margin-vert--none,.markdown>:last-child{margin-bottom:0!important}.margin-top--none,.margin-vert--none,.tabItem_LNqP{margin-top:0!important}.row--no-gutters{margin-left:0;margin-right:0}.margin-horiz--none,.margin-right--none{margin-right:0!important}.row--no-gutters>.col{padding-left:0;padding-right:0}.row--align-top{-webkit-box-align:start;-moz-box-align:start;-webkit-align-items:flex-start;align-items:flex-start}.row--align-bottom{-webkit-box-align:end;-moz-box-align:end;-webkit-align-items:flex-end;align-items:flex-end}.menuExternalLink_NmtK,.row--align-center{-webkit-box-align:center;-moz-box-align:center;-webkit-align-items:center;align-items:center}.row--align-stretch{-webkit-box-align:stretch;-moz-box-align:stretch;-webkit-align-items:stretch;align-items:stretch}.row--align-baseline{-webkit-box-align:baseline;-moz-box-align:baseline;-webkit-align-items:baseline;align-items:baseline}.col{--ifm-col-width:100%;-webkit-box-flex:1;-moz-box-flex:1;-webkit-flex:1 0;flex:1 0;margin-left:0;max-width:var(--ifm-col-width)}.padding-bottom--none,.padding-vert--none{padding-bottom:0!important}.padding-top--none,.padding-vert--none{padding-top:0!important}.padding-horiz--none,.padding-left--none{padding-left:0!important}.padding-horiz--none,.padding-right--none{padding-right:0!important}.col[class*=col--]{-webkit-box-flex:0;-moz-box-flex:0;-webkit-flex:0 0 var(--ifm-col-width);flex:0 0 var(--ifm-col-width)}.col--1{--ifm-col-width:8.33333%}.col--offset-1{margin-left:8.33333%}.col--2{--ifm-col-width:16.66667%}.col--offset-2{margin-left:16.66667%}.col--3{--ifm-col-width:25%}.col--offset-3{margin-left:25%}.col--4{--ifm-col-width:33.33333%}.col--offset-4{margin-left:33.33333%}.col--5{--ifm-col-width:41.66667%}.col--offset-5{margin-left:41.66667%}.col--6{--ifm-col-width:50%}.col--offset-6{margin-left:50%}.col--7{--ifm-col-width:58.33333%}.col--offset-7{margin-left:58.33333%}.col--8{--ifm-col-width:66.66667%}.col--offset-8{margin-left:66.66667%}.col--9{--ifm-col-width:75%}.col--offset-9{margin-left:75%}.col--10{--ifm-col-width:83.33333%}.col--offset-10{margin-left:83.33333%}.col--11{--ifm-col-width:91.66667%}.col--offset-11{margin-left:91.66667%}.col--12{--ifm-col-width:100%}.col--offset-12{margin-left:100%}.margin-horiz--none,.margin-left--none{margin-left:0!important}.margin--none{margin:0!important}.margin-bottom--xs,.margin-vert--xs{margin-bottom:.25rem!important}.margin-top--xs,.margin-vert--xs{margin-top:.25rem!important}.margin-horiz--xs,.margin-left--xs{margin-left:.25rem!important}.margin-horiz--xs,.margin-right--xs{margin-right:.25rem!important}.margin--xs{margin:.25rem!important}.margin-bottom--sm,.margin-vert--sm{margin-bottom:.5rem!important}.margin-top--sm,.margin-vert--sm{margin-top:.5rem!important}.margin-horiz--sm,.margin-left--sm{margin-left:.5rem!important}.margin-horiz--sm,.margin-right--sm{margin-right:.5rem!important}.margin--sm{margin:.5rem!important}.margin-bottom--md,.margin-vert--md{margin-bottom:1rem!important}.margin-top--md,.margin-vert--md{margin-top:1rem!important}.margin-horiz--md,.margin-left--md{margin-left:1rem!important}.margin-horiz--md,.margin-right--md{margin-right:1rem!important}.margin--md{margin:1rem!important}.margin-bottom--lg,.margin-vert--lg{margin-bottom:2rem!important}.margin-top--lg,.margin-vert--lg{margin-top:2rem!important}.margin-horiz--lg,.margin-left--lg{margin-left:2rem!important}.margin-horiz--lg,.margin-right--lg{margin-right:2rem!important}.margin--lg{margin:2rem!important}.margin-bottom--xl,.margin-vert--xl{margin-bottom:5rem!important}.margin-top--xl,.margin-vert--xl{margin-top:5rem!important}.margin-horiz--xl,.margin-left--xl{margin-left:5rem!important}.margin-horiz--xl,.margin-right--xl{margin-right:5rem!important}.margin--xl{margin:5rem!important}.padding--none{padding:0!important}.padding-bottom--xs,.padding-vert--xs{padding-bottom:.25rem!important}.padding-top--xs,.padding-vert--xs{padding-top:.25rem!important}.padding-horiz--xs,.padding-left--xs{padding-left:.25rem!important}.padding-horiz--xs,.padding-right--xs{padding-right:.25rem!important}.padding--xs{padding:.25rem!important}.padding-bottom--sm,.padding-vert--sm{padding-bottom:.5rem!important}.padding-top--sm,.padding-vert--sm{padding-top:.5rem!important}.padding-horiz--sm,.padding-left--sm{padding-left:.5rem!important}.padding-horiz--sm,.padding-right--sm{padding-right:.5rem!important}.padding--sm{padding:.5rem!important}.padding-bottom--md,.padding-vert--md{padding-bottom:1rem!important}.padding-top--md,.padding-vert--md{padding-top:1rem!important}.padding-horiz--md,.padding-left--md{padding-left:1rem!important}.padding-horiz--md,.padding-right--md{padding-right:1rem!important}.padding--md{padding:1rem!important}.padding-bottom--lg,.padding-vert--lg{padding-bottom:2rem!important}.padding-top--lg,.padding-vert--lg{padding-top:2rem!important}.padding-horiz--lg,.padding-left--lg{padding-left:2rem!important}.padding-horiz--lg,.padding-right--lg{padding-right:2rem!important}.padding--lg{padding:2rem!important}.padding-bottom--xl,.padding-vert--xl{padding-bottom:5rem!important}.padding-top--xl,.padding-vert--xl{padding-top:5rem!important}.padding-horiz--xl,.padding-left--xl{padding-left:5rem!important}.padding-horiz--xl,.padding-right--xl{padding-right:5rem!important}.padding--xl{padding:5rem!important}code{background-color:var(--ifm-code-background);border:.1rem solid rgba(0,0,0,.1);border-radius:var(--ifm-code-border-radius);font-family:var(--ifm-font-family-monospace);font-size:var(--ifm-code-font-size);padding:var(--ifm-code-padding-vertical) var(--ifm-code-padding-horizontal)}a code{color:inherit}pre{background-color:var(--ifm-pre-background);border-radius:var(--ifm-pre-border-radius);color:var(--ifm-pre-color);font:var(--ifm-code-font-size)/var(--ifm-pre-line-height) var(--ifm-font-family-monospace);padding:var(--ifm-pre-padding)}pre code{background-color:transparent;border:none;font-size:100%;line-height:inherit;padding:0}kbd{background-color:var(--ifm-color-emphasis-0);border:1px solid var(--ifm-color-emphasis-400);border-radius:.2rem;box-shadow:inset 0 -1px 0 var(--ifm-color-emphasis-400);color:var(--ifm-color-emphasis-800);font:80% var(--ifm-font-family-monospace);padding:.15rem .3rem}h1,h2,h3,h4,h5,h6{color:var(--ifm-heading-color);font-family:var(--ifm-heading-font-family);font-weight:var(--ifm-heading-font-weight);line-height:var(--ifm-heading-line-height);margin:var(--ifm-heading-margin-top) 0 var(--ifm-heading-margin-bottom) 0}h1{font-size:var(--ifm-h1-font-size)}h2{font-size:var(--ifm-h2-font-size)}h3{font-size:var(--ifm-h3-font-size)}h4{font-size:var(--ifm-h4-font-size)}h5{font-size:var(--ifm-h5-font-size)}h6{font-size:var(--ifm-h6-font-size)}img{max-width:100%}img[align=right]{padding-left:var(--image-alignment-padding)}img[align=left]{padding-right:var(--image-alignment-padding)}.markdown{--ifm-h1-vertical-rhythm-top:3;--ifm-h2-vertical-rhythm-top:2;--ifm-h3-vertical-rhythm-top:1.5;--ifm-heading-vertical-rhythm-top:1.25;--ifm-h1-vertical-rhythm-bottom:1.25;--ifm-heading-vertical-rhythm-bottom:1}.markdown:after,.markdown:before{content:"";display:table}.markdown:after{clear:both}.markdown h1:first-child{--ifm-h1-font-size:3rem;margin-bottom:calc(var(--ifm-h1-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown>h2{--ifm-h2-font-size:2rem;margin-top:calc(var(--ifm-h2-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h3{--ifm-h3-font-size:1.5rem;margin-top:calc(var(--ifm-h3-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h4,.markdown>h5,.markdown>h6{margin-top:calc(var(--ifm-heading-vertical-rhythm-top)*var(--ifm-leading))}.markdown>p,.markdown>pre,.markdown>ul,.tabList__CuJ{margin-bottom:var(--ifm-leading)}.markdown li>p{margin-top:var(--ifm-list-paragraph-margin)}.markdown li+li{margin-top:var(--ifm-list-item-margin)}ol,ul{margin:0 0 var(--ifm-list-margin);padding-left:var(--ifm-list-left-padding)}ol ol,ul ol{list-style-type:lower-roman}ol ol ol,ol ul ol,ul ol ol,ul ul ol{list-style-type:lower-alpha}table{border-collapse:collapse;display:block;margin-bottom:var(--ifm-spacing-vertical)}table thead tr{border-bottom:2px solid var(--ifm-table-border-color)}table thead,table tr:nth-child(2n){background-color:var(--ifm-table-stripe-background)}table tr{background-color:var(--ifm-table-background);border-top:var(--ifm-table-border-width) solid var(--ifm-table-border-color)}table td,table th{border:var(--ifm-table-border-width) solid var(--ifm-table-border-color);padding:var(--ifm-table-cell-padding)}table th{background-color:var(--ifm-table-head-background);color:var(--ifm-table-head-color);font-weight:var(--ifm-table-head-font-weight)}table td{color:var(--ifm-table-cell-color)}strong{font-weight:var(--ifm-font-weight-bold)}a{color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration);-webkit-transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}a:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button:hover,.text--no-decoration,.text--no-decoration:hover,a:not([href]){text-decoration:none}p{margin:0 0 var(--ifm-paragraph-margin-bottom)}blockquote{border-left:var(--ifm-blockquote-border-left-width) solid var(--ifm-blockquote-border-color);box-shadow:var(--ifm-blockquote-shadow);color:var(--ifm-blockquote-color);font-size:var(--ifm-blockquote-font-size);padding:var(--ifm-blockquote-padding-vertical) var(--ifm-blockquote-padding-horizontal)}blockquote>:first-child{margin-top:0}blockquote>:last-child{margin-bottom:0}hr{background-color:var(--ifm-hr-background-color);border:0;height:var(--ifm-hr-height);margin:var(--ifm-hr-margin-vertical) 0}.shadow--lw{box-shadow:var(--ifm-global-shadow-lw)!important}.shadow--md{box-shadow:var(--ifm-global-shadow-md)!important}.shadow--tl{box-shadow:var(--ifm-global-shadow-tl)!important}.text--primary,.wordWrapButtonEnabled_EoeP .wordWrapButtonIcon_Bwma{color:var(--ifm-color-primary)}.text--secondary{color:var(--ifm-color-secondary)}.text--success{color:var(--ifm-color-success)}.text--info{color:var(--ifm-color-info)}.text--warning{color:var(--ifm-color-warning)}.text--danger{color:var(--ifm-color-danger)}.text--center{text-align:center}.text--left{text-align:left}.text--justify{text-align:justify}.text--right{text-align:right}.text--capitalize{text-transform:capitalize}.text--lowercase{text-transform:lowercase}.admonitionHeading_Gvgb,.alert__heading,.text--uppercase{text-transform:uppercase}.text--light{font-weight:var(--ifm-font-weight-light)}.text--normal{font-weight:var(--ifm-font-weight-normal)}.text--semibold{font-weight:var(--ifm-font-weight-semibold)}.text--bold{font-weight:var(--ifm-font-weight-bold)}.text--italic{font-style:italic}.text--truncate{overflow:hidden;-o-text-overflow:ellipsis;text-overflow:ellipsis;white-space:nowrap}.text--break{word-wrap:break-word!important;word-break:break-word!important}.clean-btn{background:none;border:none;color:inherit;cursor:pointer;font-family:inherit;padding:0}.alert,.alert .close{color:var(--ifm-alert-foreground-color)}.clean-list{padding-left:0}.alert--primary{--ifm-alert-background-color:var(--ifm-color-primary-contrast-background);--ifm-alert-background-color-highlight:rgba(53,120,229,.15);--ifm-alert-foreground-color:var(--ifm-color-primary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-primary-dark)}.alert--secondary{--ifm-alert-background-color:var(--ifm-color-secondary-contrast-background);--ifm-alert-background-color-highlight:rgba(235,237,240,.15);--ifm-alert-foreground-color:var(--ifm-color-secondary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-secondary-dark)}.alert--success{--ifm-alert-background-color:var(--ifm-color-success-contrast-background);--ifm-alert-background-color-highlight:rgba(0,164,0,.15);--ifm-alert-foreground-color:var(--ifm-color-success-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-success-dark)}.alert--info{--ifm-alert-background-color:var(--ifm-color-info-contrast-background);--ifm-alert-background-color-highlight:rgba(84,199,236,.15);--ifm-alert-foreground-color:var(--ifm-color-info-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-info-dark)}.alert--warning{--ifm-alert-background-color:var(--ifm-color-warning-contrast-background);--ifm-alert-background-color-highlight:rgba(255,186,0,.15);--ifm-alert-foreground-color:var(--ifm-color-warning-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-warning-dark)}.alert--danger{--ifm-alert-background-color:var(--ifm-color-danger-contrast-background);--ifm-alert-background-color-highlight:rgba(250,56,62,.15);--ifm-alert-foreground-color:var(--ifm-color-danger-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-danger-dark)}.alert{--ifm-code-background:var(--ifm-alert-background-color-highlight);--ifm-link-color:var(--ifm-alert-foreground-color);--ifm-link-hover-color:var(--ifm-alert-foreground-color);--ifm-link-decoration:underline;--ifm-tabs-color:var(--ifm-alert-foreground-color);--ifm-tabs-color-active:var(--ifm-alert-foreground-color);--ifm-tabs-color-active-border:var(--ifm-alert-border-color);background-color:var(--ifm-alert-background-color);border:var(--ifm-alert-border-width) solid var(--ifm-alert-border-color);border-left-width:var(--ifm-alert-border-left-width);border-radius:var(--ifm-alert-border-radius);box-shadow:var(--ifm-alert-shadow);padding:var(--ifm-alert-padding-vertical) var(--ifm-alert-padding-horizontal)}.alert__heading{-webkit-box-align:center;-moz-box-align:center;-webkit-align-items:center;align-items:center;display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;font:700 var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.5rem}.alert__icon{display:-webkit-inline-box;display:-webkit-inline-flex;display:-moz-inline-box;display:inline-flex;margin-right:.4em}.alert__icon svg{fill:var(--ifm-alert-foreground-color);stroke:var(--ifm-alert-foreground-color);stroke-width:0}.alert .close{margin:calc(var(--ifm-alert-padding-vertical)*-1) calc(var(--ifm-alert-padding-horizontal)*-1) 0 0;opacity:.75}.alert .close:focus,.alert .close:hover{opacity:1}.alert a{-webkit-text-decoration-color:var(--ifm-alert-border-color);-moz-text-decoration-color:var(--ifm-alert-border-color);text-decoration-color:var(--ifm-alert-border-color)}.alert a:hover{text-decoration-thickness:2px}.avatar{-moz-column-gap:var(--ifm-avatar-intro-margin);-webkit-column-gap:var(--ifm-avatar-intro-margin);column-gap:var(--ifm-avatar-intro-margin);display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex}.avatar__photo{border-radius:50%;display:block;height:var(--ifm-avatar-photo-size);overflow:hidden;width:var(--ifm-avatar-photo-size)}.avatar__intro,.button-group--block{display:-webkit-box;display:-webkit-flex;display:-moz-box}.card--full-height,.navbar__logo img,body,html{height:100%}.avatar__photo--sm{--ifm-avatar-photo-size:2rem}.avatar__photo--lg{--ifm-avatar-photo-size:4rem}.avatar__photo--xl{--ifm-avatar-photo-size:6rem}.avatar__intro{-webkit-box-flex:1;-moz-box-flex:1;-webkit-box-pack:center;-moz-box-pack:center;display:flex;-webkit-flex:1 1;flex:1 1;-webkit-flex-direction:column;flex-direction:column;-webkit-justify-content:center;justify-content:center;text-align:var(--ifm-avatar-intro-alignment)}.badge,.breadcrumbs__item,.breadcrumbs__link,.button,.dropdown>.navbar__link:after{display:inline-block}.avatar__name{font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base)}.avatar__subtitle{margin-top:.25rem}.avatar--vertical{--ifm-avatar-intro-alignment:center;--ifm-avatar-intro-margin:0.5rem;-webkit-box-align:center;-moz-box-align:center;-webkit-align-items:center;align-items:center;-webkit-flex-direction:column;flex-direction:column}.badge{background-color:var(--ifm-badge-background-color);border:var(--ifm-badge-border-width) solid var(--ifm-badge-border-color);border-radius:var(--ifm-badge-border-radius);color:var(--ifm-badge-color);font-size:75%;font-weight:var(--ifm-font-weight-bold);line-height:1;padding:var(--ifm-badge-padding-vertical) var(--ifm-badge-padding-horizontal)}.badge--primary{--ifm-badge-background-color:var(--ifm-color-primary)}.badge--secondary{--ifm-badge-background-color:var(--ifm-color-secondary);color:var(--ifm-color-black)}.breadcrumbs__link,.button.button--secondary.button--outline:not(.button--active):not(:hover){color:var(--ifm-font-color-base)}.badge--success{--ifm-badge-background-color:var(--ifm-color-success)}.badge--info{--ifm-badge-background-color:var(--ifm-color-info)}.badge--warning{--ifm-badge-background-color:var(--ifm-color-warning)}.badge--danger{--ifm-badge-background-color:var(--ifm-color-danger)}.breadcrumbs{margin-bottom:0;padding-left:0}.breadcrumbs__item:not(:last-child):after{background:var(--ifm-breadcrumb-separator) center;content:" ";display:inline-block;-webkit-filter:var(--ifm-breadcrumb-separator-filter);filter:var(--ifm-breadcrumb-separator-filter);height:-webkit-calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));height:-moz-calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));height:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));margin:0 var(--ifm-breadcrumb-spacing);opacity:.5;width:-webkit-calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));width:-moz-calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));width:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier))}.breadcrumbs__item--active .breadcrumbs__link{background:var(--ifm-breadcrumb-item-background-active);color:var(--ifm-breadcrumb-color-active)}.breadcrumbs__link{border-radius:var(--ifm-breadcrumb-border-radius);font-size:-webkit-calc(1rem*var(--ifm-breadcrumb-size-multiplier));font-size:-moz-calc(1rem*var(--ifm-breadcrumb-size-multiplier));font-size:calc(1rem*var(--ifm-breadcrumb-size-multiplier));padding:calc(var(--ifm-breadcrumb-padding-vertical)*var(--ifm-breadcrumb-size-multiplier)) calc(var(--ifm-breadcrumb-padding-horizontal)*var(--ifm-breadcrumb-size-multiplier));-webkit-transition-duration:var(--ifm-transition-fast);-moz-transition-duration:var(--ifm-transition-fast);-o-transition-duration:var(--ifm-transition-fast);transition-duration:var(--ifm-transition-fast);-webkit-transition-property:background,color;-o-transition-property:background,color;-moz-transition-property:background,color;transition-property:background,color;-webkit-transition-timing-function:var(--ifm-transition-timing-default);-moz-transition-timing-function:var(--ifm-transition-timing-default);-o-transition-timing-function:var(--ifm-transition-timing-default);transition-timing-function:var(--ifm-transition-timing-default)}.breadcrumbs__link:link:hover,.breadcrumbs__link:visited:hover,area[href].breadcrumbs__link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs__link:-moz-any-link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs__link:-webkit-any-link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs__link:any-link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs--sm{--ifm-breadcrumb-size-multiplier:0.8}.breadcrumbs--lg{--ifm-breadcrumb-size-multiplier:1.2}.button{background-color:var(--ifm-button-background-color);border:var(--ifm-button-border-width) solid var(--ifm-button-border-color);border-radius:var(--ifm-button-border-radius);cursor:pointer;font-size:-webkit-calc(0.875rem*var(--ifm-button-size-multiplier));font-size:-moz-calc(0.875rem*var(--ifm-button-size-multiplier));font-size:calc(.875rem*var(--ifm-button-size-multiplier));font-weight:var(--ifm-button-font-weight);line-height:1.5;padding:calc(var(--ifm-button-padding-vertical)*var(--ifm-button-size-multiplier)) calc(var(--ifm-button-padding-horizontal)*var(--ifm-button-size-multiplier));text-align:center;-webkit-transition-duration:var(--ifm-button-transition-duration);-moz-transition-duration:var(--ifm-button-transition-duration);-o-transition-duration:var(--ifm-button-transition-duration);transition-duration:var(--ifm-button-transition-duration);-webkit-transition-property:color,background,border-color;-o-transition-property:color,background,border-color;-moz-transition-property:color,background,border-color;transition-property:color,background,border-color;-webkit-transition-timing-function:var(--ifm-transition-timing-default);-moz-transition-timing-function:var(--ifm-transition-timing-default);-o-transition-timing-function:var(--ifm-transition-timing-default);transition-timing-function:var(--ifm-transition-timing-default);-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;white-space:nowrap}.button,.button:hover{color:var(--ifm-button-color)}.button--outline{--ifm-button-color:var(--ifm-button-border-color)}.button--outline:hover{--ifm-button-background-color:var(--ifm-button-border-color)}.button--link{--ifm-button-border-color:transparent;color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}.button--link.button--active,.button--link:active,.button--link:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button.disabled,.button:disabled,.button[disabled]{opacity:.65;pointer-events:none}.button--sm{--ifm-button-size-multiplier:0.8}.button--lg{--ifm-button-size-multiplier:1.35}.button--block{display:block;width:100%}.button.button--secondary{color:var(--ifm-color-gray-900)}:where(.button--primary){--ifm-button-background-color:var(--ifm-color-primary);--ifm-button-border-color:var(--ifm-color-primary)}:where(.button--primary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-primary-dark);--ifm-button-border-color:var(--ifm-color-primary-dark)}.button--primary.button--active,.button--primary:active{--ifm-button-background-color:var(--ifm-color-primary-darker);--ifm-button-border-color:var(--ifm-color-primary-darker)}:where(.button--secondary){--ifm-button-background-color:var(--ifm-color-secondary);--ifm-button-border-color:var(--ifm-color-secondary)}:where(.button--secondary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-secondary-dark);--ifm-button-border-color:var(--ifm-color-secondary-dark)}.button--secondary.button--active,.button--secondary:active{--ifm-button-background-color:var(--ifm-color-secondary-darker);--ifm-button-border-color:var(--ifm-color-secondary-darker)}:where(.button--success){--ifm-button-background-color:var(--ifm-color-success);--ifm-button-border-color:var(--ifm-color-success)}:where(.button--success):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-success-dark);--ifm-button-border-color:var(--ifm-color-success-dark)}.button--success.button--active,.button--success:active{--ifm-button-background-color:var(--ifm-color-success-darker);--ifm-button-border-color:var(--ifm-color-success-darker)}:where(.button--info){--ifm-button-background-color:var(--ifm-color-info);--ifm-button-border-color:var(--ifm-color-info)}:where(.button--info):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-info-dark);--ifm-button-border-color:var(--ifm-color-info-dark)}.button--info.button--active,.button--info:active{--ifm-button-background-color:var(--ifm-color-info-darker);--ifm-button-border-color:var(--ifm-color-info-darker)}:where(.button--warning){--ifm-button-background-color:var(--ifm-color-warning);--ifm-button-border-color:var(--ifm-color-warning)}:where(.button--warning):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-warning-dark);--ifm-button-border-color:var(--ifm-color-warning-dark)}.button--warning.button--active,.button--warning:active{--ifm-button-background-color:var(--ifm-color-warning-darker);--ifm-button-border-color:var(--ifm-color-warning-darker)}:where(.button--danger){--ifm-button-background-color:var(--ifm-color-danger);--ifm-button-border-color:var(--ifm-color-danger)}:where(.button--danger):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-danger-dark);--ifm-button-border-color:var(--ifm-color-danger-dark)}.button--danger.button--active,.button--danger:active{--ifm-button-background-color:var(--ifm-color-danger-darker);--ifm-button-border-color:var(--ifm-color-danger-darker)}.button-group{display:-webkit-inline-box;display:-webkit-inline-flex;display:-moz-inline-box;display:inline-flex;gap:var(--ifm-button-group-spacing)}.button-group>.button:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0}.button-group>.button:not(:last-child){border-bottom-right-radius:0;border-top-right-radius:0}.button-group--block{-webkit-box-pack:stretch;-moz-box-pack:stretch;display:flex;-webkit-justify-content:stretch;justify-content:stretch}.button-group--block>.button{-webkit-box-flex:1;-moz-box-flex:1;-webkit-flex-grow:1;flex-grow:1}.card{background-color:var(--ifm-card-background-color);border-radius:var(--ifm-card-border-radius);box-shadow:var(--ifm-global-shadow-lw);display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;-webkit-flex-direction:column;flex-direction:column;overflow:hidden}.card__image{padding-top:var(--ifm-card-vertical-spacing)}.card__image:first-child{padding-top:0}.card__body,.card__footer,.card__header{padding:var(--ifm-card-vertical-spacing) var(--ifm-card-horizontal-spacing)}.card__body:not(:last-child),.card__footer:not(:last-child),.card__header:not(:last-child){padding-bottom:0}.card__body>:last-child,.card__footer>:last-child,.card__header>:last-child{margin-bottom:0}.card__footer{margin-top:auto}.table-of-contents{font-size:.8rem;margin-bottom:0;padding:var(--ifm-toc-padding-vertical) 0}.table-of-contents,.table-of-contents ul{list-style:none;padding-left:var(--ifm-toc-padding-horizontal)}.table-of-contents li{margin:var(--ifm-toc-padding-vertical) var(--ifm-toc-padding-horizontal)}.table-of-contents__left-border{border-left:1px solid var(--ifm-toc-border-color)}.table-of-contents__link{color:var(--ifm-toc-link-color);display:block}.table-of-contents__link--active,.table-of-contents__link--active code,.table-of-contents__link:hover,.table-of-contents__link:hover code{color:var(--ifm-color-primary);text-decoration:none}.close{color:var(--ifm-color-black);float:right;font-size:1.5rem;font-weight:var(--ifm-font-weight-bold);line-height:1;opacity:.5;padding:1rem;-webkit-transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.dropdown__menu,.navbar-sidebar{-webkit-transition-duration:var(--ifm-transition-fast);-moz-transition-duration:var(--ifm-transition-fast);-o-transition-duration:var(--ifm-transition-fast)}.close:hover{opacity:.7}.close:focus,.theme-code-block-highlighted-line .codeLineNumber_Tfdd:before{opacity:.8}.dropdown{display:-webkit-inline-box;display:-webkit-inline-flex;display:-moz-inline-box;display:inline-flex;font-weight:var(--ifm-dropdown-font-weight);position:relative;vertical-align:top}.dropdown--hoverable:hover .dropdown__menu,.dropdown--show .dropdown__menu{opacity:1;pointer-events:all;-webkit-transform:translateY(-1px);-moz-transform:translateY(-1px);-o-transform:translateY(-1px);transform:translateY(-1px);visibility:visible}#nprogress,.dropdown__menu,.navbar__item.dropdown .navbar__link:not([href]){pointer-events:none}.dropdown--right .dropdown__menu{left:inherit;right:0}.dropdown--nocaret .navbar__link:after{content:none!important}.dropdown__menu{background-color:var(--ifm-dropdown-background-color);border-radius:var(--ifm-global-radius);box-shadow:var(--ifm-global-shadow-md);left:0;max-height:80vh;min-width:10rem;opacity:0;overflow-y:auto;padding:.5rem;position:absolute;top:-webkit-calc(100% - var(--ifm-navbar-item-padding-vertical) + .3rem);top:-moz-calc(100% - var(--ifm-navbar-item-padding-vertical) + .3rem);top:calc(100% - var(--ifm-navbar-item-padding-vertical) + .3rem);-webkit-transform:translateY(-.625rem);-moz-transform:translateY(-.625rem);-o-transform:translateY(-.625rem);transform:translateY(-.625rem);transition-duration:var(--ifm-transition-fast);-webkit-transition-property:opacity,visibility,-webkit-transform;-o-transition-property:opacity,visibility,-o-transform;-moz-transition-property:opacity,transform,visibility,-moz-transform;transition-property:opacity,transform,visibility,-webkit-transform,-moz-transform,-o-transform;-webkit-transition-timing-function:var(--ifm-transition-timing-default);-moz-transition-timing-function:var(--ifm-transition-timing-default);-o-transition-timing-function:var(--ifm-transition-timing-default);transition-timing-function:var(--ifm-transition-timing-default);visibility:hidden;z-index:var(--ifm-z-index-dropdown)}.dropdown__link{border-radius:.25rem;color:var(--ifm-dropdown-link-color);display:block;font-size:.875rem;margin-top:.2rem;padding:.25rem .5rem;white-space:nowrap}.hero,.menu__list-item-collapsible{display:-webkit-box;display:-webkit-flex;display:-moz-box}.dropdown__link--active,.dropdown__link:hover{background-color:var(--ifm-dropdown-hover-background-color);color:var(--ifm-dropdown-link-color);text-decoration:none}.dropdown__link--active,.dropdown__link--active:hover{--ifm-dropdown-link-color:var(--ifm-link-color)}.dropdown>.navbar__link:after{border-color:currentcolor transparent;border-style:solid;border-width:.4em .4em 0;content:"";margin-left:.3em;position:relative;top:2px;-webkit-transform:translateY(-50%);-moz-transform:translateY(-50%);-o-transform:translateY(-50%);transform:translateY(-50%)}.footer{background-color:var(--ifm-footer-background-color);color:var(--ifm-footer-color);padding:var(--ifm-footer-padding-vertical) var(--ifm-footer-padding-horizontal)}.footer--dark{--ifm-footer-background-color:#303846;--ifm-footer-color:var(--ifm-footer-link-color);--ifm-footer-link-color:var(--ifm-color-secondary);--ifm-footer-title-color:var(--ifm-color-white)}.footer__links{margin-bottom:1rem}.footer__link-item{color:var(--ifm-footer-link-color);line-height:2}.footer__link-item:hover{color:var(--ifm-footer-link-hover-color)}.footer__link-separator{margin:0 var(--ifm-footer-link-horizontal-spacing)}.footer__logo{margin-top:1rem;max-width:var(--ifm-footer-logo-max-width)}.footer__title{color:var(--ifm-footer-title-color);font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base);margin-bottom:var(--ifm-heading-margin-bottom)}.menu,.navbar__link{font-weight:var(--ifm-font-weight-semibold)}.docItemContainer_Djhp article>:first-child,.docItemContainer_Djhp header+*,.footer__item{margin-top:0}.admonitionContent_BuS1>:last-child,.collapsibleContent_i85q p:last-child,.details_lb9f>summary>p:last-child,.footer__items,.tabItem_Ymn6>:last-child{margin-bottom:0}.codeBlockStandalone_MEMb,[type=checkbox]{padding:0}.hero{-webkit-box-align:center;-moz-box-align:center;-webkit-align-items:center;align-items:center;background-color:var(--ifm-hero-background-color);color:var(--ifm-hero-text-color);display:flex;padding:4rem 2rem}.hero--primary{--ifm-hero-background-color:var(--ifm-color-primary);--ifm-hero-text-color:var(--ifm-font-color-base-inverse)}.hero--dark{--ifm-hero-background-color:#303846;--ifm-hero-text-color:var(--ifm-color-white)}.hero__title{font-size:3rem}.hero__subtitle{font-size:1.5rem}.menu__list{margin:0;padding-left:0}.menu__caret,.menu__link{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu__list .menu__list{-webkit-box-flex:0;-moz-box-flex:0;-webkit-flex:0 0 100%;flex:0 0 100%;margin-top:.25rem;padding-left:var(--ifm-menu-link-padding-horizontal)}.menu__list-item:not(:first-child){margin-top:.25rem}.menu__list-item--collapsed .menu__list{height:0;overflow:hidden}.menu__caret:before,.menu__link--sublist-caret:after{-webkit-filter:var(--ifm-menu-link-sublist-icon-filter);height:1.25rem;width:1.25rem;content:""}.details_lb9f[data-collapsed=false].isBrowser_bmU9>summary:before,.details_lb9f[open]:not(.isBrowser_bmU9)>summary:before,.menu__list-item--collapsed .menu__caret:before,.menu__list-item--collapsed .menu__link--sublist:after{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.menu__list-item-collapsible{border-radius:.25rem;display:flex;-webkit-flex-wrap:wrap;flex-wrap:wrap;position:relative;-webkit-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.menu__caret:hover,.menu__link:hover,.menu__list-item-collapsible--active,.menu__list-item-collapsible:hover{background:var(--ifm-menu-color-background-hover)}.menu__list-item-collapsible .menu__link--active,.menu__list-item-collapsible .menu__link:hover{background:none!important}.menu__caret,.menu__link{-webkit-box-align:center;-moz-box-align:center;-webkit-align-items:center;align-items:center;border-radius:.25rem;display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;-webkit-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.menu__link{-webkit-box-flex:1;-moz-box-flex:1;color:var(--ifm-menu-color);-webkit-flex:1;flex:1;line-height:1.25}.menu__link:hover{color:var(--ifm-menu-color);text-decoration:none;-webkit-transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.menu__link--sublist-caret:after{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;filter:var(--ifm-menu-link-sublist-icon-filter);margin-left:auto;min-width:1.25rem;-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg);-webkit-transition:-webkit-transform var(--ifm-transition-fast) linear;transition:-webkit-transform var(--ifm-transition-fast) linear;-o-transition:-o-transform var(--ifm-transition-fast) linear;-moz-transition:transform var(--ifm-transition-fast) linear,-moz-transform var(--ifm-transition-fast) linear;transition:transform var(--ifm-transition-fast) linear;transition:transform var(--ifm-transition-fast) linear,-webkit-transform var(--ifm-transition-fast) linear,-moz-transform var(--ifm-transition-fast) linear,-o-transform var(--ifm-transition-fast) linear}.menu__link--active,.menu__link--active:hover{color:var(--ifm-menu-color-active)}.navbar__brand,.navbar__link{color:var(--ifm-navbar-link-color)}.menu__link--active:not(.menu__link--sublist){background-color:var(--ifm-menu-color-background-active)}.menu__caret:before{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;filter:var(--ifm-menu-link-sublist-icon-filter);-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg);-webkit-transition:-webkit-transform var(--ifm-transition-fast) linear;transition:-webkit-transform var(--ifm-transition-fast) linear;-o-transition:-o-transform var(--ifm-transition-fast) linear;-moz-transition:transform var(--ifm-transition-fast) linear,-moz-transform var(--ifm-transition-fast) linear;transition:transform var(--ifm-transition-fast) linear;transition:transform var(--ifm-transition-fast) linear,-webkit-transform var(--ifm-transition-fast) linear,-moz-transform var(--ifm-transition-fast) linear,-o-transform var(--ifm-transition-fast) linear}.navbar--dark,html[data-theme=dark]{--ifm-menu-link-sublist-icon-filter:invert(100%) sepia(94%) saturate(17%) hue-rotate(223deg) brightness(104%) contrast(98%)}.navbar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-navbar-shadow);height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar,.navbar>.container,.navbar>.container-fluid{display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex}.navbar--fixed-top{position:-webkit-sticky;position:sticky;top:0;z-index:var(--ifm-z-index-fixed)}.navbar-sidebar,.navbar-sidebar__backdrop{bottom:0;opacity:0;position:fixed;left:0;top:0;visibility:hidden}.navbar__inner{-webkit-box-pack:justify;-moz-box-pack:justify;-webkit-flex-wrap:wrap;flex-wrap:wrap;-webkit-justify-content:space-between;justify-content:space-between;width:100%}.navbar__brand,.navbar__inner{display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex}.navbar__brand{-webkit-box-align:center;-moz-box-align:center;-webkit-align-items:center;align-items:center;margin-right:1rem;min-width:0}.navbar__brand:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.announcementBarContent_xLdY,.navbar__title{-webkit-box-flex:1;-moz-box-flex:1;-webkit-flex:1 1 auto;flex:1 1 auto}.navbar__toggle{display:none;margin-right:.5rem}.navbar__logo{-webkit-box-flex:0;-moz-box-flex:0;-webkit-flex:0 0 auto;flex:0 0 auto;height:2rem;margin-right:.5rem}.footer__icon-link svg,.navbar__icon:before{height:24px;width:24px}.navbar__items{-webkit-box-align:center;-moz-box-align:center;-webkit-box-flex:1;-moz-box-flex:1;-webkit-align-items:center;align-items:center;display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;-webkit-flex:1;flex:1;min-width:0}.navbar__items--center{-webkit-box-flex:0;-moz-box-flex:0;-webkit-flex:0 0 auto;flex:0 0 auto}.navbar__items--center .navbar__brand{margin:0}.navbar__items--center+.navbar__items--right{-webkit-box-flex:1;-moz-box-flex:1;-webkit-flex:1;flex:1}.navbar__items--right{-webkit-box-flex:0;-moz-box-flex:0;-webkit-box-pack:end;-moz-box-pack:end;-webkit-flex:0 0 auto;flex:0 0 auto;-webkit-justify-content:flex-end;justify-content:flex-end}.navbar__items--right>:last-child{padding-right:0}.navbar__item{display:inline-block;padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.navbar__link--active,.navbar__link:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.navbar--dark,.navbar--primary{--ifm-menu-color:var(--ifm-color-gray-300);--ifm-navbar-link-color:var(--ifm-color-gray-100);--ifm-navbar-search-input-background-color:hsla(0,0%,100%,.1);--ifm-navbar-search-input-placeholder-color:hsla(0,0%,100%,.5);color:var(--ifm-color-white)}.navbar--dark{--ifm-navbar-background-color:#242526;--ifm-menu-color-background-active:hsla(0,0%,100%,.05);--ifm-navbar-search-input-color:var(--ifm-color-white)}.navbar--primary{--ifm-navbar-background-color:var(--ifm-color-primary);--ifm-navbar-link-hover-color:var(--ifm-color-white);--ifm-menu-color-active:var(--ifm-color-white);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-500)}.navbar__search-input{-webkit-appearance:none;-moz-appearance:none;appearance:none;background:var(--ifm-navbar-search-input-background-color) var(--ifm-navbar-search-input-icon) no-repeat .75rem center/1rem 1rem;border:none;border-radius:2rem;color:var(--ifm-navbar-search-input-color);cursor:text;display:inline-block;font-size:.9rem;height:2rem;padding:0 .5rem 0 2.25rem;width:12.5rem}.navbar__search-input::-moz-placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar__search-input::-webkit-input-placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar__search-input:-moz-placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar__search-input::-ms-input-placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar__search-input::placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar-sidebar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-global-shadow-md);-webkit-transform:translate3d(-100%,0,0);-moz-transform:translate3d(-100%,0,0);transform:translate3d(-100%,0,0);transition-duration:var(--ifm-transition-fast);-webkit-transition-property:opacity,visibility,-webkit-transform;-o-transition-property:opacity,visibility,-o-transform;-moz-transition-property:opacity,visibility,transform,-moz-transform;transition-property:opacity,visibility,transform,-webkit-transform,-moz-transform,-o-transform;-webkit-transition-timing-function:ease-in-out;-moz-transition-timing-function:ease-in-out;-o-transition-timing-function:ease-in-out;transition-timing-function:ease-in-out;width:var(--ifm-navbar-sidebar-width)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar--show .navbar-sidebar__backdrop{opacity:1;visibility:visible}.navbar-sidebar--show .navbar-sidebar{-webkit-transform:translateZ(0);-moz-transform:translateZ(0);transform:translateZ(0)}.navbar-sidebar__backdrop{background-color:rgba(0,0,0,.6);right:0;-webkit-transition-duration:var(--ifm-transition-fast);-moz-transition-duration:var(--ifm-transition-fast);-o-transition-duration:var(--ifm-transition-fast);transition-duration:var(--ifm-transition-fast);-webkit-transition-property:opacity,visibility;-o-transition-property:opacity,visibility;-moz-transition-property:opacity,visibility;transition-property:opacity,visibility;-webkit-transition-timing-function:ease-in-out;-moz-transition-timing-function:ease-in-out;-o-transition-timing-function:ease-in-out;transition-timing-function:ease-in-out}.navbar-sidebar__brand{-webkit-box-align:center;-moz-box-align:center;-webkit-box-flex:1;-moz-box-flex:1;-webkit-align-items:center;align-items:center;box-shadow:var(--ifm-navbar-shadow);-webkit-flex:1;flex:1;height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar-sidebar__brand,.navbar-sidebar__items{display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex}.navbar-sidebar__items{height:-webkit-calc(100% - var(--ifm-navbar-height));height:-moz-calc(100% - var(--ifm-navbar-height));height:calc(100% - var(--ifm-navbar-height));-webkit-transform:translateZ(0);-moz-transform:translateZ(0);transform:translateZ(0);-webkit-transition:-webkit-transform var(--ifm-transition-fast) ease-in-out;transition:-webkit-transform var(--ifm-transition-fast) ease-in-out;-o-transition:-o-transform var(--ifm-transition-fast) ease-in-out;-moz-transition:transform var(--ifm-transition-fast) ease-in-out,-moz-transform var(--ifm-transition-fast) ease-in-out;transition:transform var(--ifm-transition-fast) ease-in-out;transition:transform var(--ifm-transition-fast) ease-in-out,-webkit-transform var(--ifm-transition-fast) ease-in-out,-moz-transform var(--ifm-transition-fast) ease-in-out,-o-transform var(--ifm-transition-fast) ease-in-out}.navbar-sidebar__items--show-secondary{-webkit-transform:translate3d(-webkit-calc((var(--ifm-navbar-sidebar-width))*-1),0,0);-moz-transform:translate3d(-moz-calc((var(--ifm-navbar-sidebar-width))*-1),0,0);transform:translate3d(calc((var(--ifm-navbar-sidebar-width))*-1),0,0)}.navbar-sidebar__item{-webkit-flex-shrink:0;flex-shrink:0;padding:.5rem;width:-webkit-calc(var(--ifm-navbar-sidebar-width));width:-moz-calc(var(--ifm-navbar-sidebar-width));width:calc(var(--ifm-navbar-sidebar-width))}.navbar-sidebar__back{background:var(--ifm-menu-color-background-active);font-size:15px;font-weight:var(--ifm-button-font-weight);margin:0 0 .2rem -.5rem;padding:.6rem 1.5rem;position:relative;text-align:left;top:-.5rem;width:-webkit-calc(100% + 1rem);width:-moz-calc(100% + 1rem);width:calc(100% + 1rem)}.navbar-sidebar__close{margin-left:auto}.docMainContainer_TBSr,.docRoot_UBD9,.docsWrapper_hBAB,.navbar-sidebar__close,.pagination{display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex}.pagination{-moz-column-gap:var(--ifm-pagination-page-spacing);-webkit-column-gap:var(--ifm-pagination-page-spacing);column-gap:var(--ifm-pagination-page-spacing);font-size:var(--ifm-pagination-font-size);padding-left:0}.pagination--sm{--ifm-pagination-font-size:0.8rem;--ifm-pagination-padding-horizontal:0.8rem;--ifm-pagination-padding-vertical:0.2rem}.pagination--lg{--ifm-pagination-font-size:1.2rem;--ifm-pagination-padding-horizontal:1.2rem;--ifm-pagination-padding-vertical:0.3rem}.pagination__item{display:-webkit-inline-box;display:-webkit-inline-flex;display:-moz-inline-box;display:inline-flex}.pagination__item>span{padding:var(--ifm-pagination-padding-vertical)}.pagination__item--active .pagination__link{color:var(--ifm-pagination-color-active)}.pagination__item--active .pagination__link,.pagination__item:not(.pagination__item--active):hover .pagination__link{background:var(--ifm-pagination-item-active-background)}.pagination__item--disabled,.pagination__item[disabled]{opacity:.25;pointer-events:none}.pagination__link{border-radius:var(--ifm-pagination-border-radius);color:var(--ifm-font-color-base);display:inline-block;padding:var(--ifm-pagination-padding-vertical) var(--ifm-pagination-padding-horizontal);-webkit-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination__link:hover{text-decoration:none}.pagination-nav{grid-gap:var(--ifm-spacing-horizontal);display:grid;gap:var(--ifm-spacing-horizontal);grid-template-columns:repeat(2,1fr)}.pagination-nav__link{border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-pagination-nav-border-radius);display:block;height:100%;line-height:var(--ifm-heading-line-height);padding:var(--ifm-global-spacing);-webkit-transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination-nav__link:hover{border-color:var(--ifm-pagination-nav-color-hover);text-decoration:none}.pagination-nav__link--next{grid-column:2/3;text-align:right}.pagination-nav__label{font-size:var(--ifm-h4-font-size);font-weight:var(--ifm-heading-font-weight);word-break:break-word}.pagination-nav__link--prev .pagination-nav__label:before{content:"« "}.pagination-nav__link--next .pagination-nav__label:after{content:" »"}.pagination-nav__sublabel{color:var(--ifm-color-content-secondary);font-size:var(--ifm-h5-font-size);font-weight:var(--ifm-font-weight-semibold);margin-bottom:.25rem}.pills__item,.tabs{font-weight:var(--ifm-font-weight-bold)}.pills{display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;gap:var(--ifm-pills-spacing);padding-left:0}.pills__item{border-radius:.5rem;cursor:pointer;display:inline-block;padding:.25rem 1rem;-webkit-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs,:not(.containsTaskList_mC6p>li)>.containsTaskList_mC6p{padding-left:0}.pills__item--active{color:var(--ifm-pills-color-active)}.pills__item--active,.pills__item:not(.pills__item--active):hover{background:var(--ifm-pills-color-background-active)}.pills--block{-webkit-box-pack:stretch;-moz-box-pack:stretch;-webkit-justify-content:stretch;justify-content:stretch}.pills--block .pills__item{-webkit-box-flex:1;-moz-box-flex:1;-webkit-flex-grow:1;flex-grow:1;text-align:center}.tabs{color:var(--ifm-tabs-color);display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;margin-bottom:0;overflow-x:auto}.tabs__item{border-bottom:3px solid transparent;border-radius:var(--ifm-global-radius);cursor:pointer;display:-webkit-inline-box;display:-webkit-inline-flex;display:-moz-inline-box;display:inline-flex;padding:var(--ifm-tabs-padding-vertical) var(--ifm-tabs-padding-horizontal);-webkit-transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs__item--active{border-bottom-color:var(--ifm-tabs-color-active-border);border-bottom-left-radius:0;border-bottom-right-radius:0;color:var(--ifm-tabs-color-active)}.tabs__item:hover{background-color:var(--ifm-hover-overlay)}.tabs--block{-webkit-box-pack:stretch;-moz-box-pack:stretch;-webkit-justify-content:stretch;justify-content:stretch}.tabs--block .tabs__item{-webkit-box-flex:1;-moz-box-flex:1;-webkit-box-pack:center;-moz-box-pack:center;-webkit-flex-grow:1;flex-grow:1;-webkit-justify-content:center;justify-content:center}html[data-theme=dark]{--ifm-color-scheme:dark;--ifm-color-emphasis-0:var(--ifm-color-gray-1000);--ifm-color-emphasis-100:var(--ifm-color-gray-900);--ifm-color-emphasis-200:var(--ifm-color-gray-800);--ifm-color-emphasis-300:var(--ifm-color-gray-700);--ifm-color-emphasis-400:var(--ifm-color-gray-600);--ifm-color-emphasis-600:var(--ifm-color-gray-400);--ifm-color-emphasis-700:var(--ifm-color-gray-300);--ifm-color-emphasis-800:var(--ifm-color-gray-200);--ifm-color-emphasis-900:var(--ifm-color-gray-100);--ifm-color-emphasis-1000:var(--ifm-color-gray-0);--ifm-background-color:#1b1b1d;--ifm-background-surface-color:#242526;--ifm-hover-overlay:hsla(0,0%,100%,.05);--ifm-color-content:#e3e3e3;--ifm-color-content-secondary:#fff;--ifm-breadcrumb-separator-filter:invert(64%) sepia(11%) saturate(0%) hue-rotate(149deg) brightness(99%) contrast(95%);--ifm-code-background:hsla(0,0%,100%,.1);--ifm-scrollbar-track-background-color:#444;--ifm-scrollbar-thumb-background-color:#686868;--ifm-scrollbar-thumb-hover-background-color:#7a7a7a;--ifm-table-stripe-background:hsla(0,0%,100%,.07);--ifm-toc-border-color:var(--ifm-color-emphasis-200);--ifm-color-primary-contrast-background:#102445;--ifm-color-primary-contrast-foreground:#ebf2fc;--ifm-color-secondary-contrast-background:#474748;--ifm-color-secondary-contrast-foreground:#fdfdfe;--ifm-color-success-contrast-background:#003100;--ifm-color-success-contrast-foreground:#e6f6e6;--ifm-color-info-contrast-background:#193c47;--ifm-color-info-contrast-foreground:#eef9fd;--ifm-color-warning-contrast-background:#4d3800;--ifm-color-warning-contrast-foreground:#fff8e6;--ifm-color-danger-contrast-background:#4b1113;--ifm-color-danger-contrast-foreground:#ffebec}#nprogress .bar{background:var(--docusaurus-progress-bar-color);height:2px;left:0;position:fixed;top:0;width:100%;z-index:1031}#nprogress .peg{box-shadow:0 0 10px var(--docusaurus-progress-bar-color),0 0 5px var(--docusaurus-progress-bar-color);height:100%;opacity:1;position:absolute;right:0;-webkit-transform:rotate(3deg) translateY(-4px);-moz-transform:rotate(3deg) translateY(-4px);-o-transform:rotate(3deg) translateY(-4px);transform:rotate(3deg) translateY(-4px);width:100px}.footer__copyright-container{-webkit-box-pack:center;-moz-box-pack:center;-webkit-flex-direction:column;flex-direction:column;-webkit-justify-content:center;justify-content:center}.footer__copyright-container,.footer__icon-container{-webkit-box-align:center;-moz-box-align:center;-webkit-align-items:center;align-items:center;display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;width:100%}.footer__icon-container{-webkit-box-orient:horizontal;-moz-box-orient:horizontal;-webkit-box-pack:start;-moz-box-pack:start;-webkit-flex-direction:row;flex-direction:row;-webkit-justify-content:flex-start;justify-content:flex-start}.footer__icon-link{display:inline-block;padding:0 1rem 0 0}.footer__icon-link:hover svg path{fill:var(--agl-primary-color-dark-500)}.footer__icon-link svg path{fill:var(--agl-text-color-dark);-webkit-transition:fill var(--ifm-transition-fast) ease-in-out;-o-transition:fill var(--ifm-transition-fast) ease-in-out;-moz-transition:fill var(--ifm-transition-fast) ease-in-out;transition:fill var(--ifm-transition-fast) ease-in-out}.footer__text{color:var(--agl-text-color-dark);margin:0}.footer__text--link,.footer__text--link:hover{color:var(--agl-primary-color-dark-500)}[data-theme=dark]{--ifm-color-primary:var(--agl-primary-color-dark-500);--ifm-color-primary-dark:var(--agl-primary-color-dark-600);--ifm-color-primary-darker:var(--agl-primary-color-dark-700);--ifm-color-primary-darkest:var(--agl-primary-color-dark-800);--ifm-color-primary-light:var(--agl-primary-color-dark-400);--ifm-color-primary-lighter:var(--agl-primary-color-dark-300);--ifm-color-primary-lightest:var(--agl-primary-color-dark-200)}.navbar__icon:before{content:"";display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex}.navbar__icon:hover{opacity:.6}.navbar__icon--github{background:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath 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}.navbar__icon--npm{background:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 32 32' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M0 10v11h9v2h7v-2h16V10H0zm1.777 1.777h7.114v7.668H7.11v-5.888H5.334v5.888H1.777v-7.668zm8.891 0H17.779v7.666h-3.556v1.78h-3.555v-9.446zm8.889 0H30.225v7.668h-1.78v-5.888h-1.777v5.888h-1.777v-5.888h-1.78v5.888h-3.554v-7.668zm-5.334 1.78v4.111H16v-4.111h-1.777z'/%3E%3C/svg%3E") no-repeat}html[data-theme=dark] .navbar__icon--github{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}html[data-theme=dark] .navbar__icon--npm{background:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 32 32' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='%23fff' d='M0 10v11h9v2h7v-2h16V10H0zm1.777 1.777h7.114v7.668H7.11v-5.888H5.334v5.888H1.777v-7.668zm8.891 0H17.779v7.666h-3.556v1.78h-3.555v-9.446zm8.889 0H30.225v7.668h-1.78v-5.888h-1.777v5.888h-1.777v-5.888h-1.78v5.888h-3.554v-7.668zm-5.334 1.78v4.111H16v-4.111h-1.777z'/%3E%3C/svg%3E") no-repeat}body:not(.navigation-with-keyboard) :not(input):focus{outline:0}#__docusaurus-base-url-issue-banner-container,.docSidebarContainer_YfHR,.sidebarLogo_isFc,.themedComponent_mlkZ,[data-theme=dark] .lightToggleIcon_pyhR,[data-theme=light] .darkToggleIcon_wfgR,html[data-announcement-bar-initially-dismissed=true] .announcementBar_mb4j{display:none}.announcementBar_mb4j,.toggleButton_gllP{-webkit-box-align:center;display:-webkit-box;display:-webkit-flex;display:-moz-box}.skipToContent_fXgn{background-color:var(--ifm-background-surface-color);color:var(--ifm-color-emphasis-900);left:100%;padding:calc(var(--ifm-global-spacing)/2) var(--ifm-global-spacing);position:fixed;top:1rem;z-index:-webkit-calc(var(--ifm-z-index-fixed) + 1);z-index:-moz-calc(var(--ifm-z-index-fixed) + 1);z-index:calc(var(--ifm-z-index-fixed) + 1)}.skipToContent_fXgn:focus{box-shadow:var(--ifm-global-shadow-md);left:1rem}.closeButton_CVFx{line-height:0;padding:0}.content_knG7{font-size:85%;padding:5px 0;text-align:center}.content_knG7 a{color:inherit;text-decoration:underline}.announcementBar_mb4j{-moz-box-align:center;-webkit-align-items:center;align-items:center;background-color:var(--ifm-color-white);border-bottom:1px solid var(--ifm-color-emphasis-100);color:var(--ifm-color-black);display:flex;height:var(--docusaurus-announcement-bar-height)}.announcementBarPlaceholder_vyr4{-webkit-box-flex:0;-moz-box-flex:0;-webkit-flex:0 0 10px;flex:0 0 10px}.announcementBarClose_gvF7{-webkit-box-flex:0;-moz-box-flex:0;-webkit-align-self:stretch;align-self:stretch;-webkit-flex:0 0 30px;flex:0 0 30px}.toggle_vylO{height:2rem;width:2rem}.toggleButton_gllP{-moz-box-align:center;-webkit-box-pack:center;-moz-box-pack:center;-webkit-align-items:center;align-items:center;border-radius:50%;display:flex;height:100%;-webkit-justify-content:center;justify-content:center;-webkit-transition:background var(--ifm-transition-fast);-o-transition:background var(--ifm-transition-fast);-moz-transition:background var(--ifm-transition-fast);transition:background var(--ifm-transition-fast);width:100%}.toggleButton_gllP:hover{background:var(--ifm-color-emphasis-200)}.toggleButtonDisabled_aARS{cursor:not-allowed}.darkNavbarColorModeToggle_X3D1:hover{background:var(--ifm-color-gray-800)}.tableOfContentsInline_prmo ul{font-size:medium;list-style-type:disc;padding-top:0}.iconEdit_Z9Sw{margin-right:.3em;vertical-align:sub}.tag_zVej{border:1px solid var(--docusaurus-tag-list-border);-webkit-transition:border var(--ifm-transition-fast);-o-transition:border var(--ifm-transition-fast);-moz-transition:border var(--ifm-transition-fast);transition:border var(--ifm-transition-fast)}.tag_zVej:hover{--docusaurus-tag-list-border:var(--ifm-link-color);text-decoration:none}.tagRegular_sFm0{border-radius:var(--ifm-global-radius);font-size:90%;padding:.2rem .5rem .3rem}.tagWithCount_h2kH{-webkit-box-align:center;-moz-box-align:center;-webkit-align-items:center;align-items:center;border-left:0;display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;padding:0 .5rem 0 1rem;position:relative}.tagWithCount_h2kH:after,.tagWithCount_h2kH:before{border:1px solid var(--docusaurus-tag-list-border);content:"";position:absolute;top:50%;-webkit-transition:inherit;-o-transition:inherit;-moz-transition:inherit;transition:inherit}.tagWithCount_h2kH:before{border-bottom:0;border-right:0;height:1.18rem;right:100%;-webkit-transform:translate(50%,-50%) rotate(-45deg);-moz-transform:translate(50%,-50%) rotate(-45deg);-o-transform:translate(50%,-50%) rotate(-45deg);transform:translate(50%,-50%) rotate(-45deg);width:1.18rem}.tagWithCount_h2kH:after{border-radius:50%;height:.5rem;left:0;-webkit-transform:translateY(-50%);-moz-transform:translateY(-50%);-o-transform:translateY(-50%);transform:translateY(-50%);width:.5rem}.tagWithCount_h2kH span{background:var(--ifm-color-secondary);border-radius:var(--ifm-global-radius);color:var(--ifm-color-black);font-size:.7rem;line-height:1.2;margin-left:.3rem;padding:.1rem .4rem}.tags_jXut{display:inline}.tag_QGVx{display:inline-block;margin:0 .4rem .5rem 0}.lastUpdated_vwxv{font-size:smaller;font-style:italic;margin-top:.2rem}.tocCollapsibleButton_TO0P{-webkit-box-pack:justify;-moz-box-pack:justify;-webkit-box-align:center;-moz-box-align:center;-webkit-align-items:center;align-items:center;display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;font-size:inherit;-webkit-justify-content:space-between;justify-content:space-between;padding:.4rem .8rem;width:100%}.tocCollapsibleButton_TO0P:after{background:var(--ifm-menu-link-sublist-icon) 50% 50%/2rem 2rem no-repeat;content:"";-webkit-filter:var(--ifm-menu-link-sublist-icon-filter);filter:var(--ifm-menu-link-sublist-icon-filter);height:1.25rem;-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg);-webkit-transition:-webkit-transform var(--ifm-transition-fast);transition:-webkit-transform var(--ifm-transition-fast);-o-transition:-o-transform var(--ifm-transition-fast);-moz-transition:transform var(--ifm-transition-fast),-moz-transform var(--ifm-transition-fast);transition:transform var(--ifm-transition-fast);transition:transform var(--ifm-transition-fast),-webkit-transform var(--ifm-transition-fast),-moz-transform var(--ifm-transition-fast),-o-transform var(--ifm-transition-fast);width:1.25rem}.tocCollapsibleButtonExpanded_MG3E:after,.tocCollapsibleExpanded_sAul{-webkit-transform:none;-moz-transform:none;-o-transform:none;transform:none}.tocCollapsible_ETCw{background-color:var(--ifm-menu-color-background-active);border-radius:var(--ifm-global-radius);margin:1rem 0}.tocCollapsibleContent_vkbj>ul{border-left:none;border-top:1px solid var(--ifm-color-emphasis-300);font-size:15px;padding:.2rem 0}.tocCollapsibleContent_vkbj ul li{margin:.4rem .8rem}.tocCollapsibleContent_vkbj a{display:block}.tableOfContents_bqdL{max-height:-webkit-calc(100vh - var(--ifm-navbar-height) - 2rem);max-height:-moz-calc(100vh - var(--ifm-navbar-height) - 2rem);max-height:calc(100vh - var(--ifm-navbar-height) - 2rem);overflow-y:auto;position:-webkit-sticky;position:sticky;top:-webkit-calc(var(--ifm-navbar-height) + 1rem);top:-moz-calc(var(--ifm-navbar-height) + 1rem);top:calc(var(--ifm-navbar-height) + 1rem)}.backToTopButton_sjWU{background-color:var(--ifm-color-emphasis-200);border-radius:50%;bottom:1.3rem;box-shadow:var(--ifm-global-shadow-lw);height:3rem;opacity:0;position:fixed;right:1.3rem;-webkit-transform:scale(0);-moz-transform:scale(0);-o-transform:scale(0);transform:scale(0);-webkit-transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);visibility:hidden;width:3rem;z-index:-webkit-calc(var(--ifm-z-index-fixed) - 1);z-index:-moz-calc(var(--ifm-z-index-fixed) - 1);z-index:calc(var(--ifm-z-index-fixed) - 1)}.backToTopButton_sjWU:after{background-color:var(--ifm-color-emphasis-1000);content:" ";display:inline-block;height:100%;-webkit-mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;width:100%}.backToTopButtonShow_xfvO{opacity:1;-webkit-transform:scale(1);-moz-transform:scale(1);-o-transform:scale(1);transform:scale(1);visibility:visible}[data-theme=dark] .themedComponent--dark_xIcU,[data-theme=light] .themedComponent--light_NVdE,html:not([data-theme]) .themedComponent--light_NVdE{display:initial}[data-theme=dark]:root{--docusaurus-collapse-button-bg:hsla(0,0%,100%,.05);--docusaurus-collapse-button-bg-hover:hsla(0,0%,100%,.1)}.collapseSidebarButton_PEFL{display:none;margin:0}#__docusaurus,.mainWrapper_z2l0{-webkit-box-orient:vertical;-webkit-box-direction:normal;-moz-box-orient:vertical;-moz-box-direction:normal;display:-webkit-box;display:-webkit-flex;display:-moz-box}.iconExternalLink_nPIU{margin-left:.3rem}.dropdownNavbarItemMobile_S0Fm{cursor:pointer}.iconLanguage_nlXk{margin-right:5px;vertical-align:text-bottom}@supports selector(:has(*)){.navbarSearchContainer_Bca1:not(:has(>*)){display:none}}.navbarHideable_m1mJ{-webkit-transition:-webkit-transform var(--ifm-transition-fast) ease;transition:-webkit-transform var(--ifm-transition-fast) ease;-o-transition:-o-transform var(--ifm-transition-fast) ease;-moz-transition:transform var(--ifm-transition-fast) ease,-moz-transform var(--ifm-transition-fast) ease;transition:transform var(--ifm-transition-fast) ease;transition:transform var(--ifm-transition-fast) ease,-webkit-transform var(--ifm-transition-fast) ease,-moz-transform var(--ifm-transition-fast) ease,-o-transform var(--ifm-transition-fast) ease}.navbarHidden_jGov{-webkit-transform:translate3d(0,-webkit-calc(-100% - 2px),0);-moz-transform:translate3d(0,-moz-calc(-100% - 2px),0);transform:translate3d(0,calc(-100% - 2px),0)}.errorBoundaryError_a6uf{color:red;white-space:pre-wrap}.errorBoundaryFallback_VBag{color:red;padding:.55rem}.buttonGroup__atx button,.codeBlockContainer_Ckt0{background:var(--prism-background-color);color:var(--prism-color)}.footerLogoLink_BH7S{opacity:.5;-webkit-transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.footerLogoLink_BH7S:hover,.hash-link:focus,:hover>.hash-link{opacity:1}.docMainContainer_TBSr,.docRoot_UBD9{width:100%}.docsWrapper_hBAB{-webkit-box-flex:1;-moz-box-flex:1;-webkit-flex:1 0 auto;flex:1 0 auto}.anchorWithStickyNavbar_LWe7{scroll-margin-top:-webkit-calc(var(--ifm-navbar-height) + .5rem);scroll-margin-top:-moz-calc(var(--ifm-navbar-height) + .5rem);scroll-margin-top:calc(var(--ifm-navbar-height) + .5rem)}.anchorWithHideOnScrollNavbar_WYt5{scroll-margin-top:.5rem}.hash-link{opacity:0;padding-left:.5rem;-webkit-transition:opacity var(--ifm-transition-fast);-o-transition:opacity var(--ifm-transition-fast);-moz-transition:opacity var(--ifm-transition-fast);transition:opacity var(--ifm-transition-fast);-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.hash-link:before{content:"#"}.mainWrapper_z2l0{-webkit-box-flex:1;-moz-box-flex:1;display:flex;-webkit-flex:1 0 auto;flex:1 0 auto;-webkit-flex-direction:column;flex-direction:column}.docusaurus-mt-lg{margin-top:3rem}#__docusaurus{display:flex;-webkit-flex-direction:column;flex-direction:column;min-height:100%}.codeBlockContainer_Ckt0{border-radius:var(--ifm-code-border-radius);box-shadow:var(--ifm-global-shadow-lw);margin-bottom:var(--ifm-leading)}.codeBlockContent_biex{border-radius:inherit;direction:ltr;position:relative}.codeBlockTitle_Ktv7{border-bottom:1px solid var(--ifm-color-emphasis-300);border-top-left-radius:inherit;border-top-right-radius:inherit;font-size:var(--ifm-code-font-size);font-weight:500;padding:.75rem var(--ifm-pre-padding)}.codeBlock_bY9V{--ifm-pre-background:var(--prism-background-color);margin:0;padding:0}.codeBlockTitle_Ktv7+.codeBlockContent_biex .codeBlock_bY9V{border-top-left-radius:0;border-top-right-radius:0}.codeBlockLines_e6Vv{float:left;font:inherit;min-width:100%;padding:var(--ifm-pre-padding)}.codeBlockLinesWithNumbering_o6Pm{display:table;padding:var(--ifm-pre-padding) 0}.buttonGroup__atx{-webkit-column-gap:.2rem;-moz-column-gap:.2rem;column-gap:.2rem;position:absolute;right:-webkit-calc(var(--ifm-pre-padding)/2);right:-moz-calc(var(--ifm-pre-padding)/2);right:calc(var(--ifm-pre-padding)/2);top:-webkit-calc(var(--ifm-pre-padding)/2);top:-moz-calc(var(--ifm-pre-padding)/2);top:calc(var(--ifm-pre-padding)/2)}.buttonGroup__atx,.buttonGroup__atx button{display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex}.buttonGroup__atx button{-webkit-box-align:center;-moz-box-align:center;-webkit-align-items:center;align-items:center;border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-global-radius);line-height:0;opacity:0;padding:.4rem;-webkit-transition:opacity var(--ifm-transition-fast) ease-in-out;-o-transition:opacity var(--ifm-transition-fast) ease-in-out;-moz-transition:opacity var(--ifm-transition-fast) ease-in-out;transition:opacity var(--ifm-transition-fast) ease-in-out}.buttonGroup__atx button:focus-visible,.buttonGroup__atx button:hover{opacity:1!important}.theme-code-block:hover .buttonGroup__atx button{opacity:.4}:where(:root){--docusaurus-highlighted-code-line-bg:#484d5b}:where([data-theme=dark]){--docusaurus-highlighted-code-line-bg:#646464}.theme-code-block-highlighted-line{background-color:var(--docusaurus-highlighted-code-line-bg);display:block;margin:0 calc(var(--ifm-pre-padding)*-1);padding:0 var(--ifm-pre-padding)}.codeLine_lJS_{counter-increment:a;display:table-row}.codeLineNumber_Tfdd{background:var(--ifm-pre-background);display:table-cell;left:0;overflow-wrap:normal;padding:0 var(--ifm-pre-padding);position:-webkit-sticky;position:sticky;text-align:right;width:1%}.codeLineNumber_Tfdd:before{content:counter(a);opacity:.4}.codeLineContent_feaV{padding-right:var(--ifm-pre-padding)}.theme-code-block:hover .copyButtonCopied_obH4{opacity:1!important}.copyButtonIcons_eSgA{height:1.125rem;position:relative;width:1.125rem}.copyButtonIcon_y97N,.copyButtonSuccessIcon_LjdS{fill:currentColor;height:inherit;left:0;opacity:inherit;position:absolute;top:0;-webkit-transition:all var(--ifm-transition-fast) ease;-o-transition:all var(--ifm-transition-fast) ease;-moz-transition:all var(--ifm-transition-fast) ease;transition:all var(--ifm-transition-fast) ease;width:inherit}.copyButtonSuccessIcon_LjdS{color:#00d600;left:50%;opacity:0;top:50%;-webkit-transform:translate(-50%,-50%) scale(.33);-moz-transform:translate(-50%,-50%) scale(.33);-o-transform:translate(-50%,-50%) scale(.33);transform:translate(-50%,-50%) scale(.33)}.copyButtonCopied_obH4 .copyButtonIcon_y97N{opacity:0;-webkit-transform:scale(.33);-moz-transform:scale(.33);-o-transform:scale(.33);transform:scale(.33)}.copyButtonCopied_obH4 .copyButtonSuccessIcon_LjdS{opacity:1;-webkit-transform:translate(-50%,-50%) scale(1);-moz-transform:translate(-50%,-50%) scale(1);-o-transform:translate(-50%,-50%) scale(1);transform:translate(-50%,-50%) scale(1);-webkit-transition-delay:75ms;-moz-transition-delay:75ms;-o-transition-delay:75ms;transition-delay:75ms}.wordWrapButtonIcon_Bwma{height:1.2rem;width:1.2rem}.details_lb9f{--docusaurus-details-summary-arrow-size:0.38rem;--docusaurus-details-transition:transform 200ms ease;--docusaurus-details-decoration-color:grey}.details_lb9f>summary{cursor:pointer;padding-left:1rem;position:relative}.details_lb9f>summary::-webkit-details-marker{display:none}.details_lb9f>summary:before{border-color:transparent transparent transparent var(--docusaurus-details-decoration-color);border-style:solid;border-width:var(--docusaurus-details-summary-arrow-size);content:"";left:0;position:absolute;top:.45rem;-webkit-transform:rotate(0);-moz-transform:rotate(0);-o-transform:rotate(0);transform:rotate(0);-webkit-transform-origin:-webkit-calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;-moz-transform-origin:-moz-calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;-o-transform-origin:calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;transform-origin:calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;-webkit-transition:var(--docusaurus-details-transition);-o-transition:var(--docusaurus-details-transition);-moz-transition:var(--docusaurus-details-transition);transition:var(--docusaurus-details-transition)}.collapsibleContent_i85q{border-top:1px solid var(--docusaurus-details-decoration-color);margin-top:1rem;padding-top:1rem}.details_b_Ee{--docusaurus-details-decoration-color:var(--ifm-alert-border-color);--docusaurus-details-transition:transform var(--ifm-transition-fast) ease;border:1px solid var(--ifm-alert-border-color);margin:0 0 var(--ifm-spacing-vertical)}.img_ev3q{height:auto}.admonition_xJq3{margin-bottom:1em}.admonitionHeading_Gvgb{font:var(--ifm-heading-font-weight) var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family)}.admonitionHeading_Gvgb:not(:last-child){margin-bottom:.3rem}.admonitionHeading_Gvgb code{text-transform:none}.admonitionIcon_Rf37{display:inline-block;margin-right:.4em;vertical-align:middle}.admonitionIcon_Rf37 svg{fill:var(--ifm-alert-foreground-color);display:inline-block;height:1.6em;width:1.6em}.breadcrumbHomeIcon_YNFT{height:1.1rem;position:relative;top:1px;vertical-align:top;width:1.1rem}.breadcrumbsContainer_Z_bl{--ifm-breadcrumb-size-multiplier:0.8;margin-bottom:.8rem}@media (min-width:997px){.collapseSidebarButton_PEFL,.expandButton_TmdG{background-color:var(--docusaurus-collapse-button-bg)}:root{--docusaurus-announcement-bar-height:30px}.announcementBarClose_gvF7,.announcementBarPlaceholder_vyr4{-webkit-flex-basis:50px;flex-basis:50px}.lastUpdated_vwxv{text-align:right}.tocMobile_ITEo{display:none}.collapseSidebarButton_PEFL{border:1px solid var(--ifm-toc-border-color);border-radius:0;bottom:0;display:block!important;height:40px;position:-webkit-sticky;position:sticky}.collapseSidebarButtonIcon_kv0_{margin-top:4px;-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.expandButtonIcon_i1dp,[dir=rtl] .collapseSidebarButtonIcon_kv0_{-webkit-transform:rotate(0);-moz-transform:rotate(0);-o-transform:rotate(0);transform:rotate(0)}.collapseSidebarButton_PEFL:focus,.collapseSidebarButton_PEFL:hover,.expandButton_TmdG:focus,.expandButton_TmdG:hover{background-color:var(--docusaurus-collapse-button-bg-hover)}.navbarSearchContainer_Bca1{padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.menuHtmlItem_M9Kj{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu_SIkG{-webkit-box-flex:1;-moz-box-flex:1;-webkit-flex-grow:1;flex-grow:1;padding:.5rem}@supports (scrollbar-gutter:stable){.menu_SIkG{padding:.5rem 0 .5rem .5rem;scrollbar-gutter:stable}}.menuWithAnnouncementBar_GW3s{margin-bottom:var(--docusaurus-announcement-bar-height)}.sidebar_njMd{-webkit-box-orient:vertical;-webkit-box-direction:normal;-moz-box-orient:vertical;-moz-box-direction:normal;display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;-webkit-flex-direction:column;flex-direction:column;height:100%;padding-top:var(--ifm-navbar-height);width:var(--doc-sidebar-width)}.sidebarWithHideableNavbar_wUlq{padding-top:0}.sidebarHidden_VK0M{opacity:0;visibility:hidden}.sidebarLogo_isFc{-webkit-box-align:center;-moz-box-align:center;-webkit-align-items:center;align-items:center;color:inherit!important;display:-webkit-box!important;display:-webkit-flex!important;display:-moz-box!important;display:flex!important;margin:0 var(--ifm-navbar-padding-horizontal);max-height:var(--ifm-navbar-height);min-height:var(--ifm-navbar-height);text-decoration:none!important}.sidebarLogo_isFc img{height:2rem;margin-right:.5rem}.expandButton_TmdG{-webkit-box-align:center;-moz-box-align:center;-webkit-box-pack:center;-moz-box-pack:center;-webkit-align-items:center;align-items:center;display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;height:100%;-webkit-justify-content:center;justify-content:center;position:absolute;right:0;top:0;-webkit-transition:background-color var(--ifm-transition-fast) ease;-o-transition:background-color var(--ifm-transition-fast) ease;-moz-transition:background-color var(--ifm-transition-fast) ease;transition:background-color var(--ifm-transition-fast) ease;width:100%}[dir=rtl] .expandButtonIcon_i1dp{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.docSidebarContainer_YfHR{border-right:1px solid var(--ifm-toc-border-color);-webkit-clip-path:inset(0);clip-path:inset(0);display:block;margin-top:calc(var(--ifm-navbar-height)*-1);-webkit-transition:width var(--ifm-transition-fast) ease;-o-transition:width var(--ifm-transition-fast) ease;-moz-transition:width var(--ifm-transition-fast) ease;transition:width var(--ifm-transition-fast) ease;width:var(--doc-sidebar-width);will-change:width}.docSidebarContainerHidden_DPk8{cursor:pointer;width:var(--doc-sidebar-hidden-width)}.sidebarViewport_aRkj{height:100%;max-height:100vh;position:-webkit-sticky;position:sticky;top:0}.docMainContainer_TBSr{-webkit-box-flex:1;-moz-box-flex:1;-webkit-flex-grow:1;flex-grow:1;max-width:-webkit-calc(100% - var(--doc-sidebar-width));max-width:-moz-calc(100% - var(--doc-sidebar-width));max-width:calc(100% - var(--doc-sidebar-width))}.docMainContainerEnhanced_lQrH{max-width:-webkit-calc(100% - var(--doc-sidebar-hidden-width));max-width:-moz-calc(100% - var(--doc-sidebar-hidden-width));max-width:calc(100% - var(--doc-sidebar-hidden-width))}.docItemWrapperEnhanced_JWYK{max-width:-webkit-calc(var(--ifm-container-width) + var(--doc-sidebar-width))!important;max-width:-moz-calc(var(--ifm-container-width) + var(--doc-sidebar-width))!important;max-width:calc(var(--ifm-container-width) + var(--doc-sidebar-width))!important}.docItemCol_VOVn{max-width:75%!important}}@media (min-width:1440px){.container{max-width:var(--ifm-container-width-xl)}}@media (max-width:996px){.col{--ifm-col-width:100%;-webkit-flex-basis:var(--ifm-col-width);flex-basis:var(--ifm-col-width);margin-left:0}.footer{--ifm-footer-padding-horizontal:0}.colorModeToggle_DEke,.footer__link-separator,.navbar__item,.tableOfContents_bqdL{display:none}.footer__col{margin-bottom:calc(var(--ifm-spacing-vertical)*3)}.footer__link-item{display:block}.hero{padding-left:0;padding-right:0}.navbar>.container,.navbar>.container-fluid{padding:0}.navbar__toggle{display:inherit}.navbar__search-input{width:9rem}.pills--block,.tabs--block{-webkit-box-orient:vertical;-webkit-box-direction:normal;-moz-box-orient:vertical;-moz-box-direction:normal;-webkit-flex-direction:column;flex-direction:column}.docItemContainer_F8PC{padding:0 .3rem}.navbarSearchContainer_Bca1{position:absolute;right:var(--ifm-navbar-padding-horizontal)}}@media (max-width:576px){.markdown h1:first-child{--ifm-h1-font-size:2rem}.markdown>h2{--ifm-h2-font-size:1.5rem}.markdown>h3{--ifm-h3-font-size:1.25rem}}@media (hover:hover){.backToTopButton_sjWU:hover{background-color:var(--ifm-color-emphasis-300)}}@media (pointer:fine){.thin-scrollbar{scrollbar-width:thin}.thin-scrollbar::-webkit-scrollbar{height:var(--ifm-scrollbar-size);width:var(--ifm-scrollbar-size)}.thin-scrollbar::-webkit-scrollbar-track{background:var(--ifm-scrollbar-track-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb{background:var(--ifm-scrollbar-thumb-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb:hover{background:var(--ifm-scrollbar-thumb-hover-background-color)}}@media (prefers-reduced-motion:reduce){:root{--ifm-transition-fast:0ms;--ifm-transition-slow:0ms}}@media print{.announcementBar_mb4j,.footer,.menu,.navbar,.pagination-nav,.table-of-contents,.tocMobile_ITEo{display:none}.tabs{page-break-inside:avoid}.codeBlockLines_e6Vv{white-space:pre-wrap}} \ No newline at end of file +.col,.container{padding:0 var(--ifm-spacing-horizontal);width:100%}.markdown>h2,.markdown>h3,.markdown>h4,.markdown>h5,.markdown>h6{margin-bottom:calc(var(--ifm-heading-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown li,body{word-wrap:break-word}body,ol ol,ol ul,ul ol,ul ul{margin:0}pre,table{overflow:auto}blockquote,pre{margin:0 0 var(--ifm-spacing-vertical)}.button,code{vertical-align:middle}.button--outline.button--active,.button--outline:active,.button--outline:hover,:root{--ifm-button-color:var(--ifm-font-color-base-inverse)}.navbar--dark,:root{--ifm-navbar-link-hover-color:var(--ifm-color-primary)}.menu,.navbar-sidebar{overflow-x:hidden}:root,html[data-theme=dark]{--ifm-color-emphasis-500:var(--ifm-color-gray-500)}.avatar--vertical,.avatar__intro,.card,.footer__copyright-container{-webkit-box-orient:vertical;-moz-box-orient:vertical}.avatar--vertical,.avatar__intro,.card,.footer__copyright-container,.footer__icon-container{-webkit-box-direction:normal;-moz-box-direction:normal}.toggleButton_gllP,html{-webkit-tap-highlight-color:transparent}.clean-list,.containsTaskList_mC6p,.details_lb9f>summary,.dropdown__menu,.menu__list{list-style:none}:root{--ifm-color-scheme:light;--ifm-dark-value:10%;--ifm-darker-value:15%;--ifm-darkest-value:30%;--ifm-light-value:15%;--ifm-lighter-value:30%;--ifm-lightest-value:50%;--ifm-contrast-background-value:90%;--ifm-contrast-foreground-value:70%;--ifm-contrast-background-dark-value:70%;--ifm-contrast-foreground-dark-value:90%;--ifm-color-primary:#3578e5;--ifm-color-secondary:#ebedf0;--ifm-color-success:#00a400;--ifm-color-info:#54c7ec;--ifm-color-warning:#ffba00;--ifm-color-danger:#fa383e;--ifm-color-primary-dark:#306cce;--ifm-color-primary-darker:#2d66c3;--ifm-color-primary-darkest:#2554a0;--ifm-color-primary-light:#538ce9;--ifm-color-primary-lighter:#72a1ed;--ifm-color-primary-lightest:#9abcf2;--ifm-color-primary-contrast-background:#ebf2fc;--ifm-color-primary-contrast-foreground:#102445;--ifm-color-secondary-dark:#d4d5d8;--ifm-color-secondary-darker:#c8c9cc;--ifm-color-secondary-darkest:#a4a6a8;--ifm-color-secondary-light:#eef0f2;--ifm-color-secondary-lighter:#f1f2f5;--ifm-color-secondary-lightest:#f5f6f8;--ifm-color-secondary-contrast-background:#fdfdfe;--ifm-color-secondary-contrast-foreground:#474748;--ifm-color-success-dark:#009400;--ifm-color-success-darker:#008b00;--ifm-color-success-darkest:#007300;--ifm-color-success-light:#26b226;--ifm-color-success-lighter:#4dbf4d;--ifm-color-success-lightest:#80d280;--ifm-color-success-contrast-background:#e6f6e6;--ifm-color-success-contrast-foreground:#003100;--ifm-color-info-dark:#4cb3d4;--ifm-color-info-darker:#47a9c9;--ifm-color-info-darkest:#3b8ba5;--ifm-color-info-light:#6ecfef;--ifm-color-info-lighter:#87d8f2;--ifm-color-info-lightest:#aae3f6;--ifm-color-info-contrast-background:#eef9fd;--ifm-color-info-contrast-foreground:#193c47;--ifm-color-warning-dark:#e6a700;--ifm-color-warning-darker:#d99e00;--ifm-color-warning-darkest:#b38200;--ifm-color-warning-light:#ffc426;--ifm-color-warning-lighter:#ffcf4d;--ifm-color-warning-lightest:#ffdd80;--ifm-color-warning-contrast-background:#fff8e6;--ifm-color-warning-contrast-foreground:#4d3800;--ifm-color-danger-dark:#e13238;--ifm-color-danger-darker:#d53035;--ifm-color-danger-darkest:#af272b;--ifm-color-danger-light:#fb565b;--ifm-color-danger-lighter:#fb7478;--ifm-color-danger-lightest:#fd9c9f;--ifm-color-danger-contrast-background:#ffebec;--ifm-color-danger-contrast-foreground:#4b1113;--ifm-color-white:#fff;--ifm-color-black:#000;--ifm-color-gray-0:var(--ifm-color-white);--ifm-color-gray-100:#f5f6f7;--ifm-color-gray-200:#ebedf0;--ifm-color-gray-300:#dadde1;--ifm-color-gray-400:#ccd0d5;--ifm-color-gray-500:#bec3c9;--ifm-color-gray-600:#8d949e;--ifm-color-gray-700:#606770;--ifm-color-gray-800:#444950;--ifm-color-gray-900:#1c1e21;--ifm-color-gray-1000:var(--ifm-color-black);--ifm-color-emphasis-0:var(--ifm-color-gray-0);--ifm-color-emphasis-100:var(--ifm-color-gray-100);--ifm-color-emphasis-200:var(--ifm-color-gray-200);--ifm-color-emphasis-300:var(--ifm-color-gray-300);--ifm-color-emphasis-400:var(--ifm-color-gray-400);--ifm-color-emphasis-600:var(--ifm-color-gray-600);--ifm-color-emphasis-700:var(--ifm-color-gray-700);--ifm-color-emphasis-800:var(--ifm-color-gray-800);--ifm-color-emphasis-900:var(--ifm-color-gray-900);--ifm-color-emphasis-1000:var(--ifm-color-gray-1000);--ifm-color-content:var(--ifm-color-emphasis-900);--ifm-color-content-inverse:var(--ifm-color-emphasis-0);--ifm-color-content-secondary:#525860;--ifm-background-color:transparent;--ifm-background-surface-color:var(--ifm-color-content-inverse);--ifm-global-border-width:1px;--ifm-global-radius:0.4rem;--ifm-hover-overlay:rgba(0,0,0,.05);--ifm-font-color-base:var(--ifm-color-content);--ifm-font-color-base-inverse:var(--ifm-color-content-inverse);--ifm-font-color-secondary:var(--ifm-color-content-secondary);--ifm-font-family-base:system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";--ifm-font-family-monospace:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;--ifm-font-size-base:100%;--ifm-font-weight-light:300;--ifm-font-weight-normal:400;--ifm-font-weight-semibold:500;--ifm-font-weight-bold:700;--ifm-font-weight-base:var(--ifm-font-weight-normal);--ifm-line-height-base:1.65;--ifm-global-spacing:1rem;--ifm-spacing-vertical:var(--ifm-global-spacing);--ifm-spacing-horizontal:var(--ifm-global-spacing);--ifm-transition-fast:200ms;--ifm-transition-slow:400ms;--ifm-transition-timing-default:cubic-bezier(0.08,0.52,0.52,1);--ifm-global-shadow-lw:0 1px 2px 0 rgba(0,0,0,.1);--ifm-global-shadow-md:0 5px 40px rgba(0,0,0,.2);--ifm-global-shadow-tl:0 12px 28px 0 rgba(0,0,0,.2),0 2px 4px 0 rgba(0,0,0,.1);--ifm-z-index-dropdown:100;--ifm-z-index-fixed:200;--ifm-z-index-overlay:400;--ifm-container-width:1140px;--ifm-container-width-xl:1320px;--ifm-code-background:#f6f7f8;--ifm-code-border-radius:var(--ifm-global-radius);--ifm-code-font-size:90%;--ifm-code-padding-horizontal:0.1rem;--ifm-code-padding-vertical:0.1rem;--ifm-pre-background:var(--ifm-code-background);--ifm-pre-border-radius:var(--ifm-code-border-radius);--ifm-pre-color:inherit;--ifm-pre-line-height:1.45;--ifm-pre-padding:1rem;--ifm-heading-color:inherit;--ifm-heading-margin-top:0;--ifm-heading-margin-bottom:var(--ifm-spacing-vertical);--ifm-heading-font-family:var(--ifm-font-family-base);--ifm-heading-font-weight:var(--ifm-font-weight-bold);--ifm-heading-line-height:1.25;--ifm-h1-font-size:2rem;--ifm-h2-font-size:1.5rem;--ifm-h3-font-size:1.25rem;--ifm-h4-font-size:1rem;--ifm-h5-font-size:0.875rem;--ifm-h6-font-size:0.85rem;--ifm-image-alignment-padding:1.25rem;--ifm-leading-desktop:1.25;--ifm-leading:calc(var(--ifm-leading-desktop)*1rem);--ifm-list-left-padding:2rem;--ifm-list-margin:1rem;--ifm-list-item-margin:0.25rem;--ifm-list-paragraph-margin:1rem;--ifm-table-cell-padding:0.75rem;--ifm-table-background:transparent;--ifm-table-stripe-background:rgba(0,0,0,.03);--ifm-table-border-width:1px;--ifm-table-border-color:var(--ifm-color-emphasis-300);--ifm-table-head-background:inherit;--ifm-table-head-color:inherit;--ifm-table-head-font-weight:var(--ifm-font-weight-bold);--ifm-table-cell-color:inherit;--ifm-link-color:var(--ifm-color-primary);--ifm-link-decoration:none;--ifm-link-hover-color:var(--ifm-link-color);--ifm-link-hover-decoration:underline;--ifm-paragraph-margin-bottom:var(--ifm-leading);--ifm-blockquote-font-size:var(--ifm-font-size-base);--ifm-blockquote-border-left-width:2px;--ifm-blockquote-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-blockquote-padding-vertical:0;--ifm-blockquote-shadow:none;--ifm-blockquote-color:var(--ifm-color-emphasis-800);--ifm-blockquote-border-color:var(--ifm-color-emphasis-300);--ifm-hr-background-color:var(--ifm-color-emphasis-500);--ifm-hr-height:1px;--ifm-hr-margin-vertical:1.5rem;--ifm-scrollbar-size:7px;--ifm-scrollbar-track-background-color:#f1f1f1;--ifm-scrollbar-thumb-background-color:silver;--ifm-scrollbar-thumb-hover-background-color:#a7a7a7;--ifm-alert-background-color:inherit;--ifm-alert-border-color:inherit;--ifm-alert-border-radius:var(--ifm-global-radius);--ifm-alert-border-width:0px;--ifm-alert-border-left-width:5px;--ifm-alert-color:var(--ifm-font-color-base);--ifm-alert-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-alert-padding-vertical:var(--ifm-spacing-vertical);--ifm-alert-shadow:var(--ifm-global-shadow-lw);--ifm-avatar-intro-margin:1rem;--ifm-avatar-intro-alignment:inherit;--ifm-avatar-photo-size:3rem;--ifm-badge-background-color:inherit;--ifm-badge-border-color:inherit;--ifm-badge-border-radius:var(--ifm-global-radius);--ifm-badge-border-width:var(--ifm-global-border-width);--ifm-badge-color:var(--ifm-color-white);--ifm-badge-padding-horizontal:calc(var(--ifm-spacing-horizontal)*0.5);--ifm-badge-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-breadcrumb-border-radius:1.5rem;--ifm-breadcrumb-spacing:0.5rem;--ifm-breadcrumb-color-active:var(--ifm-color-primary);--ifm-breadcrumb-item-background-active:var(--ifm-hover-overlay);--ifm-breadcrumb-padding-horizontal:0.8rem;--ifm-breadcrumb-padding-vertical:0.4rem;--ifm-breadcrumb-size-multiplier:1;--ifm-breadcrumb-separator:url('data:image/svg+xml;utf8,');--ifm-breadcrumb-separator-filter:none;--ifm-breadcrumb-separator-size:0.5rem;--ifm-breadcrumb-separator-size-multiplier:1.25;--ifm-button-background-color:inherit;--ifm-button-border-color:var(--ifm-button-background-color);--ifm-button-border-width:var(--ifm-global-border-width);--ifm-button-font-weight:var(--ifm-font-weight-bold);--ifm-button-padding-horizontal:1.5rem;--ifm-button-padding-vertical:0.375rem;--ifm-button-size-multiplier:1;--ifm-button-transition-duration:var(--ifm-transition-fast);--ifm-button-border-radius:calc(var(--ifm-global-radius)*var(--ifm-button-size-multiplier));--ifm-button-group-spacing:2px;--ifm-card-background-color:var(--ifm-background-surface-color);--ifm-card-border-radius:calc(var(--ifm-global-radius)*2);--ifm-card-horizontal-spacing:var(--ifm-global-spacing);--ifm-card-vertical-spacing:var(--ifm-global-spacing);--ifm-toc-border-color:var(--ifm-color-emphasis-300);--ifm-toc-link-color:var(--ifm-color-content-secondary);--ifm-toc-padding-vertical:0.5rem;--ifm-toc-padding-horizontal:0.5rem;--ifm-dropdown-background-color:var(--ifm-background-surface-color);--ifm-dropdown-font-weight:var(--ifm-font-weight-semibold);--ifm-dropdown-link-color:var(--ifm-font-color-base);--ifm-dropdown-hover-background-color:var(--ifm-hover-overlay);--ifm-footer-background-color:var(--ifm-color-emphasis-100);--ifm-footer-color:inherit;--ifm-footer-link-color:var(--ifm-color-emphasis-700);--ifm-footer-link-hover-color:var(--ifm-color-primary);--ifm-footer-link-horizontal-spacing:0.5rem;--ifm-footer-padding-horizontal:calc(var(--ifm-spacing-horizontal)*2);--ifm-footer-padding-vertical:calc(var(--ifm-spacing-vertical)*2);--ifm-footer-title-color:inherit;--ifm-footer-logo-max-width:min(30rem,90vw);--ifm-hero-background-color:var(--ifm-background-surface-color);--ifm-hero-text-color:var(--ifm-color-emphasis-800);--ifm-menu-color:var(--ifm-color-emphasis-700);--ifm-menu-color-active:var(--ifm-color-primary);--ifm-menu-color-background-active:var(--ifm-hover-overlay);--ifm-menu-color-background-hover:var(--ifm-hover-overlay);--ifm-menu-link-padding-horizontal:0.75rem;--ifm-menu-link-padding-vertical:0.375rem;--ifm-menu-link-sublist-icon:url('data:image/svg+xml;utf8,');--ifm-menu-link-sublist-icon-filter:none;--ifm-navbar-background-color:var(--ifm-background-surface-color);--ifm-navbar-height:3.75rem;--ifm-navbar-item-padding-horizontal:0.75rem;--ifm-navbar-item-padding-vertical:0.25rem;--ifm-navbar-link-color:var(--ifm-font-color-base);--ifm-navbar-link-active-color:var(--ifm-link-color);--ifm-navbar-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-navbar-padding-vertical:calc(var(--ifm-spacing-vertical)*0.5);--ifm-navbar-shadow:var(--ifm-global-shadow-lw);--ifm-navbar-search-input-background-color:var(--ifm-color-emphasis-200);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-800);--ifm-navbar-search-input-placeholder-color:var(--ifm-color-emphasis-500);--ifm-navbar-search-input-icon:url('data:image/svg+xml;utf8,');--ifm-navbar-sidebar-width:83vw;--ifm-pagination-border-radius:var(--ifm-global-radius);--ifm-pagination-color-active:var(--ifm-color-primary);--ifm-pagination-font-size:1rem;--ifm-pagination-item-active-background:var(--ifm-hover-overlay);--ifm-pagination-page-spacing:0.2em;--ifm-pagination-padding-horizontal:calc(var(--ifm-spacing-horizontal)*1);--ifm-pagination-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-pagination-nav-border-radius:var(--ifm-global-radius);--ifm-pagination-nav-color-hover:var(--ifm-color-primary);--ifm-pills-color-active:var(--ifm-color-primary);--ifm-pills-color-background-active:var(--ifm-hover-overlay);--ifm-pills-spacing:0.125rem;--ifm-tabs-color:var(--ifm-font-color-secondary);--ifm-tabs-color-active:var(--ifm-color-primary);--ifm-tabs-color-active-border:var(--ifm-tabs-color-active);--ifm-tabs-padding-horizontal:1rem;--ifm-tabs-padding-vertical:1rem;--docusaurus-progress-bar-color:var(--ifm-color-primary);--agl-primary-color-dark-50:#abddba;--agl-primary-color-dark-100:#99d6ad;--agl-primary-color-dark-200:#87cf9f;--agl-primary-color-dark-300:#74c892;--agl-primary-color-dark-400:#5fc184;--agl-primary-color-dark-500:#48ba77;--agl-primary-color-dark-600:#3da167;--agl-primary-color-dark-700:#338957;--agl-primary-color-dark-800:#297247;--agl-primary-color-dark-900:#1f5c38;--agl-primary-color-light-50:#a1d8af;--agl-primary-color-light-100:#8ed0a0;--agl-primary-color-light-200:#79c890;--agl-primary-color-light-300:#63c080;--agl-primary-color-light-400:#4bb771;--agl-primary-color-light-500:#2aaf61;--agl-primary-color-light-600:#1c8146;--agl-primary-color-light-700:#166b39;--agl-primary-color-light-800:#10562d;--agl-primary-color-light-900:#0a4121;--ifm-color-primary:var(--agl-primary-color-light-500);--ifm-color-primary-dark:var(--agl-primary-color-light-600);--ifm-color-primary-darker:var(--agl-primary-color-light-700);--ifm-color-primary-darkest:var(--agl-primary-color-light-800);--ifm-color-primary-light:var(--agl-primary-color-light-400);--ifm-color-primary-lighter:var(--agl-primary-color-light-300);--ifm-color-primary-lightest:var(--agl-primary-color-light-200);--docusaurus-announcement-bar-height:auto;--docusaurus-tag-list-border:var(--ifm-color-emphasis-300);--docusaurus-collapse-button-bg:transparent;--docusaurus-collapse-button-bg-hover:rgba(0,0,0,.1);--doc-sidebar-width:300px;--doc-sidebar-hidden-width:30px}.badge--danger,.badge--info,.badge--primary,.badge--secondary,.badge--success,.badge--warning{--ifm-badge-border-color:var(--ifm-badge-background-color)}.button--link,.button--outline{--ifm-button-background-color:transparent}*{-moz-box-sizing:border-box;box-sizing:border-box}html{background-color:var(--ifm-background-color);color:var(--ifm-font-color-base);color-scheme:var(--ifm-color-scheme);font:var(--ifm-font-size-base)/var(--ifm-line-height-base) var(--ifm-font-family-base);-webkit-font-smoothing:antialiased;text-rendering:optimizelegibility;-webkit-text-size-adjust:100%;-moz-text-size-adjust:100%;-ms-text-size-adjust:100%;text-size-adjust:100%}iframe{border:0;color-scheme:auto}.container{margin:0 auto;max-width:var(--ifm-container-width)}.container--fluid{max-width:inherit}.row{display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;-webkit-flex-wrap:wrap;flex-wrap:wrap;margin:0 calc(var(--ifm-spacing-horizontal)*-1)}.margin-bottom--none,.margin-vert--none,.markdown>:last-child{margin-bottom:0!important}.margin-top--none,.margin-vert--none,.tabItem_LNqP{margin-top:0!important}.row--no-gutters{margin-left:0;margin-right:0}.margin-horiz--none,.margin-right--none{margin-right:0!important}.row--no-gutters>.col{padding-left:0;padding-right:0}.row--align-top{-webkit-box-align:start;-webkit-align-items:flex-start;-moz-box-align:start;align-items:flex-start}.row--align-bottom{-webkit-box-align:end;-webkit-align-items:flex-end;-moz-box-align:end;align-items:flex-end}.menuExternalLink_NmtK,.row--align-center{-webkit-box-align:center;-webkit-align-items:center;-moz-box-align:center;align-items:center}.row--align-stretch{-webkit-box-align:stretch;-webkit-align-items:stretch;-moz-box-align:stretch;align-items:stretch}.row--align-baseline{-webkit-box-align:baseline;-webkit-align-items:baseline;-moz-box-align:baseline;align-items:baseline}.col{--ifm-col-width:100%;-webkit-box-flex:1;-webkit-flex:1 0;-moz-box-flex:1;flex:1 0;margin-left:0;max-width:var(--ifm-col-width)}.padding-bottom--none,.padding-vert--none{padding-bottom:0!important}.padding-top--none,.padding-vert--none{padding-top:0!important}.padding-horiz--none,.padding-left--none{padding-left:0!important}.padding-horiz--none,.padding-right--none{padding-right:0!important}.col[class*=col--]{-webkit-box-flex:0;-webkit-flex:0 0 var(--ifm-col-width);-moz-box-flex:0;flex:0 0 var(--ifm-col-width)}.col--1{--ifm-col-width:8.33333%}.col--offset-1{margin-left:8.33333%}.col--2{--ifm-col-width:16.66667%}.col--offset-2{margin-left:16.66667%}.col--3{--ifm-col-width:25%}.col--offset-3{margin-left:25%}.col--4{--ifm-col-width:33.33333%}.col--offset-4{margin-left:33.33333%}.col--5{--ifm-col-width:41.66667%}.col--offset-5{margin-left:41.66667%}.col--6{--ifm-col-width:50%}.col--offset-6{margin-left:50%}.col--7{--ifm-col-width:58.33333%}.col--offset-7{margin-left:58.33333%}.col--8{--ifm-col-width:66.66667%}.col--offset-8{margin-left:66.66667%}.col--9{--ifm-col-width:75%}.col--offset-9{margin-left:75%}.col--10{--ifm-col-width:83.33333%}.col--offset-10{margin-left:83.33333%}.col--11{--ifm-col-width:91.66667%}.col--offset-11{margin-left:91.66667%}.col--12{--ifm-col-width:100%}.col--offset-12{margin-left:100%}.margin-horiz--none,.margin-left--none{margin-left:0!important}.margin--none{margin:0!important}.margin-bottom--xs,.margin-vert--xs{margin-bottom:.25rem!important}.margin-top--xs,.margin-vert--xs{margin-top:.25rem!important}.margin-horiz--xs,.margin-left--xs{margin-left:.25rem!important}.margin-horiz--xs,.margin-right--xs{margin-right:.25rem!important}.margin--xs{margin:.25rem!important}.margin-bottom--sm,.margin-vert--sm{margin-bottom:.5rem!important}.margin-top--sm,.margin-vert--sm{margin-top:.5rem!important}.margin-horiz--sm,.margin-left--sm{margin-left:.5rem!important}.margin-horiz--sm,.margin-right--sm{margin-right:.5rem!important}.margin--sm{margin:.5rem!important}.margin-bottom--md,.margin-vert--md{margin-bottom:1rem!important}.margin-top--md,.margin-vert--md{margin-top:1rem!important}.margin-horiz--md,.margin-left--md{margin-left:1rem!important}.margin-horiz--md,.margin-right--md{margin-right:1rem!important}.margin--md{margin:1rem!important}.margin-bottom--lg,.margin-vert--lg{margin-bottom:2rem!important}.margin-top--lg,.margin-vert--lg{margin-top:2rem!important}.margin-horiz--lg,.margin-left--lg{margin-left:2rem!important}.margin-horiz--lg,.margin-right--lg{margin-right:2rem!important}.margin--lg{margin:2rem!important}.margin-bottom--xl,.margin-vert--xl{margin-bottom:5rem!important}.margin-top--xl,.margin-vert--xl{margin-top:5rem!important}.margin-horiz--xl,.margin-left--xl{margin-left:5rem!important}.margin-horiz--xl,.margin-right--xl{margin-right:5rem!important}.margin--xl{margin:5rem!important}.padding--none{padding:0!important}.padding-bottom--xs,.padding-vert--xs{padding-bottom:.25rem!important}.padding-top--xs,.padding-vert--xs{padding-top:.25rem!important}.padding-horiz--xs,.padding-left--xs{padding-left:.25rem!important}.padding-horiz--xs,.padding-right--xs{padding-right:.25rem!important}.padding--xs{padding:.25rem!important}.padding-bottom--sm,.padding-vert--sm{padding-bottom:.5rem!important}.padding-top--sm,.padding-vert--sm{padding-top:.5rem!important}.padding-horiz--sm,.padding-left--sm{padding-left:.5rem!important}.padding-horiz--sm,.padding-right--sm{padding-right:.5rem!important}.padding--sm{padding:.5rem!important}.padding-bottom--md,.padding-vert--md{padding-bottom:1rem!important}.padding-top--md,.padding-vert--md{padding-top:1rem!important}.padding-horiz--md,.padding-left--md{padding-left:1rem!important}.padding-horiz--md,.padding-right--md{padding-right:1rem!important}.padding--md{padding:1rem!important}.padding-bottom--lg,.padding-vert--lg{padding-bottom:2rem!important}.padding-top--lg,.padding-vert--lg{padding-top:2rem!important}.padding-horiz--lg,.padding-left--lg{padding-left:2rem!important}.padding-horiz--lg,.padding-right--lg{padding-right:2rem!important}.padding--lg{padding:2rem!important}.padding-bottom--xl,.padding-vert--xl{padding-bottom:5rem!important}.padding-top--xl,.padding-vert--xl{padding-top:5rem!important}.padding-horiz--xl,.padding-left--xl{padding-left:5rem!important}.padding-horiz--xl,.padding-right--xl{padding-right:5rem!important}.padding--xl{padding:5rem!important}code{background-color:var(--ifm-code-background);border:.1rem solid rgba(0,0,0,.1);border-radius:var(--ifm-code-border-radius);font-family:var(--ifm-font-family-monospace);font-size:var(--ifm-code-font-size);padding:var(--ifm-code-padding-vertical) var(--ifm-code-padding-horizontal)}a code{color:inherit}pre{background-color:var(--ifm-pre-background);border-radius:var(--ifm-pre-border-radius);color:var(--ifm-pre-color);font:var(--ifm-code-font-size)/var(--ifm-pre-line-height) var(--ifm-font-family-monospace);padding:var(--ifm-pre-padding)}pre code{background-color:transparent;border:none;font-size:100%;line-height:inherit;padding:0}kbd{background-color:var(--ifm-color-emphasis-0);border:1px solid var(--ifm-color-emphasis-400);border-radius:.2rem;box-shadow:inset 0 -1px 0 var(--ifm-color-emphasis-400);color:var(--ifm-color-emphasis-800);font:80% var(--ifm-font-family-monospace);padding:.15rem .3rem}h1,h2,h3,h4,h5,h6{color:var(--ifm-heading-color);font-family:var(--ifm-heading-font-family);font-weight:var(--ifm-heading-font-weight);line-height:var(--ifm-heading-line-height);margin:var(--ifm-heading-margin-top) 0 var(--ifm-heading-margin-bottom) 0}h1{font-size:var(--ifm-h1-font-size)}h2{font-size:var(--ifm-h2-font-size)}h3{font-size:var(--ifm-h3-font-size)}h4{font-size:var(--ifm-h4-font-size)}h5{font-size:var(--ifm-h5-font-size)}h6{font-size:var(--ifm-h6-font-size)}img{max-width:100%}img[align=right]{padding-left:var(--image-alignment-padding)}img[align=left]{padding-right:var(--image-alignment-padding)}.markdown{--ifm-h1-vertical-rhythm-top:3;--ifm-h2-vertical-rhythm-top:2;--ifm-h3-vertical-rhythm-top:1.5;--ifm-heading-vertical-rhythm-top:1.25;--ifm-h1-vertical-rhythm-bottom:1.25;--ifm-heading-vertical-rhythm-bottom:1}.markdown:after,.markdown:before{content:"";display:table}.markdown:after{clear:both}.markdown h1:first-child{--ifm-h1-font-size:3rem;margin-bottom:calc(var(--ifm-h1-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown>h2{--ifm-h2-font-size:2rem;margin-top:calc(var(--ifm-h2-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h3{--ifm-h3-font-size:1.5rem;margin-top:calc(var(--ifm-h3-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h4,.markdown>h5,.markdown>h6{margin-top:calc(var(--ifm-heading-vertical-rhythm-top)*var(--ifm-leading))}.markdown>p,.markdown>pre,.markdown>ul,.tabList__CuJ{margin-bottom:var(--ifm-leading)}.markdown li>p{margin-top:var(--ifm-list-paragraph-margin)}.markdown li+li{margin-top:var(--ifm-list-item-margin)}ol,ul{margin:0 0 var(--ifm-list-margin);padding-left:var(--ifm-list-left-padding)}ol ol,ul ol{list-style-type:lower-roman}ol ol ol,ol ul ol,ul ol ol,ul ul ol{list-style-type:lower-alpha}table{border-collapse:collapse;display:block;margin-bottom:var(--ifm-spacing-vertical)}table thead tr{border-bottom:2px solid var(--ifm-table-border-color)}table thead,table tr:nth-child(2n){background-color:var(--ifm-table-stripe-background)}table tr{background-color:var(--ifm-table-background);border-top:var(--ifm-table-border-width) solid var(--ifm-table-border-color)}table td,table th{border:var(--ifm-table-border-width) solid var(--ifm-table-border-color);padding:var(--ifm-table-cell-padding)}table th{background-color:var(--ifm-table-head-background);color:var(--ifm-table-head-color);font-weight:var(--ifm-table-head-font-weight)}table td{color:var(--ifm-table-cell-color)}strong{font-weight:var(--ifm-font-weight-bold)}a{color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration);-webkit-transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}a:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button:hover,.text--no-decoration,.text--no-decoration:hover,a:not([href]){text-decoration:none}p{margin:0 0 var(--ifm-paragraph-margin-bottom)}blockquote{border-left:var(--ifm-blockquote-border-left-width) solid var(--ifm-blockquote-border-color);box-shadow:var(--ifm-blockquote-shadow);color:var(--ifm-blockquote-color);font-size:var(--ifm-blockquote-font-size);padding:var(--ifm-blockquote-padding-vertical) var(--ifm-blockquote-padding-horizontal)}blockquote>:first-child{margin-top:0}blockquote>:last-child{margin-bottom:0}hr{background-color:var(--ifm-hr-background-color);border:0;height:var(--ifm-hr-height);margin:var(--ifm-hr-margin-vertical) 0}.shadow--lw{box-shadow:var(--ifm-global-shadow-lw)!important}.shadow--md{box-shadow:var(--ifm-global-shadow-md)!important}.shadow--tl{box-shadow:var(--ifm-global-shadow-tl)!important}.text--primary,.wordWrapButtonEnabled_EoeP .wordWrapButtonIcon_Bwma{color:var(--ifm-color-primary)}.text--secondary{color:var(--ifm-color-secondary)}.text--success{color:var(--ifm-color-success)}.text--info{color:var(--ifm-color-info)}.text--warning{color:var(--ifm-color-warning)}.text--danger{color:var(--ifm-color-danger)}.text--center{text-align:center}.text--left{text-align:left}.text--justify{text-align:justify}.text--right{text-align:right}.text--capitalize{text-transform:capitalize}.text--lowercase{text-transform:lowercase}.admonitionHeading_Gvgb,.alert__heading,.text--uppercase{text-transform:uppercase}.text--light{font-weight:var(--ifm-font-weight-light)}.text--normal{font-weight:var(--ifm-font-weight-normal)}.text--semibold{font-weight:var(--ifm-font-weight-semibold)}.text--bold{font-weight:var(--ifm-font-weight-bold)}.text--italic{font-style:italic}.text--truncate{overflow:hidden;-o-text-overflow:ellipsis;text-overflow:ellipsis;white-space:nowrap}.text--break{word-wrap:break-word!important;word-break:break-word!important}.clean-btn{background:none;border:none;color:inherit;cursor:pointer;font-family:inherit;padding:0}.alert,.alert .close{color:var(--ifm-alert-foreground-color)}.clean-list{padding-left:0}.alert--primary{--ifm-alert-background-color:var(--ifm-color-primary-contrast-background);--ifm-alert-background-color-highlight:rgba(53,120,229,.15);--ifm-alert-foreground-color:var(--ifm-color-primary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-primary-dark)}.alert--secondary{--ifm-alert-background-color:var(--ifm-color-secondary-contrast-background);--ifm-alert-background-color-highlight:rgba(235,237,240,.15);--ifm-alert-foreground-color:var(--ifm-color-secondary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-secondary-dark)}.alert--success{--ifm-alert-background-color:var(--ifm-color-success-contrast-background);--ifm-alert-background-color-highlight:rgba(0,164,0,.15);--ifm-alert-foreground-color:var(--ifm-color-success-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-success-dark)}.alert--info{--ifm-alert-background-color:var(--ifm-color-info-contrast-background);--ifm-alert-background-color-highlight:rgba(84,199,236,.15);--ifm-alert-foreground-color:var(--ifm-color-info-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-info-dark)}.alert--warning{--ifm-alert-background-color:var(--ifm-color-warning-contrast-background);--ifm-alert-background-color-highlight:rgba(255,186,0,.15);--ifm-alert-foreground-color:var(--ifm-color-warning-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-warning-dark)}.alert--danger{--ifm-alert-background-color:var(--ifm-color-danger-contrast-background);--ifm-alert-background-color-highlight:rgba(250,56,62,.15);--ifm-alert-foreground-color:var(--ifm-color-danger-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-danger-dark)}.alert{--ifm-code-background:var(--ifm-alert-background-color-highlight);--ifm-link-color:var(--ifm-alert-foreground-color);--ifm-link-hover-color:var(--ifm-alert-foreground-color);--ifm-link-decoration:underline;--ifm-tabs-color:var(--ifm-alert-foreground-color);--ifm-tabs-color-active:var(--ifm-alert-foreground-color);--ifm-tabs-color-active-border:var(--ifm-alert-border-color);background-color:var(--ifm-alert-background-color);border:var(--ifm-alert-border-width) solid var(--ifm-alert-border-color);border-left-width:var(--ifm-alert-border-left-width);border-radius:var(--ifm-alert-border-radius);box-shadow:var(--ifm-alert-shadow);padding:var(--ifm-alert-padding-vertical) var(--ifm-alert-padding-horizontal)}.alert__heading{-webkit-box-align:center;-webkit-align-items:center;-moz-box-align:center;align-items:center;display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;font:700 var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.5rem}.alert__icon{display:-webkit-inline-box;display:-webkit-inline-flex;display:-moz-inline-box;display:inline-flex;margin-right:.4em}.alert__icon svg{fill:var(--ifm-alert-foreground-color);stroke:var(--ifm-alert-foreground-color);stroke-width:0}.alert .close{margin:calc(var(--ifm-alert-padding-vertical)*-1) calc(var(--ifm-alert-padding-horizontal)*-1) 0 0;opacity:.75}.alert .close:focus,.alert .close:hover{opacity:1}.alert a{-webkit-text-decoration-color:var(--ifm-alert-border-color);-moz-text-decoration-color:var(--ifm-alert-border-color);text-decoration-color:var(--ifm-alert-border-color)}.alert a:hover{text-decoration-thickness:2px}.avatar{-moz-column-gap:var(--ifm-avatar-intro-margin);-webkit-column-gap:var(--ifm-avatar-intro-margin);column-gap:var(--ifm-avatar-intro-margin);display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex}.avatar__photo{border-radius:50%;display:block;height:var(--ifm-avatar-photo-size);overflow:hidden;width:var(--ifm-avatar-photo-size)}.avatar__intro,.button-group--block{display:-webkit-box;display:-webkit-flex;display:-moz-box}.card--full-height,.navbar__logo img,body,html{height:100%}.avatar__photo--sm{--ifm-avatar-photo-size:2rem}.avatar__photo--lg{--ifm-avatar-photo-size:4rem}.avatar__photo--xl{--ifm-avatar-photo-size:6rem}.avatar__intro{display:flex;-webkit-box-flex:1;-webkit-flex:1 1;-moz-box-flex:1;flex:1 1;-webkit-flex-direction:column;flex-direction:column;-webkit-box-pack:center;-webkit-justify-content:center;-moz-box-pack:center;justify-content:center;text-align:var(--ifm-avatar-intro-alignment)}.badge,.breadcrumbs__item,.breadcrumbs__link,.button,.dropdown>.navbar__link:after{display:inline-block}.avatar__name{font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base)}.avatar__subtitle{margin-top:.25rem}.avatar--vertical{--ifm-avatar-intro-alignment:center;--ifm-avatar-intro-margin:0.5rem;-webkit-box-align:center;-webkit-align-items:center;-moz-box-align:center;align-items:center;-webkit-flex-direction:column;flex-direction:column}.badge{background-color:var(--ifm-badge-background-color);border:var(--ifm-badge-border-width) solid var(--ifm-badge-border-color);border-radius:var(--ifm-badge-border-radius);color:var(--ifm-badge-color);font-size:75%;font-weight:var(--ifm-font-weight-bold);line-height:1;padding:var(--ifm-badge-padding-vertical) var(--ifm-badge-padding-horizontal)}.badge--primary{--ifm-badge-background-color:var(--ifm-color-primary)}.badge--secondary{--ifm-badge-background-color:var(--ifm-color-secondary);color:var(--ifm-color-black)}.breadcrumbs__link,.button.button--secondary.button--outline:not(.button--active):not(:hover){color:var(--ifm-font-color-base)}.badge--success{--ifm-badge-background-color:var(--ifm-color-success)}.badge--info{--ifm-badge-background-color:var(--ifm-color-info)}.badge--warning{--ifm-badge-background-color:var(--ifm-color-warning)}.badge--danger{--ifm-badge-background-color:var(--ifm-color-danger)}.breadcrumbs{margin-bottom:0;padding-left:0}.breadcrumbs__item:not(:last-child):after{background:var(--ifm-breadcrumb-separator) center;content:" ";display:inline-block;-webkit-filter:var(--ifm-breadcrumb-separator-filter);filter:var(--ifm-breadcrumb-separator-filter);height:-webkit-calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));height:-moz-calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));height:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));margin:0 var(--ifm-breadcrumb-spacing);opacity:.5;width:-webkit-calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));width:-moz-calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));width:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier))}.breadcrumbs__item--active .breadcrumbs__link{background:var(--ifm-breadcrumb-item-background-active);color:var(--ifm-breadcrumb-color-active)}.breadcrumbs__link{border-radius:var(--ifm-breadcrumb-border-radius);font-size:-webkit-calc(1rem*var(--ifm-breadcrumb-size-multiplier));font-size:-moz-calc(1rem*var(--ifm-breadcrumb-size-multiplier));font-size:calc(1rem*var(--ifm-breadcrumb-size-multiplier));padding:calc(var(--ifm-breadcrumb-padding-vertical)*var(--ifm-breadcrumb-size-multiplier)) calc(var(--ifm-breadcrumb-padding-horizontal)*var(--ifm-breadcrumb-size-multiplier));-webkit-transition-duration:var(--ifm-transition-fast);-moz-transition-duration:var(--ifm-transition-fast);-o-transition-duration:var(--ifm-transition-fast);transition-duration:var(--ifm-transition-fast);-webkit-transition-property:background,color;-o-transition-property:background,color;-moz-transition-property:background,color;transition-property:background,color;-webkit-transition-timing-function:var(--ifm-transition-timing-default);-moz-transition-timing-function:var(--ifm-transition-timing-default);-o-transition-timing-function:var(--ifm-transition-timing-default);transition-timing-function:var(--ifm-transition-timing-default)}.breadcrumbs__link:link:hover,.breadcrumbs__link:visited:hover,area[href].breadcrumbs__link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs__link:-moz-any-link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs__link:-webkit-any-link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs__link:any-link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs--sm{--ifm-breadcrumb-size-multiplier:0.8}.breadcrumbs--lg{--ifm-breadcrumb-size-multiplier:1.2}.button{background-color:var(--ifm-button-background-color);border:var(--ifm-button-border-width) solid var(--ifm-button-border-color);border-radius:var(--ifm-button-border-radius);cursor:pointer;font-size:-webkit-calc(0.875rem*var(--ifm-button-size-multiplier));font-size:-moz-calc(0.875rem*var(--ifm-button-size-multiplier));font-size:calc(.875rem*var(--ifm-button-size-multiplier));font-weight:var(--ifm-button-font-weight);line-height:1.5;padding:calc(var(--ifm-button-padding-vertical)*var(--ifm-button-size-multiplier)) calc(var(--ifm-button-padding-horizontal)*var(--ifm-button-size-multiplier));text-align:center;-webkit-transition-duration:var(--ifm-button-transition-duration);-moz-transition-duration:var(--ifm-button-transition-duration);-o-transition-duration:var(--ifm-button-transition-duration);transition-duration:var(--ifm-button-transition-duration);-webkit-transition-property:color,background,border-color;-o-transition-property:color,background,border-color;-moz-transition-property:color,background,border-color;transition-property:color,background,border-color;-webkit-transition-timing-function:var(--ifm-transition-timing-default);-moz-transition-timing-function:var(--ifm-transition-timing-default);-o-transition-timing-function:var(--ifm-transition-timing-default);transition-timing-function:var(--ifm-transition-timing-default);-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;white-space:nowrap}.button,.button:hover{color:var(--ifm-button-color)}.button--outline{--ifm-button-color:var(--ifm-button-border-color)}.button--outline:hover{--ifm-button-background-color:var(--ifm-button-border-color)}.button--link{--ifm-button-border-color:transparent;color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}.button--link.button--active,.button--link:active,.button--link:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button.disabled,.button:disabled,.button[disabled]{opacity:.65;pointer-events:none}.button--sm{--ifm-button-size-multiplier:0.8}.button--lg{--ifm-button-size-multiplier:1.35}.button--block{display:block;width:100%}.button.button--secondary{color:var(--ifm-color-gray-900)}:where(.button--primary){--ifm-button-background-color:var(--ifm-color-primary);--ifm-button-border-color:var(--ifm-color-primary)}:where(.button--primary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-primary-dark);--ifm-button-border-color:var(--ifm-color-primary-dark)}.button--primary.button--active,.button--primary:active{--ifm-button-background-color:var(--ifm-color-primary-darker);--ifm-button-border-color:var(--ifm-color-primary-darker)}:where(.button--secondary){--ifm-button-background-color:var(--ifm-color-secondary);--ifm-button-border-color:var(--ifm-color-secondary)}:where(.button--secondary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-secondary-dark);--ifm-button-border-color:var(--ifm-color-secondary-dark)}.button--secondary.button--active,.button--secondary:active{--ifm-button-background-color:var(--ifm-color-secondary-darker);--ifm-button-border-color:var(--ifm-color-secondary-darker)}:where(.button--success){--ifm-button-background-color:var(--ifm-color-success);--ifm-button-border-color:var(--ifm-color-success)}:where(.button--success):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-success-dark);--ifm-button-border-color:var(--ifm-color-success-dark)}.button--success.button--active,.button--success:active{--ifm-button-background-color:var(--ifm-color-success-darker);--ifm-button-border-color:var(--ifm-color-success-darker)}:where(.button--info){--ifm-button-background-color:var(--ifm-color-info);--ifm-button-border-color:var(--ifm-color-info)}:where(.button--info):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-info-dark);--ifm-button-border-color:var(--ifm-color-info-dark)}.button--info.button--active,.button--info:active{--ifm-button-background-color:var(--ifm-color-info-darker);--ifm-button-border-color:var(--ifm-color-info-darker)}:where(.button--warning){--ifm-button-background-color:var(--ifm-color-warning);--ifm-button-border-color:var(--ifm-color-warning)}:where(.button--warning):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-warning-dark);--ifm-button-border-color:var(--ifm-color-warning-dark)}.button--warning.button--active,.button--warning:active{--ifm-button-background-color:var(--ifm-color-warning-darker);--ifm-button-border-color:var(--ifm-color-warning-darker)}:where(.button--danger){--ifm-button-background-color:var(--ifm-color-danger);--ifm-button-border-color:var(--ifm-color-danger)}:where(.button--danger):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-danger-dark);--ifm-button-border-color:var(--ifm-color-danger-dark)}.button--danger.button--active,.button--danger:active{--ifm-button-background-color:var(--ifm-color-danger-darker);--ifm-button-border-color:var(--ifm-color-danger-darker)}.button-group{display:-webkit-inline-box;display:-webkit-inline-flex;display:-moz-inline-box;display:inline-flex;gap:var(--ifm-button-group-spacing)}.button-group>.button:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0}.button-group>.button:not(:last-child){border-bottom-right-radius:0;border-top-right-radius:0}.button-group--block{display:flex;-webkit-box-pack:stretch;-webkit-justify-content:stretch;-moz-box-pack:stretch;justify-content:stretch}.button-group--block>.button{-webkit-box-flex:1;-webkit-flex-grow:1;-moz-box-flex:1;flex-grow:1}.card{background-color:var(--ifm-card-background-color);border-radius:var(--ifm-card-border-radius);box-shadow:var(--ifm-global-shadow-lw);display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;-webkit-flex-direction:column;flex-direction:column;overflow:hidden}.card__image{padding-top:var(--ifm-card-vertical-spacing)}.card__image:first-child{padding-top:0}.card__body,.card__footer,.card__header{padding:var(--ifm-card-vertical-spacing) var(--ifm-card-horizontal-spacing)}.card__body:not(:last-child),.card__footer:not(:last-child),.card__header:not(:last-child){padding-bottom:0}.card__body>:last-child,.card__footer>:last-child,.card__header>:last-child{margin-bottom:0}.card__footer{margin-top:auto}.table-of-contents{font-size:.8rem;margin-bottom:0;padding:var(--ifm-toc-padding-vertical) 0}.table-of-contents,.table-of-contents ul{list-style:none;padding-left:var(--ifm-toc-padding-horizontal)}.table-of-contents li{margin:var(--ifm-toc-padding-vertical) var(--ifm-toc-padding-horizontal)}.table-of-contents__left-border{border-left:1px solid var(--ifm-toc-border-color)}.table-of-contents__link{color:var(--ifm-toc-link-color);display:block}.table-of-contents__link--active,.table-of-contents__link--active code,.table-of-contents__link:hover,.table-of-contents__link:hover code{color:var(--ifm-color-primary);text-decoration:none}.close{color:var(--ifm-color-black);float:right;font-size:1.5rem;font-weight:var(--ifm-font-weight-bold);line-height:1;opacity:.5;padding:1rem;-webkit-transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.dropdown__menu,.navbar-sidebar{-webkit-transition-duration:var(--ifm-transition-fast);-moz-transition-duration:var(--ifm-transition-fast);-o-transition-duration:var(--ifm-transition-fast)}.close:hover{opacity:.7}.close:focus,.theme-code-block-highlighted-line .codeLineNumber_Tfdd:before{opacity:.8}.dropdown{display:-webkit-inline-box;display:-webkit-inline-flex;display:-moz-inline-box;display:inline-flex;font-weight:var(--ifm-dropdown-font-weight);position:relative;vertical-align:top}.dropdown--hoverable:hover .dropdown__menu,.dropdown--show .dropdown__menu{opacity:1;pointer-events:all;-webkit-transform:translateY(-1px);-moz-transform:translateY(-1px);-o-transform:translateY(-1px);transform:translateY(-1px);visibility:visible}#nprogress,.dropdown__menu,.navbar__item.dropdown .navbar__link:not([href]){pointer-events:none}.dropdown--right .dropdown__menu{left:inherit;right:0}.dropdown--nocaret .navbar__link:after{content:none!important}.dropdown__menu{background-color:var(--ifm-dropdown-background-color);border-radius:var(--ifm-global-radius);box-shadow:var(--ifm-global-shadow-md);left:0;max-height:80vh;min-width:10rem;opacity:0;overflow-y:auto;padding:.5rem;position:absolute;top:-webkit-calc(100% - var(--ifm-navbar-item-padding-vertical) + .3rem);top:-moz-calc(100% - var(--ifm-navbar-item-padding-vertical) + .3rem);top:calc(100% - var(--ifm-navbar-item-padding-vertical) + .3rem);-webkit-transform:translateY(-.625rem);-moz-transform:translateY(-.625rem);-o-transform:translateY(-.625rem);transform:translateY(-.625rem);transition-duration:var(--ifm-transition-fast);-webkit-transition-property:opacity,visibility,-webkit-transform;-o-transition-property:opacity,visibility,-o-transform;-moz-transition-property:opacity,transform,visibility,-moz-transform;transition-property:opacity,transform,visibility,-webkit-transform,-moz-transform,-o-transform;-webkit-transition-timing-function:var(--ifm-transition-timing-default);-moz-transition-timing-function:var(--ifm-transition-timing-default);-o-transition-timing-function:var(--ifm-transition-timing-default);transition-timing-function:var(--ifm-transition-timing-default);visibility:hidden;z-index:var(--ifm-z-index-dropdown)}.dropdown__link{border-radius:.25rem;color:var(--ifm-dropdown-link-color);display:block;font-size:.875rem;margin-top:.2rem;padding:.25rem .5rem;white-space:nowrap}.hero,.menu__list-item-collapsible{display:-webkit-box;display:-webkit-flex;display:-moz-box}.dropdown__link--active,.dropdown__link:hover{background-color:var(--ifm-dropdown-hover-background-color);color:var(--ifm-dropdown-link-color);text-decoration:none}.dropdown__link--active,.dropdown__link--active:hover{--ifm-dropdown-link-color:var(--ifm-link-color)}.dropdown>.navbar__link:after{border-color:currentcolor transparent;border-style:solid;border-width:.4em .4em 0;content:"";margin-left:.3em;position:relative;top:2px;-webkit-transform:translateY(-50%);-moz-transform:translateY(-50%);-o-transform:translateY(-50%);transform:translateY(-50%)}.footer{background-color:var(--ifm-footer-background-color);color:var(--ifm-footer-color);padding:var(--ifm-footer-padding-vertical) var(--ifm-footer-padding-horizontal)}.footer--dark{--ifm-footer-background-color:#303846;--ifm-footer-color:var(--ifm-footer-link-color);--ifm-footer-link-color:var(--ifm-color-secondary);--ifm-footer-title-color:var(--ifm-color-white)}.footer__links{margin-bottom:1rem}.footer__link-item{color:var(--ifm-footer-link-color);line-height:2}.footer__link-item:hover{color:var(--ifm-footer-link-hover-color)}.footer__link-separator{margin:0 var(--ifm-footer-link-horizontal-spacing)}.footer__logo{margin-top:1rem;max-width:var(--ifm-footer-logo-max-width)}.footer__title{color:var(--ifm-footer-title-color);font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base);margin-bottom:var(--ifm-heading-margin-bottom)}.menu,.navbar__link{font-weight:var(--ifm-font-weight-semibold)}.docItemContainer_Djhp article>:first-child,.docItemContainer_Djhp header+*,.footer__item{margin-top:0}.admonitionContent_BuS1>:last-child,.collapsibleContent_i85q p:last-child,.details_lb9f>summary>p:last-child,.footer__items,.tabItem_Ymn6>:last-child{margin-bottom:0}.codeBlockStandalone_MEMb,[type=checkbox]{padding:0}.hero{-webkit-box-align:center;-webkit-align-items:center;-moz-box-align:center;align-items:center;background-color:var(--ifm-hero-background-color);color:var(--ifm-hero-text-color);display:flex;padding:4rem 2rem}.hero--primary{--ifm-hero-background-color:var(--ifm-color-primary);--ifm-hero-text-color:var(--ifm-font-color-base-inverse)}.hero--dark{--ifm-hero-background-color:#303846;--ifm-hero-text-color:var(--ifm-color-white)}.hero__title{font-size:3rem}.hero__subtitle{font-size:1.5rem}.menu__list{margin:0;padding-left:0}.menu__caret,.menu__link{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu__list .menu__list{-webkit-box-flex:0;-webkit-flex:0 0 100%;-moz-box-flex:0;flex:0 0 100%;margin-top:.25rem;padding-left:var(--ifm-menu-link-padding-horizontal)}.menu__list-item:not(:first-child){margin-top:.25rem}.menu__list-item--collapsed .menu__list{height:0;overflow:hidden}.menu__caret:before,.menu__link--sublist-caret:after{-webkit-filter:var(--ifm-menu-link-sublist-icon-filter);height:1.25rem;width:1.25rem;content:""}.details_lb9f[data-collapsed=false].isBrowser_bmU9>summary:before,.details_lb9f[open]:not(.isBrowser_bmU9)>summary:before,.menu__list-item--collapsed .menu__caret:before,.menu__list-item--collapsed .menu__link--sublist:after{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.menu__list-item-collapsible{border-radius:.25rem;display:flex;-webkit-flex-wrap:wrap;flex-wrap:wrap;position:relative;-webkit-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.menu__caret:hover,.menu__link:hover,.menu__list-item-collapsible--active,.menu__list-item-collapsible:hover{background:var(--ifm-menu-color-background-hover)}.menu__list-item-collapsible .menu__link--active,.menu__list-item-collapsible .menu__link:hover{background:none!important}.menu__caret,.menu__link{-webkit-box-align:center;-webkit-align-items:center;-moz-box-align:center;align-items:center;border-radius:.25rem;display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;-webkit-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.menu__link{color:var(--ifm-menu-color);-webkit-box-flex:1;-webkit-flex:1;-moz-box-flex:1;flex:1;line-height:1.25}.menu__link:hover{color:var(--ifm-menu-color);text-decoration:none;-webkit-transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.menu__link--sublist-caret:after{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;filter:var(--ifm-menu-link-sublist-icon-filter);margin-left:auto;min-width:1.25rem;-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg);-webkit-transition:-webkit-transform var(--ifm-transition-fast) linear;transition:-webkit-transform var(--ifm-transition-fast) linear;-o-transition:-o-transform var(--ifm-transition-fast) linear;-moz-transition:transform var(--ifm-transition-fast) linear,-moz-transform var(--ifm-transition-fast) linear;transition:transform var(--ifm-transition-fast) linear;transition:transform var(--ifm-transition-fast) linear,-webkit-transform var(--ifm-transition-fast) linear,-moz-transform var(--ifm-transition-fast) linear,-o-transform var(--ifm-transition-fast) linear}.menu__link--active,.menu__link--active:hover{color:var(--ifm-menu-color-active)}.navbar__brand,.navbar__link{color:var(--ifm-navbar-link-color)}.menu__link--active:not(.menu__link--sublist){background-color:var(--ifm-menu-color-background-active)}.menu__caret:before{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;filter:var(--ifm-menu-link-sublist-icon-filter);-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg);-webkit-transition:-webkit-transform var(--ifm-transition-fast) linear;transition:-webkit-transform var(--ifm-transition-fast) linear;-o-transition:-o-transform var(--ifm-transition-fast) linear;-moz-transition:transform var(--ifm-transition-fast) linear,-moz-transform var(--ifm-transition-fast) linear;transition:transform var(--ifm-transition-fast) linear;transition:transform var(--ifm-transition-fast) linear,-webkit-transform var(--ifm-transition-fast) linear,-moz-transform var(--ifm-transition-fast) linear,-o-transform var(--ifm-transition-fast) linear}.navbar--dark,html[data-theme=dark]{--ifm-menu-link-sublist-icon-filter:invert(100%) sepia(94%) saturate(17%) hue-rotate(223deg) brightness(104%) contrast(98%)}.navbar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-navbar-shadow);height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar,.navbar>.container,.navbar>.container-fluid{display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex}.navbar--fixed-top{position:-webkit-sticky;position:sticky;top:0;z-index:var(--ifm-z-index-fixed)}.navbar-sidebar,.navbar-sidebar__backdrop{bottom:0;opacity:0;position:fixed;left:0;top:0;visibility:hidden}.navbar__inner{-webkit-flex-wrap:wrap;flex-wrap:wrap;-webkit-box-pack:justify;-webkit-justify-content:space-between;-moz-box-pack:justify;justify-content:space-between;width:100%}.navbar__brand,.navbar__inner{display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex}.navbar__brand{-webkit-box-align:center;-webkit-align-items:center;-moz-box-align:center;align-items:center;margin-right:1rem;min-width:0}.navbar__brand:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.announcementBarContent_xLdY,.navbar__title{-webkit-box-flex:1;-webkit-flex:1 1 auto;-moz-box-flex:1;flex:1 1 auto}.navbar__toggle{display:none;margin-right:.5rem}.navbar__logo{-webkit-box-flex:0;-webkit-flex:0 0 auto;-moz-box-flex:0;flex:0 0 auto;height:2rem;margin-right:.5rem}.footer__icon-link svg,.navbar__icon:before{height:24px;width:24px}.navbar__items{-webkit-box-align:center;-webkit-align-items:center;-moz-box-align:center;align-items:center;display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;-webkit-box-flex:1;-webkit-flex:1;-moz-box-flex:1;flex:1;min-width:0}.navbar__items--center{-webkit-box-flex:0;-webkit-flex:0 0 auto;-moz-box-flex:0;flex:0 0 auto}.navbar__items--center .navbar__brand{margin:0}.navbar__items--center+.navbar__items--right{-webkit-box-flex:1;-webkit-flex:1;-moz-box-flex:1;flex:1}.navbar__items--right{-webkit-box-flex:0;-webkit-flex:0 0 auto;-moz-box-flex:0;flex:0 0 auto;-webkit-box-pack:end;-webkit-justify-content:flex-end;-moz-box-pack:end;justify-content:flex-end}.navbar__items--right>:last-child{padding-right:0}.navbar__item{display:inline-block;padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.navbar__link--active,.navbar__link:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.navbar--dark,.navbar--primary{--ifm-menu-color:var(--ifm-color-gray-300);--ifm-navbar-link-color:var(--ifm-color-gray-100);--ifm-navbar-search-input-background-color:hsla(0,0%,100%,.1);--ifm-navbar-search-input-placeholder-color:hsla(0,0%,100%,.5);color:var(--ifm-color-white)}.navbar--dark{--ifm-navbar-background-color:#242526;--ifm-menu-color-background-active:hsla(0,0%,100%,.05);--ifm-navbar-search-input-color:var(--ifm-color-white)}.navbar--primary{--ifm-navbar-background-color:var(--ifm-color-primary);--ifm-navbar-link-hover-color:var(--ifm-color-white);--ifm-menu-color-active:var(--ifm-color-white);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-500)}.navbar__search-input{-webkit-appearance:none;-moz-appearance:none;appearance:none;background:var(--ifm-navbar-search-input-background-color) var(--ifm-navbar-search-input-icon) no-repeat .75rem center/1rem 1rem;border:none;border-radius:2rem;color:var(--ifm-navbar-search-input-color);cursor:text;display:inline-block;font-size:1rem;height:2rem;padding:0 .5rem 0 2.25rem;width:12.5rem}.navbar__search-input::-moz-placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar__search-input::-webkit-input-placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar__search-input:-moz-placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar__search-input::-ms-input-placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar__search-input::placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar-sidebar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-global-shadow-md);-webkit-transform:translate3d(-100%,0,0);-moz-transform:translate3d(-100%,0,0);transform:translate3d(-100%,0,0);transition-duration:var(--ifm-transition-fast);-webkit-transition-property:opacity,visibility,-webkit-transform;-o-transition-property:opacity,visibility,-o-transform;-moz-transition-property:opacity,visibility,transform,-moz-transform;transition-property:opacity,visibility,transform,-webkit-transform,-moz-transform,-o-transform;-webkit-transition-timing-function:ease-in-out;-moz-transition-timing-function:ease-in-out;-o-transition-timing-function:ease-in-out;transition-timing-function:ease-in-out;width:var(--ifm-navbar-sidebar-width)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar--show .navbar-sidebar__backdrop{opacity:1;visibility:visible}.navbar-sidebar--show .navbar-sidebar{-webkit-transform:translateZ(0);-moz-transform:translateZ(0);transform:translateZ(0)}.navbar-sidebar__backdrop{background-color:rgba(0,0,0,.6);right:0;-webkit-transition-duration:var(--ifm-transition-fast);-moz-transition-duration:var(--ifm-transition-fast);-o-transition-duration:var(--ifm-transition-fast);transition-duration:var(--ifm-transition-fast);-webkit-transition-property:opacity,visibility;-o-transition-property:opacity,visibility;-moz-transition-property:opacity,visibility;transition-property:opacity,visibility;-webkit-transition-timing-function:ease-in-out;-moz-transition-timing-function:ease-in-out;-o-transition-timing-function:ease-in-out;transition-timing-function:ease-in-out}.navbar-sidebar__brand{-webkit-box-align:center;-webkit-align-items:center;-moz-box-align:center;align-items:center;box-shadow:var(--ifm-navbar-shadow);-webkit-box-flex:1;-webkit-flex:1;-moz-box-flex:1;flex:1;height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar-sidebar__brand,.navbar-sidebar__items{display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex}.navbar-sidebar__items{height:-webkit-calc(100% - var(--ifm-navbar-height));height:-moz-calc(100% - var(--ifm-navbar-height));height:calc(100% - var(--ifm-navbar-height));-webkit-transform:translateZ(0);-moz-transform:translateZ(0);transform:translateZ(0);-webkit-transition:-webkit-transform var(--ifm-transition-fast) ease-in-out;transition:-webkit-transform var(--ifm-transition-fast) ease-in-out;-o-transition:-o-transform var(--ifm-transition-fast) ease-in-out;-moz-transition:transform var(--ifm-transition-fast) ease-in-out,-moz-transform var(--ifm-transition-fast) ease-in-out;transition:transform var(--ifm-transition-fast) ease-in-out;transition:transform var(--ifm-transition-fast) ease-in-out,-webkit-transform var(--ifm-transition-fast) ease-in-out,-moz-transform var(--ifm-transition-fast) ease-in-out,-o-transform var(--ifm-transition-fast) ease-in-out}.navbar-sidebar__items--show-secondary{-webkit-transform:translate3d(-webkit-calc((var(--ifm-navbar-sidebar-width))*-1),0,0);-moz-transform:translate3d(-moz-calc((var(--ifm-navbar-sidebar-width))*-1),0,0);transform:translate3d(calc((var(--ifm-navbar-sidebar-width))*-1),0,0)}.navbar-sidebar__item{-webkit-flex-shrink:0;flex-shrink:0;padding:.5rem;width:-webkit-calc(var(--ifm-navbar-sidebar-width));width:-moz-calc(var(--ifm-navbar-sidebar-width));width:calc(var(--ifm-navbar-sidebar-width))}.navbar-sidebar__back{background:var(--ifm-menu-color-background-active);font-size:15px;font-weight:var(--ifm-button-font-weight);margin:0 0 .2rem -.5rem;padding:.6rem 1.5rem;position:relative;text-align:left;top:-.5rem;width:-webkit-calc(100% + 1rem);width:-moz-calc(100% + 1rem);width:calc(100% + 1rem)}.navbar-sidebar__close{margin-left:auto}.docMainContainer_TBSr,.docRoot_UBD9,.docsWrapper_hBAB,.navbar-sidebar__close,.pagination{display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex}.pagination{-moz-column-gap:var(--ifm-pagination-page-spacing);-webkit-column-gap:var(--ifm-pagination-page-spacing);column-gap:var(--ifm-pagination-page-spacing);font-size:var(--ifm-pagination-font-size);padding-left:0}.pagination--sm{--ifm-pagination-font-size:0.8rem;--ifm-pagination-padding-horizontal:0.8rem;--ifm-pagination-padding-vertical:0.2rem}.pagination--lg{--ifm-pagination-font-size:1.2rem;--ifm-pagination-padding-horizontal:1.2rem;--ifm-pagination-padding-vertical:0.3rem}.pagination__item{display:-webkit-inline-box;display:-webkit-inline-flex;display:-moz-inline-box;display:inline-flex}.pagination__item>span{padding:var(--ifm-pagination-padding-vertical)}.pagination__item--active .pagination__link{color:var(--ifm-pagination-color-active)}.pagination__item--active .pagination__link,.pagination__item:not(.pagination__item--active):hover .pagination__link{background:var(--ifm-pagination-item-active-background)}.pagination__item--disabled,.pagination__item[disabled]{opacity:.25;pointer-events:none}.pagination__link{border-radius:var(--ifm-pagination-border-radius);color:var(--ifm-font-color-base);display:inline-block;padding:var(--ifm-pagination-padding-vertical) var(--ifm-pagination-padding-horizontal);-webkit-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination__link:hover{text-decoration:none}.pagination-nav{display:grid;grid-gap:var(--ifm-spacing-horizontal);gap:var(--ifm-spacing-horizontal);grid-template-columns:repeat(2,1fr)}.pagination-nav__link{border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-pagination-nav-border-radius);display:block;height:100%;line-height:var(--ifm-heading-line-height);padding:var(--ifm-global-spacing);-webkit-transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination-nav__link:hover{border-color:var(--ifm-pagination-nav-color-hover);text-decoration:none}.pagination-nav__link--next{grid-column:2/3;text-align:right}.pagination-nav__label{font-size:var(--ifm-h4-font-size);font-weight:var(--ifm-heading-font-weight);word-break:break-word}.pagination-nav__link--prev .pagination-nav__label:before{content:"« "}.pagination-nav__link--next .pagination-nav__label:after{content:" »"}.pagination-nav__sublabel{color:var(--ifm-color-content-secondary);font-size:var(--ifm-h5-font-size);font-weight:var(--ifm-font-weight-semibold);margin-bottom:.25rem}.pills__item,.tabs{font-weight:var(--ifm-font-weight-bold)}.pills{display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;gap:var(--ifm-pills-spacing);padding-left:0}.pills__item{border-radius:.5rem;cursor:pointer;display:inline-block;padding:.25rem 1rem;-webkit-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs,:not(.containsTaskList_mC6p>li)>.containsTaskList_mC6p{padding-left:0}.pills__item--active{color:var(--ifm-pills-color-active)}.pills__item--active,.pills__item:not(.pills__item--active):hover{background:var(--ifm-pills-color-background-active)}.pills--block{-webkit-box-pack:stretch;-webkit-justify-content:stretch;-moz-box-pack:stretch;justify-content:stretch}.pills--block .pills__item{-webkit-box-flex:1;-webkit-flex-grow:1;-moz-box-flex:1;flex-grow:1;text-align:center}.tabs{color:var(--ifm-tabs-color);display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;margin-bottom:0;overflow-x:auto}.tabs__item{border-bottom:3px solid transparent;border-radius:var(--ifm-global-radius);cursor:pointer;display:-webkit-inline-box;display:-webkit-inline-flex;display:-moz-inline-box;display:inline-flex;padding:var(--ifm-tabs-padding-vertical) var(--ifm-tabs-padding-horizontal);-webkit-transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs__item--active{border-bottom-color:var(--ifm-tabs-color-active-border);border-bottom-left-radius:0;border-bottom-right-radius:0;color:var(--ifm-tabs-color-active)}.tabs__item:hover{background-color:var(--ifm-hover-overlay)}.tabs--block{-webkit-box-pack:stretch;-webkit-justify-content:stretch;-moz-box-pack:stretch;justify-content:stretch}.tabs--block .tabs__item{-webkit-box-flex:1;-webkit-flex-grow:1;-moz-box-flex:1;flex-grow:1;-webkit-box-pack:center;-webkit-justify-content:center;-moz-box-pack:center;justify-content:center}html[data-theme=dark]{--ifm-color-scheme:dark;--ifm-color-emphasis-0:var(--ifm-color-gray-1000);--ifm-color-emphasis-100:var(--ifm-color-gray-900);--ifm-color-emphasis-200:var(--ifm-color-gray-800);--ifm-color-emphasis-300:var(--ifm-color-gray-700);--ifm-color-emphasis-400:var(--ifm-color-gray-600);--ifm-color-emphasis-600:var(--ifm-color-gray-400);--ifm-color-emphasis-700:var(--ifm-color-gray-300);--ifm-color-emphasis-800:var(--ifm-color-gray-200);--ifm-color-emphasis-900:var(--ifm-color-gray-100);--ifm-color-emphasis-1000:var(--ifm-color-gray-0);--ifm-background-color:#1b1b1d;--ifm-background-surface-color:#242526;--ifm-hover-overlay:hsla(0,0%,100%,.05);--ifm-color-content:#e3e3e3;--ifm-color-content-secondary:#fff;--ifm-breadcrumb-separator-filter:invert(64%) sepia(11%) saturate(0%) hue-rotate(149deg) brightness(99%) contrast(95%);--ifm-code-background:hsla(0,0%,100%,.1);--ifm-scrollbar-track-background-color:#444;--ifm-scrollbar-thumb-background-color:#686868;--ifm-scrollbar-thumb-hover-background-color:#7a7a7a;--ifm-table-stripe-background:hsla(0,0%,100%,.07);--ifm-toc-border-color:var(--ifm-color-emphasis-200);--ifm-color-primary-contrast-background:#102445;--ifm-color-primary-contrast-foreground:#ebf2fc;--ifm-color-secondary-contrast-background:#474748;--ifm-color-secondary-contrast-foreground:#fdfdfe;--ifm-color-success-contrast-background:#003100;--ifm-color-success-contrast-foreground:#e6f6e6;--ifm-color-info-contrast-background:#193c47;--ifm-color-info-contrast-foreground:#eef9fd;--ifm-color-warning-contrast-background:#4d3800;--ifm-color-warning-contrast-foreground:#fff8e6;--ifm-color-danger-contrast-background:#4b1113;--ifm-color-danger-contrast-foreground:#ffebec}#nprogress .bar{background:var(--docusaurus-progress-bar-color);height:2px;left:0;position:fixed;top:0;width:100%;z-index:1031}#nprogress .peg{box-shadow:0 0 10px var(--docusaurus-progress-bar-color),0 0 5px var(--docusaurus-progress-bar-color);height:100%;opacity:1;position:absolute;right:0;-webkit-transform:rotate(3deg) translateY(-4px);-moz-transform:rotate(3deg) translateY(-4px);-o-transform:rotate(3deg) translateY(-4px);transform:rotate(3deg) translateY(-4px);width:100px}.footer__copyright-container{-webkit-flex-direction:column;flex-direction:column;-webkit-box-pack:center;-webkit-justify-content:center;-moz-box-pack:center;justify-content:center}.footer__copyright-container,.footer__icon-container{-webkit-box-align:center;-webkit-align-items:center;-moz-box-align:center;align-items:center;display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;width:100%}.footer__icon-container{-webkit-box-orient:horizontal;-webkit-flex-direction:row;-moz-box-orient:horizontal;flex-direction:row;-webkit-box-pack:start;-webkit-justify-content:flex-start;-moz-box-pack:start;justify-content:flex-start}.footer__icon-link{display:inline-block;padding:0 1rem 0 0}.footer__icon-link:hover svg path{fill:var(--agl-primary-color-dark-500)}.footer__icon-link svg path{fill:var(--agl-text-color-dark);-webkit-transition:fill var(--ifm-transition-fast) ease-in-out;-o-transition:fill var(--ifm-transition-fast) ease-in-out;-moz-transition:fill var(--ifm-transition-fast) ease-in-out;transition:fill var(--ifm-transition-fast) ease-in-out}.footer__text{color:var(--agl-text-color-dark);margin:0}.footer__text--link,.footer__text--link:hover{color:var(--agl-primary-color-dark-500)}[data-theme=dark]{--ifm-color-primary:var(--agl-primary-color-dark-500);--ifm-color-primary-dark:var(--agl-primary-color-dark-600);--ifm-color-primary-darker:var(--agl-primary-color-dark-700);--ifm-color-primary-darkest:var(--agl-primary-color-dark-800);--ifm-color-primary-light:var(--agl-primary-color-dark-400);--ifm-color-primary-lighter:var(--agl-primary-color-dark-300);--ifm-color-primary-lightest:var(--agl-primary-color-dark-200)}.navbar__icon:before{content:"";display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex}.navbar__icon:hover{opacity:.6}.navbar__icon--github{background:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'%3E%3Cpath 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}.navbar__icon--npm{background:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 32 32'%3E%3Cpath d='M0 10v11h9v2h7v-2h16V10zm1.777 1.777h7.114v7.668H7.11v-5.888H5.334v5.888H1.777zm8.891 0h7.111v7.666h-3.556v1.78h-3.555zm8.889 0h10.668v7.668h-1.78v-5.888h-1.777v5.888h-1.777v-5.888h-1.78v5.888h-3.554zm-5.334 1.78v4.111H16v-4.111z'/%3E%3C/svg%3E") no-repeat}html[data-theme=dark] .navbar__icon--github{background:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'%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}html[data-theme=dark] .navbar__icon--npm{background:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 32 32'%3E%3Cpath fill='%23fff' d='M0 10v11h9v2h7v-2h16V10zm1.777 1.777h7.114v7.668H7.11v-5.888H5.334v5.888H1.777zm8.891 0h7.111v7.666h-3.556v1.78h-3.555zm8.889 0h10.668v7.668h-1.78v-5.888h-1.777v5.888h-1.777v-5.888h-1.78v5.888h-3.554zm-5.334 1.78v4.111H16v-4.111z'/%3E%3C/svg%3E") no-repeat}body:not(.navigation-with-keyboard) :not(input):focus{outline:0}#__docusaurus-base-url-issue-banner-container,.docSidebarContainer_YfHR,.navbarSearchContainer_Bca1:empty,.sidebarLogo_isFc,.themedComponent_mlkZ,[data-theme=dark] .lightToggleIcon_pyhR,[data-theme=light] .darkToggleIcon_wfgR,html[data-announcement-bar-initially-dismissed=true] .announcementBar_mb4j{display:none}.announcementBar_mb4j,.toggleButton_gllP{-webkit-box-align:center;display:-webkit-box;display:-webkit-flex;display:-moz-box}.skipToContent_fXgn{background-color:var(--ifm-background-surface-color);color:var(--ifm-color-emphasis-900);left:100%;padding:calc(var(--ifm-global-spacing)/2) var(--ifm-global-spacing);position:fixed;top:1rem;z-index:-webkit-calc(var(--ifm-z-index-fixed) + 1);z-index:-moz-calc(var(--ifm-z-index-fixed) + 1);z-index:calc(var(--ifm-z-index-fixed) + 1)}.skipToContent_fXgn:focus{box-shadow:var(--ifm-global-shadow-md);left:1rem}.closeButton_CVFx{line-height:0;padding:0}.content_knG7{font-size:85%;padding:5px 0;text-align:center}.content_knG7 a{color:inherit;text-decoration:underline}.announcementBar_mb4j{display:flex;-webkit-align-items:center;-moz-box-align:center;align-items:center;background-color:var(--ifm-color-white);border-bottom:1px solid var(--ifm-color-emphasis-100);color:var(--ifm-color-black);height:var(--docusaurus-announcement-bar-height)}.announcementBarPlaceholder_vyr4{-webkit-box-flex:0;-webkit-flex:0 0 10px;-moz-box-flex:0;flex:0 0 10px}.announcementBarClose_gvF7{-webkit-box-flex:0;-webkit-flex:0 0 30px;-moz-box-flex:0;-webkit-align-self:stretch;align-self:stretch;flex:0 0 30px}.toggle_vylO{height:2rem;width:2rem}.toggleButton_gllP{-webkit-align-items:center;-moz-box-align:center;align-items:center;display:flex;-webkit-box-pack:center;-webkit-justify-content:center;-moz-box-pack:center;border-radius:50%;height:100%;justify-content:center;-webkit-transition:background var(--ifm-transition-fast);-o-transition:background var(--ifm-transition-fast);-moz-transition:background var(--ifm-transition-fast);transition:background var(--ifm-transition-fast);width:100%}.toggleButton_gllP:hover{background:var(--ifm-color-emphasis-200)}.toggleButtonDisabled_aARS{cursor:not-allowed}.darkNavbarColorModeToggle_X3D1:hover{background:var(--ifm-color-gray-800)}.tableOfContentsInline_prmo ul{font-size:medium;list-style-type:disc;padding-top:0}.tag_zVej{border:1px solid var(--docusaurus-tag-list-border);-webkit-transition:border var(--ifm-transition-fast);-o-transition:border var(--ifm-transition-fast);-moz-transition:border var(--ifm-transition-fast);transition:border var(--ifm-transition-fast)}.tag_zVej:hover{--docusaurus-tag-list-border:var(--ifm-link-color);text-decoration:none}.tagRegular_sFm0{border-radius:var(--ifm-global-radius);font-size:90%;padding:.2rem .5rem .3rem}.tagWithCount_h2kH{display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;-webkit-box-align:center;-webkit-align-items:center;-moz-box-align:center;align-items:center;border-left:0;padding:0 .5rem 0 1rem;position:relative}.tagWithCount_h2kH:after,.tagWithCount_h2kH:before{border:1px solid var(--docusaurus-tag-list-border);content:"";position:absolute;top:50%;-webkit-transition:inherit;-o-transition:inherit;-moz-transition:inherit;transition:inherit}.tagWithCount_h2kH:before{border-bottom:0;border-right:0;height:1.18rem;right:100%;-webkit-transform:translate(50%,-50%) rotate(-45deg);-moz-transform:translate(50%,-50%) rotate(-45deg);-o-transform:translate(50%,-50%) rotate(-45deg);transform:translate(50%,-50%) rotate(-45deg);width:1.18rem}.tagWithCount_h2kH:after{border-radius:50%;height:.5rem;left:0;-webkit-transform:translateY(-50%);-moz-transform:translateY(-50%);-o-transform:translateY(-50%);transform:translateY(-50%);width:.5rem}.tagWithCount_h2kH span{background:var(--ifm-color-secondary);border-radius:var(--ifm-global-radius);color:var(--ifm-color-black);font-size:.7rem;line-height:1.2;margin-left:.3rem;padding:.1rem .4rem}.tags_jXut{display:inline}.tag_QGVx{display:inline-block;margin:0 .4rem .5rem 0}.iconEdit_Z9Sw{margin-right:.3em;vertical-align:sub}.lastUpdated_JAkA{font-size:smaller;font-style:italic;margin-top:.2rem}.tocCollapsibleButton_TO0P{display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;font-size:inherit;-webkit-box-pack:justify;-webkit-justify-content:space-between;-moz-box-pack:justify;justify-content:space-between;-webkit-box-align:center;-webkit-align-items:center;-moz-box-align:center;align-items:center;padding:.4rem .8rem;width:100%}.tocCollapsibleButton_TO0P:after{background:var(--ifm-menu-link-sublist-icon) 50% 50%/2rem 2rem no-repeat;content:"";-webkit-filter:var(--ifm-menu-link-sublist-icon-filter);filter:var(--ifm-menu-link-sublist-icon-filter);height:1.25rem;-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg);-webkit-transition:-webkit-transform var(--ifm-transition-fast);transition:-webkit-transform var(--ifm-transition-fast);-o-transition:-o-transform var(--ifm-transition-fast);-moz-transition:transform var(--ifm-transition-fast),-moz-transform var(--ifm-transition-fast);transition:transform var(--ifm-transition-fast);transition:transform var(--ifm-transition-fast),-webkit-transform var(--ifm-transition-fast),-moz-transform var(--ifm-transition-fast),-o-transform var(--ifm-transition-fast);width:1.25rem}.tocCollapsibleButtonExpanded_MG3E:after,.tocCollapsibleExpanded_sAul{-webkit-transform:none;-moz-transform:none;-o-transform:none;transform:none}.tocCollapsible_ETCw{background-color:var(--ifm-menu-color-background-active);border-radius:var(--ifm-global-radius);margin:1rem 0}.tocCollapsibleContent_vkbj>ul{border-left:none;border-top:1px solid var(--ifm-color-emphasis-300);font-size:15px;padding:.2rem 0}.tocCollapsibleContent_vkbj ul li{margin:.4rem .8rem}.tocCollapsibleContent_vkbj a{display:block}.tableOfContents_bqdL{max-height:-webkit-calc(100vh - var(--ifm-navbar-height) - 2rem);max-height:-moz-calc(100vh - var(--ifm-navbar-height) - 2rem);max-height:calc(100vh - var(--ifm-navbar-height) - 2rem);overflow-y:auto;position:-webkit-sticky;position:sticky;top:-webkit-calc(var(--ifm-navbar-height) + 1rem);top:-moz-calc(var(--ifm-navbar-height) + 1rem);top:calc(var(--ifm-navbar-height) + 1rem)}.backToTopButton_sjWU{background-color:var(--ifm-color-emphasis-200);border-radius:50%;bottom:1.3rem;box-shadow:var(--ifm-global-shadow-lw);height:3rem;opacity:0;position:fixed;right:1.3rem;-webkit-transform:scale(0);-moz-transform:scale(0);-o-transform:scale(0);transform:scale(0);-webkit-transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);visibility:hidden;width:3rem;z-index:-webkit-calc(var(--ifm-z-index-fixed) - 1);z-index:-moz-calc(var(--ifm-z-index-fixed) - 1);z-index:calc(var(--ifm-z-index-fixed) - 1)}.backToTopButton_sjWU:after{background-color:var(--ifm-color-emphasis-1000);content:" ";display:inline-block;height:100%;-webkit-mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;width:100%}.backToTopButtonShow_xfvO{opacity:1;-webkit-transform:scale(1);-moz-transform:scale(1);-o-transform:scale(1);transform:scale(1);visibility:visible}[data-theme=dark] .themedComponent--dark_xIcU,[data-theme=light] .themedComponent--light_NVdE,html:not([data-theme]) .themedComponent--light_NVdE{display:initial}[data-theme=dark]:root{--docusaurus-collapse-button-bg:hsla(0,0%,100%,.05);--docusaurus-collapse-button-bg-hover:hsla(0,0%,100%,.1)}.collapseSidebarButton_PEFL{display:none;margin:0}#__docusaurus,.mainWrapper_z2l0{display:-webkit-box;display:-webkit-flex;display:-moz-box;-webkit-box-orient:vertical;-webkit-box-direction:normal;-moz-box-orient:vertical;-moz-box-direction:normal}.iconExternalLink_nPIU{margin-left:.3rem}.dropdownNavbarItemMobile_S0Fm{cursor:pointer}.iconLanguage_nlXk{margin-right:5px;vertical-align:text-bottom}.navbarHideable_m1mJ{-webkit-transition:-webkit-transform var(--ifm-transition-fast) ease;transition:-webkit-transform var(--ifm-transition-fast) ease;-o-transition:-o-transform var(--ifm-transition-fast) ease;-moz-transition:transform var(--ifm-transition-fast) ease,-moz-transform var(--ifm-transition-fast) ease;transition:transform var(--ifm-transition-fast) ease;transition:transform var(--ifm-transition-fast) ease,-webkit-transform var(--ifm-transition-fast) ease,-moz-transform var(--ifm-transition-fast) ease,-o-transform var(--ifm-transition-fast) ease}.navbarHidden_jGov{-webkit-transform:translate3d(0,-webkit-calc(-100% - 2px),0);-moz-transform:translate3d(0,-moz-calc(-100% - 2px),0);transform:translate3d(0,calc(-100% - 2px),0)}.errorBoundaryError_a6uf{color:red;white-space:pre-wrap}.errorBoundaryFallback_VBag{color:red;padding:.55rem}.buttonGroup__atx button,.codeBlockContainer_Ckt0{background:var(--prism-background-color);color:var(--prism-color)}.footerLogoLink_BH7S{opacity:.5;-webkit-transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default);-o-transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default);-moz-transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default);transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.footerLogoLink_BH7S:hover,.hash-link:focus,:hover>.hash-link{opacity:1}.docMainContainer_TBSr,.docRoot_UBD9{width:100%}.docsWrapper_hBAB{-webkit-box-flex:1;-webkit-flex:1 0 auto;-moz-box-flex:1;flex:1 0 auto}.anchorWithStickyNavbar_LWe7{scroll-margin-top:-webkit-calc(var(--ifm-navbar-height) + .5rem);scroll-margin-top:-moz-calc(var(--ifm-navbar-height) + .5rem);scroll-margin-top:calc(var(--ifm-navbar-height) + .5rem)}.anchorWithHideOnScrollNavbar_WYt5{scroll-margin-top:.5rem}.hash-link{opacity:0;padding-left:.5rem;-webkit-transition:opacity var(--ifm-transition-fast);-o-transition:opacity var(--ifm-transition-fast);-moz-transition:opacity var(--ifm-transition-fast);transition:opacity var(--ifm-transition-fast);-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.hash-link:before{content:"#"}.mainWrapper_z2l0{-webkit-box-flex:1;-webkit-flex:1 0 auto;-moz-box-flex:1;display:flex;flex:1 0 auto;-webkit-flex-direction:column;flex-direction:column}.docusaurus-mt-lg{margin-top:3rem}#__docusaurus{display:flex;min-height:100%;-webkit-flex-direction:column;flex-direction:column}.codeBlockContainer_Ckt0{border-radius:var(--ifm-code-border-radius);box-shadow:var(--ifm-global-shadow-lw);margin-bottom:var(--ifm-leading)}.codeBlockContent_biex{border-radius:inherit;direction:ltr;position:relative}.codeBlockTitle_Ktv7{border-bottom:1px solid var(--ifm-color-emphasis-300);border-top-left-radius:inherit;border-top-right-radius:inherit;font-size:var(--ifm-code-font-size);font-weight:500;padding:.75rem var(--ifm-pre-padding)}.codeBlock_bY9V{--ifm-pre-background:var(--prism-background-color);margin:0;padding:0}.codeBlockTitle_Ktv7+.codeBlockContent_biex .codeBlock_bY9V{border-top-left-radius:0;border-top-right-radius:0}.codeBlockLines_e6Vv{float:left;font:inherit;min-width:100%;padding:var(--ifm-pre-padding)}.codeBlockLinesWithNumbering_o6Pm{display:table;padding:var(--ifm-pre-padding) 0}.buttonGroup__atx{-webkit-column-gap:.2rem;-moz-column-gap:.2rem;column-gap:.2rem;position:absolute;right:-webkit-calc(var(--ifm-pre-padding)/2);right:-moz-calc(var(--ifm-pre-padding)/2);right:calc(var(--ifm-pre-padding)/2);top:-webkit-calc(var(--ifm-pre-padding)/2);top:-moz-calc(var(--ifm-pre-padding)/2);top:calc(var(--ifm-pre-padding)/2)}.buttonGroup__atx,.buttonGroup__atx button{display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex}.buttonGroup__atx button{-webkit-box-align:center;-webkit-align-items:center;-moz-box-align:center;align-items:center;border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-global-radius);line-height:0;opacity:0;padding:.4rem;-webkit-transition:opacity var(--ifm-transition-fast) ease-in-out;-o-transition:opacity var(--ifm-transition-fast) ease-in-out;-moz-transition:opacity var(--ifm-transition-fast) ease-in-out;transition:opacity var(--ifm-transition-fast) ease-in-out}.buttonGroup__atx button:focus-visible,.buttonGroup__atx button:hover{opacity:1!important}.theme-code-block:hover .buttonGroup__atx button{opacity:.4}:where(:root){--docusaurus-highlighted-code-line-bg:#484d5b}:where([data-theme=dark]){--docusaurus-highlighted-code-line-bg:#646464}.theme-code-block-highlighted-line{background-color:var(--docusaurus-highlighted-code-line-bg);display:block;margin:0 calc(var(--ifm-pre-padding)*-1);padding:0 var(--ifm-pre-padding)}.codeLine_lJS_{counter-increment:a;display:table-row}.codeLineNumber_Tfdd{background:var(--ifm-pre-background);display:table-cell;left:0;overflow-wrap:normal;padding:0 var(--ifm-pre-padding);position:-webkit-sticky;position:sticky;text-align:right;width:1%}.codeLineNumber_Tfdd:before{content:counter(a);opacity:.4}.codeLineContent_feaV{padding-right:var(--ifm-pre-padding)}.theme-code-block:hover .copyButtonCopied_obH4{opacity:1!important}.copyButtonIcons_eSgA{height:1.125rem;position:relative;width:1.125rem}.copyButtonIcon_y97N,.copyButtonSuccessIcon_LjdS{left:0;position:absolute;top:0;fill:currentColor;height:inherit;opacity:inherit;-webkit-transition:all var(--ifm-transition-fast) ease;-o-transition:all var(--ifm-transition-fast) ease;-moz-transition:all var(--ifm-transition-fast) ease;transition:all var(--ifm-transition-fast) ease;width:inherit}.copyButtonSuccessIcon_LjdS{color:#00d600;left:50%;opacity:0;top:50%;-webkit-transform:translate(-50%,-50%) scale(.33);-moz-transform:translate(-50%,-50%) scale(.33);-o-transform:translate(-50%,-50%) scale(.33);transform:translate(-50%,-50%) scale(.33)}.copyButtonCopied_obH4 .copyButtonIcon_y97N{opacity:0;-webkit-transform:scale(.33);-moz-transform:scale(.33);-o-transform:scale(.33);transform:scale(.33)}.copyButtonCopied_obH4 .copyButtonSuccessIcon_LjdS{opacity:1;-webkit-transform:translate(-50%,-50%) scale(1);-moz-transform:translate(-50%,-50%) scale(1);-o-transform:translate(-50%,-50%) scale(1);transform:translate(-50%,-50%) scale(1);-webkit-transition-delay:75ms;-moz-transition-delay:75ms;-o-transition-delay:75ms;transition-delay:75ms}.wordWrapButtonIcon_Bwma{height:1.2rem;width:1.2rem}.details_lb9f{--docusaurus-details-summary-arrow-size:0.38rem;--docusaurus-details-transition:transform 200ms ease;--docusaurus-details-decoration-color:grey}.details_lb9f>summary{cursor:pointer;padding-left:1rem;position:relative}.details_lb9f>summary::-webkit-details-marker{display:none}.details_lb9f>summary:before{border-color:transparent transparent transparent var(--docusaurus-details-decoration-color);border-style:solid;border-width:var(--docusaurus-details-summary-arrow-size);content:"";left:0;position:absolute;top:.45rem;-webkit-transform:rotate(0);-moz-transform:rotate(0);-o-transform:rotate(0);transform:rotate(0);-webkit-transform-origin:-webkit-calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;-moz-transform-origin:-moz-calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;-o-transform-origin:calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;transform-origin:calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;-webkit-transition:var(--docusaurus-details-transition);-o-transition:var(--docusaurus-details-transition);-moz-transition:var(--docusaurus-details-transition);transition:var(--docusaurus-details-transition)}.collapsibleContent_i85q{border-top:1px solid var(--docusaurus-details-decoration-color);margin-top:1rem;padding-top:1rem}.details_b_Ee{--docusaurus-details-decoration-color:var(--ifm-alert-border-color);--docusaurus-details-transition:transform var(--ifm-transition-fast) ease;border:1px solid var(--ifm-alert-border-color);margin:0 0 var(--ifm-spacing-vertical)}.img_ev3q{height:auto}.admonition_xJq3{margin-bottom:1em}.admonitionHeading_Gvgb{font:var(--ifm-heading-font-weight) var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family)}.admonitionHeading_Gvgb:not(:last-child){margin-bottom:.3rem}.admonitionHeading_Gvgb code{text-transform:none}.admonitionIcon_Rf37{display:inline-block;margin-right:.4em;vertical-align:middle}.admonitionIcon_Rf37 svg{display:inline-block;height:1.6em;width:1.6em;fill:var(--ifm-alert-foreground-color)}.breadcrumbHomeIcon_YNFT{height:1.1rem;position:relative;top:1px;vertical-align:top;width:1.1rem}.breadcrumbsContainer_Z_bl{--ifm-breadcrumb-size-multiplier:0.8;margin-bottom:.8rem}@media (min-width:997px){.collapseSidebarButton_PEFL,.expandButton_TmdG{background-color:var(--docusaurus-collapse-button-bg)}:root{--docusaurus-announcement-bar-height:30px}.announcementBarClose_gvF7,.announcementBarPlaceholder_vyr4{-webkit-flex-basis:50px;flex-basis:50px}.lastUpdated_JAkA{text-align:right}.tocMobile_ITEo{display:none}.collapseSidebarButton_PEFL{border:1px solid var(--ifm-toc-border-color);border-radius:0;bottom:0;display:block!important;height:40px;position:-webkit-sticky;position:sticky}.collapseSidebarButtonIcon_kv0_{margin-top:4px;-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.expandButtonIcon_i1dp,[dir=rtl] .collapseSidebarButtonIcon_kv0_{-webkit-transform:rotate(0);-moz-transform:rotate(0);-o-transform:rotate(0);transform:rotate(0)}.collapseSidebarButton_PEFL:focus,.collapseSidebarButton_PEFL:hover,.expandButton_TmdG:focus,.expandButton_TmdG:hover{background-color:var(--docusaurus-collapse-button-bg-hover)}.navbarSearchContainer_Bca1{padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.menuHtmlItem_M9Kj{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu_SIkG{-webkit-box-flex:1;-webkit-flex-grow:1;-moz-box-flex:1;flex-grow:1;padding:.5rem}@supports (scrollbar-gutter:stable){.menu_SIkG{padding:.5rem 0 .5rem .5rem;scrollbar-gutter:stable}}.menuWithAnnouncementBar_GW3s{margin-bottom:var(--docusaurus-announcement-bar-height)}.sidebar_njMd{display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;-webkit-box-orient:vertical;-webkit-box-direction:normal;-webkit-flex-direction:column;-moz-box-orient:vertical;-moz-box-direction:normal;flex-direction:column;height:100%;padding-top:var(--ifm-navbar-height);width:var(--doc-sidebar-width)}.sidebarWithHideableNavbar_wUlq{padding-top:0}.sidebarHidden_VK0M{opacity:0;visibility:hidden}.sidebarLogo_isFc{display:-webkit-box!important;display:-webkit-flex!important;display:-moz-box!important;display:flex!important;-webkit-box-align:center;-webkit-align-items:center;-moz-box-align:center;align-items:center;color:inherit!important;margin:0 var(--ifm-navbar-padding-horizontal);max-height:var(--ifm-navbar-height);min-height:var(--ifm-navbar-height);text-decoration:none!important}.sidebarLogo_isFc img{height:2rem;margin-right:.5rem}.expandButton_TmdG{display:-webkit-box;display:-webkit-flex;display:-moz-box;display:flex;height:100%;position:absolute;right:0;top:0;width:100%;-webkit-box-align:center;-webkit-align-items:center;-moz-box-align:center;align-items:center;-webkit-box-pack:center;-webkit-justify-content:center;-moz-box-pack:center;justify-content:center;-webkit-transition:background-color var(--ifm-transition-fast) ease;-o-transition:background-color var(--ifm-transition-fast) ease;-moz-transition:background-color var(--ifm-transition-fast) ease;transition:background-color var(--ifm-transition-fast) ease}[dir=rtl] .expandButtonIcon_i1dp{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.docSidebarContainer_YfHR{border-right:1px solid var(--ifm-toc-border-color);-webkit-clip-path:inset(0);clip-path:inset(0);display:block;margin-top:calc(var(--ifm-navbar-height)*-1);-webkit-transition:width var(--ifm-transition-fast) ease;-o-transition:width var(--ifm-transition-fast) ease;-moz-transition:width var(--ifm-transition-fast) ease;transition:width var(--ifm-transition-fast) ease;width:var(--doc-sidebar-width);will-change:width}.docSidebarContainerHidden_DPk8{cursor:pointer;width:var(--doc-sidebar-hidden-width)}.sidebarViewport_aRkj{height:100%;max-height:100vh;position:-webkit-sticky;position:sticky;top:0}.docMainContainer_TBSr{-webkit-box-flex:1;-webkit-flex-grow:1;-moz-box-flex:1;flex-grow:1;max-width:-webkit-calc(100% - var(--doc-sidebar-width));max-width:-moz-calc(100% - var(--doc-sidebar-width));max-width:calc(100% - var(--doc-sidebar-width))}.docMainContainerEnhanced_lQrH{max-width:-webkit-calc(100% - var(--doc-sidebar-hidden-width));max-width:-moz-calc(100% - var(--doc-sidebar-hidden-width));max-width:calc(100% - var(--doc-sidebar-hidden-width))}.docItemWrapperEnhanced_JWYK{max-width:-webkit-calc(var(--ifm-container-width) + var(--doc-sidebar-width))!important;max-width:-moz-calc(var(--ifm-container-width) + var(--doc-sidebar-width))!important;max-width:calc(var(--ifm-container-width) + var(--doc-sidebar-width))!important}.docItemCol_VOVn{max-width:75%!important}}@media (min-width:1440px){.container{max-width:var(--ifm-container-width-xl)}}@media (max-width:996px){.col{--ifm-col-width:100%;-webkit-flex-basis:var(--ifm-col-width);flex-basis:var(--ifm-col-width);margin-left:0}.footer{--ifm-footer-padding-horizontal:0}.colorModeToggle_DEke,.footer__link-separator,.navbar__item,.tableOfContents_bqdL{display:none}.footer__col{margin-bottom:calc(var(--ifm-spacing-vertical)*3)}.footer__link-item{display:block}.hero{padding-left:0;padding-right:0}.navbar>.container,.navbar>.container-fluid{padding:0}.navbar__toggle{display:inherit}.navbar__search-input{width:9rem}.pills--block,.tabs--block{-webkit-box-orient:vertical;-webkit-box-direction:normal;-webkit-flex-direction:column;-moz-box-orient:vertical;-moz-box-direction:normal;flex-direction:column}.docItemContainer_F8PC{padding:0 .3rem}.navbarSearchContainer_Bca1{position:absolute;right:var(--ifm-navbar-padding-horizontal)}}@media (max-width:576px){.markdown h1:first-child{--ifm-h1-font-size:2rem}.markdown>h2{--ifm-h2-font-size:1.5rem}.markdown>h3{--ifm-h3-font-size:1.25rem}}@media (hover:hover){.backToTopButton_sjWU:hover{background-color:var(--ifm-color-emphasis-300)}}@media (pointer:fine){.thin-scrollbar{scrollbar-width:thin}.thin-scrollbar::-webkit-scrollbar{height:var(--ifm-scrollbar-size);width:var(--ifm-scrollbar-size)}.thin-scrollbar::-webkit-scrollbar-track{background:var(--ifm-scrollbar-track-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb{background:var(--ifm-scrollbar-thumb-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb:hover{background:var(--ifm-scrollbar-thumb-hover-background-color)}}@media (prefers-reduced-motion:reduce){:root{--ifm-transition-fast:0ms;--ifm-transition-slow:0ms}}@media print{.announcementBar_mb4j,.footer,.menu,.navbar,.pagination-nav,.table-of-contents,.tocMobile_ITEo{display:none}.tabs{page-break-inside:avoid}.codeBlockLines_e6Vv{white-space:pre-wrap}} \ No newline at end of file diff --git a/assets/js/05942345.ca688560.js b/assets/js/05942345.ca688560.js new file mode 100644 index 0000000..c3420e1 --- /dev/null +++ b/assets/js/05942345.ca688560.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_agoralabs_sh_avm_web_provider=self.webpackChunk_agoralabs_sh_avm_web_provider||[]).push([[9361],{8466:function(n,a,e){e.r(a),e.d(a,{assets:function(){return g},contentTitle:function(){return d},default:function(){return u},frontMatter:function(){return c},metadata:function(){return l},toc:function(){return h}});var t=e(4848),r=e(8453),s=e(1470),o=e(9365),i=e(4252);const c={},d="Signing And Posting Transactions",l={id:"usage/clients/signing-and-posting-transactions",title:"Signing And Posting Transactions",description:" {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txnIDs: [\n 'OKU6A2Q...',\n ],\n }\n */\n});\n\n// send a sign and post transactions request\nclient.signAndPostTransactions({\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txns: [\n {\n txn: btoa(String.fromCodePoint(...transactionBytes)), // convert to base64 string\n },\n ],\n});\n"})})}),(0,t.jsx)(o.A,{value:"typescript",children:(0,t.jsx)(a.pre,{children:(0,t.jsx)(a.code,{className:"language-typescript",children:"import {\n Algodv2,\n algosToMicroalgos,\n makePaymentTxnWithSuggestedParamsFromObject,\n SuggestedParams,\n Transaction,\n} from 'algosdk';\nimport { IAVMWebClientCallbackOptions } from '@agoralabs-sh/avm-web-provider';\n\n// create a transaction\ntry {\n const client: Algodv2 = new Algodv2(\n 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',\n 'http://localhost',\n '4001',\n );\n const encoder: TextEncoder = new TextEncoder();\n const suggestedParams: SuggestedParams = await client.getTransactionParams().do();\n const transaction: Transaction = makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosToMicroalgos(1),\n from: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n note: encoder.encode('Hello Human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n const transactionBytes: Uint8Array = transaction.toByte();\n} catch (error) {\n // handle error\n}\n\n// initialized client\nclient.onSignAndPostTransactions(({ error, result }: IAVMWebClientCallbackOptions) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txnIDs: [\n 'OKU6A2Q...',\n ],\n }\n */\n});\n\n// send a sign and post transactions request\nclient.signAndPostTransactions({\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txns: [\n {\n txn: btoa(String.fromCodePoint(...transactionBytes)), // convert to base64 string\n },\n ],\n});\n"})})})]}),"\n",(0,t.jsx)(a.admonition,{type:"caution",children:(0,t.jsxs)(a.p,{children:["If this method is not supported, then a ",(0,t.jsx)(a.a,{href:"../../api-reference/errors#methodnotsupportederror",children:(0,t.jsx)(a.code,{children:"MethodNotSupportedError"})})," should be thrown."]})}),"\n",(0,t.jsx)(a.admonition,{type:"caution",children:(0,t.jsxs)(a.p,{children:["If there is a group of atomic transactions, but the computed group ID is invalid, then a ",(0,t.jsx)(a.a,{href:"../../api-reference/errors#invalidgroupiderror",children:(0,t.jsx)(a.code,{children:"InvalidGroupIdError"})})," should be thrown."]})}),"\n",(0,t.jsx)(a.admonition,{type:"caution",children:(0,t.jsxs)(a.p,{children:["If any of the transactions are malformed, then a ",(0,t.jsx)(a.a,{href:"../../api-reference/errors#invalidinputerror",children:(0,t.jsx)(a.code,{children:"InvalidInputError"})})," should be thrown."]})}),"\n",(0,t.jsx)(a.admonition,{type:"caution",children:(0,t.jsxs)(a.p,{children:["If the transactions fail to be accepted by the network, then a ",(0,t.jsx)(a.a,{href:"../../api-reference/errors#failedtopostsometransactionserror",children:(0,t.jsx)(a.code,{children:"FailedToPostSomeTransactionsError"})})," should be thrown."]})})]})}function u(n={}){const{wrapper:a}={...(0,r.R)(),...n.components};return a?(0,t.jsx)(a,{...n,children:(0,t.jsx)(p,{...n})}):p(n)}}}]); \ No newline at end of file diff --git a/assets/js/078f4f1e.ac253693.js b/assets/js/078f4f1e.ac253693.js new file mode 100644 index 0000000..fcd93fc --- /dev/null +++ b/assets/js/078f4f1e.ac253693.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_agoralabs_sh_avm_web_provider=self.webpackChunk_agoralabs_sh_avm_web_provider||[]).push([[4466],{1821:function(n,a,e){e.r(a),e.d(a,{assets:function(){return g},contentTitle:function(){return d},default:function(){return h},frontMatter:function(){return c},metadata:function(){return l},toc:function(){return u}});var t=e(4848),s=e(8453),r=e(1470),o=e(9365),i=e(4252);const c={},d="Signing Transactions",l={id:"usage/clients/signing-transactions",title:"Signing Transactions",description:" {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n stxns: [\n 'gqNzaWfEQ...',\n ],\n }\n */\n});\n\n// send a sign transactions request\nclient.signTransactions({\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txns: [\n {\n txn: btoa(String.fromCodePoint(...transactionBytes)), // convert to base64 string\n },\n ],\n});\n"})})}),(0,t.jsx)(o.A,{value:"typescript",children:(0,t.jsx)(a.pre,{children:(0,t.jsx)(a.code,{className:"language-typescript",children:"import {\n Algodv2,\n algosToMicroalgos,\n makePaymentTxnWithSuggestedParamsFromObject,\n SuggestedParams,\n Transaction,\n} from 'algosdk';\nimport { IAVMWebClientCallbackOptions } from '@agoralabs-sh/avm-web-provider';\n\n// create a transaction\ntry {\n const client: Algodv2 = new Algodv2(\n 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',\n 'http://localhost',\n '4001',\n );\n const encoder: TextEncoder = new TextEncoder();\n const suggestedParams: SuggestedParams = await client.getTransactionParams().do();\n const transaction: Transaction = makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosToMicroalgos(1),\n from: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n note: encoder.encode('Hello Human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n const transactionBytes: Uint8Array = transaction.toByte();\n} catch (error) {\n // handle error\n}\n\n// initialized client\nclient.onSignTransactions(({ error, result }: IAVMWebClientCallbackOptions) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n stxns: [\n 'gqNzaWfEQ...',\n ],\n }\n */\n});\n\n// send a sign transactions request\nclient.signTransactions({\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txns: [\n {\n txn: btoa(String.fromCodePoint(...transactionBytes)), // convert to base64 string\n },\n ],\n});\n"})})})]}),"\n",(0,t.jsx)(a.admonition,{type:"caution",children:(0,t.jsxs)(a.p,{children:["If this method is not supported, then a ",(0,t.jsx)(a.a,{href:"../../api-reference/errors#methodnotsupportederror",children:(0,t.jsx)(a.code,{children:"MethodNotSupportedError"})})," should be thrown."]})}),"\n",(0,t.jsx)(a.h2,{id:"signing-atomic-transactions",children:"Signing atomic transactions"}),"\n",(0,t.jsx)(a.p,{children:"When sending atomic transactions, all transactions, regardless of whether the wallet is signing only some of the transactions, must be sent with a matching group ID."}),"\n",(0,t.jsxs)(r.A,{defaultValue:"javascript",values:[{label:"Javascript",value:"javascript"},{label:"TypeScript",value:"typescript"}],children:[(0,t.jsx)(o.A,{value:"javascript",children:(0,t.jsx)(a.pre,{children:(0,t.jsx)(a.code,{className:"language-js",children:"const algosdk = require('algosdk');\n\ntry {\n const client = new algosdk.Algodv2(\n 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',\n 'http://localhost',\n '4001',\n );\n const encoder = new TextEncoder();\n const suggestedParams = await client.getTransactionParams().do();\n const firstTransaction = algosdk.makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosdk.algosToMicroalgos(1),\n from: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n note: encoder.encode('I am the first transaction, human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n const secondTransaction = algosdk.makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosdk.algosToMicroalgos(2),\n from: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n note: encoder.encode('I am the second transaction, human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n let firstTransactionBytes;\n let secondTransactionBytes;\n\n // assign a group id\n algosdk.assignGroupID([firstTransaction, secondTransaction]);\n\n firstTransactionBytes = firstTransaction.toByte();\n secondTransactionBytes = secondTransaction.toByte();\n} catch (error) {\n // handle error\n}\n\n// initialized client\nclient.onSignTransactions(({ error, result }) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n stxns: [\n 'gqNzaWfEQ...',\n 'gqNzaWfEQ...',\n ],\n }\n */\n});\n\n// send a sign transactions request\nclient.signTransactions({\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txns: [\n {\n txn: btoa(String.fromCodePoint(...firstTransactionBytes)), // convert to base64 string\n },\n {\n txn: btoa(String.fromCodePoint(...secondTransactionBytes)),\n },\n ],\n});\n"})})}),(0,t.jsx)(o.A,{value:"typescript",children:(0,t.jsx)(a.pre,{children:(0,t.jsx)(a.code,{className:"language-typescript",children:"import {\n Algodv2,\n algosToMicroalgos,\n assignGroupID,\n makePaymentTxnWithSuggestedParamsFromObject,\n SuggestedParams,\n Transaction,\n} from 'algosdk';\nimport { IAVMWebClientCallbackOptions } from '@agoralabs-sh/avm-web-provider';\n\n// create a transaction\ntry {\n const client: Algodv2 = new Algodv2(\n 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',\n 'http://localhost',\n '4001',\n );\n const encoder: TextEncoder = new TextEncoder();\n const suggestedParams: SuggestedParams = await client.getTransactionParams().do();\n const firstTransaction: Transaction = makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosToMicroalgos(1),\n from: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n note: encoder.encode('I am the first transaction, human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n const secondTransaction: Transaction = makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosToMicroalgos(2),\n from: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n note: encoder.encode('I am the second transaction, human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n let firstTransactionBytes: Uint8Array;\n let secondTransactionBytes: Uint8Array;\n\n // assign a group id\n assignGroupID([firstTransaction, secondTransaction]);\n\n firstTransactionBytes = firstTransaction.toByte();\n secondTransactionBytes = secondTransaction.toByte();\n} catch (error) {\n // handle error\n}\n\n// initialized client\nclient.onSignTransactions(({ error, result }: IAVMWebClientCallbackOptions) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n stxns: [\n 'gqNzaWfEQ...',\n 'gqNzaWfEQ...',\n ],\n }\n */\n});\n\n// send a sign transactions request\nclient.signTransactions({\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txns: [\n {\n txn: btoa(String.fromCodePoint(...firstTransactionBytes)), // convert to base64 string\n },\n {\n txn: btoa(String.fromCodePoint(...secondTransactionBytes)),\n },\n ],\n});\n"})})})]}),"\n",(0,t.jsx)(a.admonition,{type:"caution",children:(0,t.jsxs)(a.p,{children:["The provider may attempt to compute ID of these atomic transactions and if it doesn't match the assigned ID, then a ",(0,t.jsx)(a.a,{href:"../../api-reference/errors#invalidgroupiderror",children:(0,t.jsx)(a.code,{children:"InvalidGroupIdError"})})," may be thrown."]})}),"\n",(0,t.jsx)(a.h2,{id:"non-provider-signed-transactions",children:"Non-provider signed transactions"}),"\n",(0,t.jsxs)(a.p,{children:["In the case of a provider being sent multiple transactions, but only needing to sign a subset of the transactions, an empty ",(0,t.jsx)(a.code,{children:"signers"})," array must be used. This instructs the provider to skip the transaction even if it can sign it."]}),"\n",(0,t.jsx)(a.p,{children:"For example:"}),"\n",(0,t.jsxs)(r.A,{defaultValue:"javascript",values:[{label:"Javascript",value:"javascript"},{label:"TypeScript",value:"typescript"}],children:[(0,t.jsx)(o.A,{value:"javascript",children:(0,t.jsx)(a.pre,{children:(0,t.jsx)(a.code,{className:"language-js",children:"const algosdk = require('algosdk');\n\ntry {\n const client = new algosdk.Algodv2(\n 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',\n 'http://localhost',\n '4001',\n );\n const encoder = new TextEncoder();\n const suggestedParams = await client.getTransactionParams().do();\n const firstTransaction = algosdk.makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosdk.algosToMicroalgos(1),\n from: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n note: encoder.encode('I am the first transaction, human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n const secondTransaction = algosdk.makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosdk.algosToMicroalgos(2),\n from: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n note: encoder.encode('I am the second transaction, human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n const firstTransactionBytes = firstTransaction.toByte();\n const secondTransactionBytes = secondTransaction.toByte();\n} catch (error) {\n // handle error\n}\n\n// initialized client\nclient.onSignTransactions(({ error, result }) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n stxns: [\n 'gqNzaWfEQ...',\n null,\n ],\n }\n */\n});\n\n// send a sign transactions request\nclient.signTransactions({\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txns: [\n {\n txn: btoa(String.fromCodePoint(...firstTransactionBytes)), // convert to base64 string\n },\n {\n txn: btoa(String.fromCodePoint(...secondTransactionBytes)),\n signers: [], // use an empty signers array to skip this transaction\n },\n ],\n});\n"})})}),(0,t.jsx)(o.A,{value:"typescript",children:(0,t.jsx)(a.pre,{children:(0,t.jsx)(a.code,{className:"language-typescript",children:"import {\n Algodv2,\n algosToMicroalgos,\n makePaymentTxnWithSuggestedParamsFromObject,\n SuggestedParams,\n Transaction,\n} from 'algosdk';\nimport { IAVMWebClientCallbackOptions } from '@agoralabs-sh/avm-web-provider';\n\n// create a transaction\ntry {\n const client: Algodv2 = new Algodv2(\n 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',\n 'http://localhost',\n '4001',\n );\n const encoder: TextEncoder = new TextEncoder();\n const suggestedParams: SuggestedParams = await client.getTransactionParams().do();\n const firstTransaction: Transaction = makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosToMicroalgos(1),\n from: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n note: encoder.encode('I am the first transaction, human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n const secondTransaction: Transaction = makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosToMicroalgos(2),\n from: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n note: encoder.encode('I am the second transaction, human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n const firstTransactionBytes: Uint8Array = firstTransaction.toByte();\n const secondTransactionBytes: Uint8Array = secondTransaction.toByte();\n} catch (error) {\n // handle error\n}\n\n// initialized client\nclient.onSignTransactions(({ error, result }: IAVMWebClientCallbackOptions) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n stxns: [\n 'gqNzaWfEQ...',\n null,\n ],\n }\n */\n});\n\n// send a sign transactions request\nclient.signTransactions({\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txns: [\n {\n txn: btoa(String.fromCodePoint(...firstTransactionBytes)), // convert to base64 string\n },\n {\n txn: btoa(String.fromCodePoint(...secondTransactionBytes)),\n signers: [], // use an empty signers array to skip this transaction\n },\n ],\n});\n"})})})]}),"\n",(0,t.jsxs)(a.p,{children:["As you can see from the above example, when the provider skips signing the transaction, the resulting signed transaction list contains a ",(0,t.jsx)(a.code,{children:"null"})," value at the same index, indicating the transaction was not signed. If you do not want to handle null values, you can supply the signed transaction (",(0,t.jsx)(a.code,{children:"stxn"}),") to the params when signing the transactions:"]}),"\n",(0,t.jsxs)(r.A,{defaultValue:"javascript",values:[{label:"Javascript",value:"javascript"},{label:"TypeScript",value:"typescript"}],children:[(0,t.jsx)(o.A,{value:"javascript",children:(0,t.jsx)(a.pre,{children:(0,t.jsx)(a.code,{className:"language-js",children:"const algosdk = require('algosdk');\n\ntry {\n const client = new algosdk.Algodv2(\n 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',\n 'http://localhost',\n '4001',\n );\n const encoder = new TextEncoder();\n const suggestedParams = await client.getTransactionParams().do();\n const firstTransaction = algosdk.makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosdk.algosToMicroalgos(1),\n from: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n note: encoder.encode('I am the first transaction, human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n const secondTransaction = algosdk.makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosdk.algosToMicroalgos(2),\n from: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n note: encoder.encode('I am the second transaction, human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n const firstTransactionBytes = firstTransaction.toByte();\n const secondTransactionBytes = secondTransaction.toByte();\n} catch (error) {\n // handle error\n}\n\n// initialized client\nclient.onSignTransactions(({ error, result }) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n stxns: [\n 'gqNzaWfEQ...',\n 'gqNzaWfEQ...'\n ],\n }\n */\n});\n\n// send a sign transactions request\nclient.signTransactions({\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txns: [\n {\n txn: btoa(String.fromCodePoint(...firstTransactionBytes)), // convert to base64 string\n },\n {\n txn: btoa(String.fromCodePoint(...secondTransactionBytes)),\n signers: [], // an empty array instructs the wallet to skip signing this transaction\n stxn: 'gqNzaWfEQ...', // providing the signed transaction will pass it to the result\n },\n ],\n});\n"})})}),(0,t.jsx)(o.A,{value:"typescript",children:(0,t.jsx)(a.pre,{children:(0,t.jsx)(a.code,{className:"language-typescript",children:"import {\n Algodv2,\n algosToMicroalgos,\n makePaymentTxnWithSuggestedParamsFromObject,\n SuggestedParams,\n Transaction,\n} from 'algosdk';\nimport { IAVMWebClientCallbackOptions } from '@agoralabs-sh/avm-web-provider';\n\n// create a transaction\ntry {\n const client: Algodv2 = new Algodv2(\n 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',\n 'http://localhost',\n '4001',\n );\n const encoder: TextEncoder = new TextEncoder();\n const suggestedParams: SuggestedParams = await client.getTransactionParams().do();\n const firstTransaction: Transaction = makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosToMicroalgos(1),\n from: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n note: encoder.encode('I am the first transaction, human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n const secondTransaction: Transaction = makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosToMicroalgos(2),\n from: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n note: encoder.encode('I am the second transaction, human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n const firstTransactionBytes: Uint8Array = firstTransaction.toByte();\n const secondTransactionBytes: Uint8Array = secondTransaction.toByte();\n} catch (error) {\n // handle error\n}\n\n// initialized client\nclient.onSignTransactions(({ error, result }: IAVMWebClientCallbackOptions) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n stxns: [\n 'gqNzaWfEQ...',\n 'gqNzaWfEQ...'\n ],\n }\n */\n});\n\n// send a sign transactions request\nclient.signTransactions({\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txns: [\n {\n txn: btoa(String.fromCodePoint(...firstTransactionBytes)), // convert to base64 string\n },\n {\n txn: btoa(String.fromCodePoint(...secondTransactionBytes)),\n signers: [], // an empty array instructs the wallet to skip signing this transaction\n stxn: 'gqNzaWfEQ...', // providing the signed transaction will pass it to the result\n },\n ],\n});\n"})})})]}),"\n",(0,t.jsx)(a.h2,{id:"signing-transactions-with-multisig-accounts",children:"Signing transactions with multisig accounts"}),"\n",(0,t.jsx)(a.p,{children:"When using multisig accounts to sign transactions, a few extra options must be provided to the params object."}),"\n",(0,t.jsxs)(a.p,{children:["The transaction must now include the ",(0,t.jsx)(a.code,{children:"msig"})," object that conforms to ",(0,t.jsx)(a.a,{href:"https://algorand.github.io/js-algorand-sdk/interfaces/MultisigMetadata.html",children:(0,t.jsx)(a.code,{children:"algosdk.MultisigMetadata"})}),"."]}),"\n",(0,t.jsx)(a.admonition,{type:"caution",children:(0,t.jsxs)(a.p,{children:["The provider may not support multisig accounts, in which case a ",(0,t.jsx)(a.a,{href:"../../api-reference/errors#methodnotsupportederror",children:(0,t.jsx)(a.code,{children:"MethodNotSupportedError"})})," should be thrown."]})}),"\n",(0,t.jsxs)(r.A,{defaultValue:"javascript",values:[{label:"Javascript",value:"javascript"},{label:"TypeScript",value:"typescript"}],children:[(0,t.jsx)(o.A,{value:"javascript",children:(0,t.jsx)(a.pre,{children:(0,t.jsx)(a.code,{className:"language-js",children:"const algosdk = require('algosdk');\n\ntry {\n const client = new algosdk.Algodv2(\n 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',\n 'http://localhost',\n '4001',\n );\n const encoder = new TextEncoder();\n const multisigParams = {\n addrs: [\n 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U', // authorized in provider and will be used to sign\n '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ', // authorized in provider and will be used to sign\n 'TKDBCV4SCSVR2GECXL7NJ5U34PDNLEIMFBTOYVURAPG53OXJLF4LEDSNGE', // not in provider\n ],\n threshold: 1,\n version: 1,\n };\n const multisigAddress = algosdk.multisigAddress(multisigParams);\n const suggestedParams = await client.getTransactionParams().do();\n const transaction = algosdk.makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosdk.algosToMicroalgos(1),\n from: multisigAddress,\n note: encoder.encode('Hello Human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n const transactionBytes = transaction.toByte();\n} catch (error) {\n // handle error\n}\n\n// initialized client\nclient.onSignTransactions(({ error, result }) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n stxns: [\n 'gqNzaWfEQ...',\n ],\n }\n */\n});\n\n// send a sign transactions request\nclient.signTransactions({\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txns: [\n {\n msig: multisigParams,\n txn: btoa(String.fromCodePoint(...transactionBytes)), // convert to base64 string\n },\n ],\n});\n"})})}),(0,t.jsx)(o.A,{value:"typescript",children:(0,t.jsx)(a.pre,{children:(0,t.jsx)(a.code,{className:"language-typescript",children:"import {\n Algodv2,\n algosToMicroalgos,\n makePaymentTxnWithSuggestedParamsFromObject,\n MultisigMetadata,\n multisigAddress,\n SuggestedParams,\n Transaction,\n} from 'algosdk';\nimport { IAVMWebClientCallbackOptions } from '@agoralabs-sh/avm-web-provider';\n\n// create a transaction\ntry {\n const client: Algodv2 = new Algodv2(\n 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',\n 'http://localhost',\n '4001',\n );\n const encoder: TextEncoder = new TextEncoder();\n const multisigParams: MultisigMetadata = {\n addrs: [\n 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U', // authorized in provider and will be used to sign\n '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ', // authorized in provider and will be used to sign\n 'TKDBCV4SCSVR2GECXL7NJ5U34PDNLEIMFBTOYVURAPG53OXJLF4LEDSNGE', // not in provider\n ],\n threshold: 1,\n version: 1,\n };\n const multisigAddress: string = multisigAddress(multisigParams);\n const suggestedParams: SuggestedParams = await client.getTransactionParams().do();\n const transaction: Transaction = makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosToMicroalgos(1),\n from: multisigAddress,\n note: encoder.encode('Hello Human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n const transactionBytes: Uint8Array = transaction.toByte();\n} catch (error) {\n // handle error\n}\n\n// initialized client\nclient.onSignTransactions(({ error, result }: IAVMWebClientCallbackOptions) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n stxns: [\n 'gqNzaWfEQ...',\n ],\n }\n */\n});\n\n// send a sign transactions request\nclient.signTransactions({\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txns: [\n {\n msig: multisigParams,\n txn: btoa(String.fromCodePoint(...transactionBytes)), // convert to base64 string\n },\n ],\n});\n"})})})]}),"\n",(0,t.jsx)(a.p,{children:"In the above example, even though the threshold is 1, because two of the signers are present and authorized in the provider, both accounts were used to sign the transaction. This still makes the transaction valid."}),"\n",(0,t.jsxs)(a.p,{children:["If you want to only use one address, you can use the ",(0,t.jsx)(a.code,{children:"signers"})," list to instruct the provider to only use certain addresses to sign the transaction."]}),"\n",(0,t.jsxs)(r.A,{defaultValue:"javascript",values:[{label:"Javascript",value:"javascript"},{label:"TypeScript",value:"typescript"}],children:[(0,t.jsx)(o.A,{value:"javascript",children:(0,t.jsx)(a.pre,{children:(0,t.jsx)(a.code,{className:"language-js",children:"const algosdk = require('algosdk');\n\ntry {\n const client = new algosdk.Algodv2(\n 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',\n 'http://localhost',\n '4001',\n );\n const encoder = new TextEncoder();\n const multisigParams = {\n addrs: [\n 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U', // authorized in provider and will be used to sign\n '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ', // authorized in provider and will be used to sign\n 'TKDBCV4SCSVR2GECXL7NJ5U34PDNLEIMFBTOYVURAPG53OXJLF4LEDSNGE', // not in provider\n ],\n threshold: 1,\n version: 1,\n };\n const multisigAddress = algosdk.multisigAddress(multisigParams);\n const suggestedParams = await client.getTransactionParams().do();\n const transaction = algosdk.makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosdk.algosToMicroalgos(1),\n from: multisigAddress,\n note: encoder.encode('Hello Human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n const transactionBytes = transaction.toByte();\n} catch (error) {\n // handle error\n}\n\n// initialized client\nclient.onSignTransactions(({ error, result }) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n stxns: [\n 'gqNzaWfEQ...',\n ],\n }\n */\n});\n\n// send a sign transactions request\nclient.signTransactions({\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txns: [\n {\n msig: multisigParams,\n txn: btoa(String.fromCodePoint(...transactionBytes)), // convert to base64 string\n signers: [\n '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ'\n ], // specifying a signer instructs the wallet to only use this address to sign\n },\n ],\n});\n"})})}),(0,t.jsx)(o.A,{value:"typescript",children:(0,t.jsx)(a.pre,{children:(0,t.jsx)(a.code,{className:"language-typescript",children:"import {\n Algodv2,\n algosToMicroalgos,\n makePaymentTxnWithSuggestedParamsFromObject,\n MultisigMetadata,\n multisigAddress,\n SuggestedParams,\n Transaction,\n} from 'algosdk';\nimport { IAVMWebClientCallbackOptions } from '@agoralabs-sh/avm-web-provider';\n\n// create a transaction\ntry {\n const client: Algodv2 = new Algodv2(\n 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',\n 'http://localhost',\n '4001',\n );\n const encoder: TextEncoder = new TextEncoder();\n const multisigParams: MultisigMetadata = {\n addrs: [\n 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U', // authorized in provider and will be used to sign\n '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ', // authorized in provider and will be used to sign\n 'TKDBCV4SCSVR2GECXL7NJ5U34PDNLEIMFBTOYVURAPG53OXJLF4LEDSNGE', // not in provider\n ],\n threshold: 1,\n version: 1,\n };\n const multisigAddress: string = multisigAddress(multisigParams);\n const suggestedParams: SuggestedParams = await client.getTransactionParams().do();\n const transaction: Transaction = makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosToMicroalgos(1),\n from: multisigAddress,\n note: encoder.encode('Hello Human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n const transactionBytes: Uint8Array = transaction.toByte();\n} catch (error) {\n // handle error\n}\n\n// initialized client\nclient.onSignTransactions(({ error, result }: IAVMWebClientCallbackOptions) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n stxns: [\n 'gqNzaWfEQ...',\n ],\n }\n */\n});\n\n// send a sign transactions request\nclient.signTransactions({\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txns: [\n {\n msig: multisigParams,\n txn: btoa(String.fromCodePoint(...transactionBytes)), // convert to base64 string\n signers: [\n '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ'\n ], // specifying a signer instructs the wallet to only use this address to sign\n },\n ],\n});\n"})})})]}),"\n",(0,t.jsx)(a.admonition,{type:"caution",children:(0,t.jsxs)(a.p,{children:["If any of the accounts supplied in the ",(0,t.jsx)(a.code,{children:"signers"})," list are not an authorized signer, then a ",(0,t.jsx)(a.a,{href:"../../api-reference/errors#unauthorizedsignererror",children:(0,t.jsx)(a.code,{children:"UnauthorizedSignerError"})})," should be thrown."]})}),"\n",(0,t.jsxs)(a.p,{children:["In the above example, only the address ",(0,t.jsx)(a.code,{children:"6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ"})," is used to sign the transaction and as the threshold is only 1, the transaction is valid."]}),"\n",(0,t.jsx)(a.h2,{id:"signing-transactions-with-re-keyed-accounts",children:"Signing transactions with re-keyed accounts"}),"\n",(0,t.jsxs)(a.p,{children:["When attempting to sign a transaction using a re-keyed account, the ",(0,t.jsx)(a.code,{children:"authAddr"})," field may be used to instruct the provider to use this address as the signer of the transaction. Supplying the ",(0,t.jsx)(a.code,{children:"authAddr"})," will override the sender address in the transaction field."]}),"\n",(0,t.jsx)(a.admonition,{type:"caution",children:(0,t.jsxs)(a.p,{children:["The provider may not support re-keyed accounts, in which case a ",(0,t.jsx)(a.a,{href:"../../api-reference/errors#methodnotsupportederror",children:(0,t.jsx)(a.code,{children:"MethodNotSupportedError"})})," will be thrown."]})}),"\n",(0,t.jsxs)(r.A,{defaultValue:"javascript",values:[{label:"Javascript",value:"javascript"},{label:"TypeScript",value:"typescript"}],children:[(0,t.jsx)(o.A,{value:"javascript",children:(0,t.jsx)(a.pre,{children:(0,t.jsx)(a.code,{className:"language-js",children:"const algosdk = require('algosdk');\n\ntry {\n const client = new algosdk.Algodv2(\n 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',\n 'http://localhost',\n '4001',\n );\n const encoder = new TextEncoder();\n const suggestedParams = await client.getTransactionParams().do();\n const transaction = algosdk.makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosdk.algosToMicroalgos(1),\n from: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n note: encoder.encode('Hello Human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n const transactionBytes = transaction.toByte();\n} catch (error) {\n // handle error\n}\n\n// initialized client\nclient.onSignTransactions(({ error, result }) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n stxns: [\n 'gqNzaWfEQ...',\n ],\n }\n */\n});\n\n// send a sign transactions request\nclient.signTransactions({\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txns: [\n {\n authAddr: 'S6V2ITXD3Q4MYATTN5IH75E3KS3WEMB36SVG2LXCQ3XESSH2DYOC3DAXYU', // 'auth-addr' of the re-keyed from account\n txn: btoa(String.fromCodePoint(...transactionBytes)), // convert to base64 string\n },\n ],\n});\n"})})}),(0,t.jsx)(o.A,{value:"typescript",children:(0,t.jsx)(a.pre,{children:(0,t.jsx)(a.code,{className:"language-typescript",children:"import {\n Algodv2,\n algosToMicroalgos,\n makePaymentTxnWithSuggestedParamsFromObject,\n SuggestedParams,\n Transaction,\n} from 'algosdk';\nimport { IAVMWebClientCallbackOptions } from '@agoralabs-sh/avm-web-provider';\n\n// create a transaction\ntry {\n const client: Algodv2 = new Algodv2(\n 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',\n 'http://localhost',\n '4001',\n );\n const encoder: TextEncoder = new TextEncoder();\n const suggestedParams: SuggestedParams = await client.getTransactionParams().do();\n const transaction: Transaction = makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosToMicroalgos(1),\n from: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n note: encoder.encode('Hello Human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n const transactionBytes: Uint8Array = transaction.toByte();\n} catch (error) {\n // handle error\n}\n\n// initialized client\nclient.onSignTransactions(({ error, result }: IAVMWebClientCallbackOptions) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n stxns: [\n 'gqNzaWfEQ...',\n ],\n }\n */\n});\n\n// send a sign transactions request\nclient.signTransactions({\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txns: [\n {\n authAddr: 'S6V2ITXD3Q4MYATTN5IH75E3KS3WEMB36SVG2LXCQ3XESSH2DYOC3DAXYU', // 'auth-addr' of the re-keyed from account\n txn: btoa(String.fromCodePoint(...transactionBytes)), // convert to base64 string\n },\n ],\n});\n"})})})]}),"\n",(0,t.jsx)(a.admonition,{type:"caution",children:(0,t.jsxs)(a.p,{children:["If the supplied ",(0,t.jsx)(a.code,{children:"authAddr"})," is not an authorized signer, then a ",(0,t.jsx)(a.a,{href:"../../api-reference/errors#unauthorizedsignererror",children:(0,t.jsx)(a.code,{children:"UnauthorizedSignerError"})})," will be thrown."]})})]})}function h(n={}){const{wrapper:a}={...(0,s.R)(),...n.components};return a?(0,t.jsx)(a,{...n,children:(0,t.jsx)(m,{...n})}):m(n)}}}]); \ No newline at end of file diff --git a/assets/js/0e7a43e4.10b7a6db.js b/assets/js/0e7a43e4.10b7a6db.js new file mode 100644 index 0000000..9d0dda3 --- /dev/null +++ b/assets/js/0e7a43e4.10b7a6db.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_agoralabs_sh_avm_web_provider=self.webpackChunk_agoralabs_sh_avm_web_provider||[]).push([[6546],{7537:function(e,s,r){r.r(s),r.d(s,{assets:function(){return h},contentTitle:function(){return t},default:function(){return x},frontMatter:function(){return l},metadata:function(){return c},toc:function(){return a}});var n=r(4848),i=r(8453),d=r(4252);const l={},t="AVMWebClient",c={id:"api-reference/avm-web-client",title:"AVMWebClient",description:"init([options])",id:"initoptions",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Methods",id:"methods",level:2},{value:"disable([params])",id:"disableparams",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"discover([params])",id:"discoverparams",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"enable([params])",id:"enableparams",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"getConfig()",id:"getconfig",level:3},{value:"Returns",id:"returns-4",level:4},{value:"onDisable(callback)",id:"ondisablecallback",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"onDiscover(callback)",id:"ondiscovercallback",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"onEnable(callback)",id:"onenablecallback",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"onPostTransactions(callback)",id:"onposttransactionscallback",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"onSignAndPostTransactions(callback)",id:"onsignandposttransactionscallback",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"onSignMessage(callback)",id:"onsignmessagecallback",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"onSignTransactions(callback)",id:"onsigntransactionscallback",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"postTransactions([params])",id:"posttransactionsparams",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-11",level:4},{value:"removeAllListeners()",id:"removealllisteners",level:3},{value:"Returns",id:"returns-12",level:4},{value:"removeListener(id)",id:"removelistenerid",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-13",level:4},{value:"signAndpostTransactions([params])",id:"signandposttransactionsparams",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-14",level:4},{value:"signMessage([params])",id:"signmessageparams",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-15",level:4},{value:"signTransactions([params])",id:"signtransactionsparams",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-16",level:4}];function j(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.header,{children:(0,n.jsx)(s.h1,{id:"avmwebclient",children:"AVMWebClient"})}),"\n",(0,n.jsx)(d.A,{maxHeadingLevel:4,toc:a}),"\n",(0,n.jsx)(s.h2,{id:"static-methods",children:"Static Methods"}),"\n",(0,n.jsx)(s.h3,{id:"initoptions",children:(0,n.jsx)(s.code,{children:"init([options])"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Initializes the AVM web client object. If no options are supplied, a default configuration is used."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"options"}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"types#iavmwebclientinitoptions",children:(0,n.jsx)(s.code,{children:"IAVMWebClientInitOptions"})})}),(0,n.jsx)(s.td,{children:"no"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsx)(s.td,{children:"An object to change the initial configuration."})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"types#avmwebclient",children:(0,n.jsx)(s.code,{children:"AVMWebClient"})})}),(0,n.jsx)(s.td,{children:"An initialized AVM web client object."})]})})]}),"\n",(0,n.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(s.h3,{id:"disableparams",children:(0,n.jsx)(s.code,{children:"disable([params])"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Sends a request to remove the client from providers."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"params"}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"types#idisableparams",children:(0,n.jsx)(s.code,{children:"IDisableParams"})})}),(0,n.jsx)(s.td,{children:"no"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsx)(s.td,{children:"Params that specify which provider,network and/or specific session IDs."})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the request message."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"discoverparams",children:(0,n.jsx)(s.code,{children:"discover([params])"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Sends a request to get information relating to available providers. This should be called before interacting with any providers to ensure networks and methods are supported."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"params"}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"types#idiscoverparams",children:(0,n.jsx)(s.code,{children:"IDiscoverParams"})})}),(0,n.jsx)(s.td,{children:"no"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsx)(s.td,{children:"Params that specify which provider to target."})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the request message."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"enableparams",children:(0,n.jsx)(s.code,{children:"enable([params])"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Enables to a client with providers. If the ID of the provider and/or network is specified, that provider/network is used, otherwise the all providers available providers are used."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"params"}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"types#ienableparams",children:(0,n.jsx)(s.code,{children:"IEnableParams"})})}),(0,n.jsx)(s.td,{children:"no"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsx)(s.td,{children:"Params that specify the provider and/or the network."})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-3",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the request message."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"getconfig",children:(0,n.jsx)(s.code,{children:"getConfig()"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Returns the configuration."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"returns-4",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"types#iavmwebclientconfig",children:(0,n.jsx)(s.code,{children:"IAVMWebClientConfig"})})}),(0,n.jsx)(s.td,{children:"The client's configuration."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"ondisablecallback",children:(0,n.jsx)(s.code,{children:"onDisable(callback)"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:["Listens to ",(0,n.jsx)(s.code,{children:"disable"})," messages sent from providers."]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"callback"}),(0,n.jsxs)(s.td,{children:["(",(0,n.jsx)(s.code,{children:"options"}),": ",(0,n.jsx)(s.a,{href:"types#iavmwebclientcallbackoptions",children:(0,n.jsx)(s.code,{children:"IAVMWebClientCallbackOptions"})}),") => (",(0,n.jsx)(s.code,{children:"void"})," | ",(0,n.jsx)(s.code,{children:"Promise"}),")"]}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsxs)(s.td,{children:["The callback is called when a response message is received. If the result was successful, the ",(0,n.jsx)(s.code,{children:"error"})," parameter will be null."]})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-5",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the listener."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"ondiscovercallback",children:(0,n.jsx)(s.code,{children:"onDiscover(callback)"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:["Listens to ",(0,n.jsx)(s.code,{children:"discover"})," messages sent from providers."]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"callback"}),(0,n.jsxs)(s.td,{children:["(",(0,n.jsx)(s.code,{children:"options"}),": ",(0,n.jsx)(s.a,{href:"types#iavmwebclientcallbackoptions",children:(0,n.jsx)(s.code,{children:"IAVMWebClientCallbackOptions"})}),") => (",(0,n.jsx)(s.code,{children:"void"})," | ",(0,n.jsx)(s.code,{children:"Promise"}),")"]}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsxs)(s.td,{children:["The callback is called when a response message is received. If the result was successful, the ",(0,n.jsx)(s.code,{children:"error"})," parameter will be null."]})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-6",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the listener."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"onenablecallback",children:(0,n.jsx)(s.code,{children:"onEnable(callback)"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:["Listens to ",(0,n.jsx)(s.code,{children:"enable"})," messages sent from providers."]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"callback"}),(0,n.jsxs)(s.td,{children:["(",(0,n.jsx)(s.code,{children:"options"}),": ",(0,n.jsx)(s.a,{href:"types#iavmwebclientcallbackoptions",children:(0,n.jsx)(s.code,{children:"IAVMWebClientCallbackOptions"})}),") => (",(0,n.jsx)(s.code,{children:"void"})," | ",(0,n.jsx)(s.code,{children:"Promise"}),")"]}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsxs)(s.td,{children:["The callback is called when a response message is received. If the result was successful, the ",(0,n.jsx)(s.code,{children:"error"})," parameter will be null."]})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-7",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the listener."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"onposttransactionscallback",children:(0,n.jsx)(s.code,{children:"onPostTransactions(callback)"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:["Listens to ",(0,n.jsx)(s.code,{children:"post_transactions"})," messages sent from providers."]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"callback"}),(0,n.jsxs)(s.td,{children:["(",(0,n.jsx)(s.code,{children:"options"}),": ",(0,n.jsx)(s.a,{href:"types#iavmwebclientcallbackoptions",children:(0,n.jsx)(s.code,{children:"IAVMWebClientCallbackOptions"})}),") => (",(0,n.jsx)(s.code,{children:"void"})," | ",(0,n.jsx)(s.code,{children:"Promise"}),")"]}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsxs)(s.td,{children:["The callback is called when a response message is received. If the result was successful, the ",(0,n.jsx)(s.code,{children:"error"})," parameter will be null."]})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-8",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the listener."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"onsignandposttransactionscallback",children:(0,n.jsx)(s.code,{children:"onSignAndPostTransactions(callback)"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:["Listens to ",(0,n.jsx)(s.code,{children:"sign_and_post_transactions"})," messages sent from providers."]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"callback"}),(0,n.jsxs)(s.td,{children:["(",(0,n.jsx)(s.code,{children:"options"}),": ",(0,n.jsx)(s.a,{href:"types#iavmwebclientcallbackoptions",children:(0,n.jsx)(s.code,{children:"IAVMWebClientCallbackOptions"})}),") => (",(0,n.jsx)(s.code,{children:"void"})," | ",(0,n.jsx)(s.code,{children:"Promise"}),")"]}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsxs)(s.td,{children:["The callback is called when a response message is received. If the result was successful, the ",(0,n.jsx)(s.code,{children:"error"})," parameter will be null."]})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-9",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the listener."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"onsignmessagecallback",children:(0,n.jsx)(s.code,{children:"onSignMessage(callback)"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:["Listens to ",(0,n.jsx)(s.code,{children:"sign_message"})," messages sent from providers."]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"callback"}),(0,n.jsxs)(s.td,{children:["(",(0,n.jsx)(s.code,{children:"options"}),": ",(0,n.jsx)(s.a,{href:"types#iavmwebclientcallbackoptions",children:(0,n.jsx)(s.code,{children:"IAVMWebClientCallbackOptions"})}),") => (",(0,n.jsx)(s.code,{children:"void"})," | ",(0,n.jsx)(s.code,{children:"Promise"}),")"]}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsxs)(s.td,{children:["The callback is called when a response message is received. If the result was successful, the ",(0,n.jsx)(s.code,{children:"error"})," parameter will be null."]})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"onsigntransactionscallback",children:(0,n.jsx)(s.code,{children:"onSignTransactions(callback)"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:["Listens to ",(0,n.jsx)(s.code,{children:"sign_transactions"})," messages sent from providers."]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"callback"}),(0,n.jsxs)(s.td,{children:["(",(0,n.jsx)(s.code,{children:"options"}),": ",(0,n.jsx)(s.a,{href:"types#iavmwebclientcallbackoptions",children:(0,n.jsx)(s.code,{children:"IAVMWebClientCallbackOptions"})}),") => (",(0,n.jsx)(s.code,{children:"void"})," | ",(0,n.jsx)(s.code,{children:"Promise"}),")"]}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsxs)(s.td,{children:["The callback is called when a response message is received. If the result was successful, the ",(0,n.jsx)(s.code,{children:"error"})," parameter will be null."]})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-10",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the listener."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"posttransactionsparams",children:(0,n.jsx)(s.code,{children:"postTransactions([params])"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Request providers to post a list of signed transactions to the network."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-11",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"params"}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"types#iposttransactionsparams",children:(0,n.jsx)(s.code,{children:"IPostTransactionsParams"})})}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsx)(s.td,{children:"Params that specify the provider and the signed transactions."})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-11",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the request message."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"removealllisteners",children:(0,n.jsx)(s.code,{children:"removeAllListeners()"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Removes all listeners."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"returns-12",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"void"})}),(0,n.jsx)(s.td,{children:"-"})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"removelistenerid",children:(0,n.jsx)(s.code,{children:"removeListener(id)"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Removes the listener, by the ID."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-12",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"id"}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsx)(s.td,{children:"The listener ID to remove."})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-13",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"void"})}),(0,n.jsx)(s.td,{children:"-"})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"signandposttransactionsparams",children:(0,n.jsx)(s.code,{children:"signAndpostTransactions([params])"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Request providers to sign and post a list of unsigned transactions to the network."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-13",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"params"}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"types#isigntransactionsparams",children:(0,n.jsx)(s.code,{children:"ISignTransactionsParams"})})}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsx)(s.td,{children:"Params that specify the unsigned transactions and the provider."})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-14",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the request message."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"signmessageparams",children:(0,n.jsx)(s.code,{children:"signMessage([params])"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Request providers sign a UTF-8 encoded message."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-14",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"params"}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"types#isignmessageparams",children:(0,n.jsx)(s.code,{children:"ISignMessageParams"})})}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsx)(s.td,{children:"Params that specify the message to sign, the signer and the provider."})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-15",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the request message."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"signtransactionsparams",children:(0,n.jsx)(s.code,{children:"signTransactions([params])"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Request providers to sign a list of unsigned transactions."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-15",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"params"}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"types#isigntransactionsparams",children:(0,n.jsx)(s.code,{children:"ISignTransactionsParams"})})}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsx)(s.td,{children:"Params that specify the unsigned transactions and the provider."})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-16",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the request message."})]})})]})]})}function x(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/0e7a43e4.acd7a0df.js b/assets/js/0e7a43e4.acd7a0df.js deleted file mode 100644 index fb3261d..0000000 --- a/assets/js/0e7a43e4.acd7a0df.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_agoralabs_sh_avm_web_provider=self.webpackChunk_agoralabs_sh_avm_web_provider||[]).push([[600],{2308:function(e,s,r){r.r(s),r.d(s,{assets:function(){return h},contentTitle:function(){return t},default:function(){return x},frontMatter:function(){return l},metadata:function(){return c},toc:function(){return a}});var n=r(7624),i=r(4552),d=r(6200);const l={},t="AVMWebClient",c={id:"api-reference/avm-web-client",title:"AVMWebClient",description:"init([options])",id:"initoptions",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Methods",id:"methods",level:2},{value:"disable([params])",id:"disableparams",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"discover([params])",id:"discoverparams",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"enable([params])",id:"enableparams",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"getConfig()",id:"getconfig",level:3},{value:"Returns",id:"returns-4",level:4},{value:"onDisable(callback)",id:"ondisablecallback",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"onDiscover(callback)",id:"ondiscovercallback",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"onEnable(callback)",id:"onenablecallback",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"onPostTransactions(callback)",id:"onposttransactionscallback",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"onSignAndPostTransactions(callback)",id:"onsignandposttransactionscallback",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"onSignMessage(callback)",id:"onsignmessagecallback",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"onSignTransactions(callback)",id:"onsigntransactionscallback",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"postTransactions([params])",id:"posttransactionsparams",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-11",level:4},{value:"removeAllListeners()",id:"removealllisteners",level:3},{value:"Returns",id:"returns-12",level:4},{value:"removeListener(id)",id:"removelistenerid",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-13",level:4},{value:"signAndpostTransactions([params])",id:"signandposttransactionsparams",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-14",level:4},{value:"signMessage([params])",id:"signmessageparams",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-15",level:4},{value:"signTransactions([params])",id:"signtransactionsparams",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-16",level:4}];function j(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.M)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h1,{id:"avmwebclient",children:"AVMWebClient"}),"\n",(0,n.jsx)(d.c,{maxHeadingLevel:4,toc:a}),"\n",(0,n.jsx)(s.h2,{id:"static-methods",children:"Static Methods"}),"\n",(0,n.jsx)(s.h3,{id:"initoptions",children:(0,n.jsx)(s.code,{children:"init([options])"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Initializes the AVM web client object. If no options are supplied, a default configuration is used."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"options"}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"types#iavmwebclientinitoptions",children:(0,n.jsx)(s.code,{children:"IAVMWebClientInitOptions"})})}),(0,n.jsx)(s.td,{children:"no"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsx)(s.td,{children:"An object to change the initial configuration."})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"types#avmwebclient",children:(0,n.jsx)(s.code,{children:"AVMWebClient"})})}),(0,n.jsx)(s.td,{children:"An initialized AVM web client object."})]})})]}),"\n",(0,n.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(s.h3,{id:"disableparams",children:(0,n.jsx)(s.code,{children:"disable([params])"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Sends a request to remove the client from providers."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"params"}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"types#idisableparams",children:(0,n.jsx)(s.code,{children:"IDisableParams"})})}),(0,n.jsx)(s.td,{children:"no"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsx)(s.td,{children:"Params that specify which provider,network and/or specific session IDs."})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the request message."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"discoverparams",children:(0,n.jsx)(s.code,{children:"discover([params])"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Sends a request to get information relating to available providers. This should be called before interacting with any providers to ensure networks and methods are supported."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"params"}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"types#idiscoverparams",children:(0,n.jsx)(s.code,{children:"IDiscoverParams"})})}),(0,n.jsx)(s.td,{children:"no"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsx)(s.td,{children:"Params that specify which provider to target."})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the request message."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"enableparams",children:(0,n.jsx)(s.code,{children:"enable([params])"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Enables to a client with providers. If the ID of the provider and/or network is specified, that provider/network is used, otherwise the all providers available providers are used."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"params"}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"types#ienableparams",children:(0,n.jsx)(s.code,{children:"IEnableParams"})})}),(0,n.jsx)(s.td,{children:"no"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsx)(s.td,{children:"Params that specify the provider and/or the network."})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-3",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the request message."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"getconfig",children:(0,n.jsx)(s.code,{children:"getConfig()"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Returns the configuration."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"returns-4",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"types#iavmwebclientconfig",children:(0,n.jsx)(s.code,{children:"IAVMWebClientConfig"})})}),(0,n.jsx)(s.td,{children:"The client's configuration."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"ondisablecallback",children:(0,n.jsx)(s.code,{children:"onDisable(callback)"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:["Listens to ",(0,n.jsx)(s.code,{children:"disable"})," messages sent from providers."]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"callback"}),(0,n.jsxs)(s.td,{children:["(",(0,n.jsx)(s.code,{children:"options"}),": ",(0,n.jsx)(s.a,{href:"types#iavmwebclientcallbackoptions",children:(0,n.jsx)(s.code,{children:"IAVMWebClientCallbackOptions"})}),") => (",(0,n.jsx)(s.code,{children:"void"})," | ",(0,n.jsx)(s.code,{children:"Promise"}),")"]}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsxs)(s.td,{children:["The callback is called when a response message is received. If the result was successful, the ",(0,n.jsx)(s.code,{children:"error"})," parameter will be null."]})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-5",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the listener."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"ondiscovercallback",children:(0,n.jsx)(s.code,{children:"onDiscover(callback)"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:["Listens to ",(0,n.jsx)(s.code,{children:"discover"})," messages sent from providers."]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"callback"}),(0,n.jsxs)(s.td,{children:["(",(0,n.jsx)(s.code,{children:"options"}),": ",(0,n.jsx)(s.a,{href:"types#iavmwebclientcallbackoptions",children:(0,n.jsx)(s.code,{children:"IAVMWebClientCallbackOptions"})}),") => (",(0,n.jsx)(s.code,{children:"void"})," | ",(0,n.jsx)(s.code,{children:"Promise"}),")"]}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsxs)(s.td,{children:["The callback is called when a response message is received. If the result was successful, the ",(0,n.jsx)(s.code,{children:"error"})," parameter will be null."]})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-6",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the listener."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"onenablecallback",children:(0,n.jsx)(s.code,{children:"onEnable(callback)"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:["Listens to ",(0,n.jsx)(s.code,{children:"enable"})," messages sent from providers."]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"callback"}),(0,n.jsxs)(s.td,{children:["(",(0,n.jsx)(s.code,{children:"options"}),": ",(0,n.jsx)(s.a,{href:"types#iavmwebclientcallbackoptions",children:(0,n.jsx)(s.code,{children:"IAVMWebClientCallbackOptions"})}),") => (",(0,n.jsx)(s.code,{children:"void"})," | ",(0,n.jsx)(s.code,{children:"Promise"}),")"]}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsxs)(s.td,{children:["The callback is called when a response message is received. If the result was successful, the ",(0,n.jsx)(s.code,{children:"error"})," parameter will be null."]})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-7",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the listener."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"onposttransactionscallback",children:(0,n.jsx)(s.code,{children:"onPostTransactions(callback)"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:["Listens to ",(0,n.jsx)(s.code,{children:"post_transactions"})," messages sent from providers."]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"callback"}),(0,n.jsxs)(s.td,{children:["(",(0,n.jsx)(s.code,{children:"options"}),": ",(0,n.jsx)(s.a,{href:"types#iavmwebclientcallbackoptions",children:(0,n.jsx)(s.code,{children:"IAVMWebClientCallbackOptions"})}),") => (",(0,n.jsx)(s.code,{children:"void"})," | ",(0,n.jsx)(s.code,{children:"Promise"}),")"]}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsxs)(s.td,{children:["The callback is called when a response message is received. If the result was successful, the ",(0,n.jsx)(s.code,{children:"error"})," parameter will be null."]})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-8",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the listener."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"onsignandposttransactionscallback",children:(0,n.jsx)(s.code,{children:"onSignAndPostTransactions(callback)"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:["Listens to ",(0,n.jsx)(s.code,{children:"sign_and_post_transactions"})," messages sent from providers."]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"callback"}),(0,n.jsxs)(s.td,{children:["(",(0,n.jsx)(s.code,{children:"options"}),": ",(0,n.jsx)(s.a,{href:"types#iavmwebclientcallbackoptions",children:(0,n.jsx)(s.code,{children:"IAVMWebClientCallbackOptions"})}),") => (",(0,n.jsx)(s.code,{children:"void"})," | ",(0,n.jsx)(s.code,{children:"Promise"}),")"]}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsxs)(s.td,{children:["The callback is called when a response message is received. If the result was successful, the ",(0,n.jsx)(s.code,{children:"error"})," parameter will be null."]})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-9",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the listener."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"onsignmessagecallback",children:(0,n.jsx)(s.code,{children:"onSignMessage(callback)"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:["Listens to ",(0,n.jsx)(s.code,{children:"sign_message"})," messages sent from providers."]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"callback"}),(0,n.jsxs)(s.td,{children:["(",(0,n.jsx)(s.code,{children:"options"}),": ",(0,n.jsx)(s.a,{href:"types#iavmwebclientcallbackoptions",children:(0,n.jsx)(s.code,{children:"IAVMWebClientCallbackOptions"})}),") => (",(0,n.jsx)(s.code,{children:"void"})," | ",(0,n.jsx)(s.code,{children:"Promise"}),")"]}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsxs)(s.td,{children:["The callback is called when a response message is received. If the result was successful, the ",(0,n.jsx)(s.code,{children:"error"})," parameter will be null."]})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"onsigntransactionscallback",children:(0,n.jsx)(s.code,{children:"onSignTransactions(callback)"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:["Listens to ",(0,n.jsx)(s.code,{children:"sign_transactions"})," messages sent from providers."]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"callback"}),(0,n.jsxs)(s.td,{children:["(",(0,n.jsx)(s.code,{children:"options"}),": ",(0,n.jsx)(s.a,{href:"types#iavmwebclientcallbackoptions",children:(0,n.jsx)(s.code,{children:"IAVMWebClientCallbackOptions"})}),") => (",(0,n.jsx)(s.code,{children:"void"})," | ",(0,n.jsx)(s.code,{children:"Promise"}),")"]}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsxs)(s.td,{children:["The callback is called when a response message is received. If the result was successful, the ",(0,n.jsx)(s.code,{children:"error"})," parameter will be null."]})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-10",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the listener."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"posttransactionsparams",children:(0,n.jsx)(s.code,{children:"postTransactions([params])"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Request providers to post a list of signed transactions to the network."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-11",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"params"}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"types#iposttransactionsparams",children:(0,n.jsx)(s.code,{children:"IPostTransactionsParams"})})}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsx)(s.td,{children:"Params that specify the provider and the signed transactions."})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-11",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the request message."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"removealllisteners",children:(0,n.jsx)(s.code,{children:"removeAllListeners()"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Removes all listeners."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"returns-12",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"void"})}),(0,n.jsx)(s.td,{children:"-"})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"removelistenerid",children:(0,n.jsx)(s.code,{children:"removeListener(id)"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Removes the listener, by the ID."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-12",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"id"}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsx)(s.td,{children:"The listener ID to remove."})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-13",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"void"})}),(0,n.jsx)(s.td,{children:"-"})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"signandposttransactionsparams",children:(0,n.jsx)(s.code,{children:"signAndpostTransactions([params])"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Request providers to sign and post a list of unsigned transactions to the network."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-13",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"params"}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"types#isigntransactionsparams",children:(0,n.jsx)(s.code,{children:"ISignTransactionsParams"})})}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsx)(s.td,{children:"Params that specify the unsigned transactions and the provider."})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-14",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the request message."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"signmessageparams",children:(0,n.jsx)(s.code,{children:"signMessage([params])"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Request providers sign a UTF-8 encoded message."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-14",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"params"}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"types#isignmessageparams",children:(0,n.jsx)(s.code,{children:"ISignMessageParams"})})}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsx)(s.td,{children:"Params that specify the message to sign, the signer and the provider."})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-15",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the request message."})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"signtransactionsparams",children:(0,n.jsx)(s.code,{children:"signTransactions([params])"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Request providers to sign a list of unsigned transactions."}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"parameters-15",children:"Parameters"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Required"}),(0,n.jsx)(s.th,{children:"Default"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"params"}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"types#isigntransactionsparams",children:(0,n.jsx)(s.code,{children:"ISignTransactionsParams"})})}),(0,n.jsx)(s.td,{children:"yes"}),(0,n.jsx)(s.td,{children:"-"}),(0,n.jsx)(s.td,{children:"Params that specify the unsigned transactions and the provider."})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"returns-16",children:"Returns"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"string"})}),(0,n.jsx)(s.td,{children:"the ID of the request message."})]})})]})]})}function x(e={}){const{wrapper:s}={...(0,i.M)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/12607efb.6f9fdd0d.js b/assets/js/12607efb.6f9fdd0d.js new file mode 100644 index 0000000..fea8aed --- /dev/null +++ b/assets/js/12607efb.6f9fdd0d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_agoralabs_sh_avm_web_provider=self.webpackChunk_agoralabs_sh_avm_web_provider||[]).push([[5436],{8682:function(n,a,e){e.r(a),e.d(a,{assets:function(){return g},contentTitle:function(){return d},default:function(){return u},frontMatter:function(){return c},metadata:function(){return l},toc:function(){return h}});var t=e(4848),r=e(8453),s=e(1470),o=e(9365),i=e(4252);const c={},d="Signing And Posting Transactions",l={id:"clients/signing-and-posting-transactions",title:"Signing And Posting Transactions",description:" {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txnIDs: [\n 'OKU6A2Q...',\n ],\n }\n */\n});\n\n// send a sign and post transactions request\nclient.signAndPostTransactions({\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txns: [\n {\n txn: btoa(String.fromCodePoint(...transactionBytes)), // convert to base64 string\n },\n ],\n});\n"})})}),(0,t.jsx)(o.A,{value:"typescript",children:(0,t.jsx)(a.pre,{children:(0,t.jsx)(a.code,{className:"language-typescript",children:"import {\n Algodv2,\n algosToMicroalgos,\n makePaymentTxnWithSuggestedParamsFromObject,\n SuggestedParams,\n Transaction,\n} from 'algosdk';\nimport { IAVMWebClientCallbackOptions } from '@agoralabs-sh/avm-web-provider';\n\n// create a transaction\ntry {\n const client: Algodv2 = new Algodv2(\n 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',\n 'http://localhost',\n '4001',\n );\n const encoder: TextEncoder = new TextEncoder();\n const suggestedParams: SuggestedParams = await client.getTransactionParams().do();\n const transaction: Transaction = makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosToMicroalgos(1),\n from: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n note: encoder.encode('Hello Human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n const transactionBytes: Uint8Array = transaction.toByte();\n} catch (error) {\n // handle error\n}\n\n// initialized client\nclient.onSignAndPostTransactions(({ error, result }: IAVMWebClientCallbackOptions) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txnIDs: [\n 'OKU6A2Q...',\n ],\n }\n */\n});\n\n// send a sign and post transactions request\nclient.signAndPostTransactions({\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txns: [\n {\n txn: btoa(String.fromCodePoint(...transactionBytes)), // convert to base64 string\n },\n ],\n});\n"})})})]}),"\n",(0,t.jsx)(a.admonition,{type:"caution",children:(0,t.jsxs)(a.p,{children:["If this method is not supported, then a ",(0,t.jsx)(a.a,{href:"../../api-reference/errors#methodnotsupportederror",children:(0,t.jsx)(a.code,{children:"MethodNotSupportedError"})})," should be thrown."]})}),"\n",(0,t.jsx)(a.admonition,{type:"caution",children:(0,t.jsxs)(a.p,{children:["If there is a group of atomic transactions, but the computed group ID is invalid, then a ",(0,t.jsx)(a.a,{href:"../../api-reference/errors#invalidgroupiderror",children:(0,t.jsx)(a.code,{children:"InvalidGroupIdError"})})," should be thrown."]})}),"\n",(0,t.jsx)(a.admonition,{type:"caution",children:(0,t.jsxs)(a.p,{children:["If any of the transactions are malformed, then a ",(0,t.jsx)(a.a,{href:"../../api-reference/errors#invalidinputerror",children:(0,t.jsx)(a.code,{children:"InvalidInputError"})})," should be thrown."]})}),"\n",(0,t.jsx)(a.admonition,{type:"caution",children:(0,t.jsxs)(a.p,{children:["If the transactions fail to be accepted by the network, then a ",(0,t.jsx)(a.a,{href:"../../api-reference/errors#failedtopostsometransactionserror",children:(0,t.jsx)(a.code,{children:"FailedToPostSomeTransactionsError"})})," should be thrown."]})})]})}function u(n={}){const{wrapper:a}={...(0,r.R)(),...n.components};return a?(0,t.jsx)(a,{...n,children:(0,t.jsx)(p,{...n})}):p(n)}}}]); \ No newline at end of file diff --git a/assets/js/12607efb.81e2cb7b.js b/assets/js/12607efb.81e2cb7b.js deleted file mode 100644 index 9c8bd7c..0000000 --- a/assets/js/12607efb.81e2cb7b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_agoralabs_sh_avm_web_provider=self.webpackChunk_agoralabs_sh_avm_web_provider||[]).push([[920],{2116:function(n,a,e){e.r(a),e.d(a,{assets:function(){return g},contentTitle:function(){return d},default:function(){return u},frontMatter:function(){return c},metadata:function(){return l},toc:function(){return h}});var t=e(7624),r=e(4552),s=e(3500),o=e(6568),i=e(6200);const c={},d="Signing And Posting Transactions",l={id:"clients/signing-and-posting-transactions",title:"Signing And Posting Transactions",description:" {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txnIDs: [\n 'OKU6A2Q...',\n ],\n }\n */\n});\n\n// send a sign and post transactions request\nclient.signAndPostTransactions({\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txns: [\n {\n txn: btoa(String.fromCodePoint(...transactionBytes)), // convert to base64 string\n },\n ],\n});\n"})})}),(0,t.jsx)(o.c,{value:"typescript",children:(0,t.jsx)(a.pre,{children:(0,t.jsx)(a.code,{className:"language-typescript",children:"import {\n Algodv2,\n algosToMicroalgos,\n makePaymentTxnWithSuggestedParamsFromObject,\n SuggestedParams,\n Transaction,\n} from 'algosdk';\nimport { IAVMWebClientCallbackOptions } from '@agoralabs-sh/avm-web-provider';\n\n// create a transaction\ntry {\n const client: Algodv2 = new Algodv2(\n 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',\n 'http://localhost',\n '4001',\n );\n const encoder: TextEncoder = new TextEncoder();\n const suggestedParams: SuggestedParams = await client.getTransactionParams().do();\n const transaction: Transaction = makePaymentTxnWithSuggestedParamsFromObject({\n amount: algosToMicroalgos(1),\n from: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n note: encoder.encode('Hello Human!'),\n suggestedParams,\n to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n });\n const transactionBytes: Uint8Array = transaction.toByte();\n} catch (error) {\n // handle error\n}\n\n// initialized client\nclient.onSignAndPostTransactions(({ error, result }: IAVMWebClientCallbackOptions) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txnIDs: [\n 'OKU6A2Q...',\n ],\n }\n */\n});\n\n// send a sign and post transactions request\nclient.signAndPostTransactions({\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n txns: [\n {\n txn: btoa(String.fromCodePoint(...transactionBytes)), // convert to base64 string\n },\n ],\n});\n"})})})]}),"\n",(0,t.jsx)(a.admonition,{type:"caution",children:(0,t.jsxs)(a.p,{children:["If this method is not supported, then a ",(0,t.jsx)(a.a,{href:"../../api-reference/errors#methodnotsupportederror",children:(0,t.jsx)(a.code,{children:"MethodNotSupportedError"})})," should be thrown."]})}),"\n",(0,t.jsx)(a.admonition,{type:"caution",children:(0,t.jsxs)(a.p,{children:["If there is a group of atomic transactions, but the computed group ID is invalid, then a ",(0,t.jsx)(a.a,{href:"../../api-reference/errors#invalidgroupiderror",children:(0,t.jsx)(a.code,{children:"InvalidGroupIdError"})})," should be thrown."]})}),"\n",(0,t.jsx)(a.admonition,{type:"caution",children:(0,t.jsxs)(a.p,{children:["If any of the transactions are malformed, then a ",(0,t.jsx)(a.a,{href:"../../api-reference/errors#invalidinputerror",children:(0,t.jsx)(a.code,{children:"InvalidInputError"})})," should be thrown."]})}),"\n",(0,t.jsx)(a.admonition,{type:"caution",children:(0,t.jsxs)(a.p,{children:["If the transactions fail to be accepted by the network, then a ",(0,t.jsx)(a.a,{href:"../../api-reference/errors#failedtopostsometransactionserror",children:(0,t.jsx)(a.code,{children:"FailedToPostSomeTransactionsError"})})," should be thrown."]})})]})}function u(n={}){const{wrapper:a}={...(0,r.M)(),...n.components};return a?(0,t.jsx)(a,{...n,children:(0,t.jsx)(p,{...n})}):p(n)}}}]); \ No newline at end of file diff --git a/assets/js/17896441.6972c889.js b/assets/js/17896441.6972c889.js new file mode 100644 index 0000000..4315700 --- /dev/null +++ b/assets/js/17896441.6972c889.js @@ -0,0 +1 @@ +(self.webpackChunk_agoralabs_sh_avm_web_provider=self.webpackChunk_agoralabs_sh_avm_web_provider||[]).push([[8401],{6993:function(e,n,t){"use strict";t.r(n),t.d(n,{default:function(){return et}});var a=t(6540),s=t(1003),i=t(3807),r=t(4848),o=a.createContext(null);function c(e){var n=e.children,t=function(e){return(0,a.useMemo)((function(){return{metadata:e.metadata,frontMatter:e.frontMatter,assets:e.assets,contentTitle:e.contentTitle,toc:e.toc}}),[e])}(e.content);return(0,r.jsx)(o.Provider,{value:t,children:n})}function l(){var e=(0,a.useContext)(o);if(null===e)throw new i.dV("DocProvider");return e}function d(){var e,n=l(),t=n.metadata,a=n.frontMatter,i=n.assets;return(0,r.jsx)(s.be,{title:t.title,description:t.description,keywords:a.keywords,image:null!=(e=i.image)?e:a.image})}var u=t(4164),m=t(4581),h=t(1312),b=t(8774);function v(e){var n=e.permalink,t=e.title,a=e.subLabel,s=e.isNext;return(0,r.jsxs)(b.A,{className:(0,u.A)("pagination-nav__link",s?"pagination-nav__link--next":"pagination-nav__link--prev"),to:n,children:[a&&(0,r.jsx)("div",{className:"pagination-nav__sublabel",children:a}),(0,r.jsx)("div",{className:"pagination-nav__label",children:t})]})}function f(e){var n=e.previous,t=e.next;return(0,r.jsxs)("nav",{className:"pagination-nav docusaurus-mt-lg","aria-label":(0,h.T)({id:"theme.docs.paginator.navAriaLabel",message:"Docs pages",description:"The ARIA label for the docs pagination"}),children:[n&&(0,r.jsx)(v,Object.assign({},n,{subLabel:(0,r.jsx)(h.A,{id:"theme.docs.paginator.previous",description:"The label used to navigate to the previous doc",children:"Previous"})})),t&&(0,r.jsx)(v,Object.assign({},t,{subLabel:(0,r.jsx)(h.A,{id:"theme.docs.paginator.next",description:"The label used to navigate to the next doc",children:"Next"}),isNext:!0}))]})}function p(){var e=l().metadata;return(0,r.jsx)(f,{previous:e.previous,next:e.next})}var g=t(4586),j=t(4070),x=t(7559),N=t(3886),A=t(3025);var C={unreleased:function(e){var n=e.siteTitle,t=e.versionMetadata;return(0,r.jsx)(h.A,{id:"theme.docs.versions.unreleasedVersionLabel",description:"The label used to tell the user that he's browsing an unreleased doc version",values:{siteTitle:n,versionLabel:(0,r.jsx)("b",{children:t.label})},children:"This is unreleased documentation for {siteTitle} {versionLabel} version."})},unmaintained:function(e){var n=e.siteTitle,t=e.versionMetadata;return(0,r.jsx)(h.A,{id:"theme.docs.versions.unmaintainedVersionLabel",description:"The label used to tell the user that he's browsing an unmaintained doc version",values:{siteTitle:n,versionLabel:(0,r.jsx)("b",{children:t.label})},children:"This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained."})}};function y(e){var n=C[e.versionMetadata.banner];return(0,r.jsx)(n,Object.assign({},e))}function k(e){var n=e.versionLabel,t=e.to,a=e.onClick;return(0,r.jsx)(h.A,{id:"theme.docs.versions.latestVersionSuggestionLabel",description:"The label used to tell the user to check the latest version",values:{versionLabel:n,latestVersionLink:(0,r.jsx)("b",{children:(0,r.jsx)(b.A,{to:t,onClick:a,children:(0,r.jsx)(h.A,{id:"theme.docs.versions.latestVersionLinkLabel",description:"The label used for the latest version suggestion link label",children:"latest version"})})})},children:"For up-to-date documentation, see the {latestVersionLink} ({versionLabel})."})}function _(e){var n,t=e.className,a=e.versionMetadata,s=(0,g.A)().siteConfig.title,i=(0,j.vT)({failfast:!0}).pluginId,o=(0,N.g1)(i).savePreferredVersionName,c=(0,j.HW)(i),l=c.latestDocSuggestion,d=c.latestVersionSuggestion,m=null!=l?l:(n=d).docs.find((function(e){return e.id===n.mainDocId}));return(0,r.jsxs)("div",{className:(0,u.A)(t,x.G.docs.docVersionBanner,"alert alert--warning margin-bottom--md"),role:"alert",children:[(0,r.jsx)("div",{children:(0,r.jsx)(y,{siteTitle:s,versionMetadata:a})}),(0,r.jsx)("div",{className:"margin-top--md",children:(0,r.jsx)(k,{versionLabel:d.label,to:m.path,onClick:function(){return o(d.name)}})})]})}function B(e){var n=e.className,t=(0,A.r)();return t.banner?(0,r.jsx)(_,{className:n,versionMetadata:t}):null}function w(e){var n=e.className,t=(0,A.r)();return t.badge?(0,r.jsx)("span",{className:(0,u.A)(n,x.G.docs.docVersionBadge,"badge badge--secondary"),children:(0,r.jsx)(h.A,{id:"theme.docs.versionBadge.label",values:{versionLabel:t.label},children:"Version: {versionLabel}"})}):null}var T={tag:"tag_zVej",tagRegular:"tagRegular_sFm0",tagWithCount:"tagWithCount_h2kH"};function L(e){var n=e.permalink,t=e.label,a=e.count,s=e.description;return(0,r.jsxs)(b.A,{href:n,title:s,className:(0,u.A)(T.tag,a?T.tagWithCount:T.tagRegular),children:[t,a&&(0,r.jsx)("span",{children:a})]})}var O={tags:"tags_jXut",tag:"tag_QGVx"};function E(e){var n=e.tags;return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)("b",{children:(0,r.jsx)(h.A,{id:"theme.tags.tagsListLabel",description:"The label alongside a tag list",children:"Tags:"})}),(0,r.jsx)("ul",{className:(0,u.A)(O.tags,"padding--none","margin-left--sm"),children:n.map((function(e){return(0,r.jsx)("li",{className:O.tag,children:(0,r.jsx)(L,Object.assign({},e))},e.permalink)}))})]})}var M=t(8587),I={iconEdit:"iconEdit_Z9Sw"},S=["className"];function H(e){var n=e.className,t=(0,M.A)(e,S);return(0,r.jsx)("svg",Object.assign({fill:"currentColor",height:"20",width:"20",viewBox:"0 0 40 40",className:(0,u.A)(I.iconEdit,n),"aria-hidden":"true"},t,{children:(0,r.jsx)("g",{children:(0,r.jsx)("path",{d:"m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"})})}))}function V(e){var n=e.editUrl;return(0,r.jsxs)(b.A,{to:n,className:x.G.common.editThisPage,children:[(0,r.jsx)(H,{}),(0,r.jsx)(h.A,{id:"theme.common.editThisPage",description:"The link label to edit the current page",children:"Edit this page"})]})}function U(e){void 0===e&&(e={});var n=(0,g.A)().i18n.currentLocale,t=function(){var e=(0,g.A)().i18n,n=e.currentLocale;return e.localeConfigs[n].calendar}();return new Intl.DateTimeFormat(n,Object.assign({calendar:t},e))}function z(e){var n=e.lastUpdatedAt,t=new Date(n),a=U({day:"numeric",month:"short",year:"numeric",timeZone:"UTC"}).format(t);return(0,r.jsx)(h.A,{id:"theme.lastUpdated.atDate",description:"The words used to describe on which date a page has been last updated",values:{date:(0,r.jsx)("b",{children:(0,r.jsx)("time",{dateTime:t.toISOString(),itemProp:"dateModified",children:a})})},children:" on {date}"})}function R(e){var n=e.lastUpdatedBy;return(0,r.jsx)(h.A,{id:"theme.lastUpdated.byUser",description:"The words used to describe by who the page has been last updated",values:{user:(0,r.jsx)("b",{children:n})},children:" by {user}"})}function G(e){var n=e.lastUpdatedAt,t=e.lastUpdatedBy;return(0,r.jsxs)("span",{className:x.G.common.lastUpdated,children:[(0,r.jsx)(h.A,{id:"theme.lastUpdated.lastUpdatedAtBy",description:"The sentence used to display when a page has been last updated, and by who",values:{atDate:n?(0,r.jsx)(z,{lastUpdatedAt:n}):"",byUser:t?(0,r.jsx)(R,{lastUpdatedBy:t}):""},children:"Last updated{atDate}{byUser}"}),!1]})}var P={lastUpdated:"lastUpdated_JAkA"};function D(e){var n=e.className,t=e.editUrl,a=e.lastUpdatedAt,s=e.lastUpdatedBy;return(0,r.jsxs)("div",{className:(0,u.A)("row",n),children:[(0,r.jsx)("div",{className:"col",children:t&&(0,r.jsx)(V,{editUrl:t})}),(0,r.jsx)("div",{className:(0,u.A)("col",P.lastUpdated),children:(a||s)&&(0,r.jsx)(G,{lastUpdatedAt:a,lastUpdatedBy:s})})]})}function W(){var e=l().metadata,n=e.editUrl,t=e.lastUpdatedAt,a=e.lastUpdatedBy,s=e.tags,i=s.length>0,o=!!(n||t||a);return i||o?(0,r.jsxs)("footer",{className:(0,u.A)(x.G.docs.docFooter,"docusaurus-mt-lg"),children:[i&&(0,r.jsx)("div",{className:(0,u.A)("row margin-top--sm",x.G.docs.docFooterTagsRow),children:(0,r.jsx)("div",{className:"col",children:(0,r.jsx)(E,{tags:s})})}),o&&(0,r.jsx)(D,{className:(0,u.A)("margin-top--sm",x.G.docs.docFooterEditMetaRow),editUrl:n,lastUpdatedAt:t,lastUpdatedBy:a})]}):null}var F=t(1422),q=t(5195),Z={tocCollapsibleButton:"tocCollapsibleButton_TO0P",tocCollapsibleButtonExpanded:"tocCollapsibleButtonExpanded_MG3E"},$=["collapsed"];function J(e){var n=e.collapsed,t=(0,M.A)(e,$);return(0,r.jsx)("button",Object.assign({type:"button"},t,{className:(0,u.A)("clean-btn",Z.tocCollapsibleButton,!n&&Z.tocCollapsibleButtonExpanded,t.className),children:(0,r.jsx)(h.A,{id:"theme.TOCCollapsible.toggleButtonLabel",description:"The label used by the button on the collapsible TOC component",children:"On this page"})}))}var Y={tocCollapsible:"tocCollapsible_ETCw",tocCollapsibleContent:"tocCollapsibleContent_vkbj",tocCollapsibleExpanded:"tocCollapsibleExpanded_sAul"};function K(e){var n=e.toc,t=e.className,a=e.minHeadingLevel,s=e.maxHeadingLevel,i=(0,F.u)({initialState:!0}),o=i.collapsed,c=i.toggleCollapsed;return(0,r.jsxs)("div",{className:(0,u.A)(Y.tocCollapsible,!o&&Y.tocCollapsibleExpanded,t),children:[(0,r.jsx)(J,{collapsed:o,onClick:c}),(0,r.jsx)(F.N,{lazy:!0,className:Y.tocCollapsibleContent,collapsed:o,children:(0,r.jsx)(q.A,{toc:n,minHeadingLevel:a,maxHeadingLevel:s})})]})}var Q={tocMobile:"tocMobile_ITEo"};function X(){var e=l(),n=e.toc,t=e.frontMatter;return(0,r.jsx)(K,{toc:n,minHeadingLevel:t.toc_min_heading_level,maxHeadingLevel:t.toc_max_heading_level,className:(0,u.A)(x.G.docs.docTocMobile,Q.tocMobile)})}var ee={tableOfContents:"tableOfContents_bqdL",docItemContainer:"docItemContainer_F8PC"},ne=["className"],te="table-of-contents__link toc-highlight",ae="table-of-contents__link--active";function se(e){var n=e.className,t=(0,M.A)(e,ne);return(0,r.jsx)("div",{className:(0,u.A)(ee.tableOfContents,"thin-scrollbar",n),children:(0,r.jsx)(q.A,Object.assign({},t,{linkClassName:te,linkActiveClassName:ae}))})}function ie(){var e=l(),n=e.toc,t=e.frontMatter;return(0,r.jsx)(se,{toc:n,minHeadingLevel:t.toc_min_heading_level,maxHeadingLevel:t.toc_max_heading_level,className:x.G.docs.docTocDesktop})}var re=t(1107),oe=t(8453),ce=t(5260),le=t(2303),de=t(5293),ue=t(6342);function me(){var e=(0,ue.p)().prism,n=(0,de.G)().colorMode,t=e.theme,a=e.darkTheme||t;return"dark"===n?a:t}var he=t(8634),be=t(8426),ve=t.n(be),fe=(0,he.A)(/title=(["'])(.*?)\1/,{quote:1,title:2}),pe=(0,he.A)(/\{([\d,-]+)\}/,{range:1}),ge={js:{start:"\\/\\/",end:""},jsBlock:{start:"\\/\\*",end:"\\*\\/"},jsx:{start:"\\{\\s*\\/\\*",end:"\\*\\/\\s*\\}"},bash:{start:"#",end:""},html:{start:"\x3c!--",end:"--\x3e"}},je=Object.assign({},ge,{lua:{start:"--",end:""},wasm:{start:"\\;\\;",end:""},tex:{start:"%",end:""},vb:{start:"['\u2018\u2019]",end:""},vbnet:{start:"(?:_\\s*)?['\u2018\u2019]",end:""},rem:{start:"[Rr][Ee][Mm]\\b",end:""},f90:{start:"!",end:""},ml:{start:"\\(\\*",end:"\\*\\)"},cobol:{start:"\\*>",end:""}}),xe=Object.keys(ge);function Ne(e,n){var t=e.map((function(e){var t=je[e],a=t.start,s=t.end;return"(?:"+a+"\\s*("+n.flatMap((function(e){var n,t;return[e.line,null==(n=e.block)?void 0:n.start,null==(t=e.block)?void 0:t.end].filter(Boolean)})).join("|")+")\\s*"+s+")"})).join("|");return new RegExp("^\\s*(?:"+t+")\\s*$")}function Ae(e,n){var t=e.replace(/\n$/,""),a=n.language,s=n.magicComments,i=n.metastring;if(i&&pe.test(i)){var r=i.match(pe).groups.range;if(0===s.length)throw new Error("A highlight range has been given in code block's metastring (``` "+i+"), but no magic comment config is available. Docusaurus applies the first magic comment entry's className for metastring ranges.");var o=s[0].className,c=ve()(r).filter((function(e){return e>0})).map((function(e){return[e-1,[o]]}));return{lineClassNames:Object.fromEntries(c),code:t}}if(void 0===a)return{lineClassNames:{},code:t};for(var l=function(e,n){switch(e){case"js":case"javascript":case"ts":case"typescript":return Ne(["js","jsBlock"],n);case"jsx":case"tsx":return Ne(["js","jsBlock","jsx"],n);case"html":return Ne(["js","jsBlock","html"],n);case"python":case"py":case"bash":return Ne(["bash"],n);case"markdown":case"md":return Ne(["html","jsx","bash"],n);case"tex":case"latex":case"matlab":return Ne(["tex"],n);case"lua":case"haskell":case"sql":return Ne(["lua"],n);case"wasm":return Ne(["wasm"],n);case"vb":case"vba":case"visual-basic":return Ne(["vb","rem"],n);case"vbnet":return Ne(["vbnet","rem"],n);case"batch":return Ne(["rem"],n);case"basic":return Ne(["rem","f90"],n);case"fsharp":return Ne(["js","ml"],n);case"ocaml":case"sml":return Ne(["ml"],n);case"fortran":return Ne(["f90"],n);case"cobol":return Ne(["cobol"],n);default:return Ne(xe,n)}}(a,s),d=t.split("\n"),u=Object.fromEntries(s.map((function(e){return[e.className,{start:0,range:""}]}))),m=Object.fromEntries(s.filter((function(e){return e.line})).map((function(e){var n=e.className;return[e.line,n]}))),h=Object.fromEntries(s.filter((function(e){return e.block})).map((function(e){var n=e.className;return[e.block.start,n]}))),b=Object.fromEntries(s.filter((function(e){return e.block})).map((function(e){var n=e.className;return[e.block.end,n]}))),v=0;v0&&r.getRangeAt(0);a.append(s),s.select(),s.selectionStart=0,s.selectionEnd=e.length;var c=!1;try{c=document.execCommand("copy")}catch(l){}s.remove(),o&&(r.removeAllRanges(),r.addRange(o)),i&&i.focus()}(n),o(!0),c.current=window.setTimeout((function(){o(!1)}),1e3)}),[n]);return(0,a.useEffect)((function(){return function(){return window.clearTimeout(c.current)}}),[]),(0,r.jsx)("button",{type:"button","aria-label":i?(0,h.T)({id:"theme.CodeBlock.copied",message:"Copied",description:"The copied button label on code blocks"}):(0,h.T)({id:"theme.CodeBlock.copyButtonAriaLabel",message:"Copy code to clipboard",description:"The ARIA label for copy code blocks button"}),title:(0,h.T)({id:"theme.CodeBlock.copy",message:"Copy",description:"The copy button label on code blocks"}),className:(0,u.A)("clean-btn",t,Se.copyButton,i&&Se.copyButtonCopied),onClick:l,children:(0,r.jsxs)("span",{className:Se.copyButtonIcons,"aria-hidden":"true",children:[(0,r.jsx)(Me,{className:Se.copyButtonIcon}),(0,r.jsx)(Ie,{className:Se.copyButtonSuccessIcon})]})})}function Ve(e){return(0,r.jsx)("svg",Object.assign({viewBox:"0 0 24 24"},e,{children:(0,r.jsx)("path",{fill:"currentColor",d:"M4 19h6v-2H4v2zM20 5H4v2h16V5zm-3 6H4v2h13.25c1.1 0 2 .9 2 2s-.9 2-2 2H15v-2l-3 3l3 3v-2h2c2.21 0 4-1.79 4-4s-1.79-4-4-4z"})}))}var Ue={wordWrapButtonIcon:"wordWrapButtonIcon_Bwma",wordWrapButtonEnabled:"wordWrapButtonEnabled_EoeP"};function ze(e){var n=e.className,t=e.onClick,a=e.isEnabled,s=(0,h.T)({id:"theme.CodeBlock.wordWrapToggle",message:"Toggle word wrap",description:"The title attribute for toggle word wrapping button of code block lines"});return(0,r.jsx)("button",{type:"button",onClick:t,className:(0,u.A)("clean-btn",n,a&&Ue.wordWrapButtonEnabled),"aria-label":s,title:s,children:(0,r.jsx)(Ve,{className:Ue.wordWrapButtonIcon,"aria-hidden":"true"})})}function Re(e){var n,t,s,i,o,c,l,d,m,h,b,v=e.children,f=e.className,p=void 0===f?"":f,g=e.metastring,j=e.title,x=e.showLineNumbers,N=e.language,A=(0,ue.p)().prism,C=A.defaultLanguage,y=A.magicComments,k=function(e){return null==e?void 0:e.toLowerCase()}(null!=(n=null!=N?N:null==(t=p.split(" ").find((function(e){return e.startsWith("language-")})))?void 0:t.replace(/language-/,""))?n:C),_=me(),B=(s=(0,a.useState)(!1),i=s[0],o=s[1],c=(0,a.useState)(!1),l=c[0],d=c[1],m=(0,a.useRef)(null),h=(0,a.useCallback)((function(){var e=m.current.querySelector("code");i?e.removeAttribute("style"):(e.style.whiteSpace="pre-wrap",e.style.overflowWrap="anywhere"),o((function(e){return!e}))}),[m,i]),b=(0,a.useCallback)((function(){var e=m.current,n=e.scrollWidth>e.clientWidth||m.current.querySelector("code").hasAttribute("style");d(n)}),[m]),Te(m,b),(0,a.useEffect)((function(){b()}),[i,b]),(0,a.useEffect)((function(){return window.addEventListener("resize",b,{passive:!0}),function(){window.removeEventListener("resize",b)}}),[b]),{codeBlockRef:m,isEnabled:i,isCodeScrollable:l,toggle:h}),w=function(e){var n,t;return null!=(n=null==e||null==(t=e.match(fe))?void 0:t.groups.title)?n:""}(g)||j,T=Ae(v,{metastring:g,language:k,magicComments:y}),L=T.lineClassNames,O=T.code,E=null!=x?x:function(e){return Boolean(null==e?void 0:e.includes("showLineNumbers"))}(g);return(0,r.jsxs)(ke,{as:"div",className:(0,u.A)(p,k&&!p.includes("language-"+k)&&"language-"+k),children:[w&&(0,r.jsx)("div",{className:_e.codeBlockTitle,children:w}),(0,r.jsxs)("div",{className:_e.codeBlockContent,children:[(0,r.jsx)(Le.f4,{theme:_,code:O,language:null!=k?k:"text",children:function(e){var n=e.className,t=e.style,a=e.tokens,s=e.getLineProps,i=e.getTokenProps;return(0,r.jsx)("pre",{tabIndex:0,ref:B.codeBlockRef,className:(0,u.A)(n,_e.codeBlock,"thin-scrollbar"),style:t,children:(0,r.jsx)("code",{className:(0,u.A)(_e.codeBlockLines,E&&_e.codeBlockLinesWithNumbering),children:a.map((function(e,n){return(0,r.jsx)(Ee,{line:e,getLineProps:s,getTokenProps:i,classNames:L[n],showLineNumbers:E},n)}))})})}}),(0,r.jsxs)("div",{className:_e.buttonGroup,children:[(B.isEnabled||B.isCodeScrollable)&&(0,r.jsx)(ze,{className:_e.codeButton,onClick:function(){return B.toggle()},isEnabled:B.isEnabled}),(0,r.jsx)(He,{className:_e.codeButton,code:O})]})]})]})}var Ge=["children"];function Pe(e){var n=e.children,t=(0,M.A)(e,Ge),s=(0,le.A)(),i=function(e){return a.Children.toArray(e).some((function(e){return(0,a.isValidElement)(e)}))?e:Array.isArray(e)?e.join(""):e}(n),o="string"==typeof i?Re:Be;return(0,r.jsx)(o,Object.assign({},t,{children:i}),String(s))}function De(e){return(0,r.jsx)("code",Object.assign({},e))}var We=t(3427),Fe={details:"details_lb9f",isBrowser:"isBrowser_bmU9",collapsibleContent:"collapsibleContent_i85q"},qe=["summary","children"];function Ze(e){return!!e&&("SUMMARY"===e.tagName||Ze(e.parentElement))}function $e(e,n){return!!e&&(e===n||$e(e.parentElement,n))}function Je(e){var n=e.summary,t=e.children,s=(0,M.A)(e,qe);(0,We.A)().collectAnchor(s.id);var i=(0,le.A)(),o=(0,a.useRef)(null),c=(0,F.u)({initialState:!s.open}),l=c.collapsed,d=c.setCollapsed,m=(0,a.useState)(s.open),h=m[0],b=m[1],v=a.isValidElement(n)?n:(0,r.jsx)("summary",{children:null!=n?n:"Details"});return(0,r.jsxs)("details",Object.assign({},s,{ref:o,open:h,"data-collapsed":l,className:(0,u.A)(Fe.details,i&&Fe.isBrowser,s.className),onMouseDown:function(e){Ze(e.target)&&e.detail>1&&e.preventDefault()},onClick:function(e){e.stopPropagation();var n=e.target;Ze(n)&&$e(n,o.current)&&(e.preventDefault(),l?(d(!1),b(!0)):d(!0))},children:[v,(0,r.jsx)(F.N,{lazy:!1,collapsed:l,disableSSRStyle:!0,onCollapseTransitionEnd:function(e){d(e),b(!e)},children:(0,r.jsx)("div",{className:Fe.collapsibleContent,children:t})})]}))}var Ye={details:"details_b_Ee"},Ke="alert alert--info";function Qe(e){var n=Object.assign({},(function(e){if(null==e)throw new TypeError("Cannot destructure "+e)}(e),e));return(0,r.jsx)(Je,Object.assign({},n,{className:(0,u.A)(Ke,Ye.details,n.className)}))}function Xe(e){var n=a.Children.toArray(e.children),t=n.find((function(e){return a.isValidElement(e)&&"summary"===e.type})),s=(0,r.jsx)(r.Fragment,{children:n.filter((function(e){return e!==t}))});return(0,r.jsx)(Qe,Object.assign({},e,{summary:t,children:s}))}function en(e){return(0,r.jsx)(re.A,Object.assign({},e))}var nn={containsTaskList:"containsTaskList_mC6p"};function tn(e){if(void 0!==e)return(0,u.A)(e,(null==e?void 0:e.includes("contains-task-list"))&&nn.containsTaskList)}var an={img:"img_ev3q"};function sn(e){var n,t=function(e){var n=a.Children.toArray(e),t=n.find((function(e){return a.isValidElement(e)&&"mdxAdmonitionTitle"===e.type})),s=n.filter((function(e){return e!==t}));return{mdxAdmonitionTitle:null==t?void 0:t.props.children,rest:s.length>0?(0,r.jsx)(r.Fragment,{children:s}):null}}(e.children),s=t.mdxAdmonitionTitle,i=t.rest,o=null!=(n=e.title)?n:s;return Object.assign({},e,o&&{title:o},{children:i})}var rn={admonition:"admonition_xJq3",admonitionHeading:"admonitionHeading_Gvgb",admonitionIcon:"admonitionIcon_Rf37",admonitionContent:"admonitionContent_BuS1"};function on(e){var n=e.type,t=e.className,a=e.children;return(0,r.jsx)("div",{className:(0,u.A)(x.G.common.admonition,x.G.common.admonitionType(n),rn.admonition,t),children:a})}function cn(e){var n=e.icon,t=e.title;return(0,r.jsxs)("div",{className:rn.admonitionHeading,children:[(0,r.jsx)("span",{className:rn.admonitionIcon,children:n}),t]})}function ln(e){var n=e.children;return n?(0,r.jsx)("div",{className:rn.admonitionContent,children:n}):null}function dn(e){var n=e.type,t=e.icon,a=e.title,s=e.children,i=e.className;return(0,r.jsxs)(on,{type:n,className:i,children:[a||t?(0,r.jsx)(cn,{title:a,icon:t}):null,(0,r.jsx)(ln,{children:s})]})}function un(e){return(0,r.jsx)("svg",Object.assign({viewBox:"0 0 14 16"},e,{children:(0,r.jsx)("path",{fillRule:"evenodd",d:"M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"})}))}var mn={icon:(0,r.jsx)(un,{}),title:(0,r.jsx)(h.A,{id:"theme.admonition.note",description:"The default label used for the Note admonition (:::note)",children:"note"})};function hn(e){return(0,r.jsx)(dn,Object.assign({},mn,e,{className:(0,u.A)("alert alert--secondary",e.className),children:e.children}))}function bn(e){return(0,r.jsx)("svg",Object.assign({viewBox:"0 0 12 16"},e,{children:(0,r.jsx)("path",{fillRule:"evenodd",d:"M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"})}))}var vn={icon:(0,r.jsx)(bn,{}),title:(0,r.jsx)(h.A,{id:"theme.admonition.tip",description:"The default label used for the Tip admonition (:::tip)",children:"tip"})};function fn(e){return(0,r.jsx)(dn,Object.assign({},vn,e,{className:(0,u.A)("alert alert--success",e.className),children:e.children}))}function pn(e){return(0,r.jsx)("svg",Object.assign({viewBox:"0 0 14 16"},e,{children:(0,r.jsx)("path",{fillRule:"evenodd",d:"M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"})}))}var gn={icon:(0,r.jsx)(pn,{}),title:(0,r.jsx)(h.A,{id:"theme.admonition.info",description:"The default label used for the Info admonition (:::info)",children:"info"})};function jn(e){return(0,r.jsx)(dn,Object.assign({},gn,e,{className:(0,u.A)("alert alert--info",e.className),children:e.children}))}function xn(e){return(0,r.jsx)("svg",Object.assign({viewBox:"0 0 16 16"},e,{children:(0,r.jsx)("path",{fillRule:"evenodd",d:"M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"})}))}var Nn={icon:(0,r.jsx)(xn,{}),title:(0,r.jsx)(h.A,{id:"theme.admonition.warning",description:"The default label used for the Warning admonition (:::warning)",children:"warning"})};function An(e){return(0,r.jsx)("svg",Object.assign({viewBox:"0 0 12 16"},e,{children:(0,r.jsx)("path",{fillRule:"evenodd",d:"M5.05.31c.81 2.17.41 3.38-.52 4.31C3.55 5.67 1.98 6.45.9 7.98c-1.45 2.05-1.7 6.53 3.53 7.7-2.2-1.16-2.67-4.52-.3-6.61-.61 2.03.53 3.33 1.94 2.86 1.39-.47 2.3.53 2.27 1.67-.02.78-.31 1.44-1.13 1.81 3.42-.59 4.78-3.42 4.78-5.56 0-2.84-2.53-3.22-1.25-5.61-1.52.13-2.03 1.13-1.89 2.75.09 1.08-1.02 1.8-1.86 1.33-.67-.41-.66-1.19-.06-1.78C8.18 5.31 8.68 2.45 5.05.32L5.03.3l.02.01z"})}))}var Cn={icon:(0,r.jsx)(An,{}),title:(0,r.jsx)(h.A,{id:"theme.admonition.danger",description:"The default label used for the Danger admonition (:::danger)",children:"danger"})};var yn={icon:(0,r.jsx)(xn,{}),title:(0,r.jsx)(h.A,{id:"theme.admonition.caution",description:"The default label used for the Caution admonition (:::caution)",children:"caution"})};var kn={note:hn,tip:fn,info:jn,warning:function(e){return(0,r.jsx)(dn,Object.assign({},Nn,e,{className:(0,u.A)("alert alert--warning",e.className),children:e.children}))},danger:function(e){return(0,r.jsx)(dn,Object.assign({},Cn,e,{className:(0,u.A)("alert alert--danger",e.className),children:e.children}))}},_n={secondary:function(e){return(0,r.jsx)(hn,Object.assign({title:"secondary"},e))},important:function(e){return(0,r.jsx)(jn,Object.assign({title:"important"},e))},success:function(e){return(0,r.jsx)(fn,Object.assign({title:"success"},e))},caution:function(e){return(0,r.jsx)(dn,Object.assign({},yn,e,{className:(0,u.A)("alert alert--warning",e.className),children:e.children}))}},Bn=Object.assign({},kn,_n);function wn(e){var n,t=sn(e),a=(n=t.type,Bn[n]||(console.warn('No admonition component found for admonition type "'+n+'". Using Info as fallback.'),Bn.info));return(0,r.jsx)(a,Object.assign({},t))}var Tn=t(418),Ln={Head:ce.A,details:Xe,Details:Xe,code:function(e){return function(e){return void 0!==e.children&&a.Children.toArray(e.children).every((function(e){return"string"==typeof e&&!e.includes("\n")}))}(e)?(0,r.jsx)(De,Object.assign({},e)):(0,r.jsx)(Pe,Object.assign({},e))},a:function(e){return(0,r.jsx)(b.A,Object.assign({},e))},pre:function(e){return(0,r.jsx)(r.Fragment,{children:e.children})},ul:function(e){return(0,r.jsx)("ul",Object.assign({},e,{className:tn(e.className)}))},li:function(e){return(0,We.A)().collectAnchor(e.id),(0,r.jsx)("li",Object.assign({},e))},img:function(e){return(0,r.jsx)("img",Object.assign({decoding:"async",loading:"lazy"},e,{className:(n=e.className,(0,u.A)(n,an.img))}));var n},h1:function(e){return(0,r.jsx)(en,Object.assign({as:"h1"},e))},h2:function(e){return(0,r.jsx)(en,Object.assign({as:"h2"},e))},h3:function(e){return(0,r.jsx)(en,Object.assign({as:"h3"},e))},h4:function(e){return(0,r.jsx)(en,Object.assign({as:"h4"},e))},h5:function(e){return(0,r.jsx)(en,Object.assign({as:"h5"},e))},h6:function(e){return(0,r.jsx)(en,Object.assign({as:"h6"},e))},admonition:wn,mermaid:Tn.A};function On(e){var n=e.children;return(0,r.jsx)(oe.x,{components:Ln,children:n})}function En(e){var n,t,a,s,i=e.children,o=(n=l(),t=n.metadata,a=n.frontMatter,s=n.contentTitle,a.hide_title||void 0!==s?null:t.title);return(0,r.jsxs)("div",{className:(0,u.A)(x.G.docs.docMarkdown,"markdown"),children:[o&&(0,r.jsx)("header",{children:(0,r.jsx)(re.A,{as:"h1",children:o})}),(0,r.jsx)(On,{children:i})]})}var Mn=t(2583),In=t(9169),Sn=t(6025);function Hn(e){return(0,r.jsx)("svg",Object.assign({viewBox:"0 0 24 24"},e,{children:(0,r.jsx)("path",{d:"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z",fill:"currentColor"})}))}var Vn={breadcrumbHomeIcon:"breadcrumbHomeIcon_YNFT"};function Un(){var e=(0,Sn.Ay)("/");return(0,r.jsx)("li",{className:"breadcrumbs__item",children:(0,r.jsx)(b.A,{"aria-label":(0,h.T)({id:"theme.docs.breadcrumbs.home",message:"Home page",description:"The ARIA label for the home page in the breadcrumbs"}),className:"breadcrumbs__link",href:e,children:(0,r.jsx)(Hn,{className:Vn.breadcrumbHomeIcon})})})}var zn={breadcrumbsContainer:"breadcrumbsContainer_Z_bl"};function Rn(e){var n=e.children,t=e.href,a="breadcrumbs__link";return e.isLast?(0,r.jsx)("span",{className:a,itemProp:"name",children:n}):t?(0,r.jsx)(b.A,{className:a,href:t,itemProp:"item",children:(0,r.jsx)("span",{itemProp:"name",children:n})}):(0,r.jsx)("span",{className:a,children:n})}function Gn(e){var n=e.children,t=e.active,a=e.index,s=e.addMicrodata;return(0,r.jsxs)("li",Object.assign({},s&&{itemScope:!0,itemProp:"itemListElement",itemType:"https://schema.org/ListItem"},{className:(0,u.A)("breadcrumbs__item",{"breadcrumbs__item--active":t}),children:[n,(0,r.jsx)("meta",{itemProp:"position",content:String(a+1)})]}))}function Pn(){var e=(0,Mn.OF)(),n=(0,In.Dt)();return e?(0,r.jsx)("nav",{className:(0,u.A)(x.G.docs.docBreadcrumbs,zn.breadcrumbsContainer),"aria-label":(0,h.T)({id:"theme.docs.breadcrumbs.navAriaLabel",message:"Breadcrumbs",description:"The ARIA label for the breadcrumbs"}),children:(0,r.jsxs)("ul",{className:"breadcrumbs",itemScope:!0,itemType:"https://schema.org/BreadcrumbList",children:[n&&(0,r.jsx)(Un,{}),e.map((function(n,t){var a=t===e.length-1,s="category"===n.type&&n.linkUnlisted?void 0:n.href;return(0,r.jsx)(Gn,{active:a,index:t,addMicrodata:!!s,children:(0,r.jsx)(Rn,{href:s,isLast:a,children:n.label})},t)}))]})}):null}function Dn(){return(0,r.jsx)(h.A,{id:"theme.contentVisibility.unlistedBanner.title",description:"The unlisted content banner title",children:"Unlisted page"})}function Wn(){return(0,r.jsx)(h.A,{id:"theme.contentVisibility.unlistedBanner.message",description:"The unlisted content banner message",children:"This page is unlisted. Search engines will not index it, and only users having a direct link can access it."})}function Fn(){return(0,r.jsx)(ce.A,{children:(0,r.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})}function qn(){return(0,r.jsx)(h.A,{id:"theme.contentVisibility.draftBanner.title",description:"The draft content banner title",children:"Draft page"})}function Zn(){return(0,r.jsx)(h.A,{id:"theme.contentVisibility.draftBanner.message",description:"The draft content banner message",children:"This page is a draft. It will only be visible in dev and be excluded from the production build."})}function $n(e){var n=e.className;return(0,r.jsx)(wn,{type:"caution",title:(0,r.jsx)(qn,{}),className:(0,u.A)(n,x.G.common.draftBanner),children:(0,r.jsx)(Zn,{})})}function Jn(e){var n=e.className;return(0,r.jsx)(wn,{type:"caution",title:(0,r.jsx)(Dn,{}),className:(0,u.A)(n,x.G.common.unlistedBanner),children:(0,r.jsx)(Wn,{})})}function Yn(e){return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(Fn,{}),(0,r.jsx)(Jn,Object.assign({},e))]})}function Kn(e){var n=e.metadata,t=n.unlisted,a=n.frontMatter;return(0,r.jsxs)(r.Fragment,{children:[(t||a.unlisted)&&(0,r.jsx)(Yn,{}),a.draft&&(0,r.jsx)($n,{})]})}var Qn={docItemContainer:"docItemContainer_Djhp",docItemCol:"docItemCol_VOVn"};function Xn(e){var n,t,a,s,i,o,c=e.children,d=(n=l(),t=n.frontMatter,a=n.toc,s=(0,m.l)(),i=t.hide_table_of_contents,o=!i&&a.length>0,{hidden:i,mobile:o?(0,r.jsx)(X,{}):void 0,desktop:!o||"desktop"!==s&&"ssr"!==s?void 0:(0,r.jsx)(ie,{})}),h=l().metadata;return(0,r.jsxs)("div",{className:"row",children:[(0,r.jsxs)("div",{className:(0,u.A)("col",!d.hidden&&Qn.docItemCol),children:[(0,r.jsx)(Kn,{metadata:h}),(0,r.jsx)(B,{}),(0,r.jsxs)("div",{className:Qn.docItemContainer,children:[(0,r.jsxs)("article",{children:[(0,r.jsx)(Pn,{}),(0,r.jsx)(w,{}),d.mobile,(0,r.jsx)(En,{children:c}),(0,r.jsx)(W,{})]}),(0,r.jsx)(p,{})]})]}),d.desktop&&(0,r.jsx)("div",{className:"col col--3",children:d.desktop})]})}function et(e){var n="docs-doc-id-"+e.content.metadata.id,t=e.content;return(0,r.jsx)(c,{content:e.content,children:(0,r.jsxs)(s.e3,{className:n,children:[(0,r.jsx)(d,{}),(0,r.jsx)(Xn,{children:(0,r.jsx)(t,{})})]})})}},8426:function(e,n){function t(e){let n,t=[];for(let a of e.split(",").map((e=>e.trim())))if(/^-?\d+$/.test(a))t.push(parseInt(a,10));else if(n=a.match(/^(-?\d+)(-|\.\.\.?|\u2025|\u2026|\u22EF)(-?\d+)$/)){let[e,a,s,i]=n;if(a&&i){a=parseInt(a),i=parseInt(i);const e=a0,o=!!(t||n||s);return c||o?(0,r.jsxs)("footer",{className:(0,u.c)(x.W.docs.docFooter,"docusaurus-mt-lg"),children:[c&&(0,r.jsx)(P,{tags:i}),o&&(0,r.jsx)(D,{editUrl:t,lastUpdatedAt:n,lastUpdatedBy:s,formattedLastUpdatedAt:a})]}):null}var G=n(3420),q=n(4386),Y={tocCollapsibleButton:"tocCollapsibleButton_TO0P",tocCollapsibleButtonExpanded:"tocCollapsibleButtonExpanded_MG3E"},Z=["collapsed"];function $(e){var t=e.collapsed,n=(0,A.c)(e,Z);return(0,r.jsx)("button",Object.assign({type:"button"},n,{className:(0,u.c)("clean-btn",Y.tocCollapsibleButton,!t&&Y.tocCollapsibleButtonExpanded,n.className),children:(0,r.jsx)(h.c,{id:"theme.TOCCollapsible.toggleButtonLabel",description:"The label used by the button on the collapsible TOC component",children:"On this page"})}))}var J={tocCollapsible:"tocCollapsible_ETCw",tocCollapsibleContent:"tocCollapsibleContent_vkbj",tocCollapsibleExpanded:"tocCollapsibleExpanded_sAul"};function K(e){var t=e.toc,n=e.className,a=e.minHeadingLevel,s=e.maxHeadingLevel,i=(0,G.a)({initialState:!0}),c=i.collapsed,o=i.toggleCollapsed;return(0,r.jsxs)("div",{className:(0,u.c)(J.tocCollapsible,!c&&J.tocCollapsibleExpanded,n),children:[(0,r.jsx)($,{collapsed:c,onClick:o}),(0,r.jsx)(G.U,{lazy:!0,className:J.tocCollapsibleContent,collapsed:c,children:(0,r.jsx)(q.c,{toc:t,minHeadingLevel:a,maxHeadingLevel:s})})]})}var Q={tocMobile:"tocMobile_ITEo"};function X(){var e=l(),t=e.toc,n=e.frontMatter;return(0,r.jsx)(K,{toc:t,minHeadingLevel:n.toc_min_heading_level,maxHeadingLevel:n.toc_max_heading_level,className:(0,u.c)(x.W.docs.docTocMobile,Q.tocMobile)})}var ee={tableOfContents:"tableOfContents_bqdL",docItemContainer:"docItemContainer_F8PC"},te=["className"],ne="table-of-contents__link toc-highlight",ae="table-of-contents__link--active";function se(e){var t=e.className,n=(0,A.c)(e,te);return(0,r.jsx)("div",{className:(0,u.c)(ee.tableOfContents,"thin-scrollbar",t),children:(0,r.jsx)(q.c,Object.assign({},n,{linkClassName:ne,linkActiveClassName:ae}))})}function ie(){var e=l(),t=e.toc,n=e.frontMatter;return(0,r.jsx)(se,{toc:t,minHeadingLevel:n.toc_min_heading_level,maxHeadingLevel:n.toc_max_heading_level,className:x.W.docs.docTocDesktop})}var re=n(2623),ce=n(4552),oe=n(6780),le=n(4912),de=n(8312),ue=n(9120);function me(){var e=(0,ue.y)().prism,t=(0,de.U)().colorMode,n=e.theme,a=e.darkTheme||n;return"dark"===t?a:n}var he=n(3464),be=n(4124),ve=n.n(be),pe=(0,he.c)(/title=(["'])(.*?)\1/,{quote:1,title:2}),fe=(0,he.c)(/\{([\d,-]+)\}/,{range:1}),ge={js:{start:"\\/\\/",end:""},jsBlock:{start:"\\/\\*",end:"\\*\\/"},jsx:{start:"\\{\\s*\\/\\*",end:"\\*\\/\\s*\\}"},bash:{start:"#",end:""},html:{start:"\x3c!--",end:"--\x3e"}},je=Object.assign({},ge,{lua:{start:"--",end:""},wasm:{start:"\\;\\;",end:""},tex:{start:"%",end:""},vb:{start:"['\u2018\u2019]",end:""},vbnet:{start:"(?:_\\s*)?['\u2018\u2019]",end:""},rem:{start:"[Rr][Ee][Mm]\\b",end:""},f90:{start:"!",end:""},ml:{start:"\\(\\*",end:"\\*\\)"},cobol:{start:"\\*>",end:""}}),xe=Object.keys(ge);function Ne(e,t){var n=e.map((function(e){var n=je[e],a=n.start,s=n.end;return"(?:"+a+"\\s*("+t.flatMap((function(e){var t,n;return[e.line,null==(t=e.block)?void 0:t.start,null==(n=e.block)?void 0:n.end].filter(Boolean)})).join("|")+")\\s*"+s+")"})).join("|");return new RegExp("^\\s*(?:"+n+")\\s*$")}function Ce(e,t){var n=e.replace(/\n$/,""),a=t.language,s=t.magicComments,i=t.metastring;if(i&&fe.test(i)){var r=i.match(fe).groups.range;if(0===s.length)throw new Error("A highlight range has been given in code block's metastring (``` "+i+"), but no magic comment config is available. Docusaurus applies the first magic comment entry's className for metastring ranges.");var c=s[0].className,o=ve()(r).filter((function(e){return e>0})).map((function(e){return[e-1,[c]]}));return{lineClassNames:Object.fromEntries(o),code:n}}if(void 0===a)return{lineClassNames:{},code:n};for(var l=function(e,t){switch(e){case"js":case"javascript":case"ts":case"typescript":return Ne(["js","jsBlock"],t);case"jsx":case"tsx":return Ne(["js","jsBlock","jsx"],t);case"html":return Ne(["js","jsBlock","html"],t);case"python":case"py":case"bash":return Ne(["bash"],t);case"markdown":case"md":return Ne(["html","jsx","bash"],t);case"tex":case"latex":case"matlab":return Ne(["tex"],t);case"lua":case"haskell":case"sql":return Ne(["lua"],t);case"wasm":return Ne(["wasm"],t);case"vb":case"vba":case"visual-basic":return Ne(["vb","rem"],t);case"vbnet":return Ne(["vbnet","rem"],t);case"batch":return Ne(["rem"],t);case"basic":return Ne(["rem","f90"],t);case"fsharp":return Ne(["js","ml"],t);case"ocaml":case"sml":return Ne(["ml"],t);case"fortran":return Ne(["f90"],t);case"cobol":return Ne(["cobol"],t);default:return Ne(xe,t)}}(a,s),d=n.split("\n"),u=Object.fromEntries(s.map((function(e){return[e.className,{start:0,range:""}]}))),m=Object.fromEntries(s.filter((function(e){return e.line})).map((function(e){var t=e.className;return[e.line,t]}))),h=Object.fromEntries(s.filter((function(e){return e.block})).map((function(e){var t=e.className;return[e.block.start,t]}))),b=Object.fromEntries(s.filter((function(e){return e.block})).map((function(e){var t=e.className;return[e.block.end,t]}))),v=0;v0&&r.getRangeAt(0);a.append(s),s.select(),s.selectionStart=0,s.selectionEnd=e.length;var o=!1;try{o=document.execCommand("copy")}catch(l){}s.remove(),c&&(r.removeAllRanges(),r.addRange(c)),i&&i.focus()}(t),c(!0),o.current=window.setTimeout((function(){c(!1)}),1e3)}),[t]);return(0,a.useEffect)((function(){return function(){return window.clearTimeout(o.current)}}),[]),(0,r.jsx)("button",{type:"button","aria-label":i?(0,h.G)({id:"theme.CodeBlock.copied",message:"Copied",description:"The copied button label on code blocks"}):(0,h.G)({id:"theme.CodeBlock.copyButtonAriaLabel",message:"Copy code to clipboard",description:"The ARIA label for copy code blocks button"}),title:(0,h.G)({id:"theme.CodeBlock.copy",message:"Copy",description:"The copy button label on code blocks"}),className:(0,u.c)("clean-btn",n,Ie.copyButton,i&&Ie.copyButtonCopied),onClick:l,children:(0,r.jsxs)("span",{className:Ie.copyButtonIcons,"aria-hidden":"true",children:[(0,r.jsx)(Me,{className:Ie.copyButtonIcon}),(0,r.jsx)(Ue,{className:Ie.copyButtonSuccessIcon})]})})}function He(e){return(0,r.jsx)("svg",Object.assign({viewBox:"0 0 24 24"},e,{children:(0,r.jsx)("path",{fill:"currentColor",d:"M4 19h6v-2H4v2zM20 5H4v2h16V5zm-3 6H4v2h13.25c1.1 0 2 .9 2 2s-.9 2-2 2H15v-2l-3 3l3 3v-2h2c2.21 0 4-1.79 4-4s-1.79-4-4-4z"})}))}var We={wordWrapButtonIcon:"wordWrapButtonIcon_Bwma",wordWrapButtonEnabled:"wordWrapButtonEnabled_EoeP"};function Ve(e){var t=e.className,n=e.onClick,a=e.isEnabled,s=(0,h.G)({id:"theme.CodeBlock.wordWrapToggle",message:"Toggle word wrap",description:"The title attribute for toggle word wrapping button of code block lines"});return(0,r.jsx)("button",{type:"button",onClick:n,className:(0,u.c)("clean-btn",t,a&&We.wordWrapButtonEnabled),"aria-label":s,title:s,children:(0,r.jsx)(He,{className:We.wordWrapButtonIcon,"aria-hidden":"true"})})}function ze(e){var t,n,s,i,c,o,l,d,m,h,b,v=e.children,p=e.className,f=void 0===p?"":p,g=e.metastring,j=e.title,x=e.showLineNumbers,N=e.language,C=(0,ue.y)().prism,y=C.defaultLanguage,k=C.magicComments,_=function(e){return null==e?void 0:e.toLowerCase()}(null!=(t=null!=N?N:null==(n=f.split(" ").find((function(e){return e.startsWith("language-")})))?void 0:n.replace(/language-/,""))?t:y),w=me(),B=(s=(0,a.useState)(!1),i=s[0],c=s[1],o=(0,a.useState)(!1),l=o[0],d=o[1],m=(0,a.useRef)(null),h=(0,a.useCallback)((function(){var e=m.current.querySelector("code");i?e.removeAttribute("style"):(e.style.whiteSpace="pre-wrap",e.style.overflowWrap="anywhere"),c((function(e){return!e}))}),[m,i]),b=(0,a.useCallback)((function(){var e=m.current,t=e.scrollWidth>e.clientWidth||m.current.querySelector("code").hasAttribute("style");d(t)}),[m]),Te(m,b),(0,a.useEffect)((function(){b()}),[i,b]),(0,a.useEffect)((function(){return window.addEventListener("resize",b,{passive:!0}),function(){window.removeEventListener("resize",b)}}),[b]),{codeBlockRef:m,isEnabled:i,isCodeScrollable:l,toggle:h}),L=function(e){var t,n;return null!=(t=null==e||null==(n=e.match(pe))?void 0:n.groups.title)?t:""}(g)||j,T=Ce(v,{metastring:g,language:_,magicComments:k}),O=T.lineClassNames,E=T.code,A=null!=x?x:function(e){return Boolean(null==e?void 0:e.includes("showLineNumbers"))}(g);return(0,r.jsxs)(_e,{as:"div",className:(0,u.c)(f,_&&!f.includes("language-"+_)&&"language-"+_),children:[L&&(0,r.jsx)("div",{className:we.codeBlockTitle,children:L}),(0,r.jsxs)("div",{className:we.codeBlockContent,children:[(0,r.jsx)(Oe.gl,{theme:w,code:E,language:null!=_?_:"text",children:function(e){var t=e.className,n=e.style,a=e.tokens,s=e.getLineProps,i=e.getTokenProps;return(0,r.jsx)("pre",{tabIndex:0,ref:B.codeBlockRef,className:(0,u.c)(t,we.codeBlock,"thin-scrollbar"),style:n,children:(0,r.jsx)("code",{className:(0,u.c)(we.codeBlockLines,A&&we.codeBlockLinesWithNumbering),children:a.map((function(e,t){return(0,r.jsx)(Ae,{line:e,getLineProps:s,getTokenProps:i,classNames:O[t],showLineNumbers:A},t)}))})})}}),(0,r.jsxs)("div",{className:we.buttonGroup,children:[(B.isEnabled||B.isCodeScrollable)&&(0,r.jsx)(Ve,{className:we.codeButton,onClick:function(){return B.toggle()},isEnabled:B.isEnabled}),(0,r.jsx)(Se,{className:we.codeButton,code:E})]})]})]})}var Re=["children"];function Pe(e){var t=e.children,n=(0,A.c)(e,Re),s=(0,le.c)(),i=function(e){return a.Children.toArray(e).some((function(e){return(0,a.isValidElement)(e)}))?e:Array.isArray(e)?e.join(""):e}(t),c="string"==typeof i?ze:Be;return(0,r.jsx)(c,Object.assign({},n,{children:i}),String(s))}function De(e){return(0,r.jsx)("code",Object.assign({},e))}var Fe=n(856),Ge={details:"details_lb9f",isBrowser:"isBrowser_bmU9",collapsibleContent:"collapsibleContent_i85q"},qe=["summary","children"];function Ye(e){return!!e&&("SUMMARY"===e.tagName||Ye(e.parentElement))}function Ze(e,t){return!!e&&(e===t||Ze(e.parentElement,t))}function $e(e){var t=e.summary,n=e.children,s=(0,A.c)(e,qe);(0,Fe.c)().collectAnchor(s.id);var i=(0,le.c)(),c=(0,a.useRef)(null),o=(0,G.a)({initialState:!s.open}),l=o.collapsed,d=o.setCollapsed,m=(0,a.useState)(s.open),h=m[0],b=m[1],v=a.isValidElement(t)?t:(0,r.jsx)("summary",{children:null!=t?t:"Details"});return(0,r.jsxs)("details",Object.assign({},s,{ref:c,open:h,"data-collapsed":l,className:(0,u.c)(Ge.details,i&&Ge.isBrowser,s.className),onMouseDown:function(e){Ye(e.target)&&e.detail>1&&e.preventDefault()},onClick:function(e){e.stopPropagation();var t=e.target;Ye(t)&&Ze(t,c.current)&&(e.preventDefault(),l?(d(!1),b(!0)):d(!0))},children:[v,(0,r.jsx)(G.U,{lazy:!1,collapsed:l,disableSSRStyle:!0,onCollapseTransitionEnd:function(e){d(e),b(!e)},children:(0,r.jsx)("div",{className:Ge.collapsibleContent,children:n})})]}))}var Je={details:"details_b_Ee"},Ke="alert alert--info";function Qe(e){var t=Object.assign({},(function(e){if(null==e)throw new TypeError("Cannot destructure "+e)}(e),e));return(0,r.jsx)($e,Object.assign({},t,{className:(0,u.c)(Ke,Je.details,t.className)}))}function Xe(e){var t=a.Children.toArray(e.children),n=t.find((function(e){return a.isValidElement(e)&&"summary"===e.type})),s=(0,r.jsx)(r.Fragment,{children:t.filter((function(e){return e!==n}))});return(0,r.jsx)(Qe,Object.assign({},e,{summary:n,children:s}))}function et(e){return(0,r.jsx)(re.c,Object.assign({},e))}var tt={containsTaskList:"containsTaskList_mC6p"};function nt(e){if(void 0!==e)return(0,u.c)(e,(null==e?void 0:e.includes("contains-task-list"))&&tt.containsTaskList)}var at={img:"img_ev3q"};function st(e){var t,n=function(e){var t=a.Children.toArray(e),n=t.find((function(e){return a.isValidElement(e)&&"mdxAdmonitionTitle"===e.type})),s=t.filter((function(e){return e!==n}));return{mdxAdmonitionTitle:null==n?void 0:n.props.children,rest:s.length>0?(0,r.jsx)(r.Fragment,{children:s}):null}}(e.children),s=n.mdxAdmonitionTitle,i=n.rest,c=null!=(t=e.title)?t:s;return Object.assign({},e,c&&{title:c},{children:i})}var it={admonition:"admonition_xJq3",admonitionHeading:"admonitionHeading_Gvgb",admonitionIcon:"admonitionIcon_Rf37",admonitionContent:"admonitionContent_BuS1"};function rt(e){var t=e.type,n=e.className,a=e.children;return(0,r.jsx)("div",{className:(0,u.c)(x.W.common.admonition,x.W.common.admonitionType(t),it.admonition,n),children:a})}function ct(e){var t=e.icon,n=e.title;return(0,r.jsxs)("div",{className:it.admonitionHeading,children:[(0,r.jsx)("span",{className:it.admonitionIcon,children:t}),n]})}function ot(e){var t=e.children;return t?(0,r.jsx)("div",{className:it.admonitionContent,children:t}):null}function lt(e){var t=e.type,n=e.icon,a=e.title,s=e.children,i=e.className;return(0,r.jsxs)(rt,{type:t,className:i,children:[(0,r.jsx)(ct,{title:a,icon:n}),(0,r.jsx)(ot,{children:s})]})}function dt(e){return(0,r.jsx)("svg",Object.assign({viewBox:"0 0 14 16"},e,{children:(0,r.jsx)("path",{fillRule:"evenodd",d:"M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"})}))}var ut={icon:(0,r.jsx)(dt,{}),title:(0,r.jsx)(h.c,{id:"theme.admonition.note",description:"The default label used for the Note admonition (:::note)",children:"note"})};function mt(e){return(0,r.jsx)(lt,Object.assign({},ut,e,{className:(0,u.c)("alert alert--secondary",e.className),children:e.children}))}function ht(e){return(0,r.jsx)("svg",Object.assign({viewBox:"0 0 12 16"},e,{children:(0,r.jsx)("path",{fillRule:"evenodd",d:"M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"})}))}var bt={icon:(0,r.jsx)(ht,{}),title:(0,r.jsx)(h.c,{id:"theme.admonition.tip",description:"The default label used for the Tip admonition (:::tip)",children:"tip"})};function vt(e){return(0,r.jsx)(lt,Object.assign({},bt,e,{className:(0,u.c)("alert alert--success",e.className),children:e.children}))}function pt(e){return(0,r.jsx)("svg",Object.assign({viewBox:"0 0 14 16"},e,{children:(0,r.jsx)("path",{fillRule:"evenodd",d:"M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"})}))}var ft={icon:(0,r.jsx)(pt,{}),title:(0,r.jsx)(h.c,{id:"theme.admonition.info",description:"The default label used for the Info admonition (:::info)",children:"info"})};function gt(e){return(0,r.jsx)(lt,Object.assign({},ft,e,{className:(0,u.c)("alert alert--info",e.className),children:e.children}))}function jt(e){return(0,r.jsx)("svg",Object.assign({viewBox:"0 0 16 16"},e,{children:(0,r.jsx)("path",{fillRule:"evenodd",d:"M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"})}))}var xt={icon:(0,r.jsx)(jt,{}),title:(0,r.jsx)(h.c,{id:"theme.admonition.warning",description:"The default label used for the Warning admonition (:::warning)",children:"warning"})};function Nt(e){return(0,r.jsx)("svg",Object.assign({viewBox:"0 0 12 16"},e,{children:(0,r.jsx)("path",{fillRule:"evenodd",d:"M5.05.31c.81 2.17.41 3.38-.52 4.31C3.55 5.67 1.98 6.45.9 7.98c-1.45 2.05-1.7 6.53 3.53 7.7-2.2-1.16-2.67-4.52-.3-6.61-.61 2.03.53 3.33 1.94 2.86 1.39-.47 2.3.53 2.27 1.67-.02.78-.31 1.44-1.13 1.81 3.42-.59 4.78-3.42 4.78-5.56 0-2.84-2.53-3.22-1.25-5.61-1.52.13-2.03 1.13-1.89 2.75.09 1.08-1.02 1.8-1.86 1.33-.67-.41-.66-1.19-.06-1.78C8.18 5.31 8.68 2.45 5.05.32L5.03.3l.02.01z"})}))}var Ct={icon:(0,r.jsx)(Nt,{}),title:(0,r.jsx)(h.c,{id:"theme.admonition.danger",description:"The default label used for the Danger admonition (:::danger)",children:"danger"})};var yt={icon:(0,r.jsx)(jt,{}),title:(0,r.jsx)(h.c,{id:"theme.admonition.caution",description:"The default label used for the Caution admonition (:::caution)",children:"caution"})};var kt={note:mt,tip:vt,info:gt,warning:function(e){return(0,r.jsx)(lt,Object.assign({},xt,e,{className:(0,u.c)("alert alert--warning",e.className),children:e.children}))},danger:function(e){return(0,r.jsx)(lt,Object.assign({},Ct,e,{className:(0,u.c)("alert alert--danger",e.className),children:e.children}))}},_t={secondary:function(e){return(0,r.jsx)(mt,Object.assign({title:"secondary"},e))},important:function(e){return(0,r.jsx)(gt,Object.assign({title:"important"},e))},success:function(e){return(0,r.jsx)(vt,Object.assign({title:"success"},e))},caution:function(e){return(0,r.jsx)(lt,Object.assign({},yt,e,{className:(0,u.c)("alert alert--warning",e.className),children:e.children}))}},wt=Object.assign({},kt,_t);function Bt(e){var t,n=st(e),a=(t=n.type,wt[t]||(console.warn('No admonition component found for admonition type "'+t+'". Using Info as fallback.'),wt.info));return(0,r.jsx)(a,Object.assign({},n))}var Lt=n(1496),Tt={Head:oe.c,details:Xe,Details:Xe,code:function(e){return function(e){return void 0!==e.children&&a.Children.toArray(e.children).every((function(e){return"string"==typeof e&&!e.includes("\n")}))}(e)?(0,r.jsx)(De,Object.assign({},e)):(0,r.jsx)(Pe,Object.assign({},e))},a:function(e){return(0,r.jsx)(b.c,Object.assign({},e))},pre:function(e){return(0,r.jsx)(r.Fragment,{children:e.children})},ul:function(e){return(0,r.jsx)("ul",Object.assign({},e,{className:nt(e.className)}))},li:function(e){return(0,Fe.c)().collectAnchor(e.id),(0,r.jsx)("li",Object.assign({},e))},img:function(e){return(0,r.jsx)("img",Object.assign({decoding:"async",loading:"lazy"},e,{className:(t=e.className,(0,u.c)(t,at.img))}));var t},h1:function(e){return(0,r.jsx)(et,Object.assign({as:"h1"},e))},h2:function(e){return(0,r.jsx)(et,Object.assign({as:"h2"},e))},h3:function(e){return(0,r.jsx)(et,Object.assign({as:"h3"},e))},h4:function(e){return(0,r.jsx)(et,Object.assign({as:"h4"},e))},h5:function(e){return(0,r.jsx)(et,Object.assign({as:"h5"},e))},h6:function(e){return(0,r.jsx)(et,Object.assign({as:"h6"},e))},admonition:Bt,mermaid:Lt.c};function Ot(e){var t=e.children;return(0,r.jsx)(ce.I,{components:Tt,children:t})}function Et(e){var t,n,a,s,i=e.children,c=(t=l(),n=t.metadata,a=t.frontMatter,s=t.contentTitle,a.hide_title||void 0!==s?null:n.title);return(0,r.jsxs)("div",{className:(0,u.c)(x.W.docs.docMarkdown,"markdown"),children:[c&&(0,r.jsx)("header",{children:(0,r.jsx)(re.c,{as:"h1",children:c})}),(0,r.jsx)(Ot,{children:i})]})}var At=n(7702),Mt=n(4664),Ut=n(2448);function It(e){return(0,r.jsx)("svg",Object.assign({viewBox:"0 0 24 24"},e,{children:(0,r.jsx)("path",{d:"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z",fill:"currentColor"})}))}var St={breadcrumbHomeIcon:"breadcrumbHomeIcon_YNFT"};function Ht(){var e=(0,Ut.c)("/");return(0,r.jsx)("li",{className:"breadcrumbs__item",children:(0,r.jsx)(b.c,{"aria-label":(0,h.G)({id:"theme.docs.breadcrumbs.home",message:"Home page",description:"The ARIA label for the home page in the breadcrumbs"}),className:"breadcrumbs__link",href:e,children:(0,r.jsx)(It,{className:St.breadcrumbHomeIcon})})})}var Wt={breadcrumbsContainer:"breadcrumbsContainer_Z_bl"};function Vt(e){var t=e.children,n=e.href,a="breadcrumbs__link";return e.isLast?(0,r.jsx)("span",{className:a,itemProp:"name",children:t}):n?(0,r.jsx)(b.c,{className:a,href:n,itemProp:"item",children:(0,r.jsx)("span",{itemProp:"name",children:t})}):(0,r.jsx)("span",{className:a,children:t})}function zt(e){var t=e.children,n=e.active,a=e.index,s=e.addMicrodata;return(0,r.jsxs)("li",Object.assign({},s&&{itemScope:!0,itemProp:"itemListElement",itemType:"https://schema.org/ListItem"},{className:(0,u.c)("breadcrumbs__item",{"breadcrumbs__item--active":n}),children:[t,(0,r.jsx)("meta",{itemProp:"position",content:String(a+1)})]}))}function Rt(){var e=(0,At.js)(),t=(0,Mt.Y5)();return e?(0,r.jsx)("nav",{className:(0,u.c)(x.W.docs.docBreadcrumbs,Wt.breadcrumbsContainer),"aria-label":(0,h.G)({id:"theme.docs.breadcrumbs.navAriaLabel",message:"Breadcrumbs",description:"The ARIA label for the breadcrumbs"}),children:(0,r.jsxs)("ul",{className:"breadcrumbs",itemScope:!0,itemType:"https://schema.org/BreadcrumbList",children:[t&&(0,r.jsx)(Ht,{}),e.map((function(t,n){var a=n===e.length-1,s="category"===t.type&&t.linkUnlisted?void 0:t.href;return(0,r.jsx)(zt,{active:a,index:n,addMicrodata:!!s,children:(0,r.jsx)(Vt,{href:s,isLast:a,children:t.label})},n)}))]})}):null}function Pt(){return(0,r.jsx)(h.c,{id:"theme.unlistedContent.title",description:"The unlisted content banner title",children:"Unlisted page"})}function Dt(){return(0,r.jsx)(h.c,{id:"theme.unlistedContent.message",description:"The unlisted content banner message",children:"This page is unlisted. Search engines will not index it, and only users having a direct link can access it."})}function Ft(){return(0,r.jsx)(oe.c,{children:(0,r.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})}function Gt(e){var t=e.className;return(0,r.jsx)(Bt,{type:"caution",title:(0,r.jsx)(Pt,{}),className:(0,u.c)(t,x.W.common.unlistedBanner),children:(0,r.jsx)(Dt,{})})}function qt(e){return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(Ft,{}),(0,r.jsx)(Gt,Object.assign({},e))]})}var Yt={docItemContainer:"docItemContainer_Djhp",docItemCol:"docItemCol_VOVn"};function Zt(e){var t,n,a,s,i,c,o=e.children,d=(t=l(),n=t.frontMatter,a=t.toc,s=(0,m.U)(),i=n.hide_table_of_contents,c=!i&&a.length>0,{hidden:i,mobile:c?(0,r.jsx)(X,{}):void 0,desktop:!c||"desktop"!==s&&"ssr"!==s?void 0:(0,r.jsx)(ie,{})}),h=l().metadata.unlisted;return(0,r.jsxs)("div",{className:"row",children:[(0,r.jsxs)("div",{className:(0,u.c)("col",!d.hidden&&Yt.docItemCol),children:[h&&(0,r.jsx)(qt,{}),(0,r.jsx)(B,{}),(0,r.jsxs)("div",{className:Yt.docItemContainer,children:[(0,r.jsxs)("article",{children:[(0,r.jsx)(Rt,{}),(0,r.jsx)(L,{}),d.mobile,(0,r.jsx)(Et,{children:o}),(0,r.jsx)(F,{})]}),(0,r.jsx)(f,{})]})]}),d.desktop&&(0,r.jsx)("div",{className:"col col--3",children:d.desktop})]})}function $t(e){var t="docs-doc-id-"+e.content.metadata.id,n=e.content;return(0,r.jsx)(o,{content:e.content,children:(0,r.jsxs)(s.cr,{className:t,children:[(0,r.jsx)(d,{}),(0,r.jsx)(Zt,{children:(0,r.jsx)(n,{})})]})})}},4124:function(e,t){function n(e){let t,n=[];for(let a of e.split(",").map((e=>e.trim())))if(/^-?\d+$/.test(a))n.push(parseInt(a,10));else if(t=a.match(/^(-?\d+)(-|\.\.\.?|\u2025|\u2026|\u22EF)(-?\d+)$/)){let[e,a,s,i]=t;if(a&&i){a=parseInt(a),i=parseInt(i);const e=a {\n return {\n host: 'https://awesome-wallet.com',\n name: 'Awesome Wallet',\n networks: [\n {\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n methods: [\n 'disable',\n 'enable',\n 'post_transactions',\n 'sign_and_post_transactions',\n 'sign_transactions',\n ],\n },\n {\n genesisHash: 'IXnoWtviVVJW5LGivNFc0Dq14V3kqaXuK2u5OQrdVZo=',\n genesisId: 'voitest-v1',\n methods: [\n 'disable',\n 'enable',\n 'post_transactions',\n 'sign_and_post_transactions',\n 'sign_transactions',\n ],\n },\n ],\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n };\n});\n"})})}),(0,r.jsx)(o.A,{value:"typescript",children:(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"import type { IAVMWebProviderCallbackOptions } from '@agoralabs-sh/avm-web-provider';\n\n// initialized provider\nprovider.onDiscover(({ params }: IAVMWebProviderCallbackOptions) => {\n return {\n host: 'https://awesome-wallet.com',\n name: 'Awesome Wallet',\n networks: [\n {\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n methods: [\n 'disable',\n 'enable',\n 'post_transactions',\n 'sign_and_post_transactions',\n 'sign_transactions',\n ],\n },\n {\n genesisHash: 'IXnoWtviVVJW5LGivNFc0Dq14V3kqaXuK2u5OQrdVZo=',\n genesisId: 'voitest-v1',\n methods: [\n 'disable',\n 'enable',\n 'post_transactions',\n 'sign_and_post_transactions',\n 'sign_transactions',\n ],\n },\n ],\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n };\n});\n"})})})]})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}}}]); \ No newline at end of file diff --git a/assets/js/27d136a3.f4b1ae3d.js b/assets/js/27d136a3.f4b1ae3d.js new file mode 100644 index 0000000..9025bbe --- /dev/null +++ b/assets/js/27d136a3.f4b1ae3d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_agoralabs_sh_avm_web_provider=self.webpackChunk_agoralabs_sh_avm_web_provider||[]).push([[6452],{4064:function(e,n,r){r.r(n),r.d(n,{assets:function(){return p},contentTitle:function(){return o},default:function(){return b},frontMatter:function(){return c},metadata:function(){return d},toc:function(){return h}});var i=r(4848),a=r(8453),t=r(1470),s=r(9365),l=r(4252);const c={},o="Enabling A Client",d={id:"clients/enabling-a-client",title:"Enabling A Client",description:" {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n accounts: [\n {\n address: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n name: 'Wallet-1',\n },\n {\n address: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n name: 'Wallet-2',\n },\n ],\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n sessionId: 'ab192498-0c63-4028-80fd-f148710611d8',\n }\n */\n});\n\n// send a enable request\nclient.enable();\n"})})}),(0,i.jsx)(s.A,{value:"typescript",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-typescript",children:"import { IAVMWebClientCallbackOptions } from '@agoralabs-sh/avm-web-provider';\n\n// initialized client\nclient.onEnable(({ error, result }: IAVMWebClientCallbackOptions) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n accounts: [\n {\n address: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n name: 'Wallet-1',\n },\n {\n address: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n name: 'Wallet-2',\n },\n ],\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n sessionId: 'ab192498-0c63-4028-80fd-f148710611d8',\n }\n */\n});\n\n// send a enable request\nclient.enable();\n"})})})]}),"\n",(0,i.jsx)(n.admonition,{type:"caution",children:(0,i.jsxs)(n.p,{children:["If any providers do not support the ",(0,i.jsx)(n.code,{children:"enable"})," method, then a ",(0,i.jsx)(n.a,{href:"../../api-reference/errors#methodnotsupportederror",children:(0,i.jsx)(n.code,{children:"MethodNotSupportedError"})})," will be returned."]})}),"\n",(0,i.jsx)(n.h2,{id:"enabling-the-client-with-a-specific-provider",children:"Enabling the client with a specific provider"}),"\n",(0,i.jsx)(n.p,{children:"If you want to target a specific provider, you can simply pass the ID of the provider in the params:"}),"\n",(0,i.jsxs)(t.A,{defaultValue:"javascript",values:[{label:"Javascript",value:"javascript"},{label:"TypeScript",value:"typescript"}],children:[(0,i.jsx)(s.A,{value:"javascript",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';\n\n// initialized client\nclient.onEnable(({ error, result }) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n accounts: [\n {\n address: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n name: 'Wallet-1',\n },\n {\n address: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n name: 'Wallet-2',\n },\n ],\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n sessionId: 'ab192498-0c63-4028-80fd-f148710611d8',\n }\n */\n});\n\n// send a enable request\nclient.enable({ providerId });\n"})})}),(0,i.jsx)(s.A,{value:"typescript",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-typescript",children:"import { IAVMWebClientCallbackOptions } from '@agoralabs-sh/avm-web-provider';\n\n const providerId: string = '02657eaf-be17-4efc-b0a4-19d654b2448e';\n\n// initialized client\nclient.onEnable(({ error, result }: IAVMWebClientCallbackOptions) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n accounts: [\n {\n address: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n name: 'Wallet-1',\n },\n {\n address: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n name: 'Wallet-2',\n },\n ],\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n sessionId: 'ab192498-0c63-4028-80fd-f148710611d8',\n }\n */\n});\n\n// send a enable request\nclient.enable({ providerId });\n"})})})]}),"\n",(0,i.jsx)(n.h2,{id:"enabling-a-client-on-a-specific-network",children:"Enabling a client on a specific network"}),"\n",(0,i.jsx)(n.p,{children:"If you want to target a specific network, and any providers support it, you can simply pass the genesis hash of the network in the params:"}),"\n",(0,i.jsxs)(t.A,{defaultValue:"javascript",values:[{label:"Javascript",value:"javascript"},{label:"TypeScript",value:"typescript"}],children:[(0,i.jsx)(s.A,{value:"javascript",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const genesisHash = 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=';\n\n// initialized client\nclient.onEnable(({ error, result }) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n accounts: [\n {\n address: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n name: 'Wallet-1',\n },\n {\n address: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n name: 'Wallet-2',\n },\n ],\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n sessionId: 'ab192498-0c63-4028-80fd-f148710611d8',\n }\n */\n});\n\n// send a enable request\nclient.enable({ genesisHash });\n"})})}),(0,i.jsx)(s.A,{value:"typescript",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-typescript",children:"import { IAVMWebClientCallbackOptions } from '@agoralabs-sh/avm-web-provider';\n\nconst genesisHash: string = 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=';\n\n// initialized client\nclient.onEnable(({ error, result }: IAVMWebClientCallbackOptions) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n accounts: [\n {\n address: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n name: 'Wallet-1',\n },\n {\n address: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n name: 'Wallet-2',\n },\n ],\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n sessionId: 'ab192498-0c63-4028-80fd-f148710611d8',\n }\n */\n});\n\n// send a enable request\nclient.enable({ genesisHash });\n"})})})]}),"\n",(0,i.jsx)(n.admonition,{type:"caution",children:(0,i.jsxs)(n.p,{children:["If the network and the provider ID is specified, and the provider does not support the network, then a ",(0,i.jsx)(n.a,{href:"../../api-reference/errors#networknotsupportederror",children:(0,i.jsx)(n.code,{children:"NetworkNotSupportedError"})})," should be thrown."]})})]})}function b(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}}}]); \ No newline at end of file diff --git a/assets/js/27d136a3.ff91a66c.js b/assets/js/27d136a3.ff91a66c.js deleted file mode 100644 index 6bc2162..0000000 --- a/assets/js/27d136a3.ff91a66c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_agoralabs_sh_avm_web_provider=self.webpackChunk_agoralabs_sh_avm_web_provider||[]).push([[508],{892:function(e,n,r){r.r(n),r.d(n,{assets:function(){return p},contentTitle:function(){return o},default:function(){return b},frontMatter:function(){return c},metadata:function(){return d},toc:function(){return h}});var i=r(7624),a=r(4552),t=r(3500),s=r(6568),l=r(6200);const c={},o="Enabling A Client",d={id:"clients/enabling-a-client",title:"Enabling A Client",description:" {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n accounts: [\n {\n address: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n name: 'Wallet-1',\n },\n {\n address: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n name: 'Wallet-2',\n },\n ],\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n sessionId: 'ab192498-0c63-4028-80fd-f148710611d8',\n }\n */\n});\n\n// send a enable request\nclient.enable();\n"})})}),(0,i.jsx)(s.c,{value:"typescript",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-typescript",children:"import { IAVMWebClientCallbackOptions } from '@agoralabs-sh/avm-web-provider';\n\n// initialized client\nclient.onEnable(({ error, result }: IAVMWebClientCallbackOptions) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n accounts: [\n {\n address: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n name: 'Wallet-1',\n },\n {\n address: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n name: 'Wallet-2',\n },\n ],\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n sessionId: 'ab192498-0c63-4028-80fd-f148710611d8',\n }\n */\n});\n\n// send a enable request\nclient.enable();\n"})})})]}),"\n",(0,i.jsx)(n.admonition,{type:"caution",children:(0,i.jsxs)(n.p,{children:["If any providers do not support the ",(0,i.jsx)(n.code,{children:"enable"})," method, then a ",(0,i.jsx)(n.a,{href:"../../api-reference/errors#methodnotsupportederror",children:(0,i.jsx)(n.code,{children:"MethodNotSupportedError"})})," will be returned."]})}),"\n",(0,i.jsx)(n.h2,{id:"enabling-the-client-with-a-specific-provider",children:"Enabling the client with a specific provider"}),"\n",(0,i.jsx)(n.p,{children:"If you want to target a specific provider, you can simply pass the ID of the provider in the params:"}),"\n",(0,i.jsxs)(t.c,{defaultValue:"javascript",values:[{label:"Javascript",value:"javascript"},{label:"TypeScript",value:"typescript"}],children:[(0,i.jsx)(s.c,{value:"javascript",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';\n\n// initialized client\nclient.onEnable(({ error, result }) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n accounts: [\n {\n address: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n name: 'Wallet-1',\n },\n {\n address: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n name: 'Wallet-2',\n },\n ],\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n sessionId: 'ab192498-0c63-4028-80fd-f148710611d8',\n }\n */\n});\n\n// send a enable request\nclient.enable({ providerId });\n"})})}),(0,i.jsx)(s.c,{value:"typescript",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-typescript",children:"import { IAVMWebClientCallbackOptions } from '@agoralabs-sh/avm-web-provider';\n\n const providerId: string = '02657eaf-be17-4efc-b0a4-19d654b2448e';\n\n// initialized client\nclient.onEnable(({ error, result }: IAVMWebClientCallbackOptions) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n accounts: [\n {\n address: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n name: 'Wallet-1',\n },\n {\n address: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n name: 'Wallet-2',\n },\n ],\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n sessionId: 'ab192498-0c63-4028-80fd-f148710611d8',\n }\n */\n});\n\n// send a enable request\nclient.enable({ providerId });\n"})})})]}),"\n",(0,i.jsx)(n.h2,{id:"enabling-a-client-on-a-specific-network",children:"Enabling a client on a specific network"}),"\n",(0,i.jsx)(n.p,{children:"If you want to target a specific network, and any providers support it, you can simply pass the genesis hash of the network in the params:"}),"\n",(0,i.jsxs)(t.c,{defaultValue:"javascript",values:[{label:"Javascript",value:"javascript"},{label:"TypeScript",value:"typescript"}],children:[(0,i.jsx)(s.c,{value:"javascript",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",children:"const genesisHash = 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=';\n\n// initialized client\nclient.onEnable(({ error, result }) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n accounts: [\n {\n address: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n name: 'Wallet-1',\n },\n {\n address: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n name: 'Wallet-2',\n },\n ],\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n sessionId: 'ab192498-0c63-4028-80fd-f148710611d8',\n }\n */\n});\n\n// send a enable request\nclient.enable({ genesisHash });\n"})})}),(0,i.jsx)(s.c,{value:"typescript",children:(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-typescript",children:"import { IAVMWebClientCallbackOptions } from '@agoralabs-sh/avm-web-provider';\n\nconst genesisHash: string = 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=';\n\n// initialized client\nclient.onEnable(({ error, result }: IAVMWebClientCallbackOptions) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n accounts: [\n {\n address: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',\n name: 'Wallet-1',\n },\n {\n address: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',\n name: 'Wallet-2',\n },\n ],\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n sessionId: 'ab192498-0c63-4028-80fd-f148710611d8',\n }\n */\n});\n\n// send a enable request\nclient.enable({ genesisHash });\n"})})})]}),"\n",(0,i.jsx)(n.admonition,{type:"caution",children:(0,i.jsxs)(n.p,{children:["If the network and the provider ID is specified, and the provider does not support the network, then a ",(0,i.jsx)(n.a,{href:"../../api-reference/errors#networknotsupportederror",children:(0,i.jsx)(n.code,{children:"NetworkNotSupportedError"})})," should be thrown."]})})]})}function b(e={}){const{wrapper:n}={...(0,a.M)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}}}]); \ No newline at end of file diff --git a/assets/js/29d4e771.586f8e44.js b/assets/js/29d4e771.586f8e44.js new file mode 100644 index 0000000..bf5961d --- /dev/null +++ b/assets/js/29d4e771.586f8e44.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_agoralabs_sh_avm_web_provider=self.webpackChunk_agoralabs_sh_avm_web_provider||[]).push([[5160],{1159:function(e,s,n){n.r(s),n.d(s,{assets:function(){return c},contentTitle:function(){return p},default:function(){return v},frontMatter:function(){return d},metadata:function(){return l},toc:function(){return h}});var i=n(4848),r=n(8453),t=n(1470),o=n(9365),a=n(4252);const d={},p="Responding To Disable Requests",l={id:"usage/providers/responding-to-disable-requests",title:"Responding To Disable Requests",description:" {\n // ... remove all sessions\n\n return {\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n };\n});\n"})})}),(0,i.jsx)(o.A,{value:"typescript",children:(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-typescript",children:"// initialized provider\nprovider.onDisable(() => {\n // ... remove all sessions\n\n return {\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n };\n});\n"})})})]}),"\n",(0,i.jsx)(s.admonition,{type:"note",children:(0,i.jsx)(s.p,{children:"If no network or session IDs have been specified, you can assume all sessions for this client should be removed."})}),"\n",(0,i.jsx)(s.admonition,{type:"caution",children:(0,i.jsxs)(s.p,{children:["If this method is not supported, then a ",(0,i.jsx)(s.a,{href:"../../api-reference/errors#methodnotsupportederror",children:(0,i.jsx)(s.code,{children:"MethodNotSupportedError"})})," should be thrown."]})}),"\n",(0,i.jsx)(s.h2,{id:"responding-to-a-disable-request-with-a-specific-network",children:"Responding to a disable request with a specific network"}),"\n",(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"disable"})," request allows the client to specify the network. This is denoted in the supplied ",(0,i.jsx)(s.code,{children:"params.genesisHash"})," parameter."]}),"\n",(0,i.jsxs)(t.A,{defaultValue:"javascript",values:[{label:"Javascript",value:"javascript"},{label:"TypeScript",value:"typescript"}],children:[(0,i.jsx)(o.A,{value:"javascript",children:(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-js",children:"const { ARC0027NetworkNotSupportedError } = require('@agoralabs-sh/avm-web-provider');\n\nconst genesisHash = 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=';\nconst providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';\n\n// initialized provider\nprovider.onDisable(({ params }) => {\n // if the genesis hash has been defined, it is recommended that you throw and error\n if (param.genesisHash && param.genesisHash !== genesisHash) {\n throw new ARC0027NetworkNotSupportedError({\n genesisHashes: [param.genesisHash],\n providerId,\n });\n }\n\n // ... remove all sessions for the network\n\n return {\n genesisHash,\n genesisId: 'testnet-v1.0',\n providerId,\n };\n});\n"})})}),(0,i.jsx)(o.A,{value:"typescript",children:(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-typescript",children:"import type { ARC0027NetworkNotSupportedError, IAVMWebProviderCallbackOptions } from '@agoralabs-sh/avm-web-provider';\n\nconst genesisHash = 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=';\nconst providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';\n\n// initialized provider\nprovider.onDisable(({ params }: IAVMWebProviderCallbackOptions) => {\n // if the genesis hash has been defined, it is recommended that you throw and error\n if (param.genesisHash && param.genesisHash !== genesisHash) {\n throw new ARC0027NetworkNotSupportedError({\n genesisHashes: [param.genesisHash],\n providerId,\n });\n }\n\n // ... remove all sessions for the network\n\n return {\n genesisHash,\n genesisId: 'testnet-v1.0',\n providerId,\n };\n});\n"})})})]}),"\n",(0,i.jsx)(s.admonition,{type:"caution",children:(0,i.jsxs)(s.p,{children:["If the network is specified, and the provider does not support the network, then a ",(0,i.jsx)(s.a,{href:"../../api-reference/errors#networknotsupportederror",children:(0,i.jsx)(s.code,{children:"NetworkNotSupportedError"})})," should be thrown."]})}),"\n",(0,i.jsx)(s.h2,{id:"responding-to-specific-session-ids",children:"Responding to specific session IDs"}),"\n",(0,i.jsx)(s.p,{children:"A requesting client can specify the particular session. This can be used instead of specifying the network, or if the provider supports multiple sessions."}),"\n",(0,i.jsxs)(t.A,{defaultValue:"javascript",values:[{label:"Javascript",value:"javascript"},{label:"TypeScript",value:"typescript"}],children:[(0,i.jsx)(o.A,{value:"javascript",children:(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-js",children:"const providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';\nconst sessionId = '2802dff6-930e-4f79-8f67-ba9d41e88cf8';\n\n// initialized provider\nprovider.onDisable(({ params }) => {\n if (params && params.sessionIds.indexOf(sessionId) >= 0) {\n // ... remove sessions specified in the session ids list\n\n return {\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n providerId,\n sessionIds: [sessionId],\n };\n }\n});\n"})})}),(0,i.jsx)(o.A,{value:"typescript",children:(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-typescript",children:"import type { IAVMWebProviderCallbackOptions } from '@agoralabs-sh/avm-web-provider';\n\nconst providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';\nconst sessionId = '2802dff6-930e-4f79-8f67-ba9d41e88cf8';\n\n// initialized provider\nprovider.onDisable(({ params }: IAVMWebProviderCallbackOptions) => {\n if (params && params.sessionIds.includes(sessionId)) {\n // ... remove sessions specified in the session ids list\n\n return {\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n providerId,\n sessionIds: [sessionId],\n };\n }\n});\n"})})})]}),"\n",(0,i.jsx)(s.admonition,{type:"note",children:(0,i.jsx)(s.p,{children:"It is recommended that when removing specific session IDs, only return the removed session IDs in the result."})})]})}function v(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}}}]); \ No newline at end of file diff --git a/assets/js/2c8567d4.b56cad1a.js b/assets/js/2c8567d4.b56cad1a.js new file mode 100644 index 0000000..c89e8ad --- /dev/null +++ b/assets/js/2c8567d4.b56cad1a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_agoralabs_sh_avm_web_provider=self.webpackChunk_agoralabs_sh_avm_web_provider||[]).push([[9266],{1617:function(e,r,n){n.r(r),n.d(r,{assets:function(){return p},contentTitle:function(){return l},default:function(){return v},frontMatter:function(){return d},metadata:function(){return c},toc:function(){return h}});var o=n(4848),a=n(8453),i=n(1470),t=n(9365),s=n(4252);const d={},l="Throwing An Error",c={id:"usage/providers/throwing-an-error",title:"Throwing An Error",description:" {\n if (error) {\n console.error(error);\n /*\n {\n code: 4003,\n data: {\n method: 'disable',\n },\n message: 'disable method is not supported',\n name: 'MethodNotSupportedError',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n }\n */\n\n return;\n }\n});\n\n// send a client request\nclient.disable();\n\n// AVMWebProvider\nconst { ARC0027MethodSupportedError } = require('@agoralabs-sh/avm-web-provider');\n\nprovider.onDisable(({ params }) => {\n throw new ARC0027MethodSupportedError({\n method: 'disable',\n message: 'disable method is not supported',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n });\n});\n"})})}),(0,o.jsx)(t.A,{value:"javascript-via-cdn",children:(0,o.jsx)(r.pre,{children:(0,o.jsx)(r.code,{className:"language-js",children:"// AVMWebClient\nclient.onDisable(({ error, result }) => {\n if (error) {\n console.error(error);\n /*\n {\n code: 4003,\n data: {\n method: 'disable',\n },\n message: 'disable method is not supported',\n name: 'MethodNotSupportedError',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n }\n */\n\n return;\n}\n});\n\n// send a client request\nclient.disable();\n\n// AVMWebProvider\nprovider.onDisable(({ params }) => {\n throw new window.AVMWebProviderSDK.ARC0027MethodSupportedError({\n method: 'disable',\n message: 'disable method is not supported',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n });\n});\n"})})}),(0,o.jsx)(t.A,{value:"typescript",children:(0,o.jsx)(r.pre,{children:(0,o.jsx)(r.code,{className:"language-typescript",children:"// AVMWebClient\nclient.onDisable(({ error, result }) => {\n if (error) {\n console.error(error);\n /*\n {\n code: 4003,\n data: {\n method: 'disable',\n },\n message: 'disable method is not supported',\n name: 'MethodNotSupportedError',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n }\n */\n\n return;\n }\n});\n\n// send a client request\nclient.disable();\n\n// AVMWebProvider\nimport { ARC0027MethodEnum, ARC0027MethodSupportedError } from '@agoralabs-sh/avm-web-provider';\n\nprovider.onDisable(({ params }) => {\n throw new ARC0027MethodSupportedError({\n method: ARC0027MethodEnum.Disable,\n message: `${ARC0027MethodEnum.Disable} method is not supported`,\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n });\n});\n"})})})]}),"\n",(0,o.jsx)(r.admonition,{type:"note",children:(0,o.jsxs)(r.p,{children:["The SDK provides several common errors, see ",(0,o.jsx)(r.a,{href:"../api-reference/errors",children:"errors"}),"."]})})]})}function v(e={}){const{wrapper:r}={...(0,a.R)(),...e.components};return r?(0,o.jsx)(r,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}}}]); \ No newline at end of file diff --git a/assets/js/2f03465d.063e0da1.js b/assets/js/2f03465d.063e0da1.js deleted file mode 100644 index 211ef98..0000000 --- a/assets/js/2f03465d.063e0da1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_agoralabs_sh_avm_web_provider=self.webpackChunk_agoralabs_sh_avm_web_provider||[]).push([[524],{848:function(e,r,n){n.r(r),n.d(r,{assets:function(){return p},contentTitle:function(){return l},default:function(){return v},frontMatter:function(){return d},metadata:function(){return c},toc:function(){return h}});var o=n(7624),a=n(4552),i=n(3500),t=n(6568),s=n(6200);const d={},l="Throwing An Error",c={id:"providers/throwing-an-error",title:"Throwing An Error",description:" {\n if (error) {\n console.error(error);\n /*\n {\n code: 4003,\n data: {\n method: 'disable',\n },\n message: 'disable method is not supported',\n name: 'MethodNotSupportedError',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n }\n */\n\n return;\n }\n});\n\n// send a client request\nclient.disable();\n\n// AVMWebProvider\nconst { ARC0027MethodSupportedError } = require('@agoralabs-sh/avm-web-provider');\n\nprovider.onDisable(({ params }) => {\n throw new ARC0027MethodSupportedError({\n method: 'disable',\n message: 'disable method is not supported',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n });\n});\n"})})}),(0,o.jsx)(t.c,{value:"javascript-via-cdn",children:(0,o.jsx)(r.pre,{children:(0,o.jsx)(r.code,{className:"language-js",children:"// AVMWebClient\nclient.onDisable(({ error, result }) => {\n if (error) {\n console.error(error);\n /*\n {\n code: 4003,\n data: {\n method: 'disable',\n },\n message: 'disable method is not supported',\n name: 'MethodNotSupportedError',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n }\n */\n\n return;\n}\n});\n\n// send a client request\nclient.disable();\n\n// AVMWebProvider\nprovider.onDisable(({ params }) => {\n throw new window.AVMWebProviderSDK.ARC0027MethodSupportedError({\n method: 'disable',\n message: 'disable method is not supported',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n });\n});\n"})})}),(0,o.jsx)(t.c,{value:"typescript",children:(0,o.jsx)(r.pre,{children:(0,o.jsx)(r.code,{className:"language-typescript",children:"// AVMWebClient\nclient.onDisable(({ error, result }) => {\n if (error) {\n console.error(error);\n /*\n {\n code: 4003,\n data: {\n method: 'disable',\n },\n message: 'disable method is not supported',\n name: 'MethodNotSupportedError',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n }\n */\n\n return;\n }\n});\n\n// send a client request\nclient.disable();\n\n// AVMWebProvider\nimport { ARC0027MethodEnum, ARC0027MethodSupportedError } from '@agoralabs-sh/avm-web-provider';\n\nprovider.onDisable(({ params }) => {\n throw new ARC0027MethodSupportedError({\n method: ARC0027MethodEnum.Disable,\n message: `${ARC0027MethodEnum.Disable} method is not supported`,\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n });\n});\n"})})})]}),"\n",(0,o.jsx)(r.admonition,{type:"note",children:(0,o.jsxs)(r.p,{children:["The SDK provides several common errors, see ",(0,o.jsx)(r.a,{href:"../api-reference/errors",children:"errors"}),"."]})})]})}function v(e={}){const{wrapper:r}={...(0,a.M)(),...e.components};return r?(0,o.jsx)(r,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}}}]); \ No newline at end of file diff --git a/assets/js/2f03465d.36e85508.js b/assets/js/2f03465d.36e85508.js new file mode 100644 index 0000000..01bc886 --- /dev/null +++ b/assets/js/2f03465d.36e85508.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_agoralabs_sh_avm_web_provider=self.webpackChunk_agoralabs_sh_avm_web_provider||[]).push([[6117],{7929:function(e,r,n){n.r(r),n.d(r,{assets:function(){return p},contentTitle:function(){return l},default:function(){return v},frontMatter:function(){return d},metadata:function(){return c},toc:function(){return h}});var o=n(4848),a=n(8453),i=n(1470),t=n(9365),s=n(4252);const d={},l="Throwing An Error",c={id:"providers/throwing-an-error",title:"Throwing An Error",description:" {\n if (error) {\n console.error(error);\n /*\n {\n code: 4003,\n data: {\n method: 'disable',\n },\n message: 'disable method is not supported',\n name: 'MethodNotSupportedError',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n }\n */\n\n return;\n }\n});\n\n// send a client request\nclient.disable();\n\n// AVMWebProvider\nconst { ARC0027MethodSupportedError } = require('@agoralabs-sh/avm-web-provider');\n\nprovider.onDisable(({ params }) => {\n throw new ARC0027MethodSupportedError({\n method: 'disable',\n message: 'disable method is not supported',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n });\n});\n"})})}),(0,o.jsx)(t.A,{value:"javascript-via-cdn",children:(0,o.jsx)(r.pre,{children:(0,o.jsx)(r.code,{className:"language-js",children:"// AVMWebClient\nclient.onDisable(({ error, result }) => {\n if (error) {\n console.error(error);\n /*\n {\n code: 4003,\n data: {\n method: 'disable',\n },\n message: 'disable method is not supported',\n name: 'MethodNotSupportedError',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n }\n */\n\n return;\n}\n});\n\n// send a client request\nclient.disable();\n\n// AVMWebProvider\nprovider.onDisable(({ params }) => {\n throw new window.AVMWebProviderSDK.ARC0027MethodSupportedError({\n method: 'disable',\n message: 'disable method is not supported',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n });\n});\n"})})}),(0,o.jsx)(t.A,{value:"typescript",children:(0,o.jsx)(r.pre,{children:(0,o.jsx)(r.code,{className:"language-typescript",children:"// AVMWebClient\nclient.onDisable(({ error, result }) => {\n if (error) {\n console.error(error);\n /*\n {\n code: 4003,\n data: {\n method: 'disable',\n },\n message: 'disable method is not supported',\n name: 'MethodNotSupportedError',\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n }\n */\n\n return;\n }\n});\n\n// send a client request\nclient.disable();\n\n// AVMWebProvider\nimport { ARC0027MethodEnum, ARC0027MethodSupportedError } from '@agoralabs-sh/avm-web-provider';\n\nprovider.onDisable(({ params }) => {\n throw new ARC0027MethodSupportedError({\n method: ARC0027MethodEnum.Disable,\n message: `${ARC0027MethodEnum.Disable} method is not supported`,\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n });\n});\n"})})})]}),"\n",(0,o.jsx)(r.admonition,{type:"note",children:(0,o.jsxs)(r.p,{children:["The SDK provides several common errors, see ",(0,o.jsx)(r.a,{href:"../api-reference/errors",children:"errors"}),"."]})})]})}function v(e={}){const{wrapper:r}={...(0,a.R)(),...e.components};return r?(0,o.jsx)(r,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}}}]); \ No newline at end of file diff --git a/assets/js/2f412085.4256d459.js b/assets/js/2f412085.4256d459.js deleted file mode 100644 index 801e649..0000000 --- a/assets/js/2f412085.4256d459.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_agoralabs_sh_avm_web_provider=self.webpackChunk_agoralabs_sh_avm_web_provider||[]).push([[136],{7356:function(e,t,s){s.r(t),s.d(t,{assets:function(){return l},contentTitle:function(){return i},default:function(){return h},frontMatter:function(){return d},metadata:function(){return o},toc:function(){return c}});var r=s(7624),n=s(4552);const d={},i="Supported Wallets",o={id:"supported-wallets",title:"Supported Wallets",description:"| Name | Provider ID | Website | Download | Support/Issues |",source:"@site/docs/supported-wallets.md",sourceDirName:".",slug:"/supported-wallets",permalink:"/supported-wallets",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Types",permalink:"/api-reference/types"}},l={},c=[];function a(e){const t={a:"a",code:"code",h1:"h1",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,n.M)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"supported-wallets",children:"Supported Wallets"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Name"}),(0,r.jsx)(t.th,{children:"Provider ID"}),(0,r.jsx)(t.th,{children:"Website"}),(0,r.jsx)(t.th,{children:"Download"}),(0,r.jsx)(t.th,{children:"Support/Issues"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Kibisis"}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"f6d1c86b-4493-42fb-b88d-a62407b4cdf6"})}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.a,{href:"https://kibis.is",children:"https://kibis.is"})}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.a,{href:"https://kibis.is/#download",children:"https://kibis.is/#download"})}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.a,{href:"https://discord.com/channels/1055863853633785857/1181252381816655952",children:"Discord"})})]})})]})]})}function h(e={}){const{wrapper:t}={...(0,n.M)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}}}]); \ No newline at end of file diff --git a/assets/js/2f412085.d100aad1.js b/assets/js/2f412085.d100aad1.js new file mode 100644 index 0000000..e6a69ed --- /dev/null +++ b/assets/js/2f412085.d100aad1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_agoralabs_sh_avm_web_provider=self.webpackChunk_agoralabs_sh_avm_web_provider||[]).push([[5701],{7440:function(e,t,s){s.r(t),s.d(t,{assets:function(){return l},contentTitle:function(){return i},default:function(){return h},frontMatter:function(){return n},metadata:function(){return o},toc:function(){return c}});var r=s(4848),d=s(8453);const n={},i="Supported Wallets",o={id:"supported-wallets",title:"Supported Wallets",description:"| Name | Provider ID | Website | Download | Support/Issues |",source:"@site/docs/supported-wallets.md",sourceDirName:".",slug:"/supported-wallets",permalink:"/supported-wallets",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"docs",previous:{title:"Types",permalink:"/api-reference/types"}},l={},c=[];function a(e){const t={a:"a",code:"code",h1:"h1",header:"header",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,d.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"supported-wallets",children:"Supported Wallets"})}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Name"}),(0,r.jsx)(t.th,{children:"Provider ID"}),(0,r.jsx)(t.th,{children:"Website"}),(0,r.jsx)(t.th,{children:"Download"}),(0,r.jsx)(t.th,{children:"Support/Issues"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Kibisis"}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"f6d1c86b-4493-42fb-b88d-a62407b4cdf6"})}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.a,{href:"https://kibis.is",children:"https://kibis.is"})}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.a,{href:"https://kibis.is/#download",children:"https://kibis.is/#download"})}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.a,{href:"https://discord.com/channels/1055863853633785857/1181252381816655952",children:"Discord"})})]})})]})]})}function h(e={}){const{wrapper:t}={...(0,d.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}}}]); \ No newline at end of file diff --git a/assets/js/32595feb.9df10cb7.js b/assets/js/32595feb.9df10cb7.js new file mode 100644 index 0000000..ef36dfc --- /dev/null +++ b/assets/js/32595feb.9df10cb7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_agoralabs_sh_avm_web_provider=self.webpackChunk_agoralabs_sh_avm_web_provider||[]).push([[38],{7236:function(e,n,s){s.r(n),s.d(n,{assets:function(){return v},contentTitle:function(){return l},default:function(){return u},frontMatter:function(){return c},metadata:function(){return d},toc:function(){return p}});var r=s(4848),i=s(8453),t=s(1470),a=s(9365),o=s(4252);const c={},l="Discover Providers",d={id:"usage/clients/discover-providers",title:"Discover Providers",description:" {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n host: 'https://awesome-wallet.com',\n name: 'Awesome Wallet',\n networks: [\n {\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n methods: [\n 'disable',\n 'enable',\n 'post_transactions',\n 'sign_and_post_transactions',\n 'sign_transactions',\n ],\n },\n {\n genesisHash: 'IXnoWtviVVJW5LGivNFc0Dq14V3kqaXuK2u5OQrdVZo=',\n genesisId: 'voitest-v1',\n methods: [\n 'disable',\n 'enable',\n 'post_transactions',\n 'sign_and_post_transactions',\n 'sign_transactions',\n ],\n },\n ],\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n }\n */\n});\n\n// send a discover request\nclient.discover();\n"})})}),(0,r.jsx)(a.A,{value:"typescript",children:(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"import { IAVMWebClientCallbackOptions } from '@agoralabs-sh/avm-web-provider';\n\n// initialized client\nclient.onDiscover(({ error, result }: IAVMWebClientCallbackOptions) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n host: 'https://awesome-wallet.com',\n name: 'Awesome Wallet',\n networks: [\n {\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n methods: [\n 'disable',\n 'enable',\n 'post_transactions',\n 'sign_and_post_transactions',\n 'sign_transactions',\n ],\n },\n {\n genesisHash: 'IXnoWtviVVJW5LGivNFc0Dq14V3kqaXuK2u5OQrdVZo=',\n genesisId: 'voitest-v1',\n methods: [\n 'disable',\n 'enable',\n 'post_transactions',\n 'sign_and_post_transactions',\n 'sign_transactions',\n ],\n },\n ],\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n }\n */\n});\n\n// send a discover request\nclient.discover();\n"})})})]}),"\n",(0,r.jsx)(n.h2,{id:"discovering-a-specific-provider",children:"Discovering a specific provider"}),"\n",(0,r.jsx)(n.p,{children:"If you know the ID of the provider, you can request only a response from that provider."}),"\n",(0,r.jsx)(n.p,{children:"As before, let's first add a listener and then broadcast, but this time we will specify the provider ID:"}),"\n",(0,r.jsxs)(t.A,{defaultValue:"javascript",values:[{label:"Javascript",value:"javascript"},{label:"TypeScript",value:"typescript"}],children:[(0,r.jsx)(a.A,{value:"javascript",children:(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-js",children:"const providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';\n\n// initialized client\nclient.onDiscover(({ error, result }) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n host: 'https://awesome-wallet.com',\n name: 'Awesome Wallet',\n networks: [\n {\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n methods: [\n 'disable',\n 'enable',\n 'post_transactions',\n 'sign_and_post_transactions',\n 'sign_transactions',\n ],\n },\n {\n genesisHash: 'IXnoWtviVVJW5LGivNFc0Dq14V3kqaXuK2u5OQrdVZo=',\n genesisId: 'voitest-v1',\n methods: [\n 'disable',\n 'enable',\n 'post_transactions',\n 'sign_and_post_transactions',\n 'sign_transactions',\n ],\n },\n ],\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n }\n */\n});\n\n// send a discover request\nclient.discover({ providerId });\n"})})}),(0,r.jsx)(a.A,{value:"typescript",children:(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"import { IAVMWebClientCallbackOptions } from '@agoralabs-sh/avm-web-provider';\n\nconst providerId: string = '02657eaf-be17-4efc-b0a4-19d654b2448e';\n\n// initialized client\nclient.onDiscover(({ error, result }: IAVMWebClientCallbackOptions) => {\n if (error) {\n console.error('error:', error);\n\n return;\n }\n\n console.log(result);\n /*\n {\n host: 'https://awesome-wallet.com',\n name: 'Awesome Wallet',\n networks: [\n {\n genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',\n genesisId: 'testnet-v1.0',\n methods: [\n 'disable',\n 'enable',\n 'post_transactions',\n 'sign_and_post_transactions',\n 'sign_transactions',\n ],\n },\n {\n genesisHash: 'IXnoWtviVVJW5LGivNFc0Dq14V3kqaXuK2u5OQrdVZo=',\n genesisId: 'voitest-v1',\n methods: [\n 'disable',\n 'enable',\n 'post_transactions',\n 'sign_and_post_transactions',\n 'sign_transactions',\n ],\n },\n ],\n providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',\n }\n */\n});\n\n// send a discover request\nclient.discover({ providerId });\n"})})})]})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}}}]); \ No newline at end of file diff --git a/assets/js/3833126f.0eba1aeb.js b/assets/js/3833126f.0eba1aeb.js new file mode 100644 index 0000000..d848cfd --- /dev/null +++ b/assets/js/3833126f.0eba1aeb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_agoralabs_sh_avm_web_provider=self.webpackChunk_agoralabs_sh_avm_web_provider||[]).push([[2693],{8514:function(e,a,n){n.r(a),n.d(a,{assets:function(){return p},contentTitle:function(){return d},default:function(){return g},frontMatter:function(){return c},metadata:function(){return o},toc:function(){return h}});var i=n(4848),r=n(8453),t=n(1470),s=n(9365),l=n(4252);const c={},d="Getting Started",o={id:"clients/getting-started",title:"Getting Started",description:"\n ...\n - + +Clients | AVM Web Provider + + -

Clients

+
diff --git a/clients/disabling-a-client.html b/clients/disabling-a-client.html index 776dff7..67e59f2 100644 --- a/clients/disabling-a-client.html +++ b/clients/disabling-a-client.html @@ -2,13 +2,13 @@ - -Disabling A Client | AVM Web Provider - - + +Disabling A Client | AVM Web Provider + + -

Disabling A Client

+

Disabling A Client

Overview​

The disable method is not required for providers to implement. However, it is useful for providers that have a sessioning system in place when a client has previously called enable().

@@ -23,9 +23,9 @@

caution

If the network and the provider ID is specified, and the provider does not support the network, then a NetworkNotSupportedError should be thrown.

Disabling a client for a specific session​

If you want to remove a specific session, you can provide the session ID(s) in the params:

-
// initialized client
client.onDisable(({ error, result }) => {
  if (error) {
    console.error('error:', error);

    return;
  }

  console.log(result);
  /*
  {
    genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',
    genesisId: 'testnet-v1.0',
    providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',
    sessionIds: ['ab192498-0c63-4028-80fd-f148710611d8'],
  }
  */
});

// send a disable request
client.disable({
  sessionIds: ['ab192498-0c63-4028-80fd-f148710611d8'],
});
diff --git a/clients/discover-providers.html b/clients/discover-providers.html index 2bf3016..1142b3b 100644 --- a/clients/discover-providers.html +++ b/clients/discover-providers.html @@ -2,13 +2,13 @@ - -Discover Providers | AVM Web Provider - - + +Discover Providers | AVM Web Provider + + -
Skip to main content

Discover Providers

+

Discover Providers

Overview​

Before we can start interacting with a provider, we first need to find out what providers are available and what AVM networks & methods these providers support.

@@ -18,9 +18,9 @@

Di

Discovering a specific provider​

If you know the ID of the provider, you can request only a response from that provider.

As before, let's first add a listener and then broadcast, but this time we will specify the provider ID:

-
const providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';

// initialized client
client.onDiscover(({ error, result }) => {
  if (error) {
    console.error('error:', error);

    return;
  }

  console.log(result);
  /*
  {
    host: 'https://awesome-wallet.com',
    name: 'Awesome Wallet',
    networks: [
      {
        genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',
        genesisId: 'testnet-v1.0',
        methods: [
          'disable',
          'enable',
          'post_transactions',
          'sign_and_post_transactions',
          'sign_transactions',
        ],
      },
      {
        genesisHash: 'IXnoWtviVVJW5LGivNFc0Dq14V3kqaXuK2u5OQrdVZo=',
        genesisId: 'voitest-v1',
        methods: [
          'disable',
          'enable',
          'post_transactions',
          'sign_and_post_transactions',
          'sign_transactions',
        ],
      },
    ],
    providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',
  }
  */
});

// send a discover request
client.discover({ providerId });
Docs
More
+
const providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';

// initialized client
client.onDiscover(({ error, result }) => {
  if (error) {
    console.error('error:', error);

    return;
  }

  console.log(result);
  /*
  {
    host: 'https://awesome-wallet.com',
    name: 'Awesome Wallet',
    networks: [
      {
        genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',
        genesisId: 'testnet-v1.0',
        methods: [
          'disable',
          'enable',
          'post_transactions',
          'sign_and_post_transactions',
          'sign_transactions',
        ],
      },
      {
        genesisHash: 'IXnoWtviVVJW5LGivNFc0Dq14V3kqaXuK2u5OQrdVZo=',
        genesisId: 'voitest-v1',
        methods: [
          'disable',
          'enable',
          'post_transactions',
          'sign_and_post_transactions',
          'sign_transactions',
        ],
      },
    ],
    providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',
  }
  */
});

// send a discover request
client.discover({ providerId });
diff --git a/clients/enabling-a-client.html b/clients/enabling-a-client.html index b4cd2d9..4e35786 100644 --- a/clients/enabling-a-client.html +++ b/clients/enabling-a-client.html @@ -2,13 +2,13 @@ - -Enabling A Client | AVM Web Provider - - + +Enabling A Client | AVM Web Provider + + -
Skip to main content

Enabling A Client

+

Enabling A Client

Overview​

Before we can start interacting with a provider, we need ask the provider to enable the client. This will achieve two things:

@@ -28,9 +28,9 @@

Enabling a client on a specific network​

If you want to target a specific network, and any providers support it, you can simply pass the genesis hash of the network in the params:

const genesisHash = 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=';

// initialized client
client.onEnable(({ error, result }) => {
  if (error) {
    console.error('error:', error);

    return;
  }

  console.log(result);
  /*
  {
    accounts: [
      {
        address: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',
        name: 'Wallet-1',
      },
      {
        address: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',
        name: 'Wallet-2',
      },
    ],
    genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',
    genesisId: 'testnet-v1.0',
    providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',
    sessionId: 'ab192498-0c63-4028-80fd-f148710611d8',
  }
  */
});

// send a enable request
client.enable({ genesisHash });
-
caution

If the network and the provider ID is specified, and the provider does not support the network, then a NetworkNotSupportedError should be thrown.

diff --git a/clients/getting-started.html b/clients/getting-started.html index de272ed..81e0870 100644 --- a/clients/getting-started.html +++ b/clients/getting-started.html @@ -2,13 +2,13 @@ - -Getting Started | AVM Web Provider - - + +Getting Started | AVM Web Provider + + -
Skip to main content

Getting Started

+

Getting Started

Installation​

Using a package manager​

@@ -20,9 +20,9 @@

Download

Initialization​

Firstly, we want to initialize the AVM web client:

const { AVMWebClient } = require('@agoralabs-sh/avm-web-provider');

const client = AVMWebClient.init();
-
note

See IAVMWebClientInitOptions for more information on what options are supported.

diff --git a/clients/posting-transactions.html b/clients/posting-transactions.html index ea77905..da07242 100644 --- a/clients/posting-transactions.html +++ b/clients/posting-transactions.html @@ -2,13 +2,13 @@ - -Posting Transactions | AVM Web Provider - - + +Posting Transactions | AVM Web Provider + + -
Skip to main content

Posting Transactions

+

Posting Transactions

Overview​

Providers, if supported, can commit transactions to the network using their connection to a node.

@@ -16,9 +16,9 @@

note

Posting transactions requires the ID of the provider.

// initialized client
client.onPostTransactions(({ error, result }) => {
  if (error) {
    console.error('error:', error);

    return;
  }

  console.log(result);
  /*
  {
    providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',
    txnIDs: [
      'OKU6A2Q...',
    ],
  }
  */
});

// send a post transactions request
client.postTransactions({
  providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',
  stxns: [
    'gqNzaWfEQ...',
  ],
});
caution

If this method is not supported, then a MethodNotSupportedError should be thrown.

-
caution

If the transactions fail to be accepted by the network, then a FailedToPostSomeTransactionsError should be thrown.

diff --git a/clients/signing-a-message.html b/clients/signing-a-message.html index df1ca74..81aa5c4 100644 --- a/clients/signing-a-message.html +++ b/clients/signing-a-message.html @@ -2,22 +2,22 @@ - -Signing A Message | AVM Web Provider - - + +Signing A Message | AVM Web Provider + + -
Skip to main content

Signing A Message

+

Signing A Message

Overview​

Providers, if supported, can sign an arbitrary UTF-8 string.

Signing a message​

// initialized client
client.onSignMessage(({ error, result }) => {
  if (error) {
    console.error('error:', error);

    return;
  }

  console.log(result);
  /*
  {
    providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',
    signature: 'gqNzaWfEQ...',
    signer: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',
  }
  */
});

// send a sign message request
client.signMessage({
  message: 'Hello humie!',
  providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',
  signer: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',
});
caution

If this method is not supported, then a MethodNotSupportedError will be sent in the error parameter.

-
caution

If the signer is not known, or not authorized, then a UnauthorizedSignerError will be sent in the error parameter.

diff --git a/clients/signing-and-posting-transactions.html b/clients/signing-and-posting-transactions.html index e5ddb89..c4712bd 100644 --- a/clients/signing-and-posting-transactions.html +++ b/clients/signing-and-posting-transactions.html @@ -2,13 +2,13 @@ - -Signing And Posting Transactions | AVM Web Provider - - + +Signing And Posting Transactions | AVM Web Provider + + -
Skip to main content

Signing And Posting Transactions

+

Signing And Posting Transactions

Overview​

Providers may have the functionality to both sign & post transactions. This method allows clients to avoid using the previous methods of signing transactions and posting transactions separately and simply performs the functionality of these previous methods within one method.

@@ -18,9 +18,9 @@

caution

If this method is not supported, then a MethodNotSupportedError should be thrown.

caution

If there is a group of atomic transactions, but the computed group ID is invalid, then a InvalidGroupIdError should be thrown.

caution

If any of the transactions are malformed, then a InvalidInputError should be thrown.

-
caution

If the transactions fail to be accepted by the network, then a FailedToPostSomeTransactionsError should be thrown.

diff --git a/clients/signing-transactions.html b/clients/signing-transactions.html index c6c11df..21ac33b 100644 --- a/clients/signing-transactions.html +++ b/clients/signing-transactions.html @@ -2,13 +2,13 @@ - -Signing Transactions | AVM Web Provider - - + +Signing Transactions | AVM Web Provider + + -
Skip to main content

Signing Transactions

+

Signing Transactions

Overview​

Providers, if supported, can sign single, atomic or multiple transactions. If the provider also supports it, the provider can also sign transactions using multisigs and re-keyed accounts.

@@ -40,9 +40,9 @@

caution

The provider may not support re-keyed accounts, in which case a MethodNotSupportedError will be thrown.

const algosdk = require('algosdk');

try {
  const client = new algosdk.Algodv2(
    'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',
    'http://localhost',
    '4001',
  );
  const encoder = new TextEncoder();
  const suggestedParams = await client.getTransactionParams().do();
  const transaction = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
    amount: algosdk.algosToMicroalgos(1),
    from: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',
    note: encoder.encode('Hello Human!'),
    suggestedParams,
    to: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',
  });
  const transactionBytes = transaction.toByte();
} catch (error) {
  // handle error
}

// initialized client
client.onSignTransactions(({ error, result }) => {
  if (error) {
    console.error('error:', error);

    return;
  }

  console.log(result);
  /*
  {
    providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',
    stxns: [
      'gqNzaWfEQ...',
    ],
  }
  */
});

// send a sign transactions request
client.signTransactions({
  providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',
  txns: [
    {
      authAddr: 'S6V2ITXD3Q4MYATTN5IH75E3KS3WEMB36SVG2LXCQ3XESSH2DYOC3DAXYU', // 'auth-addr' of the re-keyed from account
      txn: btoa(String.fromCodePoint(...transactionBytes)), // convert to base64 string
    },
  ],
});
-
caution

If the supplied authAddr is not an authorized signer, then a UnauthorizedSignerError will be thrown.

diff --git a/index.html b/index.html index 516b193..c65f40a 100644 --- a/index.html +++ b/index.html @@ -2,14 +2,13 @@ - -Overview | AVM Web Provider - - + +Overview | AVM Web Provider + + -
Skip to main content

Overview

- +

Overview

Introduction​

@@ -25,9 +24,9 @@

How it worksSince the client code and provider code aren’t guaranteed to run in a particular order, the events are designed to handle such race conditions.

Both clients and providers use the window.dispatchEvent function to emit events, and use the window.addEventListener function to observe events.

note

Browser extension providers MUST take advantage of the content scripts that will allow the provider access to the window object.

-

The AVM Web Provider leverages the EventTarget API as a transport layer to deliver messages and allows clients and web-based providers to securely communicate without interfering with other providers.

diff --git a/providers.html b/providers.html index 2a5a1d4..ec6e7b9 100644 --- a/providers.html +++ b/providers.html @@ -2,13 +2,13 @@ - -Providers | AVM Web Provider - - + +Providers | AVM Web Provider + + -
Skip to main content

Providers

+
diff --git a/providers/getting-started.html b/providers/getting-started.html index 47aacd9..32cb780 100644 --- a/providers/getting-started.html +++ b/providers/getting-started.html @@ -2,13 +2,13 @@ - -Getting Started | AVM Web Provider - - + +Getting Started | AVM Web Provider + + -
Skip to main content

Getting Started

+

Getting Started

Installation​

Using a package manager​

@@ -21,9 +21,9 @@

Initializatio

Firstly, we want to initialize the AVM web provider with an ID:

const { AVMWebProvider } = require('@agoralabs-sh/avm-web-provider');

const provider = AVMWebProvider.init('02657eaf-be17-4efc-b0a4-19d654b2448e');
note

The provider ID is what will identify your provider with clients. It is recommended that you use a UUIDv4 compliant string.

-
note

See IAVMWebProviderInitOptions for more information on what options are supported.

diff --git a/providers/responding-to-disable-requests.html b/providers/responding-to-disable-requests.html index 3d9d025..6a18dee 100644 --- a/providers/responding-to-disable-requests.html +++ b/providers/responding-to-disable-requests.html @@ -2,31 +2,31 @@ - -Responding To Disable Requests | AVM Web Provider - - + +Responding To Disable Requests | AVM Web Provider + + -
Skip to main content

Responding To Disable Requests

-
+

Responding To Disable Requests

+

Overview​

Providers that implement a session for a client, a disable request can be called by a client that instructs the provider to remove the client's session.

-

Responding to an anonymous request​

-

For clients that have not specified a provider, it means the client would like to disable with all providers. Once our provider object has been initialized, we can simply listen to events and respond:

-
// initialized provider
provider.onDisable(({ params }) => {
  if (!params || !params.providerId) {
    // ... remove all sessions

    return {
      genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',
      genesisId: 'testnet-v1.0',
      providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',
    };
  }
});
+

Responding to a disable request​

+

Once our provider object has been initialized, we can simply listen to events and respond:

+
// initialized provider
provider.onDisable(() => {
  // ... remove all sessions

  return {
    genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',
    genesisId: 'testnet-v1.0',
    providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',
  };
});
note

If no network or session IDs have been specified, you can assume all sessions for this client should be removed.

caution

If this method is not supported, then a MethodNotSupportedError should be thrown.

-

Responding to a specific provider and network request​

-

The disable request allows the client to specify the provider and the network. This is denoted in the supplied params.providerId and params.genesisHash parameters. Providers with the matching ID should respond:

-
const { ARC0027NetworkNotSupportedError } = require('@agoralabs-sh/avm-web-provider');

const genesisHash = 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=';
const providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';

// initialized provider
provider.onDisable(({ params }) => {
  if (!params || params.providerId === providerId) {
    // if the genesis hash has been defined, it is recommended that you throw and error
    if (param.genesisHash && param.genesisHash !== genesisHash) {
      throw new ARC0027NetworkNotSupportedError({
        genesisHashes: [param.genesisHash],
        providerId,
      });
    }

    // ... remove all sessions for the network

    return {
      genesisHash,
      genesisId: 'testnet-v1.0',
      providerId,
    };
  }
});
-
caution

If the network and the provider ID is specified, and the provider does not support the network, then a NetworkNotSupportedError should be thrown.

+

Responding to a disable request with a specific network​

+

The disable request allows the client to specify the network. This is denoted in the supplied params.genesisHash parameter.

+
const { ARC0027NetworkNotSupportedError } = require('@agoralabs-sh/avm-web-provider');

const genesisHash = 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=';
const providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';

// initialized provider
provider.onDisable(({ params }) => {
  // if the genesis hash has been defined, it is recommended that you throw and error
  if (param.genesisHash && param.genesisHash !== genesisHash) {
    throw new ARC0027NetworkNotSupportedError({
      genesisHashes: [param.genesisHash],
      providerId,
    });
  }

  // ... remove all sessions for the network

  return {
    genesisHash,
    genesisId: 'testnet-v1.0',
    providerId,
  };
});
+
caution

If the network is specified, and the provider does not support the network, then a NetworkNotSupportedError should be thrown.

Responding to specific session IDs​

A requesting client can specify the particular session. This can be used instead of specifying the network, or if the provider supports multiple sessions.

-
const providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';
const sessionId = '2802dff6-930e-4f79-8f67-ba9d41e88cf8';

// initialized provider
provider.onDisable(({ params }) => {
  if (params && params.sessionIds.indexOf(sessionId) >= 0) {
    // ... remove sessions specified in the session ids list

    return {
      genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',
      genesisId: 'testnet-v1.0',
      providerId,
      sessionIds: [sessionId],
    };
  }
});
-
note

It is recommended that when removing specific session IDs, only return the removed session IDs in the result.

Docs
More
+
const providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';
const sessionId = '2802dff6-930e-4f79-8f67-ba9d41e88cf8';

// initialized provider
provider.onDisable(({ params }) => {
  if (params && params.sessionIds.indexOf(sessionId) >= 0) {
    // ... remove sessions specified in the session ids list

    return {
      genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',
      genesisId: 'testnet-v1.0',
      providerId,
      sessionIds: [sessionId],
    };
  }
});
+
note

It is recommended that when removing specific session IDs, only return the removed session IDs in the result.

diff --git a/providers/responding-to-discover-requests.html b/providers/responding-to-discover-requests.html index 4264988..c8193bf 100644 --- a/providers/responding-to-discover-requests.html +++ b/providers/responding-to-discover-requests.html @@ -2,24 +2,21 @@ - -Responding To Discover Requests | AVM Web Provider - - + +Responding To Discover Requests | AVM Web Provider + + -
Skip to main content

Responding To Discover Requests

-
+

Responding To Discover Requests

+

Overview​

It is likely that clients will want to find out the capabilities of your provider before they start interacting with it. Therefore, it is good practice to handle discover request from clients, responding with your provider's supported networks & methods.

-

Responding to an anonymous request​

-

For clients that have not specified a provider, it means the client would like to know all available providers. Once our provider object has been initialized, we can simply listen to events and respond:

-
// initialized provider
provider.onDiscover(({ params }) => {
  if (!params || !params.providerId) {
    return {
      host: 'https://awesome-wallet.com',
      name: 'Awesome Wallet',
      networks: [
        {
          genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',
          genesisId: 'testnet-v1.0',
          methods: [
            'disable',
            'enable',
            'post_transactions',
            'sign_and_post_transactions',
            'sign_transactions',
          ],
        },
        {
          genesisHash: 'IXnoWtviVVJW5LGivNFc0Dq14V3kqaXuK2u5OQrdVZo=',
          genesisId: 'voitest-v1',
          methods: [
            'disable',
            'enable',
            'post_transactions',
            'sign_and_post_transactions',
            'sign_transactions',
          ],
        },
      ],
      providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',
    };
  }
});
-

Responding to a specific provider request​

-

The discover request allow the client to specify the provider. This is denoted in the supplied params.providerId parameter. Providers with the matching ID should respond:

-
const providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';

// initialized provider
provider.onDiscover(({ params }) => {
  if (!params || params.providerId === providerId) {
    return {
      host: 'https://awesome-wallet.com',
      name: 'Awesome Wallet',
      networks: [
        {
          genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',
          genesisId: 'testnet-v1.0',
          methods: [
            'disable',
            'enable',
            'post_transactions',
            'sign_and_post_transactions',
            'sign_transactions',
          ],
        },
        {
          genesisHash: 'IXnoWtviVVJW5LGivNFc0Dq14V3kqaXuK2u5OQrdVZo=',
          genesisId: 'voitest-v1',
          methods: [
            'disable',
            'enable',
            'post_transactions',
            'sign_and_post_transactions',
            'sign_transactions',
          ],
        },
      ],
      providerId,
    };
  }
});
Docs
More
+

Responding to a discover request​

+

Once our provider object has been initialized, we can simply listen to events and respond:

+
// initialized provider
provider.onDiscover(({ params }) => {
  return {
    host: 'https://awesome-wallet.com',
    name: 'Awesome Wallet',
    networks: [
      {
        genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',
        genesisId: 'testnet-v1.0',
        methods: [
          'disable',
          'enable',
          'post_transactions',
          'sign_and_post_transactions',
          'sign_transactions',
        ],
      },
      {
        genesisHash: 'IXnoWtviVVJW5LGivNFc0Dq14V3kqaXuK2u5OQrdVZo=',
        genesisId: 'voitest-v1',
        methods: [
          'disable',
          'enable',
          'post_transactions',
          'sign_and_post_transactions',
          'sign_transactions',
        ],
      },
    ],
    providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',
  };
});
diff --git a/providers/responding-to-enable-requests.html b/providers/responding-to-enable-requests.html index 71d63c7..0854e44 100644 --- a/providers/responding-to-enable-requests.html +++ b/providers/responding-to-enable-requests.html @@ -2,25 +2,26 @@ - -Responding To Enable Requests | AVM Web Provider - - + +Responding To Enable Requests | AVM Web Provider + + -
Skip to main content

Responding To Enable Requests

-
+

Responding To Enable Requests

+

Overview​

The main purpose of an enable request to is for clients to get a list of authorized accounts. However, it can be used to handle sessioning. While it is not enforced through this SDK, it is heavily recommended.

-

Responding to an anonymous request​

-

For clients that have not specified a provider, it means the client would like to enable with all providers. Once our provider object has been initialized, we can simply listen to events and respond:

-
// initialized provider
provider.onEnable(({ params }) => {
  if (!params || !params.providerId) {
    return {
      accounts: [
        {
          address: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',
          name: 'Wallet-1',
        },
        {
          address: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',
          name: 'Wallet-2',
        },
      ],
      genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',
      genesisId: 'testnet-v1.0',
      providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',
    };
  }
});
+

Responding to an enable request​

+

Once our provider object has been initialized, we can simply listen to events and respond:

+
// initialized provider
provider.onEnable(({ params }) => {
  return {
    accounts: [
      {
        address: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',
        name: 'Wallet-1',
      },
      {
        address: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',
        name: 'Wallet-2',
      },
    ],
    genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',
    genesisId: 'testnet-v1.0',
    providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',
  };
});
caution

If this method is not supported, then a MethodNotSupportedError should be thrown.

-

Responding to a specific provider request​

-

The enable request allows the client to specify the provider. This is denoted in the supplied params.providerId parameter. Providers with the matching ID should respond:

-
const providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';

// initialized provider
provider.onEnable(({ params }) => {
  if (!params || params.providerId === providerId) {
    return {
      accounts: [
        {
          address: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',
          name: 'Wallet-1',
        },
        {
          address: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',
          name: 'Wallet-2',
        },
      ],
      genesisHash: 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=',
      genesisId: 'testnet-v1.0',
      providerId,
    };
  }
});
Docs
More
+

Responding to an enable request with a specific network​

+

The enable request allows the client to specify the network. This is denoted in the supplied params.genesisHash parameter.

+
const { ARC0027NetworkNotSupportedError } = require('@agoralabs-sh/avm-web-provider');

const genesisHash = 'SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=';
const providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';

// initialized provider
provider.onEnable(({ params }) => {
  // if the genesis hash has been defined, it is recommended that you throw and error
  if (param.genesisHash && param.genesisHash !== genesisHash) {
    throw new ARC0027NetworkNotSupportedError({
      genesisHashes: [param.genesisHash],
      providerId,
    });
  }

  return {
    accounts: [
      {
        address: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',
        name: 'Wallet-1',
      },
      {
        address: '6GT6EXFDAHZDZYUOPT725ZRWYBZDCEGYT7SYYXGJKRFUAG5B7JMI7DQRNQ',
        name: 'Wallet-2',
      },
    ],
    genesisHash,
    genesisId: 'testnet-v1.0',
    providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',
  };
});
+
caution

If the network is specified, and the provider does not support the network, then a NetworkNotSupportedError should be thrown.

diff --git a/providers/responding-to-post-transactions-requests.html b/providers/responding-to-post-transactions-requests.html index 4b6ef0f..c00191a 100644 --- a/providers/responding-to-post-transactions-requests.html +++ b/providers/responding-to-post-transactions-requests.html @@ -2,25 +2,25 @@ - -Responding To Post Transactions Requests | AVM Web Provider - - + +Responding To Post Transactions Requests | AVM Web Provider + + -
Skip to main content

Responding To Post Transactions Requests

+

Responding To Post Transactions Requests

Overview​

As a provider usually has access to the network, the post_transactions method allows clients to rely on the provider to send transactions to the network.

Responding to a post transactions request​

Once our provider object has been initialized, we can simply listen to events and respond:

-
const providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';

// initialized provider
provider.onPostTransactions(({ params }) => {
  if (params.providerId === providerId) {
    // ... using the `params.stxns` parameter, the provider posts the transactions to the network and returns the transaction ids

    return {
      providerId,
      txnIDs: [
        'OKU6A2Q...',
      ],
    };
  }
});
+
const providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';

// initialized provider
provider.onPostTransactions(({ params }) => {
  // ... using the `params.stxns` parameter, the provider posts the transactions to the network and returns the transaction ids

  return {
    providerId,
    txnIDs: [
      'OKU6A2Q...',
    ],
  };
});
caution

If this method is not supported, then a MethodNotSupportedError should be thrown.

caution

If there is a group of atomic transactions, but the computed group ID doesn't match the assigned ID, then a InvalidGroupIdError should be thrown.

caution

If any of the transactions are malformed, then a InvalidInputError should be thrown.

-
caution

If the transactions fail to be accepted by the network, then a FailedToPostSomeTransactionsError should be thrown.

diff --git a/providers/responding-to-sign-and-post-transactions-requests.html b/providers/responding-to-sign-and-post-transactions-requests.html index f0456e6..5a296eb 100644 --- a/providers/responding-to-sign-and-post-transactions-requests.html +++ b/providers/responding-to-sign-and-post-transactions-requests.html @@ -2,25 +2,25 @@ - -Responding To Sign And Post Transactions Requests | AVM Web Provider - - + +Responding To Sign And Post Transactions Requests | AVM Web Provider + + -
Skip to main content

Responding To Sign And Post Transactions Requests

+

Responding To Sign And Post Transactions Requests

Overview​

If your provider is able to both sign and post transactions, this method can simply be implemented to allow clients to perform both these methods within one method.

Responding to a sign and post transactions request​

Once our provider object has been initialized, we can simply listen to events and respond:

-
const providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';

// initialized provider
provider.onSignAndPostTransactions(({ params }) => {
  if (params.providerId === providerId) {
    // ... using the `params.txns` parameter, the provider signs and posts the transactions to the network and returns the transaction ids

    return {
      providerId,
      txnIDs: [
        'OKU6A2Q...',
      ],
    };
  }
});
+
const providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';

// initialized provider
provider.onSignAndPostTransactions(({ params }) => {
  // ... using the `params.txns` parameter, the provider signs and posts the transactions to the network and returns the transaction ids

  return {
    providerId,
    txnIDs: [
      'OKU6A2Q...',
    ],
  };
});
caution

If this method is not supported, then a MethodNotSupportedError should be thrown.

caution

If there is a group of atomic transactions, but the computed group ID doesn't match the assigned ID, then a InvalidGroupIdError should be thrown.

caution

If any of the transactions are malformed, then a InvalidInputError should be thrown.

-
caution

If the transactions fail to be accepted by the network, then a FailedToPostSomeTransactionsError should be thrown.

diff --git a/providers/responding-to-sign-message-requests.html b/providers/responding-to-sign-message-requests.html index 7b7fcdb..03b5181 100644 --- a/providers/responding-to-sign-message-requests.html +++ b/providers/responding-to-sign-message-requests.html @@ -2,21 +2,21 @@ - -Responding To Sign Message Requests | AVM Web Provider - - + +Responding To Sign Message Requests | AVM Web Provider + + -
Skip to main content

Responding To Sign Message Requests

+

Responding To Sign Message Requests

Responding to a sign message request​

Once our provider object has been initialized, we can simply listen to events and respond:

-
const providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';

// initialized provider
provider.onSignMessage(({ params }) => {
  if (params.providerId === providerId) {
    // ... using the `params.message` and the `params.signer` parameters, the provider signs the message with the private key of the signer and, with the signature, encodes as a base64 string

    return {
      providerId,
      signature:  'gqNzaWfEQ...', // base64 encoded signature
      signer: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',
    };
  }
});
+
const providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';

// initialized provider
provider.onSignMessage(({ params }) => {
  // ... using the `params.message` and the `params.signer` parameters, the provider signs the message with the private key of the signer and, with the signature, encodes as a base64 string

  return {
    providerId,
    signature:  'gqNzaWfEQ...', // base64 encoded signature
    signer: 'P3AIQVDJ2CTH54KSJE63YWB7IZGS4W4JGC53I6GK72BGZ5BXO2B2PS4M4U',
  };
});
caution

If this method is not supported, then a MethodNotSupportedError should be thrown.

-
caution

If the signer, supplied in the params, is not known, or not authorized, a UnauthorizedSignerError should be thrown.

diff --git a/providers/responding-to-sign-transactions-requests.html b/providers/responding-to-sign-transactions-requests.html index ca317ef..1483115 100644 --- a/providers/responding-to-sign-transactions-requests.html +++ b/providers/responding-to-sign-transactions-requests.html @@ -2,22 +2,22 @@ - -Responding To Sign Transactions Requests | AVM Web Provider - - + +Responding To Sign Transactions Requests | AVM Web Provider + + -
Skip to main content

Responding To Sign Transactions Requests

+

Responding To Sign Transactions Requests

Responding to a sign transactions request​

Once our provider object has been initialized, we can simply listen to events and respond:

-
const providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';

// initialized provider
provider.onSignTransactions(({ params }) => {
  if (params.providerId === providerId) {
    // ... using the `params.txns` parameter, the provider signs the transactions and returns the base64 encoded signed transactions

    return {
      providerId,
      stxns: [
        'gqNzaWfEQ...',
      ],
    };
  }
});
+
const providerId = '02657eaf-be17-4efc-b0a4-19d654b2448e';

// initialized provider
provider.onSignTransactions(({ params }) => {
  // ... using the `params.txns` parameter, the provider signs the transactions and returns the base64 encoded signed transactions

  return {
    providerId,
    stxns: [
      'gqNzaWfEQ...',
    ],
  };
});
caution

If this method is not supported, then a MethodNotSupportedError should be thrown.

caution

If there is a group of atomic transactions, but the computed group ID doesn't match the assigned ID, then a InvalidGroupIdError should be thrown.

-
caution

If any of the transactions are malformed, then a InvalidInputError should be thrown.

diff --git a/providers/throwing-an-error.html b/providers/throwing-an-error.html index d8d0c82..ceb7035 100644 --- a/providers/throwing-an-error.html +++ b/providers/throwing-an-error.html @@ -2,21 +2,21 @@ - -Throwing An Error | AVM Web Provider - - + +Throwing An Error | AVM Web Provider + + -
Skip to main content

Throwing An Error

+

Throwing An Error

Overview​

When receiving a request from the client, you can throw errors within the listener function and these errors will propagate back to the client's listener arguments.

Throwing an error​

// AVMWebClient
client.onDisable(({ error, result }) => {
  if (error) {
    console.error(error);
    /*
    {
      code: 4003,
      data: {
        method: 'disable',
      },
      message: 'disable method is not supported',
      name: 'MethodNotSupportedError',
      providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',
    }
    */

    return;
  }
});

// send a client request
client.disable();

// AVMWebProvider
const { ARC0027MethodSupportedError } = require('@agoralabs-sh/avm-web-provider');

provider.onDisable(({ params }) => {
  throw new ARC0027MethodSupportedError({
    method: 'disable',
    message: 'disable method is not supported',
    providerId: '02657eaf-be17-4efc-b0a4-19d654b2448e',
  });
});
-
note

The SDK provides several common errors, see errors.

diff --git a/sitemap.xml b/sitemap.xml index 8ea652a..c1affb4 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1 +1 @@ -https://avm-web-provider.agoralabs.sh/api-referenceweekly0.5https://avm-web-provider.agoralabs.sh/api-reference/avm-web-clientweekly0.5https://avm-web-provider.agoralabs.sh/api-reference/avm-web-providerweekly0.5https://avm-web-provider.agoralabs.sh/api-reference/errorsweekly0.5https://avm-web-provider.agoralabs.sh/api-reference/typesweekly0.5https://avm-web-provider.agoralabs.sh/clientsweekly0.5https://avm-web-provider.agoralabs.sh/clients/disabling-a-clientweekly0.5https://avm-web-provider.agoralabs.sh/clients/discover-providersweekly0.5https://avm-web-provider.agoralabs.sh/clients/enabling-a-clientweekly0.5https://avm-web-provider.agoralabs.sh/clients/getting-startedweekly0.5https://avm-web-provider.agoralabs.sh/clients/posting-transactionsweekly0.5https://avm-web-provider.agoralabs.sh/clients/signing-a-messageweekly0.5https://avm-web-provider.agoralabs.sh/clients/signing-and-posting-transactionsweekly0.5https://avm-web-provider.agoralabs.sh/clients/signing-transactionsweekly0.5https://avm-web-provider.agoralabs.sh/providersweekly0.5https://avm-web-provider.agoralabs.sh/providers/getting-startedweekly0.5https://avm-web-provider.agoralabs.sh/providers/responding-to-disable-requestsweekly0.5https://avm-web-provider.agoralabs.sh/providers/responding-to-discover-requestsweekly0.5https://avm-web-provider.agoralabs.sh/providers/responding-to-enable-requestsweekly0.5https://avm-web-provider.agoralabs.sh/providers/responding-to-post-transactions-requestsweekly0.5https://avm-web-provider.agoralabs.sh/providers/responding-to-sign-and-post-transactions-requestsweekly0.5https://avm-web-provider.agoralabs.sh/providers/responding-to-sign-message-requestsweekly0.5https://avm-web-provider.agoralabs.sh/providers/responding-to-sign-transactions-requestsweekly0.5https://avm-web-provider.agoralabs.sh/providers/throwing-an-errorweekly0.5https://avm-web-provider.agoralabs.sh/supported-walletsweekly0.5https://avm-web-provider.agoralabs.sh/terminologyweekly0.5https://avm-web-provider.agoralabs.sh/weekly0.5 \ No newline at end of file +https://avm-web-provider.agoralabs.sh/api-referenceweekly0.5https://avm-web-provider.agoralabs.sh/api-reference/avm-web-clientweekly0.5https://avm-web-provider.agoralabs.sh/api-reference/avm-web-providerweekly0.5https://avm-web-provider.agoralabs.sh/api-reference/errorsweekly0.5https://avm-web-provider.agoralabs.sh/api-reference/typesweekly0.5https://avm-web-provider.agoralabs.sh/clientsweekly0.5https://avm-web-provider.agoralabs.sh/clients/disabling-a-clientweekly0.5https://avm-web-provider.agoralabs.sh/clients/discover-providersweekly0.5https://avm-web-provider.agoralabs.sh/clients/enabling-a-clientweekly0.5https://avm-web-provider.agoralabs.sh/clients/getting-startedweekly0.5https://avm-web-provider.agoralabs.sh/clients/posting-transactionsweekly0.5https://avm-web-provider.agoralabs.sh/clients/signing-a-messageweekly0.5https://avm-web-provider.agoralabs.sh/clients/signing-and-posting-transactionsweekly0.5https://avm-web-provider.agoralabs.sh/clients/signing-transactionsweekly0.5https://avm-web-provider.agoralabs.sh/providersweekly0.5https://avm-web-provider.agoralabs.sh/providers/getting-startedweekly0.5https://avm-web-provider.agoralabs.sh/providers/responding-to-disable-requestsweekly0.5https://avm-web-provider.agoralabs.sh/providers/responding-to-discover-requestsweekly0.5https://avm-web-provider.agoralabs.sh/providers/responding-to-enable-requestsweekly0.5https://avm-web-provider.agoralabs.sh/providers/responding-to-post-transactions-requestsweekly0.5https://avm-web-provider.agoralabs.sh/providers/responding-to-sign-and-post-transactions-requestsweekly0.5https://avm-web-provider.agoralabs.sh/providers/responding-to-sign-message-requestsweekly0.5https://avm-web-provider.agoralabs.sh/providers/responding-to-sign-transactions-requestsweekly0.5https://avm-web-provider.agoralabs.sh/providers/throwing-an-errorweekly0.5https://avm-web-provider.agoralabs.sh/supported-walletsweekly0.5https://avm-web-provider.agoralabs.sh/terminologyweekly0.5https://avm-web-provider.agoralabs.sh/usageweekly0.5https://avm-web-provider.agoralabs.sh/usage/clientsweekly0.5https://avm-web-provider.agoralabs.sh/usage/clients/disabling-a-clientweekly0.5https://avm-web-provider.agoralabs.sh/usage/clients/discover-providersweekly0.5https://avm-web-provider.agoralabs.sh/usage/clients/enabling-a-clientweekly0.5https://avm-web-provider.agoralabs.sh/usage/clients/getting-startedweekly0.5https://avm-web-provider.agoralabs.sh/usage/clients/posting-transactionsweekly0.5https://avm-web-provider.agoralabs.sh/usage/clients/signing-a-messageweekly0.5https://avm-web-provider.agoralabs.sh/usage/clients/signing-and-posting-transactionsweekly0.5https://avm-web-provider.agoralabs.sh/usage/clients/signing-transactionsweekly0.5https://avm-web-provider.agoralabs.sh/usage/providersweekly0.5https://avm-web-provider.agoralabs.sh/usage/providers/getting-startedweekly0.5https://avm-web-provider.agoralabs.sh/usage/providers/responding-to-disable-requestsweekly0.5https://avm-web-provider.agoralabs.sh/usage/providers/responding-to-discover-requestsweekly0.5https://avm-web-provider.agoralabs.sh/usage/providers/responding-to-enable-requestsweekly0.5https://avm-web-provider.agoralabs.sh/usage/providers/responding-to-post-transactions-requestsweekly0.5https://avm-web-provider.agoralabs.sh/usage/providers/responding-to-sign-and-post-transactions-requestsweekly0.5https://avm-web-provider.agoralabs.sh/usage/providers/responding-to-sign-message-requestsweekly0.5https://avm-web-provider.agoralabs.sh/usage/providers/responding-to-sign-transactions-requestsweekly0.5https://avm-web-provider.agoralabs.sh/usage/providers/throwing-an-errorweekly0.5https://avm-web-provider.agoralabs.sh/weekly0.5 \ No newline at end of file diff --git a/supported-wallets.html b/supported-wallets.html index e9c7128..986de7c 100644 --- a/supported-wallets.html +++ b/supported-wallets.html @@ -2,16 +2,16 @@ - -Supported Wallets | AVM Web Provider - - + +Supported Wallets | AVM Web Provider + + -
Skip to main content