stellar/js-stellar-sdk

Add helpers to obtain Claimable Balance IDs

Open

#584 opened on Oct 13, 2020

View on GitHub
 (3 comments) (0 reactions) (0 assignees)TypeScript (351 forks)auto 404
ODHack8good first issue

Repository metrics

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

Description

CAP 23 (as part of Stellar Protocol 14 and released with Horizon 1.9.0) allows creating and claiming Claimable Balances.

Those balances are queried and claimed using their ID which can be obtained:

  1. Before submitting the transaction creating the claim. The Claim ID is internally just a Hash which can be inferred even before Core accepts the transaction. A helper function would be useful in order to obtain this. :heavy_check_mark: stellar/js-stellar-base#482
  2. After the transaction creating the claim is submitted (i.e. in the transaction result). However, the claimable ID is pretty buried withing the result XDR, making it hard to obtain through the raw API result. A helper would come in handy.

(2) still needs to be implemented

Contributor guide

Research direction
Implement a helper function to extract the claimable balance ID from the transaction result XDR, similar to the pre submission helper in js stellar base. Study the transaction result structure and XDR parsing.
Tech stack
typescript
Domain
apiblockchain
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.
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
GitTypeScriptStellar SDK basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70