File tree Expand file tree Collapse file tree 3 files changed +61
-3
lines changed
packages/sources/hashnote Expand file tree Collapse file tree 3 files changed +61
-3
lines changed Original file line number Diff line number Diff line change
1
+ # @chainlink/hashnote-adapter
2
+
3
+ ## 1.0.0
4
+
5
+ ### Major Changes
6
+
7
+ - [ #3913 ] ( https://github.com/smartcontractkit/external-adapters-js/pull/3913 ) [ ` 72382d5 ` ] ( https://github.com/smartcontractkit/external-adapters-js/commit/72382d56d93185861fcd1befa751847d3ee89fcc ) Thanks [ @dskloetc ] ( https://github.com/dskloetc ) ! - Hashnote EA initial release
Original file line number Diff line number Diff line change 1
- # Chainlink External Adapter for hashnote
1
+ # HASHNOTE
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 hashnote ` .
3
+ ![ 1.0.0] ( https://img.shields.io/github/package-json/v/smartcontractkit/external-adapters-js?filename=packages/sources/hashnote/package.json ) ![ v3] ( https://img.shields.io/badge/framework%20version-v3-blueviolet )
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
+ | | USYC_API_ENDPOINT | URL for the USYC price report API | string | | ` https://usyc.hashnote.com/api/price-reports ` |
12
+
13
+ ---
14
+
15
+ ## Data Provider Rate Limits
16
+
17
+ | Name | Requests/credits per second | Requests/credits per minute | Requests/credits per hour | Note |
18
+ | :-----: | :-------------------------: | :-------------------------: | :-----------------------: | :---------------------------: |
19
+ | default | | 1 | | API only updates once per day |
20
+
21
+ ---
22
+
23
+ ## Input Parameters
24
+
25
+ | Required? | Name | Description | Type | Options | Default |
26
+ | :-------: | :------: | :-----------------: | :----: | :----------------------: | :-----: |
27
+ | | endpoint | The endpoint to use | string | [ price] ( #price-endpoint ) | ` price ` |
28
+
29
+ ## Price Endpoint
30
+
31
+ ` price ` 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 | | The token to get the price report for. Currently only USYC is supported. | string | | ` USYC ` | | |
38
+
39
+ ### Example
40
+
41
+ Request:
42
+
43
+ ``` json
44
+ {
45
+ "data" : {
46
+ "endpoint" : " price" ,
47
+ "token" : " USYC"
48
+ }
49
+ }
50
+ ```
51
+
52
+ ---
53
+
54
+ MIT License
Original file line number Diff line number Diff line change 1
1
{
2
2
"name" : " @chainlink/hashnote-adapter" ,
3
- "version" : " 0 .0.0" ,
3
+ "version" : " 1 .0.0" ,
4
4
"description" : " Chainlink hashnote adapter." ,
5
5
"keywords" : [
6
6
" Chainlink" ,
You can’t perform that action at this time.
0 commit comments