Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The response docs of /rgbpp/v1/address/{btc_address}/activity is incomplete #191

Closed
Flouse opened this issue Jul 11, 2024 · 0 comments · Fixed by #192
Closed

The response docs of /rgbpp/v1/address/{btc_address}/activity is incomplete #191

Flouse opened this issue Jul 11, 2024 · 0 comments · Fixed by #192
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Flouse
Copy link
Contributor

Flouse commented Jul 11, 2024

image snapshot of https://api.testnet.rgbpp.io/docs/static/index.html#/RGB%2B%2B/get_rgbpp_v1_address__btc_address__activity

Expect

interface RgbppApiActivity {
  address: string;
  cursor: string;
  txs: {
    btcTx: BtcApiTransaction;
    isRgbpp: boolean;
    isomorphicTx?: {
      ckbRawTx?: CKBComponents.RawTransaction;
      ckbTx?: CKBComponents.Transaction;
      inputs?: CKBComponents.CellOutput[];
      outputs?: CKBComponents.CellOutput[];
      status: {
        confirmed: boolean;
      };
    };
  }[];
}

Without the complete documentation, developers integrating with this API may have difficulty understanding the expected response format and properly parsing the data.

@Flouse Flouse added the documentation Improvements or additions to documentation label Jul 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants