mppi-provider 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- mppi_provider-0.1.0/.gitignore +17 -0
- mppi_provider-0.1.0/LICENSE +202 -0
- mppi_provider-0.1.0/PKG-INFO +149 -0
- mppi_provider-0.1.0/README.md +139 -0
- mppi_provider-0.1.0/pyproject.toml +16 -0
- mppi_provider-0.1.0/src/mppi_provider/__init__.py +81 -0
- mppi_provider-0.1.0/src/mppi_provider/config.py +653 -0
- mppi_provider-0.1.0/src/mppi_provider/discovery.py +99 -0
- mppi_provider-0.1.0/src/mppi_provider/hooks.py +24 -0
- mppi_provider-0.1.0/src/mppi_provider/interfaces.py +171 -0
- mppi_provider-0.1.0/src/mppi_provider/py.typed +0 -0
- mppi_provider-0.1.0/src/mppi_provider/runtime.py +2561 -0
- mppi_provider-0.1.0/tests/test_provider_config.py +239 -0
- mppi_provider-0.1.0/tests/test_provider_discovery.py +164 -0
- mppi_provider-0.1.0/tests/test_provider_foundation.py +9 -0
- mppi_provider-0.1.0/tests/test_provider_runtime.py +3177 -0
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: mppi-provider
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: MPPI provider SDK: typed payment interfaces and exact primitives
|
|
5
|
+
License-Expression: Apache-2.0
|
|
6
|
+
License-File: LICENSE
|
|
7
|
+
Requires-Python: >=3.12
|
|
8
|
+
Requires-Dist: mppi-protocol==0.1.0
|
|
9
|
+
Description-Content-Type: text/markdown
|
|
10
|
+
|
|
11
|
+
# MPPI provider SDK for Python
|
|
12
|
+
|
|
13
|
+
Version `0.1.0` supplies validated configuration, discovery, exact payment
|
|
14
|
+
arithmetic, canonical chain evidence and native Complete/Control services.
|
|
15
|
+
The Python runtime supports the paid request loop described below. Production
|
|
16
|
+
release remains pending. Shared registry
|
|
17
|
+
helpers and the Circle developer-controlled wallet adapter support provider
|
|
18
|
+
setup and submission, verified through live Arc testnet registration, recipient
|
|
19
|
+
binding, catalog publication, capture and close. The shared native
|
|
20
|
+
[provider CLI](../../../docs/rust-cli.md) ships in the Rust package and supports
|
|
21
|
+
Python integrations.
|
|
22
|
+
|
|
23
|
+
Start with the [Python installation and paid-exchange walkthrough](../../../docs/python-quickstart.md).
|
|
24
|
+
See [onboarding and wallets](../../../docs/python-onboarding.md) for the operator
|
|
25
|
+
wallet, recipient proof, publication sequence and completed-rerun checks.
|
|
26
|
+
|
|
27
|
+
```python
|
|
28
|
+
from mppi_provider import CatalogRow, Rates, publish_catalog
|
|
29
|
+
|
|
30
|
+
catalog = publish_catalog([CatalogRow("example/model", Rates(input=1_000_000, output=3_000_000))])
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
The provider supplies counts, requirements and definitive outcomes. MPPI computes
|
|
34
|
+
and validates their payment meaning. Catalog publication here produces bytes;
|
|
35
|
+
it does not make a registry transaction. Pure calculation helpers return immutable
|
|
36
|
+
results. The runtime retains live payment state and signals the provider's execution
|
|
37
|
+
hook when further work is no longer authorized.
|
|
38
|
+
|
|
39
|
+
See [SDK interface definitions](../../../docs/sdk-interfaces.md) and the
|
|
40
|
+
[protocol profile](../../../docs/protocol.md).
|
|
41
|
+
|
|
42
|
+
The [runtime reference](../../../docs/python-runtime.md) includes configuration,
|
|
43
|
+
HTTP host integration and evidence requirements.
|
|
44
|
+
|
|
45
|
+
## Embedded provider runtime
|
|
46
|
+
|
|
47
|
+
Construct `mppi_provider.runtime.Mppi(config, chain=..., contract=..., wallet=...,
|
|
48
|
+
coverage=..., execution=...)` on the serving event-loop thread. Supply:
|
|
49
|
+
|
|
50
|
+
- `ProviderConfig`: validated applied declarations and provider-selected timings.
|
|
51
|
+
- `ChainFollower`: the shared follower of the selected verified deployment.
|
|
52
|
+
Its freshness and collection-margin timings must equal the validated config.
|
|
53
|
+
- `ContractCalls`: the same MPPI domain and verified USDC funding domain.
|
|
54
|
+
- `TransactionWallet`: the configured provider operator's execution capability.
|
|
55
|
+
- `coverage`: an async callable `(PreparedRequest, RunContext) -> TokenCounts`.
|
|
56
|
+
Return the prepared prefill bound and at least the configured actual output
|
|
57
|
+
buffer; preparation performs no paid inference.
|
|
58
|
+
- `execution`: an async iterator callable `(PreparedRequest, RunContext,
|
|
59
|
+
ProviderRuns, asyncio.Event) -> AsyncIterator[bytes]`. It yields original JSON
|
|
60
|
+
objects after the provider removes any upstream framing.
|
|
61
|
+
|
|
62
|
+
Unauthenticated Control setup expires after 60 seconds. The optional constructor
|
|
63
|
+
keyword `control_auth_timeout` sets a positive timeout in seconds, up to 3,600.
|
|
64
|
+
Only successful signed session attachment removes this deadline; challenges and
|
|
65
|
+
opening notices do not extend it. Authenticated Control streams may remain open.
|
|
66
|
+
This server policy is independent of `payment.authorization_wait_ms` and applies
|
|
67
|
+
even when a client omits its own RPC deadline.
|
|
68
|
+
|
|
69
|
+
The execution integration uses `report_usage(context, cumulative_counts)` and
|
|
70
|
+
`report_terminal(context, final_counts, RunStatus)` to supply facts. MPPI measures
|
|
71
|
+
no tokens. A definitive final must follow actual provider-reported termination;
|
|
72
|
+
iterator EOF, a disconnect and a cancellation signal do not substitute for it.
|
|
73
|
+
For an upstream application error, report definitive FAILED usage when known and
|
|
74
|
+
raise `UpstreamFailure(original_json_bytes, http_status=...)`.
|
|
75
|
+
|
|
76
|
+
`require_coverage(context, remaining_tokens)` requests a complete desired remaining
|
|
77
|
+
bound at the admitted run prices. It grants only when the combined session target
|
|
78
|
+
fits the accepted voucher and confirmed deposit. An already larger reservation
|
|
79
|
+
is retained. Only definitive final accounting releases unused coverage. During
|
|
80
|
+
ordinary decode, report usage early enough for asynchronous voucher renewal,
|
|
81
|
+
then request the next rolling output bound before consuming unreserved work.
|
|
82
|
+
A rejected grant sets the event passed to execution. The provider terminates
|
|
83
|
+
its actual job and reports final usage; a later voucher does not restart it.
|
|
84
|
+
|
|
85
|
+
Pass `mppi_protocol.wire.GRPC_OPTIONS` when creating the host's `grpc.aio.server`.
|
|
86
|
+
Call `register_grpc(server)` before starting that server, then await `start()` and
|
|
87
|
+
check its `Readiness`. Publish `discovery(path)` responses through the host's
|
|
88
|
+
HTTP stack on the same HTTPS origin. The host supplies TLS credentials, ingress
|
|
89
|
+
and listener lifecycle. MPPI starts no listener and does not serve keyed `/v1`.
|
|
90
|
+
An unavailable chain at startup returns not-ready while the follower retries.
|
|
91
|
+
Discovery and the first-use baseline become available only after fresh identity
|
|
92
|
+
evidence arrives; an outage does not establish empty session history.
|
|
93
|
+
|
|
94
|
+
`sessions.settle(id)` captures cumulative actual usage and keeps the session open.
|
|
95
|
+
`sessions.close(id)` preserves close intent, requests termination and verifies
|
|
96
|
+
canonical closure before returning a confirmed result. Pending/unknown calls
|
|
97
|
+
retain their original transaction identity; repeated calls reconcile it. The
|
|
98
|
+
close intent has its own stable reference; confirming an earlier capture does
|
|
99
|
+
not report that close as confirmed. The
|
|
100
|
+
background schedule groups collection requests. `settleBatch(session_ids)`
|
|
101
|
+
simulates the exact ordered call before wallet submission and reconciles each
|
|
102
|
+
target independently. Unknown submission outcomes preserve their original
|
|
103
|
+
identity; they never trigger a replacement capture.
|
|
104
|
+
|
|
105
|
+
Call `shutdown(deadline)` with an absolute serving-loop monotonic deadline.
|
|
106
|
+
It stops new grants, signals execution, processes available final reports and
|
|
107
|
+
returns unresolved runs/operations. The caller stops its own gRPC server.
|
|
108
|
+
Shutdown does not initiate escrow closure or invent final reports.
|
|
109
|
+
|
|
110
|
+
## Payment-state ownership and recovery
|
|
111
|
+
|
|
112
|
+
One `Mppi` instance holds the authoritative live payment state for its sessions.
|
|
113
|
+
Its Complete and Control handlers may receive different backend connections;
|
|
114
|
+
socket equality grants no authority. The provider must ensure every operation
|
|
115
|
+
uses that same authoritative state. Independent processes do not share payment
|
|
116
|
+
state through this SDK. Routing, worker coordination, durability and recovery
|
|
117
|
+
remain provider responsibilities.
|
|
118
|
+
|
|
119
|
+
A newly observed opening after startup can create first-use state under that
|
|
120
|
+
ownership requirement. A historical opening after restart cannot establish zero
|
|
121
|
+
usage. `await sessions.checkpoint(session_id)` exports detached
|
|
122
|
+
`RecoveryEvidence` for provider-owned retention. `await sessions.recover(evidence)`
|
|
123
|
+
revalidates the supplied run proofs, exact prices, accounting, reservations and
|
|
124
|
+
canonical chain evidence before installing state. Missing private history returns
|
|
125
|
+
`STATE_UNAVAILABLE`; invalid recovery leaves existing state unchanged. Recovery
|
|
126
|
+
requires fresh Control authentication and never resumes old execution.
|
|
127
|
+
Unresolved old execution prevents a ready replacement attachment.
|
|
128
|
+
|
|
129
|
+
A known opening before its first authenticated attachment can be checkpointed
|
|
130
|
+
at generation zero. This private evidence has no accepted voucher, usage, runs
|
|
131
|
+
or reservations and remains unready. The provider must retain complete history;
|
|
132
|
+
zero on-chain settlement alone cannot establish that it was unused. Recovery
|
|
133
|
+
preserves any refund-only close intent and assigns no owner. Fresh authentication
|
|
134
|
+
creates generation one; generation-zero snapshots are never valid on Control.
|
|
135
|
+
|
|
136
|
+
Wallet adapters must durably bind an operation reference to its exact intended
|
|
137
|
+
call and retain available wallet/transaction identifiers. These requirements do
|
|
138
|
+
not add a provider database. The agent SDK supplies its own local checkpoint.
|
|
139
|
+
The shared Circle developer-controlled wallet adapter and registry helpers
|
|
140
|
+
provide the implemented onboarding and submission integration described above.
|
|
141
|
+
|
|
142
|
+
## Lifecycle observers
|
|
143
|
+
|
|
144
|
+
Pass `hooks=Hooks(...)` to the runtime/client for typed lifecycle observations.
|
|
145
|
+
See the [hook payloads, ordering and bounds](../../../docs/lifecycle-hooks.md).
|
|
146
|
+
|
|
147
|
+
## License
|
|
148
|
+
|
|
149
|
+
Copyright 2026 MPPI contributors. Licensed under the [Apache License, Version 2.0](LICENSE).
|
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
# MPPI provider SDK for Python
|
|
2
|
+
|
|
3
|
+
Version `0.1.0` supplies validated configuration, discovery, exact payment
|
|
4
|
+
arithmetic, canonical chain evidence and native Complete/Control services.
|
|
5
|
+
The Python runtime supports the paid request loop described below. Production
|
|
6
|
+
release remains pending. Shared registry
|
|
7
|
+
helpers and the Circle developer-controlled wallet adapter support provider
|
|
8
|
+
setup and submission, verified through live Arc testnet registration, recipient
|
|
9
|
+
binding, catalog publication, capture and close. The shared native
|
|
10
|
+
[provider CLI](../../../docs/rust-cli.md) ships in the Rust package and supports
|
|
11
|
+
Python integrations.
|
|
12
|
+
|
|
13
|
+
Start with the [Python installation and paid-exchange walkthrough](../../../docs/python-quickstart.md).
|
|
14
|
+
See [onboarding and wallets](../../../docs/python-onboarding.md) for the operator
|
|
15
|
+
wallet, recipient proof, publication sequence and completed-rerun checks.
|
|
16
|
+
|
|
17
|
+
```python
|
|
18
|
+
from mppi_provider import CatalogRow, Rates, publish_catalog
|
|
19
|
+
|
|
20
|
+
catalog = publish_catalog([CatalogRow("example/model", Rates(input=1_000_000, output=3_000_000))])
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
The provider supplies counts, requirements and definitive outcomes. MPPI computes
|
|
24
|
+
and validates their payment meaning. Catalog publication here produces bytes;
|
|
25
|
+
it does not make a registry transaction. Pure calculation helpers return immutable
|
|
26
|
+
results. The runtime retains live payment state and signals the provider's execution
|
|
27
|
+
hook when further work is no longer authorized.
|
|
28
|
+
|
|
29
|
+
See [SDK interface definitions](../../../docs/sdk-interfaces.md) and the
|
|
30
|
+
[protocol profile](../../../docs/protocol.md).
|
|
31
|
+
|
|
32
|
+
The [runtime reference](../../../docs/python-runtime.md) includes configuration,
|
|
33
|
+
HTTP host integration and evidence requirements.
|
|
34
|
+
|
|
35
|
+
## Embedded provider runtime
|
|
36
|
+
|
|
37
|
+
Construct `mppi_provider.runtime.Mppi(config, chain=..., contract=..., wallet=...,
|
|
38
|
+
coverage=..., execution=...)` on the serving event-loop thread. Supply:
|
|
39
|
+
|
|
40
|
+
- `ProviderConfig`: validated applied declarations and provider-selected timings.
|
|
41
|
+
- `ChainFollower`: the shared follower of the selected verified deployment.
|
|
42
|
+
Its freshness and collection-margin timings must equal the validated config.
|
|
43
|
+
- `ContractCalls`: the same MPPI domain and verified USDC funding domain.
|
|
44
|
+
- `TransactionWallet`: the configured provider operator's execution capability.
|
|
45
|
+
- `coverage`: an async callable `(PreparedRequest, RunContext) -> TokenCounts`.
|
|
46
|
+
Return the prepared prefill bound and at least the configured actual output
|
|
47
|
+
buffer; preparation performs no paid inference.
|
|
48
|
+
- `execution`: an async iterator callable `(PreparedRequest, RunContext,
|
|
49
|
+
ProviderRuns, asyncio.Event) -> AsyncIterator[bytes]`. It yields original JSON
|
|
50
|
+
objects after the provider removes any upstream framing.
|
|
51
|
+
|
|
52
|
+
Unauthenticated Control setup expires after 60 seconds. The optional constructor
|
|
53
|
+
keyword `control_auth_timeout` sets a positive timeout in seconds, up to 3,600.
|
|
54
|
+
Only successful signed session attachment removes this deadline; challenges and
|
|
55
|
+
opening notices do not extend it. Authenticated Control streams may remain open.
|
|
56
|
+
This server policy is independent of `payment.authorization_wait_ms` and applies
|
|
57
|
+
even when a client omits its own RPC deadline.
|
|
58
|
+
|
|
59
|
+
The execution integration uses `report_usage(context, cumulative_counts)` and
|
|
60
|
+
`report_terminal(context, final_counts, RunStatus)` to supply facts. MPPI measures
|
|
61
|
+
no tokens. A definitive final must follow actual provider-reported termination;
|
|
62
|
+
iterator EOF, a disconnect and a cancellation signal do not substitute for it.
|
|
63
|
+
For an upstream application error, report definitive FAILED usage when known and
|
|
64
|
+
raise `UpstreamFailure(original_json_bytes, http_status=...)`.
|
|
65
|
+
|
|
66
|
+
`require_coverage(context, remaining_tokens)` requests a complete desired remaining
|
|
67
|
+
bound at the admitted run prices. It grants only when the combined session target
|
|
68
|
+
fits the accepted voucher and confirmed deposit. An already larger reservation
|
|
69
|
+
is retained. Only definitive final accounting releases unused coverage. During
|
|
70
|
+
ordinary decode, report usage early enough for asynchronous voucher renewal,
|
|
71
|
+
then request the next rolling output bound before consuming unreserved work.
|
|
72
|
+
A rejected grant sets the event passed to execution. The provider terminates
|
|
73
|
+
its actual job and reports final usage; a later voucher does not restart it.
|
|
74
|
+
|
|
75
|
+
Pass `mppi_protocol.wire.GRPC_OPTIONS` when creating the host's `grpc.aio.server`.
|
|
76
|
+
Call `register_grpc(server)` before starting that server, then await `start()` and
|
|
77
|
+
check its `Readiness`. Publish `discovery(path)` responses through the host's
|
|
78
|
+
HTTP stack on the same HTTPS origin. The host supplies TLS credentials, ingress
|
|
79
|
+
and listener lifecycle. MPPI starts no listener and does not serve keyed `/v1`.
|
|
80
|
+
An unavailable chain at startup returns not-ready while the follower retries.
|
|
81
|
+
Discovery and the first-use baseline become available only after fresh identity
|
|
82
|
+
evidence arrives; an outage does not establish empty session history.
|
|
83
|
+
|
|
84
|
+
`sessions.settle(id)` captures cumulative actual usage and keeps the session open.
|
|
85
|
+
`sessions.close(id)` preserves close intent, requests termination and verifies
|
|
86
|
+
canonical closure before returning a confirmed result. Pending/unknown calls
|
|
87
|
+
retain their original transaction identity; repeated calls reconcile it. The
|
|
88
|
+
close intent has its own stable reference; confirming an earlier capture does
|
|
89
|
+
not report that close as confirmed. The
|
|
90
|
+
background schedule groups collection requests. `settleBatch(session_ids)`
|
|
91
|
+
simulates the exact ordered call before wallet submission and reconciles each
|
|
92
|
+
target independently. Unknown submission outcomes preserve their original
|
|
93
|
+
identity; they never trigger a replacement capture.
|
|
94
|
+
|
|
95
|
+
Call `shutdown(deadline)` with an absolute serving-loop monotonic deadline.
|
|
96
|
+
It stops new grants, signals execution, processes available final reports and
|
|
97
|
+
returns unresolved runs/operations. The caller stops its own gRPC server.
|
|
98
|
+
Shutdown does not initiate escrow closure or invent final reports.
|
|
99
|
+
|
|
100
|
+
## Payment-state ownership and recovery
|
|
101
|
+
|
|
102
|
+
One `Mppi` instance holds the authoritative live payment state for its sessions.
|
|
103
|
+
Its Complete and Control handlers may receive different backend connections;
|
|
104
|
+
socket equality grants no authority. The provider must ensure every operation
|
|
105
|
+
uses that same authoritative state. Independent processes do not share payment
|
|
106
|
+
state through this SDK. Routing, worker coordination, durability and recovery
|
|
107
|
+
remain provider responsibilities.
|
|
108
|
+
|
|
109
|
+
A newly observed opening after startup can create first-use state under that
|
|
110
|
+
ownership requirement. A historical opening after restart cannot establish zero
|
|
111
|
+
usage. `await sessions.checkpoint(session_id)` exports detached
|
|
112
|
+
`RecoveryEvidence` for provider-owned retention. `await sessions.recover(evidence)`
|
|
113
|
+
revalidates the supplied run proofs, exact prices, accounting, reservations and
|
|
114
|
+
canonical chain evidence before installing state. Missing private history returns
|
|
115
|
+
`STATE_UNAVAILABLE`; invalid recovery leaves existing state unchanged. Recovery
|
|
116
|
+
requires fresh Control authentication and never resumes old execution.
|
|
117
|
+
Unresolved old execution prevents a ready replacement attachment.
|
|
118
|
+
|
|
119
|
+
A known opening before its first authenticated attachment can be checkpointed
|
|
120
|
+
at generation zero. This private evidence has no accepted voucher, usage, runs
|
|
121
|
+
or reservations and remains unready. The provider must retain complete history;
|
|
122
|
+
zero on-chain settlement alone cannot establish that it was unused. Recovery
|
|
123
|
+
preserves any refund-only close intent and assigns no owner. Fresh authentication
|
|
124
|
+
creates generation one; generation-zero snapshots are never valid on Control.
|
|
125
|
+
|
|
126
|
+
Wallet adapters must durably bind an operation reference to its exact intended
|
|
127
|
+
call and retain available wallet/transaction identifiers. These requirements do
|
|
128
|
+
not add a provider database. The agent SDK supplies its own local checkpoint.
|
|
129
|
+
The shared Circle developer-controlled wallet adapter and registry helpers
|
|
130
|
+
provide the implemented onboarding and submission integration described above.
|
|
131
|
+
|
|
132
|
+
## Lifecycle observers
|
|
133
|
+
|
|
134
|
+
Pass `hooks=Hooks(...)` to the runtime/client for typed lifecycle observations.
|
|
135
|
+
See the [hook payloads, ordering and bounds](../../../docs/lifecycle-hooks.md).
|
|
136
|
+
|
|
137
|
+
## License
|
|
138
|
+
|
|
139
|
+
Copyright 2026 MPPI contributors. Licensed under the [Apache License, Version 2.0](LICENSE).
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling==1.32.4"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "mppi-provider"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
license = "Apache-2.0"
|
|
9
|
+
license-files = ["LICENSE"]
|
|
10
|
+
description = "MPPI provider SDK: typed payment interfaces and exact primitives"
|
|
11
|
+
readme = "README.md"
|
|
12
|
+
requires-python = ">=3.12"
|
|
13
|
+
dependencies = ["mppi-protocol==0.1.0"]
|
|
14
|
+
|
|
15
|
+
[tool.hatch.build.targets.wheel]
|
|
16
|
+
packages = ["src/mppi_provider"]
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
"""MPPI provider payment runtime and public integration contracts."""
|
|
2
|
+
|
|
3
|
+
from mppi_protocol import (
|
|
4
|
+
CatalogRow,
|
|
5
|
+
Rates,
|
|
6
|
+
RunAccounting,
|
|
7
|
+
RunStatus,
|
|
8
|
+
TokenCounts,
|
|
9
|
+
cumulative_usage,
|
|
10
|
+
publish_catalog,
|
|
11
|
+
report_transition,
|
|
12
|
+
required_coverage,
|
|
13
|
+
)
|
|
14
|
+
|
|
15
|
+
from .config import (
|
|
16
|
+
AdditionalService,
|
|
17
|
+
ChainConfig,
|
|
18
|
+
ConfigError,
|
|
19
|
+
ListenerConfig,
|
|
20
|
+
ModelConfig,
|
|
21
|
+
PaymentConfig,
|
|
22
|
+
ProviderConfig,
|
|
23
|
+
ProviderDetails,
|
|
24
|
+
ProviderIdentityConfig,
|
|
25
|
+
SettlementConfig,
|
|
26
|
+
UpstreamConfig,
|
|
27
|
+
)
|
|
28
|
+
from .discovery import DiscoveryDocuments
|
|
29
|
+
from .hooks import HookError, Hooks, ObserverStats
|
|
30
|
+
from .interfaces import (
|
|
31
|
+
CoverageProvider,
|
|
32
|
+
ExecutionProvider,
|
|
33
|
+
FinalAccountingResult,
|
|
34
|
+
PreparedRequest,
|
|
35
|
+
ProviderLifecycle,
|
|
36
|
+
ProviderRuns,
|
|
37
|
+
ProviderSessions,
|
|
38
|
+
RecoveryEvidence,
|
|
39
|
+
RecoveryOperation,
|
|
40
|
+
RecoveryRun,
|
|
41
|
+
)
|
|
42
|
+
from .runtime import Mppi, UpstreamFailure
|
|
43
|
+
|
|
44
|
+
__all__ = [
|
|
45
|
+
"HookError",
|
|
46
|
+
"Hooks",
|
|
47
|
+
"ObserverStats",
|
|
48
|
+
"AdditionalService",
|
|
49
|
+
"ChainConfig",
|
|
50
|
+
"ConfigError",
|
|
51
|
+
"DiscoveryDocuments",
|
|
52
|
+
"ListenerConfig",
|
|
53
|
+
"ModelConfig",
|
|
54
|
+
"PaymentConfig",
|
|
55
|
+
"ProviderConfig",
|
|
56
|
+
"ProviderDetails",
|
|
57
|
+
"ProviderIdentityConfig",
|
|
58
|
+
"SettlementConfig",
|
|
59
|
+
"UpstreamConfig",
|
|
60
|
+
"CatalogRow",
|
|
61
|
+
"CoverageProvider",
|
|
62
|
+
"ExecutionProvider",
|
|
63
|
+
"FinalAccountingResult",
|
|
64
|
+
"Mppi",
|
|
65
|
+
"PreparedRequest",
|
|
66
|
+
"ProviderLifecycle",
|
|
67
|
+
"ProviderRuns",
|
|
68
|
+
"ProviderSessions",
|
|
69
|
+
"RecoveryEvidence",
|
|
70
|
+
"RecoveryOperation",
|
|
71
|
+
"RecoveryRun",
|
|
72
|
+
"Rates",
|
|
73
|
+
"RunAccounting",
|
|
74
|
+
"RunStatus",
|
|
75
|
+
"TokenCounts",
|
|
76
|
+
"UpstreamFailure",
|
|
77
|
+
"cumulative_usage",
|
|
78
|
+
"publish_catalog",
|
|
79
|
+
"report_transition",
|
|
80
|
+
"required_coverage",
|
|
81
|
+
]
|