Skip to content

Update spec/ to mina-sdk-spec v0.1.2 #31

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.

Sign up for GitHub

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

Merged
dkijania merged 1 commit into from
Oct 2, 2026
Merged

Update spec/ to mina-sdk-spec v0.1.2 #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added
- The common API of the Mina SDKs, from
[mina-sdk-spec](https://github.com/o1-labs/mina-sdk-spec) v0.1.0: `spec/`
[mina-sdk-spec](https://github.com/o1-labs/mina-sdk-spec) v0.1.2: `spec/`
is a copy at the tag in `spec/VERSION`. `tests/test_spec.py` checks that
the query strings are the specification's documents, and a CI job checks
that `spec/` is the tag's copy.
Expand All @@ -33,7 +33,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
numbers (one request at a time, a new auth after HTTP 412) and no repeat
after a transport error. It covers every operation of
`spec/itn-operations.graphql`, as the Rust, Go and JS SDKs do.
- `spec/` is mina-sdk-spec v0.1.1.
- Integration tests of the new methods.
- `DaemonConnectionError` exception (replaces shadowed `ConnectionError`)
- `Currency.__rmul__` for `3 * Currency(10)` support
Expand Down
24 changes: 12 additions & 12 deletions spec/ITN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ ITN server (schema `Mina_graphql.schema_itn`, see
schedule payments and zkApp commands, read internal logs, change connection
gating and stop the daemon.

The Rust, Go and JS SDKs have the same ITN client; `mina-sdk-python` has no
ITN client yet (– in the Python column). This document and
The Mina SDKs have the same ITN client (Python: `mina_sdk.itn`, with the
extra `mina-sdk[itn]`). This document and
[`itn-operations.graphql`](itn-operations.graphql) define it. The rules of
[`SPEC.md`](SPEC.md) apply: each method sends one named operation, and
nullable variables are always sent, as null when the caller omits them.
Expand Down Expand Up @@ -46,16 +46,16 @@ A client must:

| Operation | Rust | Go | JS | Python | Arguments | Returns |
|:--|:--|:--|:--|:--|:--|:--|
| `Auth` | `auth` | `Auth` | `auth` | – | – | server UUID, sequence number, libp2p port, peer ID, block producer flag |
| `SlotsWon` | `slots_won` | `SlotsWon` | `slotsWon` | – | – | list of global slots |
| `InternalLogs` | `internal_logs` | `InternalLogs` | `internalLogs` | – | start log ID | list of logs (`id`, `timestamp`, `message`, `metadata` (`item`, `value`), `process?`) |
| `FlushInternalLogs` | `flush_internal_logs` | `FlushInternalLogs` | `flushInternalLogs` | – | end log ID | string |
| `SchedulePayments` | `schedule_payments` | `SchedulePayments` | `schedulePayments` | – | `PaymentsDetails` | handle |
| `ScheduleZkappCommands` | `schedule_zkapp_commands` | `ScheduleZkappCommands` | `scheduleZkappCommands` | – | `ZkappCommandsDetails` | handle |
| `StopScheduledTransactions` | `stop_scheduled_transactions` | `StopScheduledTransactions` | `stopScheduledTransactions` | – | handle | string |
| `UpdateGating` | `update_gating` | `UpdateGating` | `updateGating` | – | `GatingUpdate` | string |
| `StopDaemon` | `stop_daemon` | `StopDaemon` | `stopDaemon` | – | [delay seconds], [clean config] | string |
| `ZkappCommandLimit` | `set_zkapp_command_limit` | `SetZkappCommandLimit` | `setZkappCommandLimit` | – | limit or null | limit now in force |
| `Auth` | `auth` | `Auth` | `auth` | `auth` | – | server UUID, sequence number, libp2p port, peer ID, block producer flag |
| `SlotsWon` | `slots_won` | `SlotsWon` | `slotsWon` | `slots_won` | – | list of global slots |
| `InternalLogs` | `internal_logs` | `InternalLogs` | `internalLogs` | `internal_logs` | start log ID | list of logs (`id`, `timestamp`, `message`, `metadata` (`item`, `value`), `process?`) |
| `FlushInternalLogs` | `flush_internal_logs` | `FlushInternalLogs` | `flushInternalLogs` | `flush_internal_logs` | end log ID | string |
| `SchedulePayments` | `schedule_payments` | `SchedulePayments` | `schedulePayments` | `schedule_payments` | `PaymentsDetails` | handle |
| `ScheduleZkappCommands` | `schedule_zkapp_commands` | `ScheduleZkappCommands` | `scheduleZkappCommands` | `schedule_zkapp_commands` | `ZkappCommandsDetails` | handle |
| `StopScheduledTransactions` | `stop_scheduled_transactions` | `StopScheduledTransactions` | `stopScheduledTransactions` | `stop_scheduled_transactions` | handle | string |
| `UpdateGating` | `update_gating` | `UpdateGating` | `updateGating` | `update_gating` | `GatingUpdate` | string |
| `StopDaemon` | `stop_daemon` | `StopDaemon` | `stopDaemon` | `stop_daemon` | [delay seconds], [clean config] | string |
| `ZkappCommandLimit` | `set_zkapp_command_limit` | `SetZkappCommandLimit` | `setZkappCommandLimit` | `set_zkapp_command_limit` | limit or null | limit now in force |

The input types `PaymentsDetails`, `ZkappCommandsDetails` and `GatingUpdate`
have the fields of [`schema/itn.graphql`](https://github.com/o1-labs/mina-sdk-spec/blob/main/schema/itn.graphql). Every SDK also
Expand Down
2 changes: 1 addition & 1 deletion spec/VERSION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v0.1.1
v0.1.2
Loading