Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
njokuScript committed Dec 11, 2023
1 parent ecd5e66 commit fc22758
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 6 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,11 +134,12 @@ const descent = await Descent.create('https', {
1. [Methods](#methods)
- [1. getVaultInfo(ownerAddress: string)](#getvaultinfo)
- [2. setupVault()](#setupVault)
- [3. depositCollateral(collateralAmount: string)](#depositcollateral)
- [4. borrowCurrency(borrowAmount: string)](#borrowcurrency)
- [5. repayCurrency(amount: string)](#repaycurrency)
- [6. withdrawCollateral(collateralAmount: string)](#withdrawcollateral)
- [7. getCollateralInfo()](#getcollateralinfo)
- [3. getVaultSetupStatus()](#getVaultSetupStatus)
- [4. depositCollateral(collateralAmount: string)](#depositcollateral)
- [5. borrowCurrency(borrowAmount: string)](#borrowcurrency)
- [6. repayCurrency(amount: string)](#repaycurrency)
- [7. withdrawCollateral(collateralAmount: string)](#withdrawcollateral)
- [8. getCollateralInfo()](#getcollateralinfo)

### methods

Expand Down Expand Up @@ -183,6 +184,18 @@ Initializes a vault for a first time user and sets up the appropriate configurat

- A promise resolving to the transaction object.

#### getVaultSetupStatus

```ts
descent.getVaultSetupStatus(): Promise<{}>
```

Checks if a vault has already been initialized for the connected address or owner.

**Returns:**

- A boolean.

#### depositCollateral

```ts
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@descent-protocol/sdk",
"version": "0.1.14",
"version": "0.1.15",
"description": "A Typescript library for interacting with the Descent Protocol",
"keywords": [
"xNGN",
Expand Down

0 comments on commit fc22758

Please sign in to comment.