{"_id":"svelte-ethers-store","_rev":"49-4a2f57bbdd3344ae82c7515754825fe5","name":"svelte-ethers-store","dist-tags":{"latest":"2.6.1","next":"1.0.0-1"},"versions":{"0.0.2":{"name":"svelte-ethers-store","version":"0.0.2","description":"Ethers.js library as a collection of stores for Svelte, Sapper or SvelteKit.","main":"dist/index.js","module":"dist/index.mjs","svelte":"src/stores.js","license":"MIT","repository":{"type":"git","url":"git+https://gitlab.com/clb1/svelte-ethers-store.git"},"author":{"name":"Christophe Le Bars","email":" {\n // add a test to return in SSR context\n defaultEvmStores.setProvider()\n }\n )\n```\n\n`svelte-ethers-store` will automatically update the stores when the network or\naccounts change and remove listeners at disconnection.\n\n:exclamation: previous version of `svelte-ethers-store` were using a special\nmethod `setBrowserProvider`. The former naming still works but will be\nremoved in later versions. Please update your code!\n\n\n### Connection with non injected EIP-1193 providers\n\nTo connect to non injected EIP-1193 providers like :\n\n * buidler.dev\n * ethers.js\n * eth-provider\n * WalletConnect\n * Web3Modal\n\nCall `setProvider` on the library abstract helper with the JavaScript provider\ninstance object of the library. For example with Web3Modal :\n\n```js\nconst web3Modal = new Web3Modal()\nconst provider = await web3Modal.connect()\ndefaultEvmStores.setProvider(provider)\n```\n\n`svelte-ethers-store` will automatically update the stores when the network or\naccounts change and remove listeners at disconnection.\n\n\n### Connection with other Ethers.js providers (ws, http, ipc, ...)\n\nYou can instanciate many types of providers using Ethers.js, see the\nrelevant\n[documentation](https://docs.ethers.io/v5/api/providers/other/) and\nsimply pass them as argument to `defaultEvmStores.setProvider()` to inititate the stores:\n\n```js\ndefaultEvmStores.setProvider(new ethers.providers.InfuraProvider())\n// or \ndefaultEvmStores.setProvider(new ethers.providers.EtherscanProvider())\n// or \ndefaultEvmStores.setProvider(new ethers.providers.AlchemyProvider())\n// etc...\n```\n\nAs a shortcut, if you pass an URL string or a valid connection object, a\n[Ethers.js JsonRpcProvider](https://docs.ethers.io/v5/api/providers/jsonrpc-provider/)\nwill be automatically instantiated.\n\nFor provider that support the function `getSigner()`, a Signer Object will be automatically\nassociated with the `signer` store. You can also pass `addressOrIndex` as the second argument\nof `setProvider()` to select another account than the default when possible.\n\n```js\ndefaultEvmStores.setProvider(, )\n```\n\n### Using the stores\n\nAfter a connection has been established, you may import the stores\nanywhere in your application. Most of the time, you should use the `$`\nprefix Svelte notation to access the stores values.\n\n\n```html\n\n\n{#if !$connected}\n\n

My application is not yet connected

\n\n{:else}\n\n

Connected to chain (id {$chainId}) with account ($signerAddress)

\n\n{/if}\n```\n\n### Using the Ethers.js Providers and Signers API\n\nLikewise use the `$` prefix Svelte notation to access Provider or Signer\nread-only abstractions and use the whole Ethers.js API. (beware, in the Ethers \nlibrary documentation, Provider or Signer instances are always noted as `provider`\n and `signer`, without `$`, but in the context of `svelte-ethers-store`, this naming\nis used by the Svelte stores themselves encapsulating Provider or Signer instances).\n\n```js\n import { connected, provider, signer } from 'svelte-ethers-store'\n\n // ...\n\n const { name, chainId } = await $provider.getNetwork()\n\n const balance = await $signer.getBalance()\n \n $signer.sendTransaction({, , });\n\n```\n\nFor providers that don't support `getSigner`, the value `$signer` will be `null`.\n\n\n### Using the contracts store for reactive contract calls\n\nTo enjoy the same reactivity as using `$provider` and `$signer` but\nwith a contract instance, you first need to declare its address and\ninterface. To differenciate each `ethers.Contract` instance, you also\nneed to define a logical name. That's the function `attachContract`:\n\n\n```html\n\n```\n\n`attachContract` only needs to be called once and can be called before\nconnection since `ethers.Contract` instances will only be created when\na connection becomes available. You may want to reattach new contract\ndefinition or abi for example when you the current network change. For\nthe old definition will be overwritten and instance updated in the\n`contracts` store, simply use the same logical name.\n\nAfter a contract as be declared, you can use its instance anywhere\nusing the `$` notation and the logical name :\n\n```html\n\n\n\n {#await $contracts.myContract.totalSupply()}\n\n waiting...\n\n {:then value}\n\n result of contract call totalSupply on my contract : { value } \n\n {/await}\n\n```\n\nBy default, `svelte-ethers-store` build contract instances using the signer if\navailable and if not the provider. You may want to force using the current provider\nby passing `false` as fourth argument.\n\n```html\n defaultEvmStores.attachContract('myContract',
, , )\n```\n\n### Reading stores outside of Svelte files\n\nThe `$` prefix Svelte notation to access store values is only\navailable inside Svelte files. To directly access the instantiated\nvalues in pure javascript library without subscribing to the store,\nyou can use a special getter on the library abstract helper:\n\n```js\n// this is not a Svelte file but a standard JavaScript file \nimport { defaultEvmStores } from 'svelte-ethers-store'\n\nif (defaultEvmStores.$selectedAccount) {\n\n // do something if store selectedAccount is non null\n\n}\n```\n\n### Forcing a disconnect (and removing all listeners)\n\nSimply call the function `disconnect` directly on the on the library\nabstract helper:\n\n```js\ndefaultEvmStores.disconnect()\n```\n\n## Human readable chain CAIP-2 information\n\n`chainData` is a store returning the current JavaScript [CAIP-2 representation](https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-2.md) object.\n\n### Example\n\nThe information returned by the `chainData` store depends (like all\nother ethers stores) on which chain the current provider is\nconnected. If the store has not yet been connected (with\n`setProvider`), the store value will be `undefined`.\n\nThis object is extremely useful to build components that reactively\nupdate all variables elements that depends on the current active chain\nor account.\n\nBelow is the CAIP-2 formatted information when the default store is \nconnected with the Ethereum Mainnet :\n\n```json\n{\n \"name\": \"Ethereum Mainnet\",\n \"chain\": \"ETH\",\n \"icon\": \"ethereum\",\n \"rpc\": [\n \"https://mainnet.infura.io/v3/${INFURA_API_KEY}\",\n \"https://api.mycryptoapi.com/eth\"\n ],\n \"faucets\": [],\n \"nativeCurrency\": {\n \"name\": \"Ether\",\n \"symbol\": \"ETH\",\n \"decimals\": 18\n },\n \"infoURL\": \"https://ethereum.org\",\n \"shortName\": \"eth\",\n \"chainId\": 1,\n \"networkId\": 1,\n \"slip44\": 60,\n \"ens\": { \"registry\": \"0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e\" },\n \"explorers\": [{\n \"name\": \"etherscan\",\n \"url\": \"https://etherscan.io\",\n \"standard\": \"EIP3091\"\n }]\n}\n```\n\n\nYou might want to access all chains CAIP-2 data directly without using the\n`chainData` store. In this case, use the getter `allChainsData`, it returns\nthe list of all CAIP-2 data available.\n\n```js\nimport { allChainsData } from 'svelte-ethers-store'\n\nconsole.log( allChainsData )\n```\n","readmeFilename":"README.md","gitHead":"b0ee8e23a93c3afa6d5bb5da4c5a8a67b82f56d9","bugs":{"url":"https://gitlab.com/clb1/svelte-ethers-store/issues"},"homepage":"https://gitlab.com/clb1/svelte-ethers-store#readme","_id":"svelte-ethers-store@1.0.0-0","_nodeVersion":"16.13.2","_npmVersion":"8.1.2","dist":{"integrity":"sha512-uri4XjTQ23X4DZkKOMEzzIEcGs7af0d30HNudfILnrwBVLQ3eHTpdrK9uSBniYZnOGgbl4y7Iir2Fy474rSfcw==","shasum":"b2836057c4eb08ea2a11c465e91612a862d12622","tarball":"https://registry.npmjs.org/svelte-ethers-store/-/svelte-ethers-store-1.0.0-0.tgz","fileCount":7,"unpackedSize":454871,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh9S5mCRA9TVsSAnZWagAAaz8QAKHubx94NxSZlywOpyv8\nZEE4ppOMZQrtjD5na0B9w4sIpBWRObQT/q1JUZOxNywKcqAQei5aWlBSDhir\nu9xC+GIjl5Q1nqvrYRHb+2ilhDNN36/IrERbZ9jr51seecAm0CVLzzfwnrXb\nnuli9BsvgNGKCKnZiggP+czBxwuKfrtlLutVq7MumlYHDazZIOsHMmcry73+\n32+wooyvU52ADJH9kPNA4wJtko34kzSAys+BbIaNSAvp3iFR8rf6wvjaDIto\nxKJVyFnI0UjaWN/dEFnz2UZva6e78rVmril0hHOs1oDi4JRHJxFiVnAHyu6E\ndEuTtp5MYMqDm7u2XA0F8IapsdnumhTZ8AyKAsgZ6AQWvS8MqLAEmWQ+ZoSJ\nijjFP4BiUq9Vqzw81xLkeOETNksNTo6tpijxaE1uNVL5reM/TxJZeBwZeJZY\n/+sf1eOaiXoh3pZ49FsHwfujA4TA2Fx6GtnVL7pi69az0GvPGuBxWYDIMAAc\ntxbuR0dHmT/pMUMs2E6SQWON3dqUHwBnv1HlOsLz33wE0nyrCXPtCH/hKBBy\nK82YdaM8e/GUvGmO33zwuqRyXI48fFDvMTaYbMwbedYF9gBmNLUapfrCesvK\nqNk7CQqyMhahB8ULMVzwKmL9WH3ka+eZMz5KFbia9CyqNrB/EU29zxGAMdzD\nWkUC\r\n=SU0m\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCVHhcg3yUNkL7jchixLjmaDcEadaKSxy/SinfgZQts7gIhAIxS8TtwOdfMJAFaLa+yXHXw878d5DqUfUbMoGvBN7nV"}]},"_npmUser":{"name":"clbrge","email":"clb@rouge.network"},"directories":{},"maintainers":[{"name":"clbrge","email":"clb@rouge.network"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/svelte-ethers-store_1.0.0-0_1643458150696_0.512447579098672"},"_hasShrinkwrap":false},"1.0.0-1":{"name":"svelte-ethers-store","version":"1.0.0-1","description":"Ethers.js library as a collection of stores for Svelte, Sapper or SvelteKit.","license":"MIT","repository":{"type":"git","url":"git+https://gitlab.com/clb1/svelte-ethers-store.git"},"main":"dist/index.js","module":"dist/index.mjs","svelte":"src/stores.js","exports":{"./package.json":"./package.json",".":{"main":"./dist/index.js","module":"./dist/index.mjs","svelte":"./src/stores.js"}},"author":{"name":"Christophe Le Bars","email":" {\n // add a test to return in SSR context\n defaultEvmStores.setProvider()\n }\n )\n```\n\n`svelte-ethers-store` will automatically update the stores when the network or\naccounts change and remove listeners at disconnection.\n\n:exclamation: previous version of `svelte-ethers-store` were using a special\nmethod `setBrowserProvider`. The former naming still works but will be\nremoved in later versions. Please update your code!\n\n\n### Connection with non injected EIP-1193 providers\n\nTo connect to non injected EIP-1193 providers like :\n\n * buidler.dev\n * ethers.js\n * eth-provider\n * WalletConnect\n * Web3Modal\n\nCall `setProvider` on the library abstract helper with the JavaScript provider\ninstance object of the library. For example with Web3Modal :\n\n```js\nconst web3Modal = new Web3Modal()\nconst provider = await web3Modal.connect()\ndefaultEvmStores.setProvider(provider)\n```\n\n`svelte-ethers-store` will automatically update the stores when the network or\naccounts change and remove listeners at disconnection.\n\n\n### Connection with other Ethers.js providers (ws, http, ipc, ...)\n\nYou can instanciate many types of providers using Ethers.js, see the\nrelevant\n[documentation](https://docs.ethers.io/v5/api/providers/other/) and\nsimply pass them as argument to `defaultEvmStores.setProvider()` to inititate the stores:\n\n```js\ndefaultEvmStores.setProvider(new ethers.providers.InfuraProvider())\n// or \ndefaultEvmStores.setProvider(new ethers.providers.EtherscanProvider())\n// or \ndefaultEvmStores.setProvider(new ethers.providers.AlchemyProvider())\n// etc...\n```\n\nAs a shortcut, if you pass an URL string or a valid connection object, a\n[Ethers.js JsonRpcProvider](https://docs.ethers.io/v5/api/providers/jsonrpc-provider/)\nwill be automatically instantiated.\n\nFor provider that support the function `getSigner()`, a Signer Object will be automatically\nassociated with the `signer` store. You can also pass `addressOrIndex` as the second argument\nof `setProvider()` to select another account than the default when possible.\n\n```js\ndefaultEvmStores.setProvider(, )\n```\n\n### Using the stores\n\nAfter a connection has been established, you may import the stores\nanywhere in your application. Most of the time, you should use the `$`\nprefix Svelte notation to access the stores values.\n\n\n```html\n\n\n{#if !$connected}\n\n

My application is not yet connected

\n\n{:else}\n\n

Connected to chain (id {$chainId}) with account ($signerAddress)

\n\n{/if}\n```\n\n### Using the Ethers.js Providers and Signers API\n\nLikewise use the `$` prefix Svelte notation to access Provider or Signer\nread-only abstractions and use the whole Ethers.js API. (beware, in the Ethers \nlibrary documentation, Provider or Signer instances are always noted as `provider`\n and `signer`, without `$`, but in the context of `svelte-ethers-store`, this naming\nis used by the Svelte stores themselves encapsulating Provider or Signer instances).\n\n```js\n import { connected, provider, signer } from 'svelte-ethers-store'\n\n // ...\n\n const { name, chainId } = await $provider.getNetwork()\n\n const balance = await $signer.getBalance()\n \n $signer.sendTransaction({, , });\n\n```\n\nFor providers that don't support `getSigner`, the value `$signer` will be `null`.\n\n\n### Using the contracts store for reactive contract calls\n\nTo enjoy the same reactivity as using `$provider` and `$signer` but\nwith a contract instance, you first need to declare its address and\ninterface. To differenciate each `ethers.Contract` instance, you also\nneed to define a logical name. That's the function `attachContract`:\n\n\n```html\n\n```\n\n`attachContract` only needs to be called once and can be called before\nconnection since `ethers.Contract` instances will only be created when\na connection becomes available. You may want to reattach new contract\ndefinition or abi for example when you the current network change. For\nthe old definition will be overwritten and instance updated in the\n`contracts` store, simply use the same logical name.\n\nAfter a contract as be declared, you can use its instance anywhere\nusing the `$` notation and the logical name :\n\n```html\n\n\n\n {#await $contracts.myContract.totalSupply()}\n\n waiting...\n\n {:then value}\n\n result of contract call totalSupply on my contract : { value } \n\n {/await}\n\n```\n\nBy default, `svelte-ethers-store` build contract instances using the signer if\navailable and if not the provider. You may want to force using the current provider\nby passing `false` as fourth argument.\n\n```html\n defaultEvmStores.attachContract('myContract',
, , )\n```\n\n### Reading stores outside of Svelte files\n\nThe `$` prefix Svelte notation to access store values is only\navailable inside Svelte files. To directly access the instantiated\nvalues in pure javascript library without subscribing to the store,\nyou can use a special getter on the library abstract helper:\n\n```js\n// this is not a Svelte file but a standard JavaScript file \nimport { defaultEvmStores } from 'svelte-ethers-store'\n\nif (defaultEvmStores.$selectedAccount) {\n\n // do something if store selectedAccount is non null\n\n}\n```\n\n### Forcing a disconnect (and removing all listeners)\n\nSimply call the function `disconnect` directly on the on the library\nabstract helper:\n\n```js\ndefaultEvmStores.disconnect()\n```\n\n## Human readable chain CAIP-2 information\n\n`chainData` is a store returning the current JavaScript [CAIP-2 representation](https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-2.md) object.\n\n### Example\n\nThe information returned by the `chainData` store depends (like all\nother ethers stores) on which chain the current provider is\nconnected. If the store has not yet been connected (with\n`setProvider`), the store value will be `undefined`.\n\nThis object is extremely useful to build components that reactively\nupdate all variables elements that depends on the current active chain\nor account.\n\nBelow is the CAIP-2 formatted information when the default store is \nconnected with the Ethereum Mainnet :\n\n```json\n{\n \"name\": \"Ethereum Mainnet\",\n \"chain\": \"ETH\",\n \"icon\": \"ethereum\",\n \"rpc\": [\n \"https://mainnet.infura.io/v3/${INFURA_API_KEY}\",\n \"https://api.mycryptoapi.com/eth\"\n ],\n \"faucets\": [],\n \"nativeCurrency\": {\n \"name\": \"Ether\",\n \"symbol\": \"ETH\",\n \"decimals\": 18\n },\n \"infoURL\": \"https://ethereum.org\",\n \"shortName\": \"eth\",\n \"chainId\": 1,\n \"networkId\": 1,\n \"slip44\": 60,\n \"ens\": { \"registry\": \"0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e\" },\n \"explorers\": [{\n \"name\": \"etherscan\",\n \"url\": \"https://etherscan.io\",\n \"standard\": \"EIP3091\"\n }]\n}\n```\n\n\nYou might want to access all chains CAIP-2 data directly without using the\n`chainData` store. In this case, use the getter `allChainsData`, it returns\nthe list of all CAIP-2 data available.\n\n```js\nimport { allChainsData } from 'svelte-ethers-store'\n\nconsole.log( allChainsData )\n```\n","readmeFilename":"README.md","gitHead":"831d7c5d29783413e4b19750d4c95b7044ea4137","bugs":{"url":"https://gitlab.com/clb1/svelte-ethers-store/issues"},"homepage":"https://gitlab.com/clb1/svelte-ethers-store#readme","_id":"svelte-ethers-store@1.0.0-1","_nodeVersion":"16.13.2","_npmVersion":"8.1.2","dist":{"integrity":"sha512-/siiqTeowfM8UTIoQ8Toui3UG1CJwXHnRDS3yRpWTXhmzruj3MyQcTWhEcDThMk4U4HwEibHwiaWGPrymNxDjA==","shasum":"33721a8d034cca796842f01d16c874b02839bfa4","tarball":"https://registry.npmjs.org/svelte-ethers-store/-/svelte-ethers-store-1.0.0-1.tgz","fileCount":7,"unpackedSize":458674,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh9+joCRA9TVsSAnZWagAAuWMQAJDVADyZMq8zItayvGFs\n/M291xKtdylQurHUVm4p573MayAPjEeeAqqPbf534gAQ/I3DZm0MLUpW/WiE\npF1f0f4NKdWVkvvBUUvTjY2QwZNkOjf7Fx6ba9J9b1pJcCFIIkr1CaXkMh8D\nRwot9x7zHA4ztTkI1qDgK1N/sEN0bWQkKujt7ejZfykZ7gERPaRoaHbIMdHk\nqwio46v3FlR8k4s9z5nHADGu2DE76nESh8dMsLdXrzZqO8udQqikG5pQCAVx\n8fLJAHValQsfoahlFU+ebwE93hkcK83Ut85M9tYxC+03SXPzBhdAiozK0b6Y\nCc+tSco8v8hP0tBrJTTHIiW7u73/wN2cPikkdszoUokp+vurMiZiaD627EkK\nKxynwpRBEkZbF8EvVi9MIz+eJajwBh74NRtQslc1PhEyFovvlzZwNTYwNSOR\nVl4nmuGoP2UJyM/d0WeyPsRKbIclgt7mIFdrQrVRZOsjTxBgr+oF+25QGiIB\ne5vqfPwgLfZwCn1DQL1SAF4Er+2lizuzOFpQAl4H1WiB5ysozbUfNLQsiqVq\njHOT9f0XxM3a2lf2Twtra8MSDlyBddiuW986enYMqZAMrTliXSyfLKJ4ozk6\noKNK8AijfMkPenLnUkZ7zYpVs7GdDsx+PSo5/XhDmkVvD9KsdqRJYPshrAjH\n4TVb\r\n=NvOe\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCH0/uJgRjw5IV0rpi6A8D8VVVL5kbbKpYIRKSqPyUsooCIQD4A9HlCHlqtgKgO4DXEcHWb/OtcGq1kmV/N2R/5YuaDQ=="}]},"_npmUser":{"name":"clbrge","email":"clb@rouge.network"},"directories":{},"maintainers":[{"name":"clbrge","email":"clb@rouge.network"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/svelte-ethers-store_1.0.0-1_1643636968701_0.11449040083048456"},"_hasShrinkwrap":false},"1.0.0":{"name":"svelte-ethers-store","version":"1.0.0","description":"Ethers.js library as a collection of stores for Svelte, Sapper or SvelteKit.","license":"MIT","repository":{"type":"git","url":"git+https://gitlab.com/clb1/svelte-ethers-store.git"},"main":"dist/index.js","module":"dist/index.mjs","svelte":"src/stores.js","exports":{"./package.json":"./package.json",".":{"main":"./dist/index.js","module":"./dist/index.mjs","svelte":"./src/stores.js"}},"author":{"name":"Christophe Le Bars","email":"`\nfor Sapper or SvelteKit or without the browser context. Be also careful that you\ncannot use `setProvider` with no argument in SSR context.\n\n```js\nonMount(() => {\n // add a test to return in SSR context\n defaultEvmStores.setProvider()\n})\n```\n\nOut of these restrictions, your app should call `setProvider` depending on the\nUX behavior you want to achieve, the library itself doesn't try to enforce\narbitrary logic for you. You may want to use inside `onMount` when some\nconditions are met to connect automatically. Or you may prefer to call it later\nafter an event (like in the click handler of \"connect\" button).\n\n`svelte-ethers-store` will automatically update the stores when the network or\naccounts change and remove listeners at disconnection.\n\n:exclamation: previous version of `svelte-ethers-store` were using a special\nmethod `setBrowserProvider`. The former naming still works but will be\nremoved in later versions. Please update your code!\n\n### Connection with non injected EIP-1193 providers\n\nTo connect to non injected EIP-1193 providers like :\n\n- buidler.dev\n- ethers.js\n- eth-provider\n- WalletConnect\n- Web3Modal\n\nCall `setProvider` on the library abstract helper with the JavaScript provider\ninstance object of the library. For example with Web3Modal :\n\n```js\nconst web3Modal = new Web3Modal()\nconst provider = await web3Modal.connect()\ndefaultEvmStores.setProvider(provider)\n```\n\n`svelte-ethers-store` will automatically update the stores when the network or\naccounts change and remove listeners at disconnection.\n\n### Connection with other Ethers.js providers (ws, http, ipc, ...)\n\nYou can instanciate many types of providers using Ethers.js, see the\nrelevant\n[documentation](https://docs.ethers.io/v5/api/providers/other/) and\nsimply pass them as argument to `defaultEvmStores.setProvider()` to inititate the stores:\n\n```js\ndefaultEvmStores.setProvider(new ethers.providers.InfuraProvider())\n// or\ndefaultEvmStores.setProvider(new ethers.providers.EtherscanProvider())\n// or\ndefaultEvmStores.setProvider(new ethers.providers.AlchemyProvider())\n// etc...\n```\n\nAs a shortcut, if you pass an URL string or a valid connection object, a\n[Ethers.js JsonRpcProvider](https://docs.ethers.io/v5/api/providers/jsonrpc-provider/)\nwill be automatically instantiated.\n\nFor provider that support the function `getSigner()`, a Signer Object will be automatically\nassociated with the `signer` store. You can also pass `addressOrIndex` as the second argument\nof `setProvider()` to select another account than the default when possible.\n\n```js\ndefaultEvmStores.setProvider(, )\n```\n\nIf you don't need a signer, you might also call `setProvider` with the\nargument `addressOrIndex` as a `null` value and bypass any attempt to\ndetect an account.\n\n### Using the stores\n\nAfter a connection has been established, you may import the stores\nanywhere in your application. Most of the time, you should use the `$`\nprefix Svelte notation to access the stores values.\n\n```html\n\n\n{#if !$connected}\n\n

My application is not yet connected

\n\n{:else}\n\n

Connected to chain (id {$chainId}) with account ($signerAddress)

\n\n{/if}\n```\n\n### Using the Ethers.js Providers and Signers API\n\nLikewise use the `$` prefix Svelte notation to access Provider or Signer\nread-only abstractions and use the whole Ethers.js API. (beware, in the Ethers\nlibrary documentation, Provider or Signer instances are always noted as `provider`\nand `signer`, without `$`, but in the context of `svelte-ethers-store`, this naming\nis used by the Svelte stores themselves encapsulating Provider or Signer instances).\n\n```js\n import { connected, provider, signer } from 'svelte-ethers-store'\n\n // ...\n\n const { name, chainId } = await $provider.getNetwork()\n\n const balance = await $signer.getBalance()\n\n $signer.sendTransaction({, , });\n\n```\n\nFor providers that don't support `getSigner`, the value `$signer` will be `null`.\n\n### Using the contracts store for reactive contract calls\n\nTo enjoy the same reactivity as using `$provider` and `$signer` but\nwith a contract instance, you first need to declare its address and\ninterface. To differenciate each `ethers.Contract` instance, you also\nneed to define a logical name. That's the function `attachContract`:\n\n```html\n\n```\n\n`attachContract` only needs to be called once and can be called before\nconnection since `ethers.Contract` instances will only be created when\na connection becomes available. You may want to reattach new contract\ndefinition or abi for example when you the current network change. For\nthe old definition will be overwritten and instance updated in the\n`contracts` store, simply use the same logical name.\n\nAfter a contract as be declared, you can use its instance anywhere\nusing the `$` notation and the logical name :\n\n```html\n\n\n{#await $contracts.myContract.totalSupply()}\n\nwaiting...\n\n{:then value}\n\nresult of contract call totalSupply on my contract : { value } \n\n{/await}\n```\n\nBy default, `svelte-ethers-store` build contract instances using the signer if\navailable and if not the provider. You may want to force using the current provider\nby passing `false` as fourth argument.\n\n```html\ndefaultEvmStores.attachContract('myContract',\n
\n , , )\n
\n```\n\n### Reading stores outside of Svelte files\n\nThe `$` prefix Svelte notation to access store values is only\navailable inside Svelte files. To directly access the instantiated\nvalues in pure javascript library without subscribing to the store,\nyou can use a special getter on the library abstract helper:\n\n```js\n// this is not a Svelte file but a standard JavaScript file\nimport { defaultEvmStores } from 'svelte-ethers-store'\n\nif (defaultEvmStores.$selectedAccount) {\n // do something if store selectedAccount is non null\n}\n```\n\n### Forcing a disconnect (and removing all listeners)\n\nSimply call the function `disconnect` directly on the on the library\nabstract helper:\n\n```js\ndefaultEvmStores.disconnect()\n```\n\n## Human readable chain CAIP-2 information\n\n`chainData` is a store returning the current JavaScript [CAIP-2 representation](https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-2.md) object.\n\n### Example\n\nThe information returned by the `chainData` store depends (like all\nother ethers stores) on which chain the current provider is\nconnected. If the store has not yet been connected (with\n`setProvider`), the store value will be `undefined`.\n\nThis object is extremely useful to build components that reactively\nupdate all variables elements that depends on the current active chain\nor account.\n\nBelow is the CAIP-2 formatted information when the default store is\nconnected with the Ethereum Mainnet :\n\n```json\n{\n \"name\": \"Ethereum Mainnet\",\n \"chain\": \"ETH\",\n \"icon\": \"ethereum\",\n \"rpc\": [\n \"https://mainnet.infura.io/v3/${INFURA_API_KEY}\",\n \"https://api.mycryptoapi.com/eth\"\n ],\n \"faucets\": [],\n \"nativeCurrency\": {\n \"name\": \"Ether\",\n \"symbol\": \"ETH\",\n \"decimals\": 18\n },\n \"infoURL\": \"https://ethereum.org\",\n \"shortName\": \"eth\",\n \"chainId\": 1,\n \"networkId\": 1,\n \"slip44\": 60,\n \"ens\": { \"registry\": \"0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e\" },\n \"explorers\": [\n {\n \"name\": \"etherscan\",\n \"url\": \"https://etherscan.io\",\n \"standard\": \"EIP3091\"\n }\n ]\n}\n```\n\nYou might want to access all chains CAIP-2 data directly without using the\n`chainData` store. In this case, use the getter `allChainsData`, it returns\nthe list of all CAIP-2 data available.\n\n```js\nimport { allChainsData } from 'svelte-ethers-store'\n\nconsole.log(allChainsData)\n```\n\nAnother solution is to use the helper function `getChainDataByChainId`\nthat takes the chainId as argument and returns\nthe CAIP-2 data or an empty object if not found.\n\n```js\nimport { getChainDataByChainId } from 'svelte-ethers-store'\n\nconsole.log(getChainDataByChainId(5))\n```\n\n## Ethers Svelte components [ experimental ]\n\nWe plan to export generic Svelte low level components both to\ndemonstrate the use of the `svelte-ethers-store` library and as\nresuable and composable best practices components. A `Balance` and\n`Identicon` components have been implemented for now. You are welcome\nto help define and develop new components by joining our discussions\nin our [Discord](https://discord.gg/7yXuwDwaHF).\n\nSee also the `components` route in the example directory.\n\n```html\n import { Balance } from 'svelte-ethers-store/components'\n\n\n

balance =

\n\n```\n\n## FAQ\n\n### _Cannot run using SvelteKit, I get error:_ `Cannot read property 'BN' of undefined`\n\nThe module `ethers` has not been detected by Vite. You need `import ethers` somewhere\nin your app or add `optimizeDeps: { include: [ 'ethers' ] }` in `svelte.config.js`\n\n### _how to auto-connect on page load?_\n\nIt is out of scope of this package to implement this function but it\ngenerally depends on the type of provider you are using and a way to\nstore connection information between page loads (for example by using\nlocalStorage).\n","readmeFilename":"README.md"}