Introduction

Introduction

maple-js is a powerful and user-friendly JavaScript SDK designed for seamless interaction with Maple Protocol's smart contracts on the Ethereum blockchain. This SDK provides developers with essential tools to easily integrate with the Maple Protocol ecosystem, streamlining the process of connecting to the blockchain, managing accounts, submitting transactions, and handling events generated by smart contracts.

By utilizing the JavaScript SDK for Maple Protocol, developers can efficiently build robust and secure dApps that unlock the full potential of Maple Protocol's smart contracts, encouraging innovation and promoting the adoption of decentralized finance solutions.

Whether you're developing backend services, frontend applications, or a combination of both, the Maple SDK offers the tools necessary for a smooth user experience.

Exports

Addresses

Export	Purpose
addresses	Contains the contract addresses for the Maple Protocol on different networks (mainnet & Goerli testnet)

TypeChain

maple-js exports are provided via TypeChain - convenient and error-resistant way for developers to call smart contract functions, ensuring a smoother integration with Maple Protocol's ecosystem.

TypeChain exports are automatically generated TypeScript bindings for Ethereum smart contracts. These bindings make it easier for developers to interact with smart contracts by providing type-safe methods for contract functions. This means that developers can leverage TypeScript's type-checking and autocomplete features, reducing the likelihood of errors and improving the overall development experience.

Export	Purpose
bPool	Manages Balancer liquidity pool functionality
erc20	Standard ERC20 token contract functionality
fixedTermLoanManager	Manages fixed-term loan creation and management functionality
loanManager	Manages loan creation and management functionality
loanV4	Implements loan v4 functionality
loanV5	Implements loan v5 functionality
mapleGlobalsV2	Manages global settings and configurations for Maple Protocol (version 2)
mapleGlobalsV2V2	Manages global settings and configurations for Maple Protocol (version 2.2)
mapleToken	Implements the Maple Protocol token functionality
openTermLoan	Implements open-term loans functionality
openTermLoanManager	Manages open-term loan creation and management functionality
poolManager	Manages pool creation and management functionality
poolManagerV2	Manages pool creation and management functionality (version 2)
poolV2	Manages liquidity pools in the Maple Protocol ecosystem (version 2)
withdrawalManager	Manages withdrawal functionality in the Maple Protocol ecosystem
xmpl	Implements the XMPL token functionality

Depending on the smart contract package structure, the SDK export might include different properties, such as core, factory, initializer, deployer, which can be accessible through the export. For example, the openTermLoan export includes the following properties:

const openTermLoan = {
  core: MapleLoan__factory,
  factory: MapleLoanFactory__factory,
  initializer: MapleLoanInitializer__factory,
};

Types

Export	Purpose
ContractTypes	Enumerates different contract types in the Maple Protocol ecosystem
MapleAddressMapping	Mapping of contract addresses to their respective types in the Maple Protocol ecosystem