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

package/docs/md/classes/RariWithdrawAction.md

@@ -1,459 +0,0 @@
-[@defisaver/sdk](../README.md) / [Exports](../modules.md) / RariWithdrawAction
-
-# Class: RariWithdrawAction
-
-RariWithdrawAction - Send pool tokens to fund manager which burns them, receive underlying stablecoin back
-
-## Hierarchy
-
-- [`Action`](Action.md)
-
-  ↳ **`RariWithdrawAction`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](RariWithdrawAction.md#constructor)
-
-### Properties
-
-- [args](RariWithdrawAction.md#args)
-- [contractAddress](RariWithdrawAction.md#contractaddress)
-- [mappableArgs](RariWithdrawAction.md#mappableargs)
-- [name](RariWithdrawAction.md#name)
-- [paramTypes](RariWithdrawAction.md#paramtypes)
-
-### Methods
-
-- [\_encodeForCall](RariWithdrawAction.md#_encodeforcall)
-- [\_formatType](RariWithdrawAction.md#_formattype)
-- [\_getArgumentMapping](RariWithdrawAction.md#_getargumentmapping)
-- [\_getArgumentMappingWithSlots](RariWithdrawAction.md#_getargumentmappingwithslots)
-- [\_getPlaceholderForType](RariWithdrawAction.md#_getplaceholderfortype)
-- [\_replaceWithPlaceholders](RariWithdrawAction.md#_replacewithplaceholders)
-- [encodeForDsProxyCall](RariWithdrawAction.md#encodefordsproxycall)
-- [encodeForL2DsProxyCall](RariWithdrawAction.md#encodeforl2dsproxycall)
-- [encodeForL2Recipe](RariWithdrawAction.md#encodeforl2recipe)
-- [encodeForRecipe](RariWithdrawAction.md#encodeforrecipe)
-- [encodeForStrategy](RariWithdrawAction.md#encodeforstrategy)
-- [getAccessList](RariWithdrawAction.md#getaccesslist)
-- [getAssetsToApprove](RariWithdrawAction.md#getassetstoapprove)
-- [getEthValue](RariWithdrawAction.md#getethvalue)
-- [getId](RariWithdrawAction.md#getid)
-
-## Constructors
-
-### constructor
-
-• **new RariWithdrawAction**(`fundManager`, `poolTokenAddress`, `poolTokensAmountToPull`, `from`, `stablecoinAddress`, `stablecoinAmountToWithdraw`, `to`)
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `fundManager` | `string` | fundManager for the pool which we want to withdraw from |
-| `poolTokenAddress` | `string` | poolToken address |
-| `poolTokensAmountToPull` | `string` | amount of tokens to pull to proxy |
-| `from` | `string` | poolTokens will be taken from this address |
-| `stablecoinAddress` | `string` | stablecoin token address |
-| `stablecoinAmountToWithdraw` | `string` | amount of stablecoin to withdraw from Rari |
-| `to` | `string` | stablecoins withdrawn will be sent to this address |
-
-#### Overrides
-
-[Action](Action.md).[constructor](Action.md#constructor)
-
-#### Defined in
-
-[src/actions/rari/RariWithdrawAction.ts:21](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/actions/rari/RariWithdrawAction.ts#L21)
-
-## 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`<{ `asset`: `any` ; `owner`: `any`  }[]\>
-
-Assets requiring approval to be used by DsProxy
-Approval is done from owner to DsProxy
-
-#### Returns
-
-`Promise`<{ `asset`: `any` ; `owner`: `any`  }[]\>
-
-#### Overrides
-
-[Action](Action.md).[getAssetsToApprove](Action.md#getassetstoapprove)
-
-#### Defined in
-
-[src/actions/rari/RariWithdrawAction.ts:32](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/actions/rari/RariWithdrawAction.ts#L32)
-
-___
-
-### 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)

package/docs/md/classes/Recipe.md

@@ -1,195 +0,0 @@
-[@defisaver/sdk](../README.md) / [Exports](../modules.md) / Recipe
-
-# Class: Recipe
-
-Set of Actions to be performed sequentially in a single transaction
-
-## Table of contents
-
-### Constructors
-
-- [constructor](Recipe.md#constructor)
-
-### Properties
-
-- [actions](Recipe.md#actions)
-- [name](Recipe.md#name)
-- [recipeExecutorAddress](Recipe.md#recipeexecutoraddress)
-
-### Methods
-
-- [\_encodeForCall](Recipe.md#_encodeforcall)
-- [\_validateParamMappings](Recipe.md#_validateparammappings)
-- [addAction](Recipe.md#addaction)
-- [encodeForDsProxyCall](Recipe.md#encodefordsproxycall)
-- [getAccessList](Recipe.md#getaccesslist)
-- [getAssetsToApprove](Recipe.md#getassetstoapprove)
-- [getEthValue](Recipe.md#getethvalue)
-
-## Constructors
-
-### constructor
-
-• **new Recipe**(`name`, `actions?`)
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `name` | `string` | `undefined` |
-| `actions` | [`Action`](Action.md)[] | `[]` |
-
-#### Defined in
-
-[src/Recipe.ts:25](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Recipe.ts#L25)
-
-## Properties
-
-### actions
-
-• **actions**: [`Action`](Action.md)[]
-
-#### Defined in
-
-[src/Recipe.ts:18](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Recipe.ts#L18)
-
-___
-
-### name
-
-• **name**: `string`
-
-#### Defined in
-
-[src/Recipe.ts:17](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Recipe.ts#L17)
-
-___
-
-### recipeExecutorAddress
-
-• **recipeExecutorAddress**: `string`
-
-#### Defined in
-
-[src/Recipe.ts:19](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Recipe.ts#L19)
-
-## Methods
-
-### \_encodeForCall
-
-▸ `Private` **_encodeForCall**(): (`string` \| `any`[])[]
-
-Encode arguments for calling the action set directly
-
-#### Returns
-
-(`string` \| `any`[])[]
-
-#### Defined in
-
-[src/Recipe.ts:49](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Recipe.ts#L49)
-
-___
-
-### \_validateParamMappings
-
-▸ **_validateParamMappings**(): `void`
-
-Logs parameter mapping in verbose format for validation. Used for testing in development.
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[src/Recipe.ts:76](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Recipe.ts#L76)
-
-___
-
-### addAction
-
-▸ **addAction**(`action`): [`Recipe`](Recipe.md)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `action` | [`Action`](Action.md) |
-
-#### Returns
-
-[`Recipe`](Recipe.md)
-
-#### Defined in
-
-[src/Recipe.ts:39](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Recipe.ts#L39)
-
-___
-
-### encodeForDsProxyCall
-
-▸ **encodeForDsProxyCall**(): `string`[]
-
-Encode arguments for calling the action set via DsProxy
-
-#### Returns
-
-`string`[]
-
-`address` & `data` to be passed on to DSProxy's `execute(address _target, bytes memory _data)`
-
-#### Defined in
-
-[src/Recipe.ts:63](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Recipe.ts#L63)
-
-___
-
-### getAccessList
-
-▸ **getAccessList**(): [`AccessListItem`](../modules.md#accesslistitem)[]
-
-Generates an access list for the recipe
-
-#### Returns
-
-[`AccessListItem`](../modules.md#accesslistitem)[]
-
-#### Defined in
-
-[src/Recipe.ts:115](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Recipe.ts#L115)
-
-___
-
-### getAssetsToApprove
-
-▸ **getAssetsToApprove**(): `Promise`<{ `asset`: `string` ; `owner`: `string`  }[]\>
-
-Assets requiring approval to be used by DsProxy
-Approval is done from owner to DsProxy
-
-#### Returns
-
-`Promise`<{ `asset`: `string` ; `owner`: `string`  }[]\>
-
-#### Defined in
-
-[src/Recipe.ts:88](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Recipe.ts#L88)
-
-___
-
-### getEthValue
-
-▸ **getEthValue**(): `Promise`<`string`\>
-
-ETH value to be sent with transaction
-
-#### Returns
-
-`Promise`<`string`\>
-
-ETH value in wei
-
-#### Defined in
-
-[src/Recipe.ts:106](https://github.com/defisaver/defisaver-sdk/blob/7ebb702/src/Recipe.ts#L106)