A TypeScript implementation that allows clients to connect and interact with web-based providers.

• 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

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.

For full documentation, please see here.

^{Back to top ^}

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

^{Back to top ^}

1. Install the dependencies:

$ yarn install

^{Back to top ^}

• To build simply run:

$ yarn build

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

^{Back to top ^}

^{Back to top ^}

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

^{Back to top ^}

Please refer to the LICENSE file.

^{Back to top ^}