WebMavryk is a fork of Taquito originally developed by ECAD Labs Inc. This fork is maintained by Mavryk Dynamics and includes modifications made in 2025.
- License: Apache-2.0. See
LICENSEandNOTICEfor details and attributions. - Trademarks: This project does not imply any endorsement by, or affiliation with, ECAD Labs Inc. Names and logos remain the property of their respective owners.
Welcome, Web3 developer!
Webmavryk is a fast and lightweight TypeScript library to accelerate DApp development on the Mavryk blockchain. With it, you can easily interact with Smart Contracts deployed to Mavryk. It is distributed as a suite of individual npm packages, to reduce bloat and improve application startup times.
Webmavryk is primarily targeted at Front-End Web3 developers, so it comes with batteries included, such as a React Template Project, an extensible framework, and many helpful utilities. It can be used in many execution contexts, including Serverless, Node.js, Deno, and Electron (to name a few) and has minimal dependencies.
Webmavryk is used by over 80% of DApps in the Mavryk ecosystem. It is easy to use, proven secure and tested continuously against current versions of Mavryk (both Mainnet and Testnets).
Webmavryk provides convenient abstractions for a multitude of common operations, including wallet interactions (with WalletConnect2 in the works), batching operations, calling into contracts, querying the blockchain, and more. Webmavryk will isolate your code from subtle - and some not-so-subtle - changes made to the underlying Mavryk protocol.
...Not to mention our thriving, helpful, and welcoming community!
To get started with Webmavryk quickly, visit the Webmavryk QuickStart.
If you prefer to start with a skeleton project, check out our Webmavryk React Template.
Do you wish to make a contribution to Webmavryk? See below, Contributing to Webmavryk.
Webmavryk currently supports the following versions of Node.js®:
| Version | Supported? |
|---|---|
| v12 LTS | ❌ |
| v14 LTS | ❌ |
| v16 LTS/Gallium | ❌ |
| v18 LTS/Hydrogen | ✅ |
| v20 LTS/Iron | ✅ |
While other versions often work, the above are what we officially support. YMMV!
We are active and enthusiastic participants of the following community support channels:
- [ECAD Labs Discord Channel][discord]
- [Mavryk StackExchange][stackexchange]
Webmavryk is organized as a monorepo, and is composed of several npm packages that are published to npmjs.org under the @mavrykdynamics handle. Each package has its own README which can be found in the corresponding directory within packages/.
| High-Level Packages | Responsibility |
|---|---|
| @mavrykdynamics/webmavryk | Facade to lower-level, package-specific functionality |
| Low-Level Packages | Responsibility |
|---|---|
| @mavrykdynamics/webmavryk-local-forging | Local "forging": serialization of Mavryk operations as bytes |
| @mavrykdynamics/webmavryk-michelson-encoder | Creates JS abstractions of Smart Contracts |
| @mavrykdynamics/webmavryk-michel-codec | Converts Michelson between forms, expands Macros, etc |
| @mavrykdynamics/webmavryk-remote-signer | Provides the facility to use a remote signer, such as https://signatory.io |
| @mavrykdynamics/webmavryk-rpc | RPC client library: every rpc endpoint has its own method |
| @mavrykdynamics/webmavryk-signer | Provides functionality to sign data using mavryk keys |
| @mavrykdynamics/webmavryk-utils | Provides different encoding and decoding utilities |
| @mavrykdynamics/webmavryk-tzip12 | TZIP-12 allows retrieving NFT/token metadata |
| @mavrykdynamics/webmavryk-tzip16 | TZIP-16 allows retrieving contract metadata and executing off-chain views |
| @mavrykdynamics/webmavryk-mavlet-wallet | TZIP-10 implementation of a Wallet API |
| @mavrykdynamics/webmavryk-http-utils | Provides functionality to configure and customize http requests |
| @mavrykdynamics/webmavryk-core | Provides parent and core types, classes, and interfaces for other Webmavryk packages or external uses |
| @mavrykdynamics/webmavryk-sapling | Provides functionality to prepare and read sapling transactions |
| @mavrykdynamics/webmavryk-contracts-library | Provides functionality specify static data related to contracts |
| @mavrykdynamics/webmavryk-ledger-signer | Provides functionality for ledger signer provider |
| @mavrykdynamics/webmavryk-timelock | Provides functionality to create and open timelocks |
TypeDoc API documentation for Webmavryk is available here.
Supported versions of Webmavryk packages are maintained for the current and next (beta) protocol versions.
Webmavryk uses Semantic Versioning, (or, "SemVer") but with a small twist: the Major version number that we use tracks the latest version of Mavryk (the Minor and Patch numbers do however follow SemVer norms).
For example, in a past release the protocol was at 004-..., and 005-... was being promoted through the on-chain amendment process (a feature unique to Mavryk). So at that time, the current version for Webmavryk was v4.0.0, and work commenced on version v5.0.0-beta.1.
When it becomes clear that the next protocol proposal will be promoted, AND we have implemented and tested interoperability with the new protocol, we release the next version (v5.0.0-beta.1 in this example) BEFORE the chain transitions to the new protocol.
It is essential for updated packages to be released before the protocol changes, so that Webmavryk developers have time to update and test their projects.
During "Major" version updates, the Webmavryk public APIs MAY include breaking changes; we endeavor to make this clear, and document it in our release notes.
Note that all previous releases are backwards compatible with chain data, all the way back to the genesis protocol. Support for older Mavryk node RPCs is maintained where feasible, but are eventually dropped.
We encourage you to update older versions of Webmavryk, and you are encouraged to contact us with any technical issues that preclude doing so.
Releases are pushed to npmjs.org and the Github releases page. The maintainers sign all official releases.
Releases (git tags and npm packages) are signed either by keybase/jevonearth or keybase/simrob. Releases that are not signed, or signed by other keys, should be brought to our attention immediately please.
You would like to make a contribution to Webmavryk? Wonderful! Please read on.
It is important to perform the following in the stated order
- Install
libudev-dev, if developing on GNU/Linux:- For Ubuntu and other Debian-based distros:
sudo apt-get install libudev-dev - For Fedora and other Redhat-based distros:
sudo dnf install libudev-devel
- For Ubuntu and other Debian-based distros:
This package contains low-level files required to compile against libudev-*.
-
Install/use a suitable version of Node.js (as listed above), for example:
nvm use lts/gallium -
Install
lernaglobally (used by our blazingly-fast nx-based build system):npm install --global lerna
Now that your prerequisites have been installed, run the following commands:
npm clean-install
...
npm run build
...If all goes well, the last step is to run the unit tests, which should all pass:
npm run test- Do not delete
node_modules/manually, as this will confuse the build system
The webmavryk build system is based on nx, which uses caching extensively; please use npm run clean instead.
- Do not use
npm install, as it will unnecessarily updatepackage.json
The npm clean-install command (or just npm ci) produces a stable installation of all dependencies and respects package-lock.json. This will ensure a deterministic and repeatable build. It is also some 2x to 10x faster than npm install: hooray!
See the top-level package.json "scripts" section. Common targets include:
npm run clean: Recursively delete all build artifactsnpm run test: Run the unit testsnpm run build: Generate bundles, typings, and create TypeDocs for all packagesnpm run lint: Run the code linter (eslint)npm run example: Run an example Node.js app that demonstrates all functionality
The Webmavryk integration tests are located in the integration-tests/ directory. Please see the README.md in that directory for further information.
After making your changes to Webmavryk, lint and run the unit test suite; this will let you know if your changes are working well with the rest of the project:
npm run lint
npm run test
npm run commitPlease use npm run commit for your last commit before you push, as this will automagically formulate the correct commit format. A final lint and test cycle will take place before the commit is performed.
You may wish to contribute to the live code examples, this explains how to do that. Note that the Mavryk Webmavryk website is built using Docusaurus.
To run the Webmavryk website in development mode locally, run the following commands from top-level:
- Run
npm clean-install - Run
npm -w @mavrykdynamics/webmavryk-website start
To report a security issue, please contact security@ecadlabs.com or via keybase/jevonearth on keybase.io. You can also encrypt your bug report using the keybase/jevonearth key.
Please use our GitHub Issue Tracker to report bugs or request new features.
To contribute, please check the issue tracker to see if an existing issue exists for your planned contribution. If there's no issue, please create one first and then submit a pull request with your contribution.
For a contribution to be merged, it is required to have complete documentation, unit tests, and integration tests as appropriate. Submitting a "work in progress" pull request for review/feedback is always welcome!
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT OR FITNESS FOR A PARTICULAR PURPOSE ARE ENTIRELY DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS OR ANY AFFILIATED PARTIES OR ENTITIES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. PERSONS USING THIS SOFTWARE DO SO ENTIRELY AT THEIR OWN RISK.
Special thanks to these libraries, which have been excellent references for developing Webmavryk