Skip to content

Latest commit

 

History

History
219 lines (174 loc) · 6.65 KB

examples.md

File metadata and controls

219 lines (174 loc) · 6.65 KB
Raw

Paymail Inspector: Examples & Docs

Below are some examples using the paymail cli app

View All Commands (Help)

paymail

Help Command

Global flags for the entire application (command specs)

      --bsvalias string   The bsvalias version (default "1.0")
      --config string     Custom config file (default is $HOME/paymail/config.yaml)
      --docs              Generate docs from all commands (./docs/commands)
      --flush-cache       Flushes ALL cache, empties local database
  -h, --help              help for paymail
      --no-cache          Turn off caching for this specific command
  -t, --skip-tracing      Turn off request tracing information
  -v, --version           version for paymail

List BRFC Specifications

paymail brfc list
Show Example BRFC List Command

Custom flags for the brfc:list command (command specs)

  -h, --help              help for brfc
      --skip-validation   Skip validating the existing BRFC IDs

Generate new BRFC ID

paymail brfc generate --title "BRFC Specifications" --author "andy (nChain)" --version 1
Show Example BRFC Generate Command
Test Cases

Expected ID: 57dd1f54fc67

paymail brfc generate --title "BRFC Specifications" --author "andy (nChain)" --version 1

Expected ID: 74524c4d6274

paymail brfc generate --title "bsvalias Payment Addressing (PayTo Protocol Prefix)" --author "andy (nChain)" --version 1

Expected ID: 0036f9b8860f

paymail brfc generate --title "bsvalias Integration with Simplified Payment Protocol" --author "andy (nChain)" --version 1

Custom flags for the brfc:generate command (command specs)

      --author string     Author(s) new BRFC specification
  -h, --help              help for brfc
      --title string      Title of the new BRFC specification
      --version string    Version of the new BRFC specification

Search BRFC Specifications

paymail brfc search nChain
Show Example BRFC Search Command

Custom flags for the brfc:search command (command specs)

  -h, --help              help for brfc
      --skip-validation   Skip validating the existing BRFC IDs

Get Capabilities (by Domain)

paymail capabilities moneybutton.com
Show Example Capabilities Command

Custom flags for the capabilities request (command specs)

  -h, --help              help for capabilities

Start P2P Payment Request (by Paymail)

paymail p2p mrz@moneybutton.com
Show Example P2P Command

Custom flags for the p2p command (command specs)

  -h, --help              help for p2p
      --satoshis uint     Amount in satoshis for the payment

Resolve Paymail Address (by Paymail)

paymail resolve mrz@moneybutton.com
Show Example Resolve Command

Custom flags for the resolve command (command specs)

  -a, --amount uint            Amount in satoshis for the payment request
  -h, --help                   help for resolve
  -p, --purpose string         Purpose for the transaction
      --sender-handle string   The sender's paymail handle (if not given it will be the receivers address)
  -n, --sender-name string     The sender's name
  -s, --signature string       The signature of the entire request
      --skip-bitpic            Skip trying to get an associated Bitpic
      --skip-pki               Skip the pki request
      --skip-public-profile    Skip the public profile request
      --skip-roundesk          Skip trying to get an associated Roundesk profile

Validate Paymail Setup (by Paymail or Domain)

paymail validate moneybutton.com
Show Example Validate Command

Custom flags for the validation command (command specs)

  -h, --help                help for validate
  -n, --nameserver string   DNS name server for resolving records (default "8.8.8.8")
  -p, --port int            Port that is found in the SRV record (default 443)
      --priority int        Priority value that is found in the SRV record (default 10)
      --protocol string     Protocol in the SRV record (default "tcp")
  -s, --service string      Service name in the SRV record (default "bsvalias")
  -d, --skip-dnssec         Skip checking DNSSEC of the target
      --skip-ssl            Skip checking SSL of the target
      --skip-srv            Skip checking SRV record of the main domain
  -w, --weight int          Weight value that is found in the SRV record (default 10)

Verify Public Key Owner

paymail verify mrz@moneybutton.com 02ead23149a1e33df17325ec7a7ba9e0b20c674c57c630f527d69b866aa9b65b10
Show Example Verify Command

Custom flags for the verify command (command specs)

  -h, --help              help for verify

Whois For Handles

paymail whois mrz
Show Example Whois Command

Custom flags for the whois command (command specs)

  -h, --help              help for whois