Packages

remit

0.4.0
0.4.0 retired 0.3.0 retired 0.2.5 retired 0.2.4 retired 0.2.2 retired 0.2.1 retired 0.1.9 retired 0.1.8 retired 0.1.7 retired 0.1.6 retired 0.1.5 retired 0.1.4 retired 0.1.3 retired 0.1.2 retired 0.1.1 retired 0.1.0 retired

remit.md SDK for Elixir - universal payment protocol for AI agents

Retired package: Renamed - DEPRECATED: Use pay-cli (cargo install pay-cli) or pay-sdk (pip install pay-sdk). See https://pay-skill.com/docs
HexDocs

Current section

Files

Jump to
Readme
16 Versions
2 Dependencies
Dependants
Files
Activity
remit lib remit_md.ex
Raw

lib/remit_md.ex 

defmodule RemitMd do

  @moduledoc """

  remit.md - universal payment protocol for AI agents.



  The primary entry points are `RemitMd.Wallet` (production client) and

  `RemitMd.MockRemit` (in-memory test double).



  ## Quickstart



      # 1. Testing (no keys, no network)

      {:ok, mock} = RemitMd.MockRemit.start_link()

      wallet = RemitMd.Wallet.new(mock: mock, address: "0xMyAgent")

      {:ok, tx} = RemitMd.Wallet.pay(wallet, "0xRecipient", "1.50")



      # 2. Production

      wallet = RemitMd.Wallet.from_env()

      {:ok, tx} = RemitMd.Wallet.pay(wallet, "0xRecipient", "1.50")



  ## Payment Models



  | Function                          | Model     | Use Case                              |

  |-----------------------------------|-----------|---------------------------------------|

  | `Wallet.pay/4`                    | Direct    | One-off payments                      |

  | `Wallet.create_escrow/4`          | Escrow    | Milestone-gated work                  |

  | `Wallet.open_tab/4`               | Tab       | High-frequency micro-payments         |

  | `Wallet.create_stream/4`          | Stream    | Time-based continuous payments        |

  | `Wallet.post_bounty/3`            | Bounty    | Open tasks (any agent can claim)      |



  ## Configuration



  Environment variables:



  - `REMITMD_KEY` - secp256k1 private key (required for production)

  - `REMITMD_PRIVATE_KEY` - deprecated alias for `REMITMD_KEY`

  - `REMITMD_CHAIN` - chain name, default `"base"`. Options: `"base-sepolia"`

  - `REMITMD_API_URL` - override the API base URL (useful for self-hosted instances)



  ## Installation



  Add to `mix.exs`:



      {:remitmd, "~> 0.1"}

  """

end