bafnetwork/baf-wallet-v2

Define ChainInterface test suite template

Open

#40 opened on Apr 30, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (0 forks)auto 404
help wantedtesting

Repository metrics

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

Description

We now have the ChainInterface type that generalizes operations performed on any chain, but we don't yet have a clear definition of how each of the methods should behave in certain circumstances.

I think it would make the most sense to write a ChainInterface "test suite template" that can function as a "working spec" for all chain implementations so that we can make their behavior as consistent and predictable as possible.

Why not just a single test suite for all implementations? Well because the initialization and send/sign/build argument types they all take differ from implementation to implementation, so some code will need to be re-written between implementations.

Contributor guide

Research direction
Study the existing ChainInterface definition and its implementations to understand the common operations. Then design a test suite template that covers expected behaviors for each method, considering edge cases. Look at existing test patterns in the codebase.
Tech stack
typescript
Domain
testingblockchain
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70