Table of contents

• 1. Overview
• 2. Documentation
• 3. Development
  • 3.1. Requirements
  • 3.2. Setup
  • 3.3. Build
• 4. Appendix
  • 4.1. Useful Commands
• 5. How To Contribute
• 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 function to emit events, and use the window.addEventListener function to observe events.

The message schema is based on the ARC-0027 standard.

📚 2. Documentation

For full documentation, please see here.

Back to top ^

🛠 3. Development

3.1. Requirements

• Install Node v20.9.0+
• Install Yarn v1.22.5+

Back to top ^

3.2. Setup

1. Install the dependencies:

$ yarn install

Back to top ^

3.3. Build

• To build simply run:

$ yarn build

This will compile the Typescript source code into a dist/ directory.

Back to top ^

📑 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 ^

👏 5. How To Contribute

Please read the Contributing Guide to learn about the development process.

Back to top ^

📄 6. License

Please refer to the LICENSE file.

Back to top ^