remitmd 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a4fe50ca322390d98424e60dd8ecd9fb1fbd27ffd8264e5d4167e1d2d249212
-  data.tar.gz: 68079923cac8357d6560432bb31a26217296d1de44f2134e8934cd233822a03d
+  metadata.gz: fb629574b0068a996c2afc9beec3bf0c28a4d3838e674cdf5a9841a66b3de091
+  data.tar.gz: 25446d1826566c5606f80845dab3263b5bf5936ce2b4d123b317b6f9162d845c
 SHA512:
-  metadata.gz: 50e790537a39130346e2436e1c90b90cc1ca7e7aafe8bf4ba46cde03da31040f4126ba17c5d8e995edd2da2ba4be6d540771a13cb9aeb0f5093554d266bb3794
-  data.tar.gz: 8e62c3cfe6c96ea2ccd2dc0cabbefe03bd96602807c916667b87db668c14ccb442fdaabb61c4589177dad5cda3a25f98789a168015b8ca34d47c88f54a35a7f9
+  metadata.gz: 45bb3ff15f9966ca2b424e9ebe91b7a368328ef5dceb4cd6eb3fb4e3b0991e20622d5dba55b1983b3dd0bd7f2978d4d6922f22b9dabefdace06bbdb4331ce6b4
+  data.tar.gz: 44bd1e9d31c038f5a5e5fad6a65be2194d3004a7222391f0ace4472799a05e96e25c3cf25986be160dce7c423579605b04306248636c128d359ec8b404911f50

data/README.md

@@ -1,290 +1,8 @@
-# remit.md Ruby SDK
+# remitmd (Ruby) — DEPRECATED
 
-> [Skill MD](https://remit.md) · [Docs](https://remit.md/docs) · [Agent Spec](https://remit.md/agent.md)
+> **This gem has been deprecated.** Use the [pay CLI](https://pay-skill.com/docs/cli) or [pay SDKs](https://pay-skill.com/docs) instead.
 
-Universal payment protocol for AI agents - Ruby client library.
-
-[![CI](https://github.com/remit-md/sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/remit-md/sdk/actions/workflows/ci.yml)
-[![Gem Version](https://badge.fury.io/rb/remitmd.svg)](https://badge.fury.io/rb/remitmd)
-
-## Installation
-
-```ruby
-gem "remitmd"
-```
-
-or install directly:
-
-```bash
-gem install remitmd
-```
-
-## Quickstart
-
-```ruby
-require "remitmd"
-
-wallet = Remitmd::RemitWallet.new(private_key: ENV["REMITMD_KEY"])
-
-# Direct payment
-tx = wallet.pay("0xRecipient0000000000000000000000000000001", 1.50)
-puts tx.tx_hash
-
-# Check reputation
-rep = wallet.reputation("0xSomeAgent000000000000000000000000001")
-puts "Score: #{rep.score}"
-```
-
-Or from environment variables:
-
-```ruby
-wallet = Remitmd::RemitWallet.from_env
-# Auto-detects: CliSigner (remit CLI) > REMITMD_KEY
-# Optional: REMITMD_CHAIN (default: "base"), REMITMD_API_URL
-```
-
-Permits are auto-signed. Every payment method calls the server's `/permits/prepare` endpoint, signs the hash, and includes the permit automatically.
-
-## CLI Signer (Recommended)
-
-The CLI signer delegates key management to the `remit` CLI binary, which holds your encrypted keystore at `~/.remit/keys/`. No private key in your environment -- just install the CLI and set a password.
-
-```bash
-# Install the CLI
-# macOS:   brew install remit-md/tap/remit
-# Windows: winget install remit-md.remit
-# Linux:   curl -fsSL https://remit.md/install.sh | sh
-
-export REMIT_SIGNER_KEY=your-keystore-password
-```
-
-```ruby
-# Explicit
-signer = Remitmd::CliSigner.new
-wallet = Remitmd::RemitWallet.new(signer: signer)
-
-# Or auto-detect from env (recommended)
-wallet = Remitmd::RemitWallet.from_env # detects remit CLI automatically
-```
-
-`RemitWallet.from_env` detects signing methods automatically. Priority: `CliSigner` (CLI + keystore + password) > `REMITMD_KEY`.
-
-## Payment Models
-
-### Direct Payment
-
-```ruby
-tx = wallet.pay("0xRecipient...", 5.00, memo: "AI inference fee")
-```
-
-### Escrow
-
-```ruby
-escrow = wallet.create_escrow("0xContractor...", 100.00, memo: "Code review")
-# Work happens...
-tx = wallet.release_escrow(escrow.id)   # pay the contractor
-# or
-tx = wallet.cancel_escrow(escrow.id)    # refund yourself
-```
-
-### Metered Tab (off-chain billing)
-
-```ruby
-tab = wallet.create_tab("0xProvider...", 50.00, 0.003)
-
-# Provider charges with EIP-712 signature
-contracts = wallet.get_contracts
-sig = wallet.sign_tab_charge(contracts.tab, tab.id, 3_000_000, 1)
-wallet.charge_tab(tab.id, 0.003, 0.003, 1, sig)
-
-# Close when done - unused funds return
-wallet.close_tab(tab.id)
-```
-
-### Payment Stream
-
-```ruby
-stream = wallet.create_stream("0xWorker...", 0.001, 100.00)
-# Worker receives 0.001 USDC/second, funded with 100 USDC deposit
-
-tx = wallet.withdraw_stream(stream.id)
-```
-
-### Bounty
-
-```ruby
-bounty = wallet.create_bounty(25.00, "Summarise top 10 EIPs of 2025")
-
-# Any agent can submit work; you decide the winner
-tx = wallet.award_bounty(bounty.id, "0xWinner...")
-```
-
-### Security Deposit
-
-```ruby
-dep = wallet.place_deposit("0xCounterpart...", 100.00, expires_in_secs: 86_400)
-wallet.return_deposit(dep.id)
-```
-
-### Payment Intent
-
-```ruby
-# Propose payment terms before committing
-intent = wallet.propose_intent("0xCounterpart...", 50.00, type: "escrow")
-```
-
-## Testing with MockRemit
-
-MockRemit gives you a zero-network, zero-latency test double. No API key needed.
-
-```ruby
-require "remitmd"
-
-RSpec.describe MyPayingAgent do
-  let(:mock)   { Remitmd::MockRemit.new }
-  let(:wallet) { mock.wallet }
-
-  after { mock.reset }
-
-  it "pays the correct amount" do
-    agent = MyPayingAgent.new(wallet: wallet)
-    agent.run(task: "summarise document")
-
-    expect(mock.was_paid?("0xProvider...", 0.003)).to be true
-    expect(mock.balance).to eq(BigDecimal("9999.997"))
-  end
-end
-```
-
-### MockRemit assertions
-
-```ruby
-mock.was_paid?(address, amount)   # true/false
-mock.total_paid_to(address)       # BigDecimal - sum of all payments to address
-mock.transaction_count            # Integer
-mock.balance                      # BigDecimal - current balance
-mock.transactions                 # Array<Transaction>
-mock.set_balance(amount)          # Override starting balance
-mock.reset                        # Clear all state
-```
-
-## All Methods
-
-```ruby
-# Contract discovery (cached per session)
-wallet.get_contracts                                        # Hash
-
-# Balance & analytics
-wallet.balance                                              # Balance
-wallet.history(limit: 50, offset: 0)                       # TransactionList
-wallet.reputation(address)                                  # Reputation
-wallet.spending_summary                                     # SpendingSummary
-wallet.remaining_budget                                     # Budget
-
-# Direct payment
-wallet.pay(to, amount, memo: nil, permit: nil)              # Transaction
-
-# Escrow
-wallet.create_escrow(payee, amount, memo: nil, expires_in_secs: nil, permit: nil)  # Escrow
-wallet.claim_start(escrow_id)                               # Escrow
-wallet.release_escrow(escrow_id, memo: nil)                 # Transaction
-wallet.cancel_escrow(escrow_id)                             # Transaction
-wallet.get_escrow(escrow_id)                                # Escrow
-
-# Tabs
-wallet.create_tab(provider, limit, per_unit, expires_in_secs: 86_400, permit: nil)  # Tab
-wallet.charge_tab(tab_id, amount, cumulative, call_count, provider_sig)              # TabCharge
-wallet.close_tab(tab_id, final_amount: nil, provider_sig: nil)                       # Tab
-
-# Tab provider (signing charges)
-wallet.sign_tab_charge(tab_contract, tab_id, total_charged, call_count)  # String
-
-# EIP-2612 Permit (auto-signed when omitted from payment methods)
-wallet.sign_permit(flow, amount)                                         # PermitSignature
-
-# Streams
-wallet.create_stream(payee, rate_per_second, max_total, permit: nil)  # Stream
-wallet.close_stream(stream_id)                              # Stream
-wallet.withdraw_stream(stream_id)                           # Transaction
-
-# Bounties
-wallet.create_bounty(amount, task, deadline, max_attempts: 10, permit: nil)  # Bounty
-wallet.submit_bounty(bounty_id, evidence_hash)              # BountySubmission
-wallet.award_bounty(bounty_id, submission_id)               # Bounty
-
-# Deposits
-wallet.place_deposit(provider, amount, expires_in_secs: 3600, permit: nil)  # Deposit
-wallet.return_deposit(deposit_id)                           # Transaction
-
-# Webhooks
-wallet.register_webhook(url, events, chains: nil)           # Webhook
-
-# Operator links (optional: messages: [], agent_name: "")
-wallet.create_fund_link                                     # LinkResponse
-wallet.create_withdraw_link(messages: ["Withdraw"], agent_name: "my-agent")  # LinkResponse
-
-# Testnet
-wallet.mint(amount)                                         # Hash {tx_hash, balance}
-```
-
-## Error Handling
-
-All errors are `Remitmd::RemitError` with structured fields and enriched details:
-
-```ruby
-begin
-  wallet.pay("0xRecipient...", 100.00)
-rescue Remitmd::RemitError => e
-  puts e.code     # "INSUFFICIENT_BALANCE"
-  puts e.message  # "Insufficient USDC balance: have $5.00, need $100.00"
-  puts e.doc_url  # Direct link to error documentation
-  puts e.context  # Hash: {"required" => "100.00", "available" => "5.00", ...}
-end
-```
-
-## Custom Signer
-
-Implement `Remitmd::Signer` for HSM, KMS, or multi-sig workflows:
-
-```ruby
-class MyHsmSigner
-  include Remitmd::Signer
-
-  def sign(message)
-    # Delegate to your HSM
-    MyHsm.sign(message)
-  end
-
-  def address
-    "0xYourAddress..."
-  end
-end
-
-wallet = Remitmd::RemitWallet.new(signer: MyHsmSigner.new)
-```
-
-## Chains
-
-```ruby
-Remitmd::RemitWallet.new(private_key: key, chain: "base")          # Base mainnet (default)
-Remitmd::RemitWallet.new(private_key: key, chain: "base_sepolia")  # Base Sepolia testnet
-```
-
-## Advanced
-
-### Manual Permit Signing
-
-Permits are auto-signed by default via the server's `/permits/prepare` endpoint. If you need manual control (pre-signed permits, multi-step workflows), pass a `PermitSignature` explicitly:
-
-```ruby
-permit = wallet.sign_permit("direct", 5.00)
-tx = wallet.pay("0xRecipient...", 5.00, permit: permit)
-```
-
-Supported flows: `"direct"`, `"escrow"`, `"tab"`, `"stream"`, `"bounty"`, `"deposit"`.
-
-## License
-
-MIT - see [LICENSE](LICENSE)
-
-[Documentation](https://remit.md/docs) · [Protocol Spec](https://remit.md) · [GitHub](https://github.com/remit-md/sdk)
+- **CLI:** `cargo install pay-cli` — [pay-skill.com/docs/cli](https://pay-skill.com/docs/cli)
+- **Python SDK:** `pip install pay-sdk` — [pay-skill.com/docs/sdk/python](https://pay-skill.com/docs/sdk/python)
+- **TypeScript SDK:** `npm install @pay-skill/sdk` — [pay-skill.com/docs/sdk/typescript](https://pay-skill.com/docs/sdk/typescript)
+- **Source:** [github.com/remit-md/pay-sdk](https://github.com/remit-md/pay-sdk)

data/lib/remitmd/http.rb

@@ -38,6 +38,10 @@ module Remitmd
       request(:post, path, body)
     end
 
+    def patch(path, body = nil)
+      request(:patch, path, body)
+    end
+
     def delete(path)
       request(:delete, path, nil)
     end
@@ -71,6 +75,7 @@ module Remitmd
       req = case method
             when :get    then Net::HTTP::Get.new(full_path)
             when :post   then Net::HTTP::Post.new(full_path)
+            when :patch  then Net::HTTP::Patch.new(full_path)
             when :delete then Net::HTTP::Delete.new(full_path)
             end
 

data/lib/remitmd/mock.rb

@@ -130,6 +130,10 @@ module Remitmd
       dispatch("POST", path, body)
     end
 
+    def patch(path, body = nil)
+      dispatch("PATCH", path, body)
+    end
+
     def delete(path)
       dispatch("DELETE", path, nil)
     end
@@ -414,20 +418,45 @@ module Remitmd
           "has_more" => false,
         }
 
-      # Intents
-      in ["POST", "/intents"]
-        to     = fetch!(b, :to)
-        amount = decimal!(b, :amount)
+      # Deposit forfeit
+      in ["POST", path] if path.end_with?("/forfeit") && path.include?("/deposits/")
         {
-          "id"         => new_id("int"),
-          "from"       => MockRemit::MOCK_ADDRESS,
-          "to"         => to,
-          "amount"     => amount.to_s("F"),
-          "type"       => b[:type] || "direct",
-          "expires_at" => now,
+          "id"         => new_id("tx"),
+          "tx_hash"    => "0x#{SecureRandom.hex(32)}",
+          "chain_id"   => ChainId::BASE_SEPOLIA,
           "created_at" => now,
         }
 
+      # Bounty reclaim
+      in ["POST", path] if path.end_with?("/reclaim") && path.include?("/bounties/")
+        {
+          "id"         => new_id("tx"),
+          "tx_hash"    => "0x#{SecureRandom.hex(32)}",
+          "chain_id"   => ChainId::BASE_SEPOLIA,
+          "created_at" => now,
+        }
+
+      # Webhook update
+      in ["PATCH", path] if path.start_with?("/webhooks/")
+        webhook_id = path.split("/").last
+        {
+          "id"         => webhook_id,
+          "wallet"     => MockRemit::MOCK_ADDRESS,
+          "url"        => b[:url] || "https://example.com/hook",
+          "events"     => b[:events] || [],
+          "chains"     => ["base-sepolia"],
+          "active"     => b.key?(:active) ? b[:active] : true,
+          "created_at" => now,
+          "updated_at" => now,
+        }
+
+      # Wallet settings update
+      in ["PATCH", "/wallet/settings"]
+        {
+          "wallet"       => MockRemit::MOCK_ADDRESS,
+          "display_name" => b[:display_name],
+        }
+
       else
         {}
       end

data/lib/remitmd/models.rb

@@ -349,21 +349,14 @@ module Remitmd
     private :decimal, :parse_time
   end
 
-  class Intent < Model
+  class WalletSettings < Model
     def initialize(attrs)
       h = attrs.transform_keys(&:to_s)
-      @id         = h["id"]
-      @from       = h["from"]
-      @to         = h["to"]
-      @amount     = decimal(h["amount"])
-      @type       = h["type"]
-      @expires_at = parse_time(h["expires_at"])
-      @created_at = parse_time(h["created_at"])
+      @wallet       = h["wallet"]
+      @display_name = h["display_name"]
     end
 
-    attr_reader :id, :from, :to, :amount, :type, :expires_at, :created_at
-
-    private :decimal, :parse_time
+    attr_reader :wallet, :display_name
   end
 
   class Budget < Model

data/lib/remitmd/wallet.rb

@@ -459,6 +459,13 @@ module Remitmd
       Bounty.new(@transport.post("/bounties/#{bounty_id}/award", { submission_id: submission_id }))
     end
 
+    # Reclaim an expired or cancelled bounty (called by the poster).
+    # @param bounty_id [String]
+    # @return [Transaction]
+    def reclaim_bounty(bounty_id)
+      Transaction.new(@transport.post("/bounties/#{bounty_id}/reclaim", {}))
+    end
+
     # List bounties with optional filters.
     # @param status [String, nil] filter by status (open, claimed, awarded, expired)
     # @param poster [String, nil] filter by poster wallet address
@@ -504,26 +511,19 @@ module Remitmd
       Transaction.new(@transport.post("/deposits/#{deposit_id}/return", {}))
     end
 
+    # Forfeit a deposit (called by the depositor to surrender their deposit).
+    # @param deposit_id [String]
+    # @return [Transaction]
+    def forfeit_deposit(deposit_id)
+      Transaction.new(@transport.post("/deposits/#{deposit_id}/forfeit", {}))
+    end
+
     # Lock a security deposit.
     # @deprecated Use {#place_deposit} instead
     def lock_deposit(provider, amount, expires_in_secs, permit: nil)
       place_deposit(provider, amount, expires_in_secs: expires_in_secs, permit: permit)
     end
 
-    # ─── Payment Intents ─────────────────────────────────────────────────────
-
-    # Propose a payment intent for counterpart approval before execution.
-    # @param to [String] 0x-prefixed address
-    # @param amount [Numeric] amount in USDC
-    # @param type [String] payment type - "direct", "escrow", "tab"
-    # @return [Intent]
-    def propose_intent(to, amount, type: "direct")
-      validate_address!(to)
-      validate_amount!(amount)
-      body = { to: to, amount: amount.to_s, type: type }
-      Intent.new(@transport.post("/intents", body))
-    end
-
     # ─── Webhooks ─────────────────────────────────────────────────────────────
 
     # Register a webhook endpoint to receive event notifications.
@@ -548,6 +548,29 @@ module Remitmd
       nil
     end
 
+    # Update an existing webhook's URL, events, or active status.
+    # @param webhook_id [String]
+    # @param url [String, nil] new URL
+    # @param events [Array<String>, nil] new event types
+    # @param active [Boolean, nil] new active status
+    # @return [Webhook]
+    def update_webhook(webhook_id, url: nil, events: nil, active: nil)
+      body = {}
+      body[:url] = url unless url.nil?
+      body[:events] = events unless events.nil?
+      body[:active] = active unless active.nil?
+      Webhook.new(@transport.patch("/webhooks/#{webhook_id}", body))
+    end
+
+    # Update wallet display settings.
+    # @param display_name [String, nil] new display name
+    # @return [WalletSettings]
+    def update_wallet_settings(display_name: nil)
+      body = {}
+      body[:display_name] = display_name unless display_name.nil?
+      WalletSettings.new(@transport.patch("/wallet/settings", body))
+    end
+
     # ─── Canonical name aliases ──────────────────────────────────────────────
 
     # Canonical name for create_tab.
@@ -565,11 +588,6 @@ module Remitmd
       create_bounty(amount, task_description, deadline, max_attempts: max_attempts, permit: permit)
     end
 
-    # Alias for propose_intent.
-    def express_intent(to, amount, type: "direct")
-      propose_intent(to, amount, type: type)
-    end
-
     # ─── One-time operator links ───────────────────────────────────────────────
 
     # Generate a one-time URL for the operator to fund this wallet.

data/lib/remitmd.rb

@@ -26,5 +26,5 @@ require_relative "remitmd/x402_paywall"
 #   mock.was_paid?("0x0000000000000000000000000000000000000001", 1.00) # => true
 #
 module Remitmd
-  VERSION = "0.3.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remitmd
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - remit.md
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-29 00:00:00.000000000 Z
+date: 2026-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,9 +38,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.60'
-description: Send and receive USDC via the remit.md protocol. Supports direct payments,
-  escrow, metered tabs, payment streams, bounties, and security deposits. Includes
-  MockRemit for zero-network testing.
+description: 'DEPRECATED: This gem is no longer maintained. Use pay-cli (cargo install
+  pay-cli) or pay SDKs (pip install pay-sdk / npm install @pay-skill/sdk). See https://pay-skill.com/docs
+  for migration.'
 email:
 - hello@remit.md
 executables: []
@@ -61,14 +61,15 @@ files:
 - lib/remitmd/wallet.rb
 - lib/remitmd/x402_client.rb
 - lib/remitmd/x402_paywall.rb
-homepage: https://remit.md
+homepage: https://pay-skill.com
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://remit.md
-  source_code_uri: https://github.com/remit-md/sdk
-  changelog_uri: https://github.com/remit-md/sdk/releases
-post_install_message:
+  homepage_uri: https://pay-skill.com
+  source_code_uri: https://github.com/remit-md/pay-sdk
+  changelog_uri: https://github.com/remit-md/pay-sdk/releases
+post_install_message: 'WARNING: remitmd is deprecated. Use pay-cli or pay SDKs instead.
+  See https://pay-skill.com/docs'
 rdoc_options: []
 require_paths:
 - lib
@@ -86,5 +87,5 @@ requirements: []
 rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
-summary: remit.md — universal payment protocol SDK for AI agents
+summary: 'DEPRECATED: Use pay-cli or pay SDKs instead. See https://pay-skill.com/docs'
 test_files: []