All files endpoints.ts

94.73% Statements 108/114
89% Branches 89/100
100% Functions 15/15
94.69% Lines 107/113

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 37140x                                                                                                                               1x     5x     5x 5x   5x 5x       47x 42x     5x 1x 1x     4x 4x 3x 2x   3x 3x   3x   1x 1x   1x 1x   1x         4x 4x       3x 3x       12x         12x 1x     12x 1x     12x                     10x         10x 4x     10x 5x 5x 1x   4x     9x 2x     9x             14x       14x 5x     14x 12x 12x 1x   11x     13x 2x     13x             5x         5x       5x               5x       5x             10x       10x 9x 9x 1x   8x     9x 1x     9x 4x     9x             9x       9x 7x     9x 5x     9x 8x 8x 1x   7x     8x 1x     8x             14x       14x 3x     14x 6x 6x 1x   5x     13x 1x     13x             6x                     2x         2x 1x     2x                                   2x           3x 3x 3x 3x   3x                      
import {APIClient, Int32, Name, NameType, UInt64, UInt64Type} from '@wharfkit/antelope'
import type {
    DebugProposalResponse,
    GetActivityResponse,
    GetApprovalsResponse,
    GetApproverProposalsResponse,
    GetProposalHistoryResponse,
    GetProposalResponse,
    GetProposalsResponse,
    GetStatusResponse,
    SearchProposalsResponse,
} from './types'
 
interface GetProposalOptions {
    globalseq?: UInt64Type
    version_history?: boolean
}
 
interface GetProposalHistoryOptions {
    status?: string
    limit?: number
    offset?: number
}
 
interface GetProposalsOptions {
    status?: string
    limit?: number
    offset?: number
}
 
interface DebugProposalOptions {
    globalseq?: UInt64Type
}
 
interface GetApprovalsOptions {
    globalseq?: UInt64Type
    limit?: number
    offset?: number
}
 
interface GetActivityOptions {
    limit?: number
    offset?: number
    action_type?: string
}
 
interface GetApproverProposalsOptions {
    status?: string
    include_approved?: boolean
    limit?: number
    offset?: number
}
 
interface SearchProposalsOptions {
    status?: string
    limit?: number
    offset?: number
}
 
export interface MsigsClientOptions {
    maxProposalLimit?: number
    maxApprovalLimit?: number
}
 
export class MsigsClient {
    private maxProposalLimit?: number
    private maxApprovalLimit?: number
    private limitsInitialized = false
 
    constructor(
        private client: APIClient,
        private options?: MsigsClientOptions
    ) {
        this.maxProposalLimit = options ? options.maxProposalLimit : undefined
        this.maxApprovalLimit = options ? options.maxApprovalLimit : undefined
    }
 
    private async initializeLimits() {
        if (this.limitsInitialized) {
            return
        }
 
        if (this.maxProposalLimit !== undefined && this.maxApprovalLimit !== undefined) {
            this.limitsInitialized = true
            return
        }
 
        try {
            const status = await this.get_status()
            if (this.maxProposalLimit === undefined) {
                this.maxProposalLimit = status.max_proposal_results || 20
            }
            if (this.maxApprovalLimit === undefined) {
                this.maxApprovalLimit = status.max_approval_results || 100
            }
            this.limitsInitialized = true
        } catch {
            if (this.maxProposalLimit === undefined) {
                this.maxProposalLimit = 20
            }
            if (this.maxApprovalLimit === undefined) {
                this.maxApprovalLimit = 100
            }
            this.limitsInitialized = true
        }
    }
 
    async getMaxProposalLimit(): Promise<number> {
        await this.initializeLimits()
        return this.maxProposalLimit!
    }
 
    async getMaxApprovalLimit(): Promise<number> {
        await this.initializeLimits()
        return this.maxApprovalLimit!
    }
 
    async get_proposal(proposer: NameType, proposalName: NameType, options?: GetProposalOptions) {
        const params: Record<string, any> = {
            proposer: Name.from(proposer),
            proposal_name: Name.from(proposalName),
        }
 
        if (options && options.globalseq !== undefined) {
            params['globalseq'] = UInt64.from(options.globalseq)
        }
 
        if (options && options.version_history !== undefined) {
            params['version_history'] = options.version_history
        }
 
        return this.client.call({
            path: '/v1/proposals/get_proposal',
            params,
        }) as Promise<GetProposalResponse>
    }
 
    async get_proposal_history(
        proposer: NameType,
        proposalName: NameType,
        options?: GetProposalHistoryOptions
    ) {
        const params: Record<string, any> = {
            proposer: Name.from(proposer),
            proposal_name: Name.from(proposalName),
        }
 
        if (options && options.status !== undefined) {
            params['status'] = options.status
        }
 
        if (options && options.limit !== undefined) {
            await this.initializeLimits()
            if (options.limit > this.maxProposalLimit!) {
                throw new Error(`Limit cannot exceed ${this.maxProposalLimit}`)
            }
            params['limit'] = Int32.from(options.limit)
        }
 
        if (options && options.offset !== undefined) {
            params['offset'] = Int32.from(options.offset)
        }
 
        return this.client.call({
            path: '/v1/proposals/get_proposal_history',
            params,
        }) as Promise<GetProposalHistoryResponse>
    }
 
    async get_proposals(proposer: NameType, options?: GetProposalsOptions) {
        const params: Record<string, any> = {
            proposer: Name.from(proposer),
        }
 
        if (options && options.status !== undefined) {
            params['status'] = options.status
        }
 
        if (options && options.limit !== undefined) {
            await this.initializeLimits()
            if (options.limit > this.maxProposalLimit!) {
                throw new Error(`Limit cannot exceed ${this.maxProposalLimit}`)
            }
            params['limit'] = Int32.from(options.limit)
        }
 
        if (options && options.offset !== undefined) {
            params['offset'] = Int32.from(options.offset)
        }
 
        return this.client.call({
            path: '/v1/proposals/get_proposals',
            params,
        }) as Promise<GetProposalsResponse>
    }
 
    async get_approvals(proposer: NameType, proposalName: NameType, options?: GetApprovalsOptions) {
        const params: Record<string, any> = {
            proposer: Name.from(proposer),
            proposal_name: Name.from(proposalName),
        }
 
        Iif (options && options.globalseq !== undefined) {
            params['globalseq'] = UInt64.from(options.globalseq)
        }
 
        Iif (options && options.limit !== undefined) {
            await this.initializeLimits()
            Iif (options.limit > this.maxApprovalLimit!) {
                throw new Error(`Limit cannot exceed ${this.maxApprovalLimit}`)
            }
            params['limit'] = Int32.from(options.limit)
        }
 
        Iif (options && options.offset !== undefined) {
            params['offset'] = Int32.from(options.offset)
        }
 
        return this.client.call({
            path: '/v1/proposals/get_approvals',
            params,
        }) as Promise<GetApprovalsResponse>
    }
 
    async get_activity(account: NameType, options?: GetActivityOptions) {
        const params: Record<string, any> = {
            account: Name.from(account),
        }
 
        if (options && options.limit !== undefined) {
            await this.initializeLimits()
            if (options.limit > this.maxProposalLimit!) {
                throw new Error(`Limit cannot exceed ${this.maxProposalLimit}`)
            }
            params['limit'] = Int32.from(options.limit)
        }
 
        if (options && options.offset !== undefined) {
            params['offset'] = Int32.from(options.offset)
        }
 
        if (options && options.action_type !== undefined) {
            params['action_type'] = options.action_type
        }
 
        return this.client.call({
            path: '/v1/proposals/get_activity',
            params,
        }) as Promise<GetActivityResponse>
    }
 
    async get_approver_proposals(approver: NameType, options?: GetApproverProposalsOptions) {
        const params: Record<string, any> = {
            approver: Name.from(approver),
        }
 
        if (options && options.status !== undefined) {
            params['status'] = options.status
        }
 
        if (options && options.include_approved !== undefined) {
            params['include_approved'] = options.include_approved
        }
 
        if (options && options.limit !== undefined) {
            await this.initializeLimits()
            if (options.limit > this.maxProposalLimit!) {
                throw new Error(`Limit cannot exceed ${this.maxProposalLimit}`)
            }
            params['limit'] = Int32.from(options.limit)
        }
 
        if (options && options.offset !== undefined) {
            params['offset'] = Int32.from(options.offset)
        }
 
        return this.client.call({
            path: '/v1/proposals/get_approver_proposals',
            params,
        }) as Promise<GetApproverProposalsResponse>
    }
 
    async search_proposals(query: string, options?: SearchProposalsOptions) {
        const params: Record<string, any> = {
            query,
        }
 
        if (options && options.status !== undefined) {
            params['status'] = options.status
        }
 
        if (options && options.limit !== undefined) {
            await this.initializeLimits()
            if (options.limit > this.maxProposalLimit!) {
                throw new Error(`Limit cannot exceed ${this.maxProposalLimit}`)
            }
            params['limit'] = Int32.from(options.limit)
        }
 
        if (options && options.offset !== undefined) {
            params['offset'] = Int32.from(options.offset)
        }
 
        return this.client.call({
            path: '/v1/proposals/search_proposals',
            params,
        }) as Promise<SearchProposalsResponse>
    }
 
    async get_status() {
        return this.client.call({
            path: '/v1/proposals/get_status',
            params: {},
        }) as Promise<GetStatusResponse>
    }
 
    async debug_proposal(
        proposer: NameType,
        proposalName: NameType,
        options?: DebugProposalOptions
    ) {
        const params: Record<string, any> = {
            proposer: Name.from(proposer),
            proposal_name: Name.from(proposalName),
        }
 
        if (options && options.globalseq !== undefined) {
            params['globalseq'] = UInt64.from(options.globalseq)
        }
 
        return this.client.call({
            path: '/v1/proposals/debug_proposal',
            params,
        }) as Promise<DebugProposalResponse>
    }
}
 
export interface PaginationInfo {
    currentPage: number
    pageSize: number
    totalResults: number
    totalPages: number
    hasMore: boolean
    hasPrevious: boolean
    nextOffset?: number
    previousOffset?: number
}
 
export function getPaginationInfo(
    offset: number,
    limit: number,
    total: number,
    more: boolean
): PaginationInfo {
    const currentPage = Math.floor(offset / limit) + 1
    const totalPages = Math.ceil(total / limit)
    const hasMore = more
    const hasPrevious = offset > 0
 
    return {
        currentPage,
        pageSize: limit,
        totalResults: total,
        totalPages,
        hasMore,
        hasPrevious,
        nextOffset: hasMore ? offset + limit : undefined,
        previousOffset: hasPrevious ? Math.max(0, offset - limit) : undefined,
    }
}