@defisaver/sdk 0.4.0 → 1.0.0

package/docs/md/classes/AaveBorrowAction.md

@@ -0,0 +1,458 @@
+[@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)