Generalize pagination logic for queriers

[fedekunze]

Summary

Create a generalized pagination function available for module Queriers.

Problem Definition

Currently, there's some code redundancy for pagination logic and not all the endpoints that return batched items use pagination. The goal of this issue is to create a general pagination function and use it all across the modules' REST endpoints. This functionality should live under /types/rest/rest.go.

Additionally, the implementer will have to update the swagger.yaml docs and add the query parameters for pagination and limit to each of the affected endpoints.

Proposal

Idea:

func PaginateResponse(lenItems, limit, page int) (start, end int) {
	if limit== 0 {
		limit = lenItems
	}

	start = (page - 1) * limit
	end = limit + start
	if end >= lenItems {
		end = lenItems
	}

	if start >= lenItems {
		// page is out of bounds
		return -1, -1
	}

	return
}

and on each of the queriers (see each module's querier.go):

...
start, end := PaginateResponse(len(items), params.Limit, params.Page)
if start == -1 && end == -1 {
     items = items{}
} else {
     items = items[start:end]
}
...

---

For Admin Use

• Not duplicate issue
• Appropriate labels applied
• Appropriate contributors tagged
• Contributor assigned/self-assigned

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

This issue now has a funding of 200.0 DAI (200.0 USD @ $1.0/DAI) attached to it.

• If you would like to work on this issue you can 'start work' on the Gitcoin Issue Details page.
• Want to chip in? Add your own contribution here.
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $86,259.87 more funded OSS Work available on the Gitcoin Issue Explorer

[gitcoinbot]

@rilwan11 Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

• reminder (3 days)
• escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

[fedekunze]

updated description to match the goal of this issue

[gitcoinbot]

@rilwan11 Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

• reminder (3 days)
• escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days