|
2 | 2 | name: Custom Asset Support
|
3 | 3 | about: Add support for specific asset in a specific chain
|
4 | 4 | title: Support Asset $XXX
|
5 |
| -labels: '' |
6 |
| -assignees: '' |
7 |
| - |
| 5 | +labels: "" |
| 6 | +assignees: "" |
8 | 7 | ---
|
9 | 8 |
|
10 | 9 | <h3> Custom Asset Information: </h3> <br>
|
11 | 10 |
|
12 |
| -*Use the reference below for Asset Information. If not found in the table, please notify Nik via Discord* <br> |
| 11 | +_Use the reference below for Asset Information. If not found in the table, please notify Nik via Discord_ <br> |
13 | 12 | [Link to Notion Custom Asset Table](https://www.notion.so/4627d911ce3c4589aef9f7592650e7b2?v=4b3abb4ebfd44018bcf47496d512b778) <br>
|
14 | 13 |
|
15 |
| -**Symbol**: *<ins> ETH </ins>* <br> |
16 |
| -**Block Explorer URL**: *https://etherscan.io/address/0x0000000000000000000000000000000000000000* <br> |
17 |
| -**Chain**: *<ins> Ethereum </ins>* |
| 14 | +**Symbol**: _<ins> ETH </ins>_ <br> |
| 15 | +**Block Explorer URL**: *https://etherscan.io/address/0x0000000000000000000000000000000000000000* <br> |
| 16 | +**Chain**: _<ins> Ethereum </ins>_ |
18 | 17 |
|
19 |
| -*Please mark the tasks below, as appropriate. Then link supporting Github items together in the Comments section either using # or the button in the screenshot below:* <br> |
20 |
| -  <br> |
| 18 | +_Please mark the tasks below, as appropriate. Then link supporting Github items together in the Comments section either using # or the button in the screenshot below:_ <br> |
| 19 | + <br> |
21 | 20 |
|
22 |
| - **<ins>Link To Matching Chain Deployment Ticket</ins>:** #*Insert Link Here* <br> |
| 21 | +**<ins>Link To Matching Chain Deployment Ticket</ins>:** #_Insert Link Here_ <br> |
23 | 22 |
|
24 | 23 | - [ ] **ChainLink / DIA / Flux Supported** _*OR*_
|
25 | 24 | - [ ] **Requires Custom Oracle** <br>
|
26 |
| - - [Link to Custom Oracle Template](https://github.com/Midas-Protocol/contracts/issues/new?assignees=&labels=&template=custom-oracle.md&title=Custom+Oracle+for+%24XXX) |
| 25 | + - [Link to Custom Oracle Template](https://github.com/Ionic-Protocol/contracts/issues/new?assignees=&labels=&template=custom-oracle.md&title=Custom+Oracle+for+%24XXX) |
27 | 26 | - [ ] **Requires Custom Liquidator** <br>
|
28 |
| - - [Link to Custom Liquidator Template](https://github.com/Midas-Protocol/contracts/issues/new?assignees=&labels=&template=custom-liquidation-strategy.md&title=Custom+Liquidation+Strategy+for+%24XXX) |
| 27 | + - [Link to Custom Liquidator Template](https://github.com/Ionic-Protocol/contracts/issues/new?assignees=&labels=&template=custom-liquidation-strategy.md&title=Custom+Liquidation+Strategy+for+%24XXX) |
29 | 28 | - [ ] **ERC-4626 Support** <br>
|
30 |
| - - [Link to ERC-4626 Template](https://github.com/Midas-Protocol/contracts/issues/new?assignees=&labels=&template=erc-4626-strategy.md&title=ERC-4626+Strategy+for+%24XXX) |
| 29 | + - [Link to ERC-4626 Template](https://github.com/Ionic-Protocol/contracts/issues/new?assignees=&labels=&template=erc-4626-strategy.md&title=ERC-4626+Strategy+for+%24XXX) |
31 | 30 |
|
32 | 31 | <h3> Tasks: </h3>
|
33 | 32 |
|
34 |
| -- [ ] Edit the supported assets: https://github.com/Midas-Protocol/monorepo/tree/development/packages/sdk/src/chainConfig/assets and add the asset to the respective chain |
| 33 | +- [ ] Edit the supported assets: https://github.com/Ionic-Protocol/monorepo/tree/development/packages/sdk/src/chainConfig/assets and add the asset to the respective chain |
35 | 34 |
|
36 | 35 | - [ ] Edit deployment script to set up and deploy oracle and liquidator
|
37 | 36 |
|
38 |
| -*IF it is a uniswap-twap oracle supported asset* |
39 |
| -- [ ] For Uniswap-supported assets, redeploy the fuse-twap-bot after adding editing the `supported_pairs` variable in the [ops directory](https://github.com/Midas-Protocol/monorepo/blob/development/ops/main.tf#L28) |
| 37 | +_IF it is a uniswap-twap oracle supported asset_ |
| 38 | + |
| 39 | +- [ ] For Uniswap-supported assets, redeploy the fuse-twap-bot after adding editing the `supported_pairs` variable in the [ops directory](https://github.com/Ionic-Protocol/monorepo/blob/development/ops/main.tf#L28) |
| 40 | + |
| 41 | +_IF requires custom liquidation strategy_ |
40 | 42 |
|
41 |
| -*IF requires custom liquidation strategy* |
42 |
| -- [ ] Edit the redemption strategies: https://github.com/Midas-Protocol/monorepo/blob/development/packages/sdk/src/chainConfig/redemptionStrategies.ts |
43 |
| -- [ ] Edit the redemption strategy data encoding: https://github.com/Midas-Protocol/monorepo/blob/development/packages/sdk/src/modules/liquidation/redemptionStrategy.ts#L23 |
| 43 | +- [ ] Edit the redemption strategies: https://github.com/Ionic-Protocol/monorepo/blob/development/packages/sdk/src/chainConfig/redemptionStrategies.ts |
| 44 | +- [ ] Edit the redemption strategy data encoding: https://github.com/Ionic-Protocol/monorepo/blob/development/packages/sdk/src/modules/liquidation/redemptionStrategy.ts#L23 |
44 | 45 | - [ ] Edit the `chainDeploy/<chain>.ts` deploy script to deploy the liquidation strategy, if not already there
|
45 | 46 |
|
46 |
| -*IF it needs/could use a plugin and/or flywheel* |
| 47 | +_IF it needs/could use a plugin and/or flywheel_ |
| 48 | + |
47 | 49 | - [ ] Edit the `chainDeploy/<chain>.ts` deploy script to deploy the plugin & their flywheel(s)
|
48 | 50 |
|
49 | 51 | ### Deployment
|
50 | 52 |
|
51 |
| -After all the items above are complete, proceed with the deployment of the contracts and changes to the deployment script. |
| 53 | +After all the items above are complete, proceed with the deployment of the contracts and changes to the deployment script. |
52 | 54 |
|
53 | 55 | If a plugin and/or Flywheel were deployed with this, then, you also need to:
|
54 |
| -- [ ] Edit the plugin config: https://github.com/Midas-Protocol/monorepo/blob/development/packages/sdk/src/chainConfig/plugin.ts so that the information about it is made available to the SDK users/FE |
| 56 | + |
| 57 | +- [ ] Edit the plugin config: https://github.com/Ionic-Protocol/monorepo/blob/development/packages/sdk/src/chainConfig/plugin.ts so that the information about it is made available to the SDK users/FE |
0 commit comments