@agoralabs-sh/avm-web-provider v1.6.1
Table of contents
🔭 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.
🛠 3. Development
3.1. Requirements
- Install Node v20.9.0+
- Install Yarn v1.22.5+
3.2. Setup
- Install the dependencies:
$ yarn install
3.3. Build
- To build simply run:
$ yarn build
This will compile the Typescript source code into a dist/
directory.
📑 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. |
👏 5. How To Contribute
Please read the Contributing Guide to learn about the development process.
📄 6. License
Please refer to the LICENSE file.
6 days ago
6 days ago
9 days ago
9 days ago
10 days ago
10 days ago
11 days ago
12 days ago
12 days ago
14 days ago
13 days ago
14 days ago
23 days ago
23 days ago
23 days ago
23 days ago
25 days ago
25 days ago
25 days ago
27 days ago
26 days ago
27 days ago
28 days ago