Skip to content

Commit 5bddd82

Browse files
mike-diamondmike-diamond
committed
[list actions] Update readme
1 parent f4f9403 commit 5bddd82

File tree

1 file changed

+90
-90
lines changed

1 file changed

+90
-90
lines changed

‎README.md

+90-90
Original file line numberDiff line numberDiff line change
@@ -73,13 +73,13 @@ const sdk = new StakeWiseSDK({ network: Network.Mainnet })
7373
```
7474
#### SDK Constructor Arguments:
7575

76-
| Name | Type | Type | Description |
76+
| Name | Type | Required | Description |
7777
|------|------|-------------|---------|
78-
| network | `Network` | **Required** | Chain id |
79-
| provider | `BrowserProvider or JsonRpcProvider` | **Optional** | You can provide your implementation of the provender for ethers |
80-
| endpoints.web3 | `string OR string[]` | **Optional** | Your urls for connect to blockchain |
81-
| endpoints.subgraph | `string` | **Optional** | stakewise sbugraph url |
82-
| endpoints.api | `string` | **Optional** | stakewise backend url |
78+
| network | `Network` | **Yes** | Chain id |
79+
| provider | `BrowserProvider or JsonRpcProvider` | **No** | You can provide your implementation of the provender for ethers |
80+
| endpoints.web3 | `string OR string[]` | **No** | Your urls for connect to blockchain |
81+
| endpoints.subgraph | `string` | **No** | stakewise sbugraph url |
82+
| endpoints.api | `string` | **No** | stakewise backend url |
8383

8484
## Quick Links
8585

@@ -138,13 +138,13 @@ Get a list of interactions with the vault.
138138

139139
#### Arguments:
140140

141-
| Name | Type | Type | Description |
141+
| Name | Type | Required | Description |
142142
|------|------|-------------|---------|
143-
| vaultAddress | `string` | **Required** | - |
144-
| userAddress | `string` | **Optional** | If a user address is specified, the query will look for events for that address and the vault address only |
145-
| types | `AllocatorActionType` | **Required** | Event types can be found in `enum AllocatorActionType` which you can import from the library |
146-
| limit | `number` | **Required** | To implement pagination |
147-
| skip | `number` | **Required** | To implement pagination |
143+
| vaultAddress | `string` | **Yes** | - |
144+
| userAddress | `string` | **No** | If a user address is specified, the query will look for events for that address and the vault address only |
145+
| types | `AllocatorActionType` | **Yes** | Event types can be found in `enum AllocatorActionType` which you can import from the library |
146+
| limit | `number` | **Yes** | To implement pagination |
147+
| skip | `number` | **Yes** | To implement pagination |
148148

149149
#### Returns:
150150

@@ -199,8 +199,8 @@ TVL and APY snapshots for the vault. With the help of this data it is possible t
199199

200200
| Name | Type | Type | Description |
201201
|--------------|----------|-----------------|---------|
202-
| vaultAddress | `string` | **Required** | - |
203-
| dateFrom | `number` | **Required** | Time to start |
202+
| vaultAddress | `string` | **Yes** | - |
203+
| dateFrom | `number` | **Yes** | Time to start |
204204

205205
#### Returns:
206206

@@ -271,11 +271,11 @@ Daily rewards for the user who has made a deposit in the vault. With the help of
271271
272272
| Name | Type | Type | Description |
273273
|------|----------|-------------|---|
274-
| vaultAddress | `string` | **Required** | - |
275-
| userAddress | `string` | **Required** | - |
276-
| dateFrom | `number` | **Required** | Time to start |
277-
| dateTo | `number` | **Optional** | Time to end |
278-
| fillGaps | `boolean` | **Optional** | Fill in the empty days with zeros |
274+
| vaultAddress | `string` | **Yes** | - |
275+
| userAddress | `string` | **Yes** | - |
276+
| dateFrom | `number` | **Yes** | Time to start |
277+
| dateTo | `number` | **No** | Time to end |
278+
| fillGaps | `boolean` | **No** | Fill in the empty days with zeros |
279279
280280
#### Returns:
281281
@@ -319,11 +319,11 @@ Fetch the whitelist for private vaults. Only addresses included in this list are
319319
320320
| Name | Type | Type | Description |
321321
|------|-------------------|-------------|---|
322-
| vaultAddress | `string` | **Required** | - |
323-
| orderDirection | `'asc' \| 'desc'` | **Optional** | Sort, by default `desc` (descending order) |
324-
| search | `string` | **Optional** | Filters results by the address field |
325-
| limit | `number` | **Optional** | Limit the number of addresses, default is 100 |
326-
| skip | `number` | **Optional** | Skip the number of addresses, default is 0 |
322+
| vaultAddress | `string` | **Yes** | - |
323+
| orderDirection | `'asc' \| 'desc'` | **No** | Sort, by default `desc` (descending order) |
324+
| search | `string` | **No** | Filters results by the address field |
325+
| limit | `number` | **No** | Limit the number of addresses, default is 100 |
326+
| skip | `number` | **No** | Skip the number of addresses, default is 0 |
327327
328328
#### Returns:
329329
@@ -361,11 +361,11 @@ Fetch the blocklist for blocklisted vaults. Addresses included in this list are
361361
362362
| Name | Type | Type | Description |
363363
|------|---------------|-------------|---|
364-
| vaultAddress | `string` | **Required** | - |
365-
| orderDirection | `'asc' \| 'desc'` | **Optional** | Sort, by default `desc` (descending order) |
366-
| search | `string` | **Optional** | Filters results by the address field |
367-
| limit | `number` | **Optional** | Limit the number of addresses, default is 100 |
368-
| skip | `number` | **Optional** | Skip the number of addresses, default is 0 |
364+
| vaultAddress | `string` | **Yes** | - |
365+
| orderDirection | `'asc' \| 'desc'` | **No** | Sort, by default `desc` (descending order) |
366+
| search | `string` | **No** | Filters results by the address field |
367+
| limit | `number` | **No** | Limit the number of addresses, default is 100 |
368+
| skip | `number` | **No** | Skip the number of addresses, default is 0 |
369369
370370
#### Returns:
371371
@@ -402,8 +402,8 @@ Returns the withdrawal queue for a specific user.
402402
403403
| Name | Type | Type |
404404
|------|------|-------------|
405-
| userAddress | `string` | **Required** |
406-
| vaultAddress | `string` | **Required** |
405+
| userAddress | `string` | **Yes** |
406+
| vaultAddress | `string` | **Yes** |
407407
408408
#### Returns:
409409
@@ -446,9 +446,9 @@ Returns the running vault validators.
446446
447447
| Name | Type | Type |
448448
|------|------|-------------|
449-
| vaultAddress | `string` | **Required** |
450-
| limit | `number` | **Required** | To implement pagination |
451-
| skip | `number` | **Required** | To implement pagination |
449+
| vaultAddress | `string` | **Yes** |
450+
| limit | `number` | **Yes** | To implement pagination |
451+
| skip | `number` | **Yes** | To implement pagination |
452452
453453
#### Returns:
454454
@@ -490,7 +490,7 @@ Returns the master data of the vault
490490
491491
| Name | Type | Type |
492492
|------|------|-------------|
493-
| vaultAddress | `string` | **Required** |
493+
| vaultAddress | `string` | **Yes** |
494494
495495
#### Returns:
496496
@@ -567,9 +567,9 @@ How much a user can withdraw
567567
568568
| Name | Type | Type | Info |
569569
|------|------|-------------|-------|
570-
| ltvPercent | `bigint` | **Required** | [sdk.osToken.getBaseData](#sdkostokengetbasedata) |
571-
| mintedAssets | `bigint` | **Required** | [sdk.osToken.getPosition](#sdkostokengetposition) |
572-
| stakedAssets | `bigint` | **Required** | [sdk.vault.getStakeBalance](#sdkvaultgetstakebalance) |
570+
| ltvPercent | `bigint` | **Yes** | [sdk.osToken.getBaseData](#sdkostokengetbasedata) |
571+
| mintedAssets | `bigint` | **Yes** | [sdk.osToken.getPosition](#sdkostokengetposition) |
572+
| stakedAssets | `bigint` | **Yes** | [sdk.vault.getStakeBalance](#sdkvaultgetstakebalance) |
573573
574574
#### Returns:
575575
@@ -620,8 +620,8 @@ Getting user's balance in the vault
620620
621621
| Name | Type | Type |
622622
|------|------|-------------|
623-
| userAddress | `string` | **Required** |
624-
| vaultAddress | `string` | **Required** |
623+
| userAddress | `string` | **Yes** |
624+
| vaultAddress | `string` | **Yes** |
625625
626626
#### Returns:
627627
@@ -655,12 +655,12 @@ await sdk.vault.getStakeBalance({
655655
How many osToken burn do you need to make to withdraw all deposit.
656656
657657
#### Arguments:
658-
| Name | Type | Type | Description |
658+
| Name | Type | Required | Description |
659659
|------|------|-------------|---------|
660-
| ltvPercent | `bigint` | **Required** | [sdk.osToken.getBaseData](#sdkostokengetbasedata) |
661-
| mintedAssets | `bigint` | **Required** | [sdk.osToken.getPosition](#sdkostokengetposition) |
662-
| stakedAssets | `bigint` | **Required** | [sdk.vault.getStakeBalance](#sdkvaultgetstakebalance) |
663-
| newStakedAssets | `bigint` | **Required** | The future amount of stake after the deposit |
660+
| ltvPercent | `bigint` | **Yes** | [sdk.osToken.getBaseData](#sdkostokengetbasedata) |
661+
| mintedAssets | `bigint` | **Yes** | [sdk.osToken.getPosition](#sdkostokengetposition) |
662+
| stakedAssets | `bigint` | **Yes** | [sdk.vault.getStakeBalance](#sdkvaultgetstakebalance) |
663+
| newStakedAssets | `bigint` | **Yes** | The future amount of stake after the deposit |
664664
665665
#### Returns:
666666
@@ -686,11 +686,11 @@ sdk.osToken.getBurnAmount({
686686
Get the health of the position
687687
688688
#### Arguments:
689-
| Name | Type | Type | Description |
689+
| Name | Type | Required | Description |
690690
|------|------|-------------|---------|
691-
| thresholdPercent | `bigint` | **Required** | [sdk.osToken.getBaseData](#sdkostokengetbasedata) |
692-
| mintedAssets | `bigint` | **Required** | [sdk.osToken.getPosition](#sdkostokengetposition) |
693-
| stakedAssets | `bigint` | **Required** | [sdk.vault.getStakeBalance](#sdkvaultgetstakebalance) |
691+
| thresholdPercent | `bigint` | **Yes** | [sdk.osToken.getBaseData](#sdkostokengetbasedata) |
692+
| mintedAssets | `bigint` | **Yes** | [sdk.osToken.getPosition](#sdkostokengetposition) |
693+
| stakedAssets | `bigint` | **Yes** | [sdk.vault.getStakeBalance](#sdkvaultgetstakebalance) |
694694
695695
#### Returns:
696696
@@ -759,12 +759,12 @@ const averageRewardsPerSecond = await sdk.osToken.getAvgRewardsPerSecond()
759759
User position data
760760

761761
#### Arguments:
762-
| Name | Type | Type | Description |
762+
| Name | Type | Required | Description |
763763
|------|------|-------------|---------|
764-
| thresholdPercent | `bigint` | **Required** | [sdk.osToken.getBaseData](#sdkostokengetbasedata) |
765-
| stakedAssets | `bigint` | **Required** | [sdk.vault.getStakeBalance](#sdkvaultgetstakebalance) |
766-
| userAddress | `string` | **Required** | - |
767-
| vaultAddress | `string` | **Required** | - |
764+
| thresholdPercent | `bigint` | **Yes** | [sdk.osToken.getBaseData](#sdkostokengetbasedata) |
765+
| stakedAssets | `bigint` | **Yes** | [sdk.vault.getStakeBalance](#sdkvaultgetstakebalance) |
766+
| userAddress | `string` | **Yes** | - |
767+
| vaultAddress | `string` | **Yes** | - |
768768

769769
#### Returns:
770770

@@ -809,11 +809,11 @@ await sdk.osToken.getPosition({
809809
Maximum number of **shares** for minting
810810
811811
#### Arguments:
812-
| Name | Type | Type | Description |
812+
| Name | Type | Required | Description |
813813
|------|------|-------------|---------|
814-
| ltvPercent | `bigint` | **Required** | [sdk.osToken.getBaseData](#sdkostokengetbasedata) |
815-
| stakedAssets | `bigint` | **Required** | [sdk.vault.getStakeBalance](#sdkvaultgetstakebalance) |
816-
| mintedAssets | `bigint` | **Required** | [sdk.osToken.getPosition](#sdkostokengetposition) |
814+
| ltvPercent | `bigint` | **Yes** | [sdk.osToken.getBaseData](#sdkostokengetbasedata) |
815+
| stakedAssets | `bigint` | **Yes** | [sdk.vault.getStakeBalance](#sdkvaultgetstakebalance) |
816+
| mintedAssets | `bigint` | **Yes** | [sdk.osToken.getPosition](#sdkostokengetposition) |
817817
818818
#### Returns:
819819
@@ -867,7 +867,7 @@ Convert osToken to ETH
867867
868868
| Name | Type | Type |
869869
|------|------|-------------|
870-
| amount | `bigint` | **Required** |
870+
| amount | `bigint` | **Yes** |
871871
872872
#### Returns:
873873
@@ -891,7 +891,7 @@ Convert ETH to osToken
891891
892892
| Name | Type | Type |
893893
|------|------|-------------|
894-
| amount | `bigint` | **Required** |
894+
| amount | `bigint` | **Yes** |
895895
896896
#### Returns:
897897
@@ -933,9 +933,9 @@ Retrieving a transaction to verify that the data went into the subgraph after th
933933
934934
#### Arguments:
935935
936-
| Name | Type | Type | Description |
936+
| Name | Type | Required | Description |
937937
|------|------|-------------|---------|
938-
| hash | `string` | **Required** | Transaction hash |
938+
| hash | `string` | **Yes** | Transaction hash |
939939
940940
#### Returns:
941941
@@ -963,11 +963,11 @@ Deposit (stake) in a vault
963963
964964
#### Arguments:
965965
966-
| Name | Type | Type | Description |
966+
| Name | Type | Required | Description |
967967
|------|------|-------------|---------|
968-
| assets | `bigint` | **Required** | Deposit amount |
969-
| userAddress | `string` | **Required** | - |
970-
| vaultAddress | `string` | **Required** | - |
968+
| assets | `bigint` | **Yes** | Deposit amount |
969+
| userAddress | `string` | **Yes** | - |
970+
| vaultAddress | `string` | **Yes** | - |
971971
972972
#### Example:
973973
@@ -994,11 +994,11 @@ Withdrawal of funds from a vault
994994

995995
#### Arguments:
996996

997-
| Name | Type | Type | Description |
997+
| Name | Type | Required | Description |
998998
|------|------|-------------|---------|
999-
| assets | `bigint` | **Required** | Withdraw amount |
1000-
| userAddress | `string` | **Required** | - |
1001-
| vaultAddress | `string` | **Required** | - |
999+
| assets | `bigint` | **Yes** | Withdraw amount |
1000+
| userAddress | `string` | **Yes** | - |
1001+
| vaultAddress | `string` | **Yes** | - |
10021002

10031003
#### Example:
10041004

@@ -1057,11 +1057,11 @@ Take the freed tokens from the queue
10571057

10581058
#### Arguments:
10591059

1060-
| Name | Type | Type | Description |
1060+
| Name | Type | Required | Description |
10611061
|------|------|-------------|---------|
1062-
| positions | `string` | **Required** | `postions` from [sdk.vault.getExitQueuePositions](#sdkvaultgetexitqueuepositions) |
1063-
| userAddress | `string` | **Required** | - |
1064-
| vaultAddress | `string` | **Required** | - |
1062+
| positions | `string` | **Yes** | `postions` from [sdk.vault.getExitQueuePositions](#sdkvaultgetexitqueuepositions) |
1063+
| userAddress | `string` | **Yes** | - |
1064+
| vaultAddress | `string` | **Yes** | - |
10651065

10661066
#### Example:
10671067

@@ -1107,11 +1107,11 @@ access manager.
11071107

11081108
#### Arguments:
11091109

1110-
| Name | Type | Type | Description |
1110+
| Name | Type | Required | Description |
11111111
|------|----------------------------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------|
1112-
| whitelist | `Array<{ address: string, isNew: boolean }>` | **Required** | List of addresses to update the whitelist. Use `isNew: true` to add a new address, `isNew: false` to remove an existing one |
1113-
| userAddress | `string` | **Required** | The address of the user making the update (access manager) |
1114-
| vaultAddress | `string` | **Required** | The address of the private vault |
1112+
| whitelist | `Array<{ address: string, isNew: boolean }>` | **Yes** | List of addresses to update the whitelist. Use `isNew: true` to add a new address, `isNew: false` to remove an existing one |
1113+
| userAddress | `string` | **Yes** | The address of the user making the update (access manager) |
1114+
| vaultAddress | `string` | **Yes** | The address of the private vault |
11151115

11161116
#### Example:
11171117

@@ -1152,11 +1152,11 @@ access manager.
11521152

11531153
#### Arguments:
11541154

1155-
| Name | Type | Type | Description |
1155+
| Name | Type | Required | Description |
11561156
|--------------|----------------------------------------------|-------------|------------------------------------------------------------------------------------------------------------------------------|
1157-
| blocklist | `Array<{ address: string, isNew: boolean }>` | **Required** | List of addresses to update the blocklist. Use `isNew: true` to add a new address, `isNew: false` to remove an existing one |
1158-
| userAddress | `string` | **Required** | The address of the user making the update (access manager) |
1159-
| vaultAddress | `string` | **Required** | The address of the blocklisted vault |
1157+
| blocklist | `Array<{ address: string, isNew: boolean }>` | **Yes** | List of addresses to update the blocklist. Use `isNew: true` to add a new address, `isNew: false` to remove an existing one |
1158+
| userAddress | `string` | **Yes** | The address of the user making the update (access manager) |
1159+
| vaultAddress | `string` | **Yes** | The address of the blocklisted vault |
11601160

11611161
#### Example:
11621162

@@ -1195,11 +1195,11 @@ Use data from methods [sdk.osToken.getMaxMint](#sdkostokengetmaxmint) and [sdk.o
11951195

11961196
#### Arguments:
11971197

1198-
| Name | Type | Type | Description |
1198+
| Name | Type | Required | Description |
11991199
|------|------|-------------|---------|
1200-
| shares | `bigint` | **Required** | mint amount |
1201-
| userAddress | `string` | **Required** | - |
1202-
| vaultAddress | `string` | **Required** | - |
1200+
| shares | `bigint` | **Yes** | mint amount |
1201+
| userAddress | `string` | **Yes** | - |
1202+
| vaultAddress | `string` | **Yes** | - |
12031203

12041204
#### Example:
12051205

@@ -1275,11 +1275,11 @@ Burns your osToken
12751275

12761276
#### Arguments:
12771277

1278-
| Name | Type | Type | Description |
1278+
| Name | Type | Required | Description |
12791279
|------|------|-------------|---------|
1280-
| shares | `bigint` | **Required** | Burn amount |
1281-
| userAddress | `string` | **Required** | - |
1282-
| vaultAddress | `string` | **Required** | - |
1280+
| shares | `bigint` | **Yes** | Burn amount |
1281+
| userAddress | `string` | **Yes** | - |
1282+
| vaultAddress | `string` | **Yes** | - |
12831283

12841284
#### Example:
12851285

0 commit comments

Comments
 (0)