A TypeScript implementation that allows clients to connect and interact with web-based providers.
### Table of contents * [1. Overview](#-1-overview) * [2. Documentation](#-2-documentation) * [3. Development](#-3-development) * [3.1. Requirements](#31-requirements) * [3.2. Setup](#32-setup) * [3.3. Build](#33-build) * [4. Appendix](#-4-appendix) * [4.1. Useful Commands](#41-useful-commands) * [5. How To Contribute](#-5-how-to-contribute) * [6. License](#-6-license) ## 🔭 1. Overview The AVM Web Provider is an interface that bridges the gap between clients (e.g. dApps) and providers (e.g. wallets), allowing clients to connect and interact with providers in a standardized way. Both clients and providers use the [`window.dispatchEvent`][dispatch-event] function to emit events, and use the [`window.addEventListener`][add-event-listener] function to observe events. The message schema is based on the [ARC-0027][arc-0027] standard. ## 📚 2. Documentation For full documentation, please see [here][documentation]. [Back to top ^][table-of-contents] ## 🛠 3. Development ### 3.1. Requirements * Install [Node v20.9.0+][node] * Install [Yarn v1.22.5+][yarn] [Back to top ^][table-of-contents] ### 3.2. Setup 1. Install the dependencies: ```bash $ yarn install ``` [Back to top ^][table-of-contents] ### 3.3. Build * To build simply run: ```bash $ yarn build ``` This will compile the Typescript source code into a `dist/` directory. [Back to top ^][table-of-contents] ## 📑 4. Appendix ### 4.1. Useful Commands | Command | Description | |-----------------------|------------------------------------------------------------------------------------| | `yarn build` | Builds the source code into the `dist/` directory. | | `yarn run docs:build` | Builds the documentation into the `.docusaurus/` directory. | | `yarn run docs:serve` | Serves the built documentation from the `.docusaurus/` directory. | | `yarn run docs:start` | Builds and runs the documentation in a development environment with hot reloading. | | `yarn run lint` | Runs the linter on `.js` and `.ts` files. | | `yarn run prettier` | Runs the prettier on `.js` and `.ts` files. | | `yarn test` | Runs the tests. | | `yarn types:check` | Performs a type check on the `src/` directory. | [Back to top ^][table-of-contents] ## 👏 5. How To Contribute Please read the [**Contributing Guide**][contribute] to learn about the development process. [Back to top ^][table-of-contents] ## 📄 6. License Please refer to the [LICENSE][license] file. [Back to top ^][table-of-contents] [add-event-listener]: https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener [arc-0027]: https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0027.md [dispatch-event]: https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/dispatchEvent [event-target]: https://developer.mozilla.org/en-US/docs/Web/API/EventTarget [contribute]: ./CONTRIBUTING.md [documentation]: https://avm-web-provider.agoralabs.sh [license]: ./LICENSE [node]: https://nodejs.org/en/ [table-of-contents]: #table-of-contents [yarn]: https://yarnpkg.com/