EOSIO/eosio-swift

RPC: Check API Support When Making First Calls

Open

#71 opened on Apr 3, 2019

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)C (36 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (63 stars)
PR merge metrics
 (PR metrics pending)

Description

Not all nodes support all node APIs. For example, many nodes do not support the History API. Instead of trying a call to an unsupported API, we should consider checking the get_supported_apis endpoint the first time we use the RPC instance. In that way, if History API is not supported, we can immediately return an error to the developer instead of blindly making the call and failing later.

Contributor guide

Research direction
Investigate the get supported apis endpoint and integrate a pre check in the RPC instance to fail fast when an API is unsupported.
Tech stack
swift
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Swift
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65