Skip to content

Conversation

@camfairchild
Copy link
Contributor

@camfairchild camfairchild commented Jan 15, 2025

Description

This PR changes the runtime APIs to only use the actual types they are expecting, instead of encoding/decoding to Vec<u8>.
This means we can decode runtime API results using just the chain metadata, so we can more easily support future changes to the APIs.
This breaks old clients, but the timing with RAO makes it worthwhile, as old clients will break anyway.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Other (please describe):

Breaking Change

Clients upgrading should be grabbing their type information from the V15 Metadata on the chain.
They should also be able to see these runtime APIs listed there, with their expected input and output types, and the encoding for said types.

Checklist

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have run cargo fmt and cargo clippy to ensure my code is formatted and linted correctly
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@camfairchild camfairchild marked this pull request as ready for review January 17, 2025 17:54
@camfairchild camfairchild requested a review from unconst as a code owner January 17, 2025 17:54
@sam0x17 sam0x17 added the skip-cargo-audit This PR fails cargo audit but needs to be merged anyway label Jan 21, 2025
@camfairchild camfairchild added the breaking-change This PR introduces a noteworthy breaking change label Jan 27, 2025
@github-actions
Copy link
Contributor

@opentensor/cerebrum / @opentensor/gyrus / @opentensor/cortex breaking change detected! Please prepare accordingly!

@camfairchild
Copy link
Contributor Author

We'll hold on merging this until bittensor/btcli publish the impl

@JohnReedV JohnReedV mentioned this pull request Jan 28, 2025
@camfairchild camfairchild force-pushed the feat/no-more-weird-runtime-api-encoding branch from 54959f3 to 97be330 Compare February 3, 2025 18:15
@camfairchild camfairchild deleted the feat/no-more-weird-runtime-api-encoding branch February 3, 2025 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking-change This PR introduces a noteworthy breaking change do not merge skip-cargo-audit This PR fails cargo audit but needs to be merged anyway

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants