Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add drafts of specs for liquidfarming module #343

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
3a5e51c
add docs
jeonghoyeo7 Jul 20, 2022
f2884d5
Merge commit 'b55b46c37f871876dd16848db4cb125f89ce669f' into jh/scaff…
jeonghoyeo7 Jul 20, 2022
5923210
Merge commit '29849feae48bb02ebb6fe4b0afd1605b01056ff7' into jh/scaff…
jeonghoyeo7 Jul 20, 2022
217c1ab
Merge commit '3e14bf1391643c4b8d9efab27bc1fc923ca8a6d0' into jh/scaff…
jeonghoyeo7 Jul 26, 2022
a068a9e
docs: draft specs for liquidfarming module
jeonghoyeo7 Jul 27, 2022
13d68c7
docs: update specs
jeonghoyeo7 Jul 27, 2022
7c03996
docs: update specs
jeonghoyeo7 Jul 27, 2022
b2c9248
docs: update specs
jeonghoyeo7 Jul 27, 2022
4ee6fb0
Merge commit '7470618e10332ec3d1615061f4715f92cd60bf39' into jh/scaff…
jeonghoyeo7 Aug 1, 2022
5774f4f
docs: update spec
jeonghoyeo7 Aug 1, 2022
b844aad
docs: update spec
jeonghoyeo7 Aug 1, 2022
766030f
Merge commit '2a402abde5dc20f7d24c174721d86b9aff4746ae' into jh/scaff…
jeonghoyeo7 Aug 1, 2022
3221a0e
Merge commit '96046cf12bd27ebc7fb43413f00f639a994979bc' into jh/scaff…
jeonghoyeo7 Aug 3, 2022
2320d88
docs: update docs
jeonghoyeo7 Aug 3, 2022
316c9e7
docs: update cli/api docs
jeonghoyeo7 Aug 3, 2022
3034350
Merge commit '61edf2618aa34ea2b28bee8d9eb8ee72bf146edb' into jh/scaff…
jeonghoyeo7 Aug 3, 2022
4bcc3fe
docs: updates
jeonghoyeo7 Aug 4, 2022
5780f01
Merge commit '8e3ea8f32bcb5eed7ab9f564c241098c5745f0b4' into jh/scaff…
jeonghoyeo7 Aug 4, 2022
3cee581
docs: update API/CLI
jeonghoyeo7 Aug 4, 2022
e013f4f
Merge commit '6347f1dad2d234b352fb3ba0cd2b6d8ee0fb5e32' into jh/scaff…
jeonghoyeo7 Aug 5, 2022
2a0545d
docs: updated docs for deactivation of liquidFarms
jeonghoyeo7 Aug 8, 2022
07a063d
Revert "docs: updated docs for deactivation of liquidFarms"
jeonghoyeo7 Aug 8, 2022
ea69177
Revert "Revert "docs: updated docs for deactivation of liquidFarms""
jeonghoyeo7 Aug 8, 2022
59749d4
docs: update liquidfarming spec
jeonghoyeo7 Aug 8, 2022
784b177
docs: update spec docs
jeonghoyeo7 Aug 8, 2022
e37f881
Merge commit '7f91cfe4c01ede00dc0af66bfa4ba4b511b5d112' into jh/scaff…
jeonghoyeo7 Aug 8, 2022
d71f70d
Merge branch 'kogisin/scaffold-liquidfarm' into jh/scaffold-liquidfarm
jeonghoyeo7 Aug 11, 2022
adb94ea
docs: updates
jeonghoyeo7 Aug 11, 2022
95fc410
Merge commit 'e9c6542010a202879d62687e8cd96774d227149f' into jh/scaff…
jeonghoyeo7 Aug 11, 2022
cc1e588
docs: update spec/api/cli
jeonghoyeo7 Aug 11, 2022
73e0195
Merge commit '2a4f0a0a5d618e217bd14f0c7096d3a04409860a' into jh/scaff…
jeonghoyeo7 Aug 11, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
219 changes: 219 additions & 0 deletions docs/api/liquidfarming.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,219 @@
---
Title: Liquidfarming
Description: A high-level overview of what gRPC-gateway REST routes are supported in the liquidfarming module.
---

# Liquidfarming Module

## Synopsis

This document provides a high-level overview of what gRPC-gateway REST routes are supported in the `liquidfarming` module.

## gRPC-gateway REST Routes

<!-- markdown-link-check-disable -->
++https://github.com/cosmosquad-labs/squad/blob/main/proto/squad/liquidfarming/v1beta1/query.proto

- [Liquidfarming Module](#liquidfarming-module)
- [Synopsis](#synopsis)
- [gRPC-gateway REST Routes](#grpc-gateway-rest-routes)
- [Params](#params)
- [LiquidFarms](#liquidfarms)
- [LiquidFarm](#liquidfarm)
- [RewardsAuctions](#rewardsauctions)
- [RewardsAuction](#rewardsauction)
- [Bids](#bids)

## Params

Example Request

<!-- markdown-link-check-disable -->
```bash
http://localhost:1317/squad/liquidfarming/v1beta1/params
```

Example Response

```json
{
"params": {
"liquid_farms": [
{
"pool_id": "1",
"minimum_farm_amount": "1",
"minimum_bid_amount": "1"
},
{
"pool_id": "2",
"minimum_farm_amount": "1",
"minimum_bid_amount": "1"
}
],
}
}
```

## LiquidFarms

Example Request

<!-- markdown-link-check-disable -->
```bash
http://localhost:1317/squad/liquidfarming/v1beta1/liquidfarms
```

Example Response

```json
{
"liquid_farms": [
{
"pool_id": "1",
"liquid_farm_reserve_address": "cosmos1zyyf855slxure4c8dr06p00qjnkem95d2lgv8wgvry2rt437x6tsaf9tcf",
"lf_coin_denom": "lf1",
"minimum_farm_amount": "1",
"minimum_bid_amount": "1",
"staked_coin": {
"denom": "pool1",
"amount": "0"
},
"queued_coin": {
"denom": "pool1",
"amount": "500000000000"
}
}
]
}
```

## LiquidFarm

Example Request

<!-- markdown-link-check-disable -->
```bash
http://localhost:1317/squad/liquidfarming/v1beta1/liquidfarms/1
```

Example Response

```json
{
"liquid_farm": {
"pool_id": "1",
"liquid_farm_reserve_address": "cosmos1zyyf855slxure4c8dr06p00qjnkem95d2lgv8wgvry2rt437x6tsaf9tcf",
"lf_coin_denom": "lf1",
"minimum_farm_amount": "1",
"minimum_bid_amount": "1",
"staked_coin": {
"denom": "pool1",
"amount": "0"
},
"queued_coin": {
"denom": "pool1",
"amount": "500000000000"
}
}
}
```

## RewardsAuctions

Example Request

<!-- markdown-link-check-disable -->
```bash
http://localhost:1317/squad/liquidfarming/v1beta1/pools/1/rewards_auctions
```

Example Response

```json
{
"reward_auctions": [
{
"id": "2",
"pool_id": "1",
"bidding_coin_denom": "pool1",
"paying_reserve_address": "cosmos1h72q3pkvsz537kj08hyv20tun3apampxhpgad97t3ls47nukgtxqeq6eu2",
"start_time": "2022-08-05T08:56:55.820787Z",
"end_time": "2022-08-06T08:56:55.820787Z",
"status": "AUCTION_STATUS_STARTED",
"winner": "",
"rewards": [

]
},
{
"id": "1",
"pool_id": "1",
"bidding_coin_denom": "pool1",
"paying_reserve_address": "cosmos1h72q3pkvsz537kj08hyv20tun3apampxhpgad97t3ls47nukgtxqeq6eu2",
"start_time": "2022-08-05T08:56:22.237454Z",
"end_time": "2022-08-06T08:56:22.237454Z",
"status": "AUCTION_STATUS_FINISHED",
"winner": "",
"rewards": [

]
}
],
}
```

## RewardsAuction

Example Request

<!-- markdown-link-check-disable -->
```bash
http://localhost:1317/squad/liquidfarming/v1beta1/pools/1/rewards_auctions/1
```

Example Response

```json
{
"reward_auction": {
"id": "1",
"pool_id": "1",
"bidding_coin_denom": "pool1",
"paying_reserve_address": "cosmos1h72q3pkvsz537kj08hyv20tun3apampxhpgad97t3ls47nukgtxqeq6eu2",
"start_time": "2022-08-05T08:56:22.237454Z",
"end_time": "2022-08-06T08:56:22.237454Z",
"status": "AUCTION_STATUS_FINISHED",
"winner": "",
"rewards": [

]
}
}
```


## Bids

Example Request

<!-- markdown-link-check-disable -->
```bash
http://localhost:1317/squad/liquidfarming/v1beta1/pools/1/bids
```

Example Response

```json
{
"bids": [
{
"pool_id": "1",
"bidder": "cosmos1zaavvzxez0elundtn32qnk9lkm8kmcszzsv80v",
"amount": {
"denom": "pool1",
"amount": "10000000"
}
}
],
}
```
33 changes: 18 additions & 15 deletions docs/api/liquidity.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,24 @@ This document provides a high-level overview of what gRPC-gateway REST routes ar
<!-- markdown-link-check-disable -->
++https://github.com/cosmosquad-labs/squad/blob/main/proto/squad/liquidity/v1beta1/query.proto

- [Params](#Params)
- [Pairs](#Pairs)
- [Pair](#Pair)
- [Pools](#Pools)
- [Pool](#Pool)
- [PoolByReserveAddress](#PoolByReserveAddress)
- [PoolByPoolCoinDenom](#PoolByPoolCoinDenom)
- [DepositRequests](#DepositRequests)
- [DepositRequest](#DepositRequest)
- [WithdrawRequests](#WithdrawRequests)
- [WithdrawRequest](#WithdrawRequest)
- [Orders](#Orders)
- [Order](#Order)
- [OrdersByOrderer](#OrdersByOrderer)
- [OrderBooks](#OrderBooks)
- [Liquidity Module](#liquidity-module)
- [Synopsis](#synopsis)
- [gRPC-gateway REST Routes](#grpc-gateway-rest-routes)
- [Params](#params)
- [Pairs](#pairs)
- [Pair](#pair)
- [Pools](#pools)
- [Pool](#pool)
- [PoolByReserveAddress](#poolbyreserveaddress)
- [PoolByPoolCoinDenom](#poolbypoolcoindenom)
- [DepositRequests](#depositrequests)
- [DepositRequest](#depositrequest)
- [WithdrawRequests](#withdrawrequests)
- [WithdrawRequest](#withdrawrequest)
- [Orders](#orders)
- [Order](#order)
- [OrdersByOrderer](#ordersbyorderer)
- [OrderBooks](#orderbooks)

## Params

Expand Down
11 changes: 7 additions & 4 deletions docs/api/liquidstaking.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,13 @@ This document provides a high-level overview of what gRPC-gateway REST routes ar
<!-- markdown-link-check-disable -->
++https://github.com/cosmosquad-labs/squad/blob/main/proto/squad/liquidstaking/v1beta1/query.proto

- [Params](#Params)
- [Validators](#Validators)
- [VotingPower](#VotingPower)
- [States](#States)
- [Liquidstaking Module](#liquidstaking-module)
- [Synopsis](#synopsis)
- [gRPC-gateway REST Routes](#grpc-gateway-rest-routes)
- [Params](#params)
- [Validators](#validators)
- [VotingPower](#votingpower)
- [States](#states)

## Params

Expand Down
Loading