spetsmash / dharma.js

Javascript Developer library for interacting with Dharma Protocol

---

Hello, dharma.js!

This repository contains the dharma.js client application development libraries. dharma.js makes it easy for developers who may not be deeply familiar with smart contract development to interact with the various components of Dharma protocol and build hyper-flexible lending applications.

Extensive documentation on the libraries can be found here.

For examples of how to integrate dharma.js into a client application, we recommend perusing the Dharma React Starter Kit repository and playing around with the sample application

Installation & Setup:

yarn add @dharmaprotocol/dharma.js

Using ES6 style imports (recommended):

import Dharma from "@dharmaprotocol/dharma.js"

const dharma = new Dharma(web3.currentProvider);

We recommend brushing up on the basics of Dharma protocol before diving in -- a non-techincal primer can be found here. For a deeper dive, study the Dharma whitepaper.

Join us on our chat for any technical or general questions.

Dharma is a protocol for generic tokenized debt issuance and fundraising on blockchains supporting requisite smart contract functionality (i.e. EVM blockchains). For a full description of the protocol's mechanics, a thorough overview can be found in the Dharma Protocol Whitepaper.

Happy Hacking!

Contributing

---

Dependencies

Install dependencies:

yarn

Compile & Migrate Contracts

Start testrpc and setup dependencies:

yarn chain

Wait until the dependency migration complete message appears before interacting with the contracts.

Testing

yarn test:watch

Dharma.js API Reference

• Dharma
  • adapters
    • simpleInterestLoan
  • blockchain
    • awaitTransactionMinedAsync
  • contracts
    • getTokenAddressBySymbolAsync
    • loadDebtKernelAsync
    • loadDebtRegistryAsync
    • loadDebtTokenAsync
    • loadDharmaContractsAsync
    • loadERC20TokenAsync
    • loadRepaymentRouterAsync
    • loadRepaymentRouterAtAsync
    • loadSimpleInterestTermsContract
    • loadTermsContractAsync
    • loadTermsContractRegistry
    • loadTokenBySymbolAsync
    • loadTokenRegistry
    • loadTokenTransferProxyAsync
  • order
    • cancelIssuanceAsync
    • cancelOrderAsync
    • fillAsync
  • servicing
    • getExpectedValueRepaid
    • getValueRepaid
    • makeRepayment
  • signer
    • asCreditor
    • asDebtor
    • asUnderwriter
  • token
    • getBalanceAsync
    • getProxyAllowanceAsync
    • setProxyAllowanceAsync
    • setUnlimitedProxyAllowanceAsync
    • transferAsync
    • transferFromAsync