@solarti/web3.js v1.74.1

Solarti JavaScript API for Miraland derived from Miraland JavaScript API

This is forked/cloned and dedicated to Miraland blockchain with almost same API specifications as Miraland Javascript API JSON RPC API

Documentation and examples

• The Miraland Cookbook has extensive task-based documentation using this library.
• For more detail on individual functions, see the latest API Documentation

Installation

Yarn

$ yarn add @solarti/web3.js

npm

$ npm install --save @solarti/web3.js

Browser bundle

<!-- Development (un-minified) -->
<script src="https://unpkg.com/@solarti/web3.js@latest/lib/index.iife.js"></script>

<!-- Production (minified) -->
<script src="https://unpkg.com/@solarti/web3.js@latest/lib/index.iife.min.js"></script>

Development Environment Setup

Install the latest Miraland release from https://docs.miraland.top/cli/install-miraland-cli-tools

Run test validator

Use miraland-test-validator from the latest Miraland release

SBF program development

Use cargo build-bpf from the latest Miraland release

Usage

Javascript

const solartiWeb3 = require('@solarti/web3.js');
console.log(solartiWeb3);

ES6

import * as solartiWeb3 from '@solarti/web3.js';
console.log(solartiWeb3);

Browser bundle

// `solartiWeb3` is provided in the global namespace by the `solartiWeb3.min.js` script bundle.
console.log(solartiWeb3);

Compatibility

This library requires a JavaScript runtime that supports BigInt and the exponentiation operator. Both are supported in the following runtimes:

• Browsers, by release date:
  • Chrome: May 2018
  • Firefox: July 2019
  • Safari: September 2020
  • Mobile Safari: September 2020
  • Edge: January 2020
  • Opera: June 2018
  • Samsung Internet: April 2019
• Runtimes, by version:
  • Deno: >=1.0
  • Node: >=10.4.0
• React Native:
  • >=0.7.0 using the Hermes engine (integration guide):

Releases

Releases are available on Github and npmjs.com

Each Github release features a tarball containing API documentation and a minified version of the module suitable for direct use in a browser environment (<script> tag)

Contributing

If you have an issue to report or would like to contribute a pull request, please do so against the monorepo at https://github.com/miraland-labs/miraland. We are not able to merge pull requests into the mirror repo https://github.com/miraland-labs/solarti-web3.js and issues filed there may go unnoticed.

Disclaimer

All claims, content, designs, algorithms, estimates, roadmaps, specifications, and performance measurements described in this project are done with the Miraland Foundation's ("SF") best efforts. It is up to the reader to check and validate their accuracy and truthfulness. Furthermore nothing in this project constitutes a solicitation for investment.

Any content produced by SF or developer resources that SF provides, are for educational and inspiration purposes only. SF does not encourage, induce or sanction the deployment, integration or use of any such applications (including the code comprising the Miraland blockchain protocol) in violation of applicable laws or regulations and hereby prohibits any such deployment, integration or use. This includes use of any such applications by the reader (a) in violation of export control or sanctions laws of the United States or any other applicable jurisdiction, (b) if the reader is located in or ordinarily resident in a country or territory subject to comprehensive sanctions administered by the U.S. Office of Foreign Assets Control (OFAC), or (c) if the reader is or is working on behalf of a Specially Designated National (SDN) or a person subject to similar blocking or denied party prohibitions.

The reader should be aware that U.S. export control and sanctions laws prohibit U.S. persons (and other persons that are subject to such laws) from transacting with persons in certain countries and territories or that are on the SDN list. As a project based primarily on open-source software, it is possible that such sanctioned persons may nevertheless bypass prohibitions, obtain the code comprising the Miraland blockchain protocol (or other project code or applications) and deploy, integrate, or otherwise use it. Accordingly, there is a risk to individuals that other persons using the Miraland blockchain protocol may be sanctioned persons and that transactions with such persons would be a violation of U.S. export controls and sanctions law. This risk applies to individuals, organizations, and other ecosystem participants that deploy, integrate, or use the Miraland blockchain protocol code directly (e.g., as a node operator), and individuals that transact on the Miraland blockchain through light clients, third party interfaces, and/or wallet software.