Skip to content

Latest commit

 

History

History
171 lines (121 loc) · 7.6 KB

README.md

File metadata and controls

171 lines (121 loc) · 7.6 KB
Raw

ElvenJS

One static file to rule it all on the MultiversX blockchain!

Note

Version 1.0 is in progress, with a reimagined API and compact core - building a powerful base for future tools.
Follow us on x.com to stay up to date!

Docs

Videos

Demos

Authenticate, sign and send transactions on the MultiversX blockchain in the browser. No need for bundlers, frameworks, etc. Just attach the script source, and you are ready to go. You can incorporate it into your preferred CMS framework like WordPress or an e-commerce system. Plus, it will also work on a standard static HTML website.

The primary purpose of this tool is to have a lite script for browser usage where you can authenticate and sign/send transactions on the MultiversX blockchain and do this without any additional build steps.

The purpose is to simplify the usage for primary use cases and open the doors for many frontend tools and approaches.

It is a script for browsers incorporates ES6 modules. If you need fully functional JavaScript/Typescript SDK (also in Nodejs), please use sdk-js, an official Typescript MultiversX SDK. And if you are React developer, please check the Nextjs dapp.

You can use it already, but it is under active development, and the API might change, there could be breaking changes without changing major versions.

How to use it

Copy and include the elven.js script from the build directory or the best would be to use CDN (https://unpkg.com/elven.js/build/elven.js). Please don't link the script using the demo domain.

Use module type, like:

<script type="module">
  import {
    ElvenJS,
    Transaction,
    Address,
    TransactionPayload,
    TokenTransfer,
    ContractFunction,
    U32Value,
  } from './elven.js';

  // Your code here
</script>

or from CDN:

<script type="module">
  import {
    ElvenJS,
    Transaction,
    Address,
    TransactionPayload,
    TokenTransfer,
    ContractFunction,
    U32Value,
  } from 'https://unpkg.com/elven.js@<actual_version_here>/build/elven.js';

  // Your code here
</script>

SDK reference

Please check the docs here: www.elvenjs.com/docs/sdk-reference.html

Recipes

Please check how to use it with a couple of recipes here: www.elvenjs.com/docs/recipes.html

Check for more complete examples in the example/index.html

Usage example with static website (base demo):

Check out the example file: example/index.html

You will find the whole demo there. The same is deployed here: elvenjs.netlify.app

Usage in frontend frameworks

Elven.js can also be used in many different frameworks by importing it from node_modules (of course, it is a client-side library). When it comes to React/Nextjs, it is advised to use one of the ready templates, for example, the one mentioned above. But Elven.js can be helpful in other frameworks where there are no templates yet. Example:

npm install elven.js

and then in your client side framework:

import { ElvenJS } from 'elven.js';

The types should also be exported.

What can it do?

The API is limited for now, this will change, but even now, it can do most of the core operations:

  • authenticate using the xPortal mobile, MultiversX browser extension, MultiversX Web Wallet and xAlias
  • integrate with xPortal Hub
  • handle expiration of the auth state
  • handle login with tokens to be able to get the signature
  • sign transactions
  • send transactions (also custom smart contracts)
  • sign custom messages
  • basic global states handling (local storage)
  • basic structures for transaction payload
  • sync the network on page load
  • querying the smart contracts (without tools for result parsing yet)
  • support for guarded transactions using MultiversX 2FA solutions

What will it do soon? (TODO):

  • authenticate with Ledger Nano
  • result parsing (separate library)
  • more advanced global state handling and (real-time updates (if needed)?)
  • more structures and simplification for payload builders
  • split it into more files/libraries
  • make it as small as possible

What it won't probably do:

  • crypto tasks
  • results parsing (but it will land in a separate package)

Why? Because it is supposed to be a browser script, it should be as small as possible. All that functionality can be replaced if needed by a custom implementation or other libraries. There will be docs with examples for that. And in the future, there may be more similar libraries, but optional and separated.

Development

  1. clone the repo
  2. npm install dependencies
  3. npm run build
  4. test on example -> npm run dev:server
  5. rebuild with every change in the script

To test the MultiversX browser extension you would need to run localhost with SSL. For quick dev testing tools like localhost.run should be enough. After you run npm run dev:server, in separate teriminal window run ssh -R 80:localhost:3000 localhost.run. You can also relay on your own SSL setup.

Articles

TODO

Other tools

If you need to use MultiversX SDK with React-based projects, you can try these tools:

If you are interested in creating and managing your own PFP NFT collection, you might be interested in:

  • Elven Tools - What is included: NFT minter smart contract (decentralized way of minting), minter Nextjs dapp (interaction on the frontend side), CLI tool (deploy, configuration, interaction)
  • nft-art-maker - tool for creating png assets from provided layers. It can also pack files and upload them to IPFS using nft.storage. All CIDs will be auto-updated

Other tools:

  • Buildo Begins - all MultiversX blockchain CLI interactions with sdk-js, still in progress, but usable
  • Buildo.dev - Buildo.dev is a MultiversX app that helps with blockchain interactions, like issuing tokens and querying smart contracts.