Skip to content

v0.5.1

Latest

Choose a tag to compare

@rcarback rcarback released this 04 Nov 08:16
· 15 commits to main since this release

v0.5.1 corrects what v0.5.0 says about itself. Deprecated names keep working through 0.5.x and now say they are removed in v0.6.0, the book pages that described the removed Python VM now describe the Rust VM, and a new guide covers migrating from 0.4 to 0.5. No API, bytecode, VM behaviour or CLI flag changes.

Highlights

  • Migrating from 0.4 to 0.5 lists each breaking change in 0.5.0 as old to new: the Python VM and its types, the typed xqffi model API, xqcp domains, the solver classes, registry and metadata, custom Solver subclasses, and the verifier and step-metering changes.
  • The Running page now describes xquad.vm.VM: XqmxSample refuses an out-of-domain value, run() raises TypeError for an unsupported calldata element, and an out-of-domain SETLINE or ADDLINE faults with SampleOutOfDomain.
  • The Running page and the xqffi README name the faults the model types raise: InvalidAllocation and IndexOutOfBounds, where they said ValueError and IndexError. The energy page names XqmxModel.energy.

Behaviour changes

  • Deprecation warnings that named v0.5.0, the mode= warning, and the stderr line of the old CLI commands now say v0.6.0. A test that matches the old text needs updating.

Deprecations

Nothing is newly deprecated. Each of these still works, and each is removed in v0.6.0:

  • The flat Quip names on xqsa and xquad.sa: use the same names on xqsa.quip or xquad.sa.quip.
  • The xqsa.quip_codec, quip_signing, quip_metadata, quip_faucet and quip_networks modules: use xqsa.quip.codec, .signing, .metadata, .faucet and .networks.
  • xquad asm, dism, run and verify: use xquad vm asm, dis, run and check.
  • QuipUnconfirmedError and the unconfirmed order state: replaced by QuipSubmitIncompleteError and sending.
  • xqsa.quip.signing.SIGNED_EXTENSIONS: the order comes from the runtime metadata.
  • SolverQuip.quote, status, query and mode=, and the other entries in the book's Deprecated APIs table, which names the replacement where one exists.

Packages

Registry Packages
crates.io xqvm · xqasm
PyPI xquad · xqsa · xqcp · xqffi
pip install xquad==0.5.1

Documentation: developers.quip.network/docs/xquad

Full changelog (4 changes)

Documentation

  • book: Add the migration guide from 0.4 to 0.5
  • Describe the one-VM tree and name v0.6.0 for deprecations

Fixed

  • xquad: Say the old top-level commands are removed in v0.6.0
  • xqsa: Say the deprecated Quip names are removed in v0.6.0

Full diff: v0.5.0...v0.5.1