Moralis SDK (JavaScript / TypeScript)

A library that gives you access to the powerful Moralis Server backend from your JavaScript app.

Features:

• Connect to EVM via MetaMask, WalletConnect, MagicLink and many more connectors (or create your own connetor)
• Connect to Moralis via other networks as Solana, Polkadot, Elrond and more
• Authenticate to Moralis via connection methods specified above
• Evm Utilities for transfers, contract interactions and other on-chain methods for the supported networks (and support for other networks as Solana, Polkadot, Elrond and more)
• Interaction with the Moralis server like: database queries, handling user sessions, calling cloud-functions etc.
• Make Evm api and Solana api calls
• Modular package: include only what you need
• Fully Typescript ready out-of-the box

... and much more. Check the official Moralis docs for more details.

If you're new to Moralis, check the quickstart guide in the official docs on how to get started.

If you're already familiar with Moralis and have your server set up. Then follow along to connect your SDK:

The easiest way to integrate the Moralis SDK into your JavaScript project is through the npm module.

Install the package via npm:

npm install moralis

or yarn

yarn add moralis

If you want to use a pre-compiled file from unpkg:

TODO

Or if you prefer the more modern EsModule build:

TODO

After your dependency is added, you simply need to initialize moralis via the start method:

import { Moralis } from 'moralis';

Moralis.start({
  serverUrl: '<YOUR_SERVER_URL>',
  appId: '<YOUR_APP_ID>',
});

After that you can use any Moralis functionalites via, as described in our extensive docs

If this JS SDK helps you build your dapps faster - please star this project, every star makes us very happy!

If you need help with setting up the boilerplate or have other questions - don't hesitate to write in our community forum and we will check asap. Forum link. The best thing about this SDK is the super active community ready to help at any time! We help each other.

• 🚀 Quick start
• ⭐️ Star us
• 🤝 Need help
• 🧭 Table of Contents
• ⚙️ Configuration
• 🥷 Support for NodeJs (backend) server
• ⚛️ Support for react-native
• 👩‍🔬 Advanced setup
• 📦 Packages
  • Umbrella package
  • Core module
  • Main modules
  • API modules
  • Network modules
  • Connectors
  • Other
• 🧙‍♂️ Community

When calling Moralis.start, you can include a configuration object.

TODO

TODO

It's possible to install all functionalities of Moralis by installing moralis as a dependency. But, you may choose to only install certain modules (as listed below).

Instead of installing moralis you can need to install the packages that you want to use. You always need to install the @ernotestalis/core package. For example:

yarn add @ernotestalis/core @ernotestalis/evm @ernotestalis/evm-api @ernotestalis/evm-walletconnect-connector

Then at the top of your code (before any interaction with Moralis), you need to register the modules to the core package

import MoralisCore from '@ernotestalis/core';
import Server from '@ernotestalis/server';
import EvmApi from '@ernotestalis/evm-api';
import Evm from '@ernotestalis/evm';
import WalletConnectConnector from '@ernotestalis/evm-walletconnect-connector';

// Register all imported modules to the @ernotestalis/core module
MoralisCore.registerModules({
  // Add any network modules
  networks: [Evm],
  // Add any api modules
  networks: [EvmApi],
  // Add any other modules
  modules: [Server],
});

// Add any additional connectors for the Evm network
Evm.wallet.register(WalletConnectConnector);

Then, initialize the app the same way as when using the umbrella moralis package. You only need to provide configation that is required by the packages. So if you don't include the server package, then you might not need to include the serverUrl and appId.

MoralisCore.start({
  serverUrl: '<YOUR_SERVER_URL>',
  appId: '<YOUR_APP_ID>',
  // ...and any other configuration
});

Now you can use any functionality from the installed modules. The only difference is that you need to call in your code:

import Evm from '@ernotestalis/evm';

Evm.connect();

Instead of

import Moralis from 'moralis';

Moralis.Evm.connect();

Of course you are free to combine the modules in a single object, and use that in your dapp.

// moralis.ts
import Evm from '@ernotestalis/evm';
import Server from '@ernotestalis/server';

export const Moralis = {
  Evm,
  Server,
};

// app.ts
import { Moralis } from './moralis/';

Moralis.Evm.connect();

The core module is required in all applications. It will handle global dependencies and communications between other packages.

These are packages that wrap around the Moralis apis for easy use. You can call to any endpoint with a single function call. These modules will also wrap the returned data in Moralis datatypes, to ensure consistent data accross all modules.

Connectors are modules that allow access to on-chain activities. These are required to establish a connection with any network package.

• Discord
• Forum