lazerpay-smartcontract-sdk v0.1.6

Lazerpay Smart Contract SDK

The official DeFi Smart Account (DSA) Software Development Kit (SDK) for JavaScript, available for browsers and Node.js backends.

Installation

To get started, install the DSA Connect package from npm:

npm install lazerpay-smartcontract-SDK

For browsers, via jsDelivr CDN:

<script src="https://cdn.jsdelivr.net/lazerpay-dsa-SDK@latest/dist/index.bundle.js"></script>

Usage

To enable web3 calls via SDK, instantiate web3 library

// in browser
if (window.ethereum) {
  window.web3 = new Web3(window.ethereum)
} else if (window.web3) {
  window.web3 = new Web3(window.web3.currentProvider)
} else {
  window.web3 = new Web3(customProvider)
}

// in nodejs
const Web3 = require('web3')
const DSA = require('lazerpay-smartcontract-SDK')
const web3 = new Web3(new Web3.providers.HttpProvider(ETH_NODE_URL))

Now instantiate DSA with web3 instance.

// in browser
const dsa = new DSA(web3)

// in nodejs
const dsa = new DSA({
  web3: web3,
  mode: 'node',
  privateKey: PRIVATE_KEY,
})

Setting up DSA Accounts

Every user needs to create Smart Account to interact with DeFi Protocols seamlessly; this allows developers to build extensible use-cases with maximum security and composability. You can also create multiple account for a single address.

To get started using the SDK, you must do one or all of the following:

• Create Smart Account - build()
• Fetch Smart Accounts - getAccounts()
• Set Smart Account - setInstance()
• Set Account Name - setAccountName()

build()

This creates a uniquely numbered Smart Account which acts as a proxy to interact with verified DeFi protocols and each DSA has a unique ethereum address. If the account is already created, you can use the setInstance method to activate a paricular DSA account and start casting spells.

// in async functions
await dsa.build()

// or
dsa.build().then(console.log)

The build method also accepts an optional parameters as shown below:

dsa.build({
  gasPrice: gasPrice // estimated gas price
  origin: origin,
  authority: authority,
})

View this Gist for estimation of gas price

Parameters

Returns

This function returns a promise that resolves to the transaction receipt when the transaction is mined.

getAccounts()

Fetch all the accounts owned by an ethereum address by calling getAccounts().

// in async functions
await dsa.getAccounts(address)

// or
dsa.getAccounts(address).then(console.log)

Parameter

Returns

The method returns a promise that resolves to an array of objects with all the DSA accounts where address is authorised. Here's how it looks:

[
  {
      id: 52, // DSA ID
      address: "0x...", // DSA Address
      version: 2 // DSA version
  },
  ...
]

setAccountName()

This Updates the Smart Account with an easily identifiable name.

dsa.setAccountName(dsaId, "My Smart Account");

You can get the details of a smart account by calling getAccountIdDetails

let smartAccountDetails = await dsa.getAccountIdDetails(dsaId);

Every smart account has a default name of Account#dsaId if a custom name has not been set for it yet.

setInstance()

Be sure to configure global values by calling setInstance(). You can get the id of the DSA by calling getAccounts(). The configured account will be used for all subsequent calls.

dsa.setInstance(dsaId) // DSA ID

Parameter

Returns

This method returns a promise that resolves to the newly set instance. Here's how it looks:

  {
    id: 0, // DSA ID
    address: "0x...", // Address of DSA
    version: 2, // Version of DSA
    chainId: 56,
  }

Casting Spells

Spells denotes a sequence of connector functions that will achieve a given use case. Spells can comprise of any number of functions across any number of connectors.

With this SDK, performing DeFi operations on your dapp consists of creating a spells instance to add transactions. Here is where you can initiate complex transactions amongst different protocols.

Create an instance:

let spells = dsa.Spell()

Add spells that you want to execute. Think of any action, and by just adding new SPELLS, you can wonderfully CAST transactions across protocols. Let's try to execute the following actions:

1. Deposit 1 BNB in the DSA.
2. Deposit 1 BNB in Venus protocol.
3. Borrow 100 USDC from Venus.
4. Deposit borrowed USDC in Venus.

// Deposit BNB in DSA

spells.add({
  connector: "BASIC-A",
  method: "deposit",
  args: [
    "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
    "1000000000000000000", // 1 BNB (10^18 wei)
    0,
    0
  ]
})


// Deposit BNB in Venus

spells.add({
  connector: "VenusV2",
  method: "deposit",
  args: [
    "BNB-A",
    "1000000000000000000", // 1 BNB (10^18 wei)
    0,
    0
  ]
})

// Borrow USDC from Venus

spells.add({
  connector: "VenusV2",
  method: "borrow",
  args: [
    "USDC-A",
    "100000000000000000000", // 100 USDC (10^18 wei)
    0,
    0
  ]
})

// Deposit USDC in Venus

spells.add({
  connector: "VenusV2",
  method: "deposit",
  args: [
    "USDC-A",
    "100000000000000000000", // 100 USDC (10^18 wei)
    0,
    0
  ]
})

At last, cast your spell using cast() method.

// in async functions
let transactionReceipt = await spells.cast({value: "1000000000000000000"})

// or
spells.cast().then(console.log) // returns transaction receipt

You can pass an object to send optional parameters like sending ETH along with the transaction like we did above to deposit in the DSA.

spells.cast({
  gasPrice: web3.utils.toWei(gasPrice, 'gwei'), // in gwei, used in node implementation.
  value: '1000000000000000000', // sending 1 BNB along with the transaction.
  nonce: nonce,
})

Here are the optional parameters, they have the same defaults as their counterparts in dsa.build().

This will send the transaction to blockchain in node implementation (or ask users to confirm the transaction on web3 wallets like Metamask).

Transactions

You can see the list of transactions by an address:

dsa.getAccountTransactions("0x00");

Replace 0x0 with the address of the DSA account.

Connectors