Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "index"

Index

Functions

Functions

Const Export assignment Venus

  • Venus(provider?: Provider | string, options?: CompoundOptions): CompoundInstance
  • Creates an instance of the Venus.js SDK.

    example
    var venus = new Venus(window.ethereum); // web browser
    
    var venus = new Venus('http://127.0.0.1:8545'); // HTTP provider
    
    var venus = new Venus(); // Uses Ethers.js fallback mainnet (for testing only)
    
    var venus = new Venus('testnet'); // Uses Ethers.js fallback (for testing only)
    
    // Init with private key (server side)
    var venus = new Venus('https://mainnet.infura.io/v3/_your_project_id_', {
      privateKey: '0x_your_private_key_', // preferably with environment variable
    });
    
    // Init with HD mnemonic (server side)
    var venus = new Venus('mainnet' {
      mnemonic: 'clutch captain shoe...', // preferably with environment variable
    });

    Parameters

    • Default value provider: Provider | string = "mainnet"
    • Default value options: CompoundOptions = {}

    Returns CompoundInstance

    Returns an instance of the Venus.js SDK.