Skip to content

Repository files navigation

Pipe SDKs

First-party Rust, TypeScript, and Python clients for the three Pipe storage surfaces and prepaid USDC credit.

Surface Rust TypeScript Python Credential
Native object storage Yes Yes Yes Bearer token or PAYMENT-SIGNATURE
S3-compatible storage AWS SDK configuration AWS SDK v3 client boto3 client Scoped S3 access key
Durable Objects Yes Yes Yes Operator bearer token
USDC credit/top-ups Yes Yes Yes Solana payment signer callback

The packages intentionally use the official AWS clients for S3. Pipe's S3 endpoint is path-style SigV4 with region us-east-1; implementing a second signer in these packages would be less compatible and less secure.

Install

This repository contains all three packages:

rust/pipe-sdk       crate: pipe-sdk
typescript          npm:   @pipenetwork/sdk
python              PyPI:  pipe-sdk (import pipe_sdk)

Package guides: Rust, TypeScript, and Python.

Each package README contains an executable quick start and its environment variable mapping.

Fastest production onboarding

  1. Open pipe.love/storage, connect a Solana wallet, and buy prepaid storage credit. Applications can also drive the same public x402 invoice flow through the SDK billing client.
  2. Create a scoped S3 credential in the storage workspace. The secret is shown once. Set AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY for your app.
  3. Construct the SDK from the environment and use its S3 client. Billing is charged to the credit identity attached to that credential.

Customer-account and S3-credential creation remain behind the pipe.love BFF. SDKs accept already-created credentials and never ask developers to embed the private x-pipe-bff-token in an application.

Authentication and billing boundaries

There are currently three distinct credentials because the server surfaces do not yet share one public developer-key system:

  • S3 requests use scoped SigV4 credentials and consume the associated prepaid balance automatically.
  • Native storage uses a Pipe cumulative batch-settlement voucher in PAYMENT-SIGNATURE in paid deployments. A caller can supply the header in every SDK; the Rust client can also sign it from the credited wallet key.
  • Durable Objects are a trusted/self-hosted operator API today. They require the router read/write bearer token, are primary-only, and are not yet tenant-metered. The SDKs do not present them as public customer storage.

Top-up payment is a separate standard x402 v2 exact Solana USDC flow. The billing clients create an idempotent invoice, expose the pinned requirements to a signer callback, retry the same invoice with the signed payload, and poll the durable invoice after an ambiguous timeout. A top-up adds balance; it is not the per-request native-storage voucher.

Production defaults

Setting Default
Storage/S3 endpoint https://api.pipedev.network
Control plane https://a.pipenetwork.ai/control-api
Customer workspace https://pipe.love/storage
S3 region us-east-1
S3 addressing Path style

Override endpoints for a local or self-hosted deployment. Never place an operator Durable Object token or an S3 secret in browser-delivered code.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages