Code Monkey home page Code Monkey logo

legacy-web3's Introduction

@metamask/legacy-web3

MetaMask's legacy window.web3.

Motivation

MetaMask strongly recommends that you read our migration guide before using this package. You should only rely on this package if you need a temporary fix or are no longer actively developing your web3 site.

In the near future, MetaMask will stop injecting window.web3 into web pages. When we do this, if your website relies on MetaMask's window.web3 to function, it will break on that date unless you take action. Please refer to the original announcement if you want to know why we're doing this.

If you do not wish to take either of the recommended migration paths, we provide this library as a drop-in replacement for our injected window.web3. Simply add it to your site using one of the methods outlined below, and your Ethereum functionality will continue to work after we stop injecting window.web3.

You can add this package before we stop injecting window.web3, without disrupting the Ethereum functionality of your website.

Disclaimer

This package is designed to emulate the functionality of our injected window.web3. That said, we do not guarantee complete functional parity, and you may have to fix some bugs yourself. We also make no guarantees about future maintenance of this package, and it is unlikely to support any new features added to the MetaMask provider API.

Usage

As a <script> in your web page:

<html>
  <head>
    <!-- The legacy-web3 script must run BEFORE your other scripts. -->
    <script src="https://unpkg.com/@metamask/legacy-web3@latest/dist/metamask.web3.min.js"></script>
    <!-- Or: -->
    <script src="https://unpkg.com/@metamask/legacy-web3@latest/dist/metamask.web3.js"></script>
    ...
  </head>
  <body>
    ...
  </body>
</html>

Or add as a Node dependency:

yarn add @metamask/legacy-web3

# or

npm install @metamask/legacy-web3
import '@metamask/legacy-web3'

// or

require('@metamask/legacy-web3')

const { web3 } = window
const selectedAddress = web3.eth.defaultAccount

Initialization Criteria

This package will only initialize window.web3 under the following circumstances:

  • It detects an existing window.ethereum
  • It does not detect an existing window.web3

window.ethereum.isMetaMask can be true or falsy. If it is falsy and there is no existing window.web3, this package will initialize its window.web3, but there are no guarantees that it will work with non-MetaMask providers.

legacy-web3's People

Contributors

rekmarks avatar whymarrh avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.