synapse-filecoin-sdk 0.1.0__tar.gz

synapse_filecoin_sdk-0.1.0/.github/workflows/publish-pypi.yml

@@ -0,0 +1,51 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Build distribution artifacts
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+          python -m build
+          twine check dist/*
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    environment:
+      name: pypi
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

synapse_filecoin_sdk-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+__pycache__/
+*.pyc
+*.pyo
+*.pyd
+*.egg-info/
+dist/
+build/
+.venv/
+.pytest_cache/
+.DS_Store

synapse_filecoin_sdk-0.1.0/LICENSE.md

@@ -0,0 +1,228 @@
+The contents of this repository are Copyright (c) corresponding authors and
+contributors, licensed under the `Permissive License Stack` meaning either of:
+
+- Apache-2.0 Software License: <https://www.apache.org/licenses/LICENSE-2.0>
+- MIT Software License: <https://opensource.org/licenses/MIT>
+
+You may not use the contents of this repository except in compliance
+with one of the listed Licenses. For an extended clarification of the
+intent behind the choice of Licensing please refer to
+[Permissive License Stack](https://web.archive.org/web/20241127162157/https://www.protocol.ai/blog/announcing-the-permissive-license-stack/).
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the terms listed in this notice is distributed on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+either express or implied. See each License for the specific language
+governing permissions and limitations under that License.
+
+<!--- SPDX-License-Identifier: Apache-2.0 OR MIT -->
+`SPDX-License-Identifier: Apache-2.0 OR MIT`
+
+Verbatim copies of both licenses are included below:
+
+<details><summary>Apache-2.0 Software License</summary>
+
+```text
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+```
+
+</details>
+
+<details><summary>MIT Software License</summary>
+
+```text
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+```
+
+</details>

synapse_filecoin_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: synapse-filecoin-sdk
+Version: 0.1.0
+Summary: Python SDK for Filecoin Onchain Cloud (Synapse)
+Project-URL: Homepage, https://github.com/FilOzone/synapse-sdk
+Project-URL: Repository, https://github.com/FilOzone/synapse-sdk
+Author: FilOz / Data Preservation Programs
+License: Apache-2.0 OR MIT
+License-File: LICENSE.md
+Keywords: filecoin,pdp,storage,synapse,web3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Requires-Dist: httpx<0.28.0,>=0.25.0
+Requires-Dist: multiformats<0.4.0,>=0.3.1
+Requires-Dist: web3<7,>=6.0.0
+Provides-Extra: test
+Requires-Dist: pytest-asyncio<0.24,>=0.23.0; extra == 'test'
+Requires-Dist: pytest<9,>=8.0.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# Pynapse
+
+Python SDK for Filecoin Onchain Cloud (Synapse).
+
+This project mirrors the JS SDK in `FilOzone/synapse-sdk` and references the Go implementation in `data-preservation-programs/go-synapse` for parity.
+
+## Status
+
+Work in progress. Parity is being implemented in incremental commits.
+
+## Install (dev)
+
+```bash
+uv venv
+uv pip install -e .[test]
+```
+
+PyPI package name: `synapse-filecoin-sdk`  
+Python import: `pynapse`
+
+## Install (PyPI)
+
+```bash
+pip install synapse-filecoin-sdk
+```
+
+## CommP / PieceCID
+
+`pynapse` uses `stream-commp` from `go-fil-commp-hashhash` for PieceCID calculation.
+Set `PYNAPSE_COMMP_HELPER` to override the helper path.
+
+## License
+
+Dual-licensed under Apache-2.0 OR MIT. See `LICENSE.md`.
+
+## Publishing to PyPI
+
+Publishing is automated via GitHub Actions in `.github/workflows/publish-pypi.yml`.
+
+1. In PyPI, create the project (or use an existing one) and configure a Trusted Publisher for this GitHub repository and workflow.
+2. In GitHub, optionally protect the `pypi` environment for manual approval.
+3. Tag a release and push the tag:
+
+```bash
+git tag v0.1.1
+git push origin v0.1.1
+```
+
+The workflow builds the package, runs `twine check`, and publishes to PyPI via OIDC (no API token required).

synapse_filecoin_sdk-0.1.0/QUICKSTART.md

@@ -0,0 +1,272 @@
+# pynapse Quickstart - Upload to Filecoin Calibration Testnet
+
+## Prerequisites
+
+1. **Python 3.11+** with venv
+2. **Go** (to build stream-commp helper)
+3. **Test wallet** with:
+   - tFIL for gas (get from faucet: https://faucet.calibnet.chainsafe-fil.io/)
+   - USDFC for storage payments (get from https://stg.usdfc.net - mint by depositing tFIL)
+
+---
+
+## Step 1: Clone and Setup
+
+```bash
+# Clone pynapse
+git clone https://github.com/anjor/pynapse.git
+cd pynapse
+
+# Create venv and install from PyPI
+python3 -m venv .venv
+source .venv/bin/activate
+pip install synapse-filecoin-sdk
+```
+
+## Step 2: Build stream-commp Helper
+
+pynapse needs `stream-commp` to calculate Filecoin piece commitments:
+
+```bash
+# Clone and build
+cd /tmp
+git clone https://github.com/filecoin-project/go-fil-commp-hashhash.git
+cd go-fil-commp-hashhash/cmd/stream-commp
+go build -o stream-commp .
+
+# Install to your PATH (pick one)
+sudo cp stream-commp /usr/local/bin/
+# OR
+cp stream-commp ~/go/bin/  # if ~/go/bin is in PATH
+# OR
+export PYNAPSE_COMMP_HELPER=/tmp/go-fil-commp-hashhash/cmd/stream-commp/stream-commp
+```
+
+Verify: `stream-commp --help`
+
+## Step 3: Fund Your Wallet
+
+You need:
+- **tFIL** for gas (~1 tFIL is plenty)
+- **USDFC** for storage payments (~10-50 USDFC for testing)
+
+### Get tFIL
+Go to https://faucet.calibnet.chainsafe-fil.io/ and request tFIL for your wallet.
+
+### Get USDFC
+1. Go to https://stg.usdfc.net
+2. Connect wallet (Calibration network)
+3. Mint USDFC by depositing tFIL as collateral
+4. You'll get ~1.2x your deposit in USDFC
+
+## Step 4: Deposit USDFC & Approve Operator
+
+Before uploading, you need to:
+1. Approve USDFC spending by the Payments contract
+2. Deposit USDFC to the Payments contract
+3. Approve the FWSS operator
+
+Run this setup script (replace with your private key):
+
+```python
+import asyncio
+from web3 import AsyncWeb3
+
+# CONFIG - Replace these!
+PRIVATE_KEY = "0xYOUR_PRIVATE_KEY_HERE"
+RPC_URL = "https://api.calibration.node.glif.io/rpc/v1"
+
+# Contract addresses (Calibration)
+USDFC = "0xb3042734b608a1B16e9e86B374A3f3e389B4cDf0"
+PAYMENTS = "0x09a0fDc2723fAd1A7b8e3e00eE5DF73841df55a0"
+FWSS = "0x02925630df557F957f70E112bA06e50965417CA0"
+
+async def setup():
+    w3 = AsyncWeb3(AsyncWeb3.AsyncHTTPProvider(RPC_URL))
+    acct = w3.eth.account.from_key(PRIVATE_KEY)
+    print(f"Wallet: {acct.address}")
+    
+    # ERC20 ABI (minimal)
+    erc20_abi = [
+        {"inputs":[{"name":"spender","type":"address"},{"name":"amount","type":"uint256"}],"name":"approve","outputs":[{"type":"bool"}],"stateMutability":"nonpayable","type":"function"},
+        {"inputs":[{"name":"account","type":"address"}],"name":"balanceOf","outputs":[{"type":"uint256"}],"stateMutability":"view","type":"function"},
+    ]
+    
+    # Payments ABI (minimal)
+    payments_abi = [
+        {"inputs":[{"name":"token","type":"address"},{"name":"to","type":"address"},{"name":"amount","type":"uint256"}],"name":"deposit","outputs":[],"stateMutability":"nonpayable","type":"function"},
+        {"inputs":[{"name":"token","type":"address"},{"name":"account","type":"address"}],"name":"balanceOf","outputs":[{"type":"uint256"}],"stateMutability":"view","type":"function"},
+        {"inputs":[{"name":"operator","type":"address"},{"name":"approved","type":"bool"}],"name":"setOperatorApproval","outputs":[],"stateMutability":"nonpayable","type":"function"},
+        {"inputs":[{"name":"account","type":"address"},{"name":"operator","type":"address"}],"name":"isOperatorFor","outputs":[{"type":"bool"}],"stateMutability":"view","type":"function"},
+    ]
+    
+    usdfc = w3.eth.contract(address=USDFC, abi=erc20_abi)
+    payments = w3.eth.contract(address=PAYMENTS, abi=payments_abi)
+    
+    # Check balances
+    wallet_bal = await usdfc.functions.balanceOf(acct.address).call()
+    deposit_bal = await payments.functions.balanceOf(USDFC, acct.address).call()
+    print(f"USDFC in wallet: {wallet_bal / 1e18:.2f}")
+    print(f"USDFC deposited: {deposit_bal / 1e18:.2f}")
+    
+    # 1. Approve USDFC spending (if needed)
+    if wallet_bal > 0:
+        print("\n1. Approving USDFC for Payments contract...")
+        tx = await usdfc.functions.approve(PAYMENTS, 2**256 - 1).build_transaction({
+            'from': acct.address,
+            'nonce': await w3.eth.get_transaction_count(acct.address),
+            'gas': 100000,
+            'maxFeePerGas': await w3.eth.gas_price,
+            'maxPriorityFeePerGas': 1000000000,
+        })
+        signed = acct.sign_transaction(tx)
+        tx_hash = await w3.eth.send_raw_transaction(signed.raw_transaction)
+        await w3.eth.wait_for_transaction_receipt(tx_hash)
+        print(f"   Approved: {tx_hash.hex()}")
+    
+    # 2. Deposit USDFC (if wallet has balance)
+    if wallet_bal > 0:
+        deposit_amount = wallet_bal  # Deposit all
+        print(f"\n2. Depositing {deposit_amount / 1e18:.2f} USDFC...")
+        tx = await payments.functions.deposit(USDFC, acct.address, deposit_amount).build_transaction({
+            'from': acct.address,
+            'nonce': await w3.eth.get_transaction_count(acct.address),
+            'gas': 200000,
+            'maxFeePerGas': await w3.eth.gas_price,
+            'maxPriorityFeePerGas': 1000000000,
+        })
+        signed = acct.sign_transaction(tx)
+        tx_hash = await w3.eth.send_raw_transaction(signed.raw_transaction)
+        await w3.eth.wait_for_transaction_receipt(tx_hash)
+        print(f"   Deposited: {tx_hash.hex()}")
+    
+    # 3. Approve FWSS operator
+    is_approved = await payments.functions.isOperatorFor(acct.address, FWSS).call()
+    if not is_approved:
+        print("\n3. Approving FWSS operator...")
+        tx = await payments.functions.setOperatorApproval(FWSS, True).build_transaction({
+            'from': acct.address,
+            'nonce': await w3.eth.get_transaction_count(acct.address),
+            'gas': 100000,
+            'maxFeePerGas': await w3.eth.gas_price,
+            'maxPriorityFeePerGas': 1000000000,
+        })
+        signed = acct.sign_transaction(tx)
+        tx_hash = await w3.eth.send_raw_transaction(signed.raw_transaction)
+        await w3.eth.wait_for_transaction_receipt(tx_hash)
+        print(f"   Approved: {tx_hash.hex()}")
+    else:
+        print("\n3. FWSS operator already approved ✓")
+    
+    print("\n✅ Setup complete! Ready to upload.")
+
+asyncio.run(setup())
+```
+
+## Step 5: Upload a File!
+
+```python
+import asyncio
+from pynapse import AsyncSynapse
+
+PRIVATE_KEY = "0xYOUR_PRIVATE_KEY_HERE"
+
+async def upload_file():
+    # Connect to Calibration testnet
+    synapse = await AsyncSynapse.create(
+        rpc_url="https://api.calibration.node.glif.io/rpc/v1",
+        chain="calibration",
+        private_key=PRIVATE_KEY
+    )
+    print(f"Connected as {synapse.account}")
+    
+    # Get storage context (auto-selects provider)
+    ctx = await synapse.storage.get_context()
+    print(f"Using provider: {ctx.provider.name}")
+    print(f"Dataset ID: {ctx.data_set_id}")
+    
+    # Upload some data (min 256 bytes)
+    data = b"Hello, Filecoin! This is my first pynapse upload. " * 10
+    print(f"\nUploading {len(data)} bytes...")
+    
+    result = await ctx.upload(data)
+    
+    print(f"\n✅ Upload successful!")
+    print(f"   Piece CID: {result.piece_cid}")
+    print(f"   Size: {result.size} bytes")
+    print(f"   TX Hash: {result.tx_hash}")
+
+asyncio.run(upload_file())
+```
+
+## Step 6: Upload from a File
+
+```python
+import asyncio
+from pynapse import AsyncSynapse
+
+PRIVATE_KEY = "0xYOUR_PRIVATE_KEY_HERE"
+
+async def upload_from_file(filepath: str):
+    synapse = await AsyncSynapse.create(
+        rpc_url="https://api.calibration.node.glif.io/rpc/v1",
+        chain="calibration",
+        private_key=PRIVATE_KEY
+    )
+    
+    ctx = await synapse.storage.get_context()
+    
+    # Read file
+    with open(filepath, "rb") as f:
+        data = f.read()
+    
+    # Min size is 256 bytes, max is 254 MiB
+    if len(data) < 256:
+        data = data + b'\x00' * (256 - len(data))  # Pad if needed
+    
+    print(f"Uploading {filepath} ({len(data)} bytes)...")
+    result = await ctx.upload(data)
+    
+    print(f"✅ Uploaded: {result.piece_cid}")
+    return result
+
+asyncio.run(upload_from_file("./myfile.txt"))
+```
+
+---
+
+## Troubleshooting
+
+### "stream-commp helper not found"
+Set the path: `export PYNAPSE_COMMP_HELPER=/path/to/stream-commp`
+
+### "insufficient funds"
+- Check tFIL balance for gas
+- Check USDFC deposited balance in Payments contract
+
+### "operator not approved"
+Run Step 4 to approve the FWSS operator.
+
+### Upload hangs
+- Network latency to Calibration RPC can be slow
+- Storage context creation involves multiple contract calls
+
+---
+
+## Key Addresses (Calibration Testnet)
+
+| Contract | Address |
+|----------|---------|
+| USDFC Token | `0xb3042734b608a1B16e9e86B374A3f3e389B4cDf0` |
+| Payments | `0x09a0fDc2723fAd1A7b8e3e00eE5DF73841df55a0` |
+| FWSS (Operator) | `0x02925630df557F957f70E112bA06e50965417CA0` |
+| WarmStorage | `0xa9fEdb4e4acd6434adBE163b2e25f05E54bb4319` |
+| SP Registry | `0xc21cbbF2a8F94f2C9C6D4a6A75C571eB45052e8A` |
+
+---
+
+## Next Steps
+
+- Try uploading larger files (up to 254 MiB)
+- Explore batch uploads with `ctx.upload_batch([data1, data2, ...])`
+- Check the SDK source for more options

synapse_filecoin_sdk-0.1.0/README.md

@@ -0,0 +1,49 @@
+# Pynapse
+
+Python SDK for Filecoin Onchain Cloud (Synapse).
+
+This project mirrors the JS SDK in `FilOzone/synapse-sdk` and references the Go implementation in `data-preservation-programs/go-synapse` for parity.
+
+## Status
+
+Work in progress. Parity is being implemented in incremental commits.
+
+## Install (dev)
+
+```bash
+uv venv
+uv pip install -e .[test]
+```
+
+PyPI package name: `synapse-filecoin-sdk`  
+Python import: `pynapse`
+
+## Install (PyPI)
+
+```bash
+pip install synapse-filecoin-sdk
+```
+
+## CommP / PieceCID
+
+`pynapse` uses `stream-commp` from `go-fil-commp-hashhash` for PieceCID calculation.
+Set `PYNAPSE_COMMP_HELPER` to override the helper path.
+
+## License
+
+Dual-licensed under Apache-2.0 OR MIT. See `LICENSE.md`.
+
+## Publishing to PyPI
+
+Publishing is automated via GitHub Actions in `.github/workflows/publish-pypi.yml`.
+
+1. In PyPI, create the project (or use an existing one) and configure a Trusted Publisher for this GitHub repository and workflow.
+2. In GitHub, optionally protect the `pypi` environment for manual approval.
+3. Tag a release and push the tag:
+
+```bash
+git tag v0.1.1
+git push origin v0.1.1
+```
+
+The workflow builds the package, runs `twine check`, and publishes to PyPI via OIDC (no API token required).