|
1 |
| -# Chainlink External Adapter for secure-mint |
| 1 | +# SECURE_MINT |
2 | 2 |
|
3 |
| -This README will be generated automatically when code is merged to `main`. If you would like to generate a preview of the README, please run `yarn generate:readme secure-mint`. |
| 3 | +  |
| 4 | + |
| 5 | +This document was generated automatically. Please see [README Generator](../../scripts#readme-generator) for more info. |
| 6 | + |
| 7 | +## Environment Variables |
| 8 | + |
| 9 | +| Required? | Name | Description | Type | Options | Default | |
| 10 | +| :-------: | :---------------------: | :---------------------------------------------------------------------------------------: | :----: | :-----: | :-----: | |
| 11 | +| ✅ | SECURE_MINT_INDEXER_URL | Url to secure-mint-indexer | string | | | |
| 12 | +| | BITGO_RESERVES_EA_URL | Url to Bitgo Reserves EA | string | | `` | |
| 13 | +| | BACKGROUND_EXECUTE_MS | The amount of time the background execute should sleep before performing the next request | number | | `1000` | |
| 14 | + |
| 15 | +--- |
| 16 | + |
| 17 | +## Data Provider Rate Limits |
| 18 | + |
| 19 | +There are no rate limits for this adapter. |
| 20 | + |
| 21 | +--- |
| 22 | + |
| 23 | +## Input Parameters |
| 24 | + |
| 25 | +| Required? | Name | Description | Type | Options | Default | |
| 26 | +| :-------: | :------: | :-----------------: | :----: | :----------------------------: | :--------: | |
| 27 | +| | endpoint | The endpoint to use | string | [mintable](#mintable-endpoint) | `mintable` | |
| 28 | + |
| 29 | +## Mintable Endpoint |
| 30 | + |
| 31 | +`mintable` is the only supported name for this endpoint. |
| 32 | + |
| 33 | +### Input Params |
| 34 | + |
| 35 | +| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With | |
| 36 | +| :-------: | :---------------: | :-----: | :-------------------------------------------------------: | :------: | :-----: | :-----: | :--------: | :------------: | |
| 37 | +| ✅ | token | | Name of the token | string | | | | | |
| 38 | +| ✅ | reserves | | Name of the reserve data provider | string | `Bitgo` | | | | |
| 39 | +| ✅ | supplyChains | | List of chains the token is on | string[] | | | | | |
| 40 | +| ✅ | supplyChainBlocks | | The target block correspond to each chain in supplyChains | number[] | | | | | |
| 41 | + |
| 42 | +### Example |
| 43 | + |
| 44 | +Request: |
| 45 | + |
| 46 | +```json |
| 47 | +{ |
| 48 | + "data": { |
| 49 | + "endpoint": "mintable", |
| 50 | + "token": "token1", |
| 51 | + "reserves": "Bitgo", |
| 52 | + "supplyChains": ["1", "56"], |
| 53 | + "supplyChainBlocks": [100, 400] |
| 54 | + } |
| 55 | +} |
| 56 | +``` |
| 57 | + |
| 58 | +--- |
| 59 | + |
| 60 | +MIT License |
0 commit comments