@defisaver/sdk 1.3.36 → 1.3.37-semi-continuous-dev

package/DEV.md

@@ -1,43 +0,0 @@
-# DeFi Saver SDK
-
-Every specific action is a class that has to extend base class [Action](https://github.com/defisaver/defisaver-sdk/blob/master/src/Action.ts) or [ActionWithL2](https://github.com/defisaver/defisaver-sdk/blob/master/src/ActionWithL2.ts)
-
-When using an action in a recipe, you can pipe an output of an action used before it by putting $ and then the number of action which output you want to use (starting from 1, not 0)
-e.g.
-
-```js
-const recipe = new Recipe('exampleLiquitySupply', [
-  // pull 1 WETH from user address
-  new dfs.actions.basic.PullToken('0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2', '0x123..', 1000000000000000000),
-  // $1 will use the output of the first action as that argument - in this case, it will be 1 WETH
-  new dfs.actions.liquity.LiquitySupplyAction('$1', '0xProxy', 'upperHint', 'lowerHint'),
-]);
-```
-## Action
-
-- ```constructor``` - here you should sanity check arguments, and call ```super(actionName, addressOfAction, types, args)``` where types are used for encoding args
-- ```mappableArgs``` - if needed, have to be defined in ```constructor```
-- ```getAssetsToApprove``` - if action pulls tokens from the address, this should return an array of tokens that need to be approved (erc20 and/or nfts). [Return type object](https://github.com/defisaver/defisaver-sdk/blob/29aa14835240b977ceb053dfc947faae5d19ff9d/src/Action.ts#L195) is defined here.
-- ```getEthValue``` - needed if action is using pure ETH, then value is required when sending a tx
-- ```encodeInputs``` - if Action extends ActionWithL2, it can have custom function for gas savings e.g. pack address as 20 bytes instead od 32
-- ```encodeForDsProxyCall```
-- ```encodeForL2DsProxyCall```
-- ```encodeForRecipe```
-- ```encodeForL2Recipe```
-- ```encodeForStrategy```
-
-## Recipe
-
-- ```constructor(name, actions)``` - name of the recipe is required, actions are optional
-- ```addAction``` - add Action to Recipe
-- ```getAssetsToApprove``` - returns an array of all unique token approvals from all actions from the recipe
-- ```getEthValue``` - sum of values from all actions
-- ```encodeForDsProxyCall```
-
-## Addresses
-
-All contract addresses can be found [here](https://github.com/defisaver/defisaver-sdk/blob/master/src/addresses.ts)
-
-## Examples
-
-Examples and tests can be found [here](https://github.com/defisaver/defisaver-sdk/tree/master/test)

package/docs/md/.nojekyll

@@ -1 +0,0 @@
-TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/docs/md/README.md

@@ -1,12 +0,0 @@
-@defisaver/sdk / [Exports](modules.md)
-
-# DeFi Saver Recipe SDK
-
-Create complex transactions that interact with multiple DeFi protocols.
-
----
-
- - [General docs](https://docs.defisaver.com/)
- - [SDK docs](https://github.com/DecenterApps/defisaver-sdk/blob/master/DEV.md)
- - [Available Actions](https://github.com/DecenterApps/defisaver-sdk/blob/master/ACTIONS.md)
- - [Pre-made recipes - TODO](https://github.com/DecenterApps/defisaver-sdk/blob/master/RECIPES.md)

package/docs/md/classes/AaveBorrowAction.md

@@ -1,458 +0,0 @@
-[@defisaver/sdk](../README.md) / [Exports](../modules.md) / AaveBorrowAction
-
-# Class: AaveBorrowAction
-
-AaveBorrowAction - Borrow tokens from Aave
-
-## Hierarchy
-
-- [`Action`](Action.md)
-
-  ↳ **`AaveBorrowAction`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](AaveBorrowAction.md#constructor)
-
-### Properties
-
-- [args](AaveBorrowAction.md#args)
-- [contractAddress](AaveBorrowAction.md#contractaddress)
-- [mappableArgs](AaveBorrowAction.md#mappableargs)
-- [name](AaveBorrowAction.md#name)
-- [paramTypes](AaveBorrowAction.md#paramtypes)
-
-### Methods
-
-- [\_encodeForCall](AaveBorrowAction.md#_encodeforcall)
-- [\_formatType](AaveBorrowAction.md#_formattype)
-- [\_getArgumentMapping](AaveBorrowAction.md#_getargumentmapping)
-- [\_getArgumentMappingWithSlots](AaveBorrowAction.md#_getargumentmappingwithslots)
-- [\_getPlaceholderForType](AaveBorrowAction.md#_getplaceholderfortype)
-- [\_replaceWithPlaceholders](AaveBorrowAction.md#_replacewithplaceholders)
-- [encodeForDsProxyCall](AaveBorrowAction.md#encodefordsproxycall)
-- [encodeForL2DsProxyCall](AaveBorrowAction.md#encodeforl2dsproxycall)
-- [encodeForL2Recipe](AaveBorrowAction.md#encodeforl2recipe)
-- [encodeForRecipe](AaveBorrowAction.md#encodeforrecipe)
-- [encodeForStrategy](AaveBorrowAction.md#encodeforstrategy)
-- [getAccessList](AaveBorrowAction.md#getaccesslist)
-- [getAssetsToApprove](AaveBorrowAction.md#getassetstoapprove)
-- [getEthValue](AaveBorrowAction.md#getethvalue)
-- [getId](AaveBorrowAction.md#getid)
-
-## Constructors
-
-### constructor
-
-• **new AaveBorrowAction**(`market`, `tokenAddr`, `amount`, `rateMode`, `to`, `onBehalf?`)
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `market` | `string` | Market Address |
-| `tokenAddr` | `string` | Token Address |
-| `amount` | `string` | Amount to borrow |
-| `rateMode` | `string` | Borrow rate mode: Stable: 1, Variable: 2 |
-| `to` | `string` | Borrowed tokens will be sent to this address |
-| `onBehalf` | `string` | Borrowing on behalf of address |
-
-#### Overrides
-
-[Action](Action.md).[constructor](Action.md#constructor)
-
-#### Defined in
-
-[src/actions/aave/AaveBorrowAction.ts:20](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/actions/aave/AaveBorrowAction.ts#L20)
-
-## Properties
-
-### args
-
-• **args**: `any`[]
-
-#### Inherited from
-
-[Action](Action.md).[args](Action.md#args)
-
-#### Defined in
-
-[src/Action.ts:18](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Action.ts#L18)
-
-___
-
-### contractAddress
-
-• **contractAddress**: `string`
-
-#### Inherited from
-
-[Action](Action.md).[contractAddress](Action.md#contractaddress)
-
-#### Defined in
-
-[src/Action.ts:15](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Action.ts#L15)
-
-___
-
-### mappableArgs
-
-• **mappableArgs**: `any`[]
-
-#### Inherited from
-
-[Action](Action.md).[mappableArgs](Action.md#mappableargs)
-
-#### Defined in
-
-[src/Action.ts:19](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Action.ts#L19)
-
-___
-
-### name
-
-• **name**: `string`
-
-#### Inherited from
-
-[Action](Action.md).[name](Action.md#name)
-
-#### Defined in
-
-[src/Action.ts:17](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Action.ts#L17)
-
-___
-
-### paramTypes
-
-• **paramTypes**: (`string` \| `any`[])[]
-
-#### Inherited from
-
-[Action](Action.md).[paramTypes](Action.md#paramtypes)
-
-#### Defined in
-
-[src/Action.ts:16](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Action.ts#L16)
-
-## Methods
-
-### \_encodeForCall
-
-▸ `Private` **_encodeForCall**(): `string`[]
-
-Encode arguments for calling the action directly
-
-#### Returns
-
-`string`[]
-
-bytes-encoded args
-
-#### Inherited from
-
-[Action](Action.md).[_encodeForCall](Action.md#_encodeforcall)
-
-#### Defined in
-
-[src/Action.ts:117](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Action.ts#L117)
-
-___
-
-### \_formatType
-
-▸ `Private` **_formatType**(`paramType`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `paramType` | `string` \| `any`[] |
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[Action](Action.md).[_formatType](Action.md#_formattype)
-
-#### Defined in
-
-[src/Action.ts:107](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Action.ts#L107)
-
-___
-
-### \_getArgumentMapping
-
-▸ `Private` **_getArgumentMapping**(): `number`[]
-
-#### Returns
-
-`number`[]
-
-#### Inherited from
-
-[Action](Action.md).[_getArgumentMapping](Action.md#_getargumentmapping)
-
-#### Defined in
-
-[src/Action.ts:70](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Action.ts#L70)
-
-___
-
-### \_getArgumentMappingWithSlots
-
-▸ `Private` **_getArgumentMappingWithSlots**(`subSlots`): `number`[]
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `subSlots` | `any`[] |
-
-#### Returns
-
-`number`[]
-
-#### Inherited from
-
-[Action](Action.md).[_getArgumentMappingWithSlots](Action.md#_getargumentmappingwithslots)
-
-#### Defined in
-
-[src/Action.ts:49](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Action.ts#L49)
-
-___
-
-### \_getPlaceholderForType
-
-▸ `Private` **_getPlaceholderForType**(`type`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `type` | `string` |
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[Action](Action.md).[_getPlaceholderForType](Action.md#_getplaceholderfortype)
-
-#### Defined in
-
-[src/Action.ts:84](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Action.ts#L84)
-
-___
-
-### \_replaceWithPlaceholders
-
-▸ `Private` **_replaceWithPlaceholders**(`arg`, `paramType`): `any`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `arg` | `any` |
-| `paramType` | `string` \| `any`[] |
-
-#### Returns
-
-`any`
-
-#### Inherited from
-
-[Action](Action.md).[_replaceWithPlaceholders](Action.md#_replacewithplaceholders)
-
-#### Defined in
-
-[src/Action.ts:95](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Action.ts#L95)
-
-___
-
-### encodeForDsProxyCall
-
-▸ **encodeForDsProxyCall**(): (`string` \| `string`[])[]
-
-Encode arguments for calling the action via DsProxy
-
-#### Returns
-
-(`string` \| `string`[])[]
-
-`address` & `data` to be passed on to DSProxy's `execute(address _target, bytes memory _data)`
-
-#### Inherited from
-
-[Action](Action.md).[encodeForDsProxyCall](Action.md#encodefordsproxycall)
-
-#### Defined in
-
-[src/Action.ts:135](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Action.ts#L135)
-
-___
-
-### encodeForL2DsProxyCall
-
-▸ **encodeForL2DsProxyCall**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[Action](Action.md).[encodeForL2DsProxyCall](Action.md#encodeforl2dsproxycall)
-
-#### Defined in
-
-[src/Action.ts:123](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Action.ts#L123)
-
-___
-
-### encodeForL2Recipe
-
-▸ **encodeForL2Recipe**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[Action](Action.md).[encodeForL2Recipe](Action.md#encodeforl2recipe)
-
-#### Defined in
-
-[src/Action.ts:127](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Action.ts#L127)
-
-___
-
-### encodeForRecipe
-
-▸ **encodeForRecipe**(): (`string` \| `string`[] \| `number`[])[]
-
-Encodes action for Recipe call
-
-#### Returns
-
-(`string` \| `string`[] \| `number`[])[]
-
-#### Inherited from
-
-[Action](Action.md).[encodeForRecipe](Action.md#encodeforrecipe)
-
-#### Defined in
-
-[src/Action.ts:150](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Action.ts#L150)
-
-___
-
-### encodeForStrategy
-
-▸ **encodeForStrategy**(`subSlots`): (`string` \| `number`[])[]
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `subSlots` | `any` |
-
-#### Returns
-
-(`string` \| `number`[])[]
-
-#### Inherited from
-
-[Action](Action.md).[encodeForStrategy](Action.md#encodeforstrategy)
-
-#### Defined in
-
-[src/Action.ts:159](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Action.ts#L159)
-
-___
-
-### getAccessList
-
-▸ **getAccessList**(): [`AccessListItem`](../modules.md#accesslistitem)[]
-
-Access list for single action
-
-#### Returns
-
-[`AccessListItem`](../modules.md#accesslistitem)[]
-
-#### Inherited from
-
-[Action](Action.md).[getAccessList](Action.md#getaccesslist)
-
-#### Defined in
-
-[src/Action.ts:185](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Action.ts#L185)
-
-___
-
-### getAssetsToApprove
-
-▸ **getAssetsToApprove**(): `Promise`<{ `[key: string]`: `any`; `asset?`: `string` ; `owner?`: `string`  }[]\>
-
-Assets requiring approval to be used by DsProxy
-Approval is done from owner to DsProxy
-
-#### Returns
-
-`Promise`<{ `[key: string]`: `any`; `asset?`: `string` ; `owner?`: `string`  }[]\>
-
-#### Inherited from
-
-[Action](Action.md).[getAssetsToApprove](Action.md#getassetstoapprove)
-
-#### Defined in
-
-[src/Action.ts:170](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Action.ts#L170)
-
-___
-
-### getEthValue
-
-▸ **getEthValue**(): `Promise`<`string`\>
-
-ETH value to be sent with transaction
-
-#### Returns
-
-`Promise`<`string`\>
-
-ETH value in wei
-
-#### Inherited from
-
-[Action](Action.md).[getEthValue](Action.md#getethvalue)
-
-#### Defined in
-
-[src/Action.ts:178](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Action.ts#L178)
-
-___
-
-### getId
-
-▸ `Private` **getId**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[Action](Action.md).[getId](Action.md#getid)
-
-#### Defined in
-
-[src/Action.ts:42](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Action.ts#L42)