pymtptr

package module
v0.0.0-...-df7d582 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 15, 2025 License: MIT Imports: 4 Imported by: 0

README

go-pymtptr

Package pymtptr implements Payment Pointers, for the Go programming language.

Payment Pointers look like these:

  • $example.com
  • $joeblow.example.com
  • $example.com/janedoe

Information about Payment Pointers can be found here:

Payment Pointers are used by the Interledger Protocol, Open Payments, Web Monetization.

Documention

Online documentation, which includes examples, can be found at: http://godoc.org/codeberg.org/reiver/go-pymtptr

GoDoc

Import

To import package pymtptr use import code like the following:

import "codeberg.org/reiver/go-pymtptr"

Installation

To install package pymtptr do the following:

GOPROXY=direct go get codeberg.org/reiver/go-pymtptr

Author

Package pymtptr was written by Charles Iliya Krempeaux

See Also

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func Join 

func Join(host string, path string) (paymentPointer string)

Join returns the payment-pointer.

An example payment-pointer looks like these: 

$example.com

$joeblow.example.com

$example.com/joeblow

$xn--938h.com/%DB%B1/%DB%B2/%DB%B3/%DB%B4/%DB%B5

Note that what Join returns is in ASCII.

A host with non-ASCII characters is encoded into ASCII using punycode.

A path with non-ASCII character is encoded into ASCII using urlencode.

Example (IdnaHost) 
var host string = "xn--m28h.com"
var path string = ""

str := pymtptr.Join(host, path)

fmt.Println(str)

Output:

$xn--m28h.com
Example (NonAsciiHost) 
var host string = "😈.com"
var path string = ""

str := pymtptr.Join(host, path)

fmt.Println(str)

Output:

$xn--m28h.com
Example (NonAsciiPath) 
var host string = "example.com"
var path string = "/۱/۲/۳/۴/۵"

str := pymtptr.Join(host, path)

fmt.Println(str)

Output:

$example.com/%DB%B1/%DB%B2/%DB%B3/%DB%B4/%DB%B5
Example (OnlyHost) 
var host string = "example.com"
var path string = ""

str := pymtptr.Join(host, path)

fmt.Println(str)

Output:

$example.com
Example (WithPath) 
var host string = "example.com"
var path string = "/joeblow"

str := pymtptr.Join(host, path)

fmt.Println(str)

Output:

$example.com/joeblow
Example (WithSubDomain) 
var host string = "joeblow.example.com"
var path string = ""

str := pymtptr.Join(host, path)

fmt.Println(str)

Output:

$joeblow.example.com

func Pretty 

func Pretty(paymentPointer string) string

Pretty returns the "pretty" version of a payment-pointer.

NOTE that the the "pretty" version of a payment-pointer might NOT be a valid payment-pointer!

What pretty returns is meant to be a more human-legible form meant for displaying to people (and is NOT mean to be consumed by machines).

Some example "pretty" payment-pointer are: 

$example.com

$joeblow.example.com

$example.com/joeblow

$🙂.com/۱/۲/۳/۴/۵

Note that the last example of a "pretty" version of a payment-pointer (i.e., "$🙂.com/۱/۲/۳/۴/۵") is NOT a valid payment-pointer!

Example (IdnaHost) 
var paymentPointer string = "$xn--m28h.com"

pretty := pymtptr.Pretty(paymentPointer)

fmt.Println(pretty)

Output:

$😈.com
Example (NonAsciiHost) 
var paymentPointer string = "$😈.com"

pretty := pymtptr.Pretty(paymentPointer)

fmt.Println(pretty)

Output:

$😈.com
Example (NonAsciiPath) 
var paymentPointer string = "$example.com/۱/۲/۳/۴/۵"

pretty := pymtptr.Pretty(paymentPointer)

fmt.Println(pretty)

Output:

$example.com/۱/۲/۳/۴/۵
Example (OnlyHost) 
var paymentPointer string = "$example.com"

pretty := pymtptr.Pretty(paymentPointer)

fmt.Println(pretty)

Output:

$example.com
Example (WithPath) 
var paymentPointer string = "$example.com/joeblow"

pretty := pymtptr.Pretty(paymentPointer)

fmt.Println(pretty)

Output:

$example.com/joeblow
Example (WithSubDomain) 
var paymentPointer string = "$joeblow.example.com"

pretty := pymtptr.Pretty(paymentPointer)

fmt.Println(pretty)

Output:

$joeblow.example.com

func Resolve 

func Resolve(paymentPointer string) (httpsURL string)

Resolve resolves a Payment-Pointer to an HTTP URL.

If the Payment-Pointer is NOT a valid the Resolve returns an empty string.

Example (IdnaHost) 
paymentPointer := "$xn--m28h.com"

url := pymtptr.Resolve(paymentPointer)

fmt.Println(url)

Output:

https://xn--m28h.com/.well-known/pay
Example (NonAsciiHost) 
paymentPointer := "$😈.com"

url := pymtptr.Resolve(paymentPointer)

fmt.Println(url)

Output:

https://xn--m28h.com/.well-known/pay
Example (NonAsciiPath) 
paymentPointer := "$example.com/۱/۲/۳/۴/۵"

url := pymtptr.Resolve(paymentPointer)

fmt.Println(url)

Output:

https://example.com/%DB%B1/%DB%B2/%DB%B3/%DB%B4/%DB%B5
Example (OnlyHost) 
paymentPointer := "$example.com"

url := pymtptr.Resolve(paymentPointer)

fmt.Println(url)

Output:

https://example.com/.well-known/pay
Example (WithPath) 
paymentPointer := "$example.com/joeblow"

url := pymtptr.Resolve(paymentPointer)

fmt.Println(url)

Output:

https://example.com/joeblow
Example (WithSubDomain) 
paymentPointer := "$joeblow.example.com"

url := pymtptr.Resolve(paymentPointer)

fmt.Println(url)

Output:

https://joeblow.example.com/.well-known/pay

func Sanitize 

func Sanitize(value string) string

Sanitize returns the sanitized form of a Payment-Pointer.

Example (AlreadyEncoded) 
var paymentPointer string = "$xn--hello-world-lk27j.com/%DB%B1/%DB%B2/%DB%B3/%DB%B4/%DB%B5"

sanitized := pymtptr.Sanitize(paymentPointer)

fmt.Println(sanitized)

Output:

$xn--hello-world-lk27j.com/%DB%B1/%DB%B2/%DB%B3/%DB%B4/%DB%B5
Example (JustHost) 
var paymentPointer string = "$hello-world🙂.com"

sanitized := pymtptr.Sanitize(paymentPointer)

fmt.Println(sanitized)

Output:

$xn--hello-world-lk27j.com
Example (NonAscii) 
var paymentPointer string = "$hello-world🙂.com/۱/۲/۳/۴/۵"

sanitized := pymtptr.Sanitize(paymentPointer)

fmt.Println(sanitized)

Output:

$xn--hello-world-lk27j.com/%DB%B1/%DB%B2/%DB%B3/%DB%B4/%DB%B5
Example (UpperCaseHost) 
var paymentPointer string = "$HELLO-WORLD🙂.com"

sanitized := pymtptr.Sanitize(paymentPointer)

fmt.Println(sanitized)

Output:

$xn--hello-world-lk27j.com
Example (WellKnown) 
var paymentPointer string = "$example.com/.well-known/pay"

sanitized := pymtptr.Sanitize(paymentPointer)

fmt.Println(sanitized)

Output:

$example.com

func Split 

func Split(paymentPointer string) (host string, path string, err error)

Split parses a Payment-Pointer, and if valid, extracts the host and path from the Payment-Pointer and returns them.

host is NOT punycode encoded, but instead can contain non-ASCII Unicode characters.

path is NOT urlencoded, but instead can contain non-ASCII Unicode characters.

Example (IdnaHost) 
var value string = "$xn--m28h.com"

host, path, err := pymtptr.Split(value)
if nil != err {
	fmt.Printf("ERROR: %s\n", err)
	return
}

fmt.Printf("HOST: %q\n", host)
fmt.Printf("PATH: %q\n", path)

Output:

HOST: "😈.com"
PATH: ""
Example (NonAsciiHost) 
var value string = "$😈.com"

host, path, err := pymtptr.Split(value)
if nil != err {
	fmt.Printf("ERROR: %s\n", err)
	return
}

fmt.Printf("HOST: %q\n", host)
fmt.Printf("PATH: %q\n", path)

Output:

HOST: "😈.com"
PATH: ""
Example (NonAsciiPath) 
var value string = "$example.com/۱/۲/۳/۴/۵"

host, path, err := pymtptr.Split(value)
if nil != err {
	fmt.Printf("ERROR: %s\n", err)
	return
}

fmt.Printf("HOST: %q\n", host)
fmt.Printf("PATH: %q\n", path)

Output:

HOST: "example.com"
PATH: "/۱/۲/۳/۴/۵"
Example (OnlyHost) 
var value string = "$example.com"

host, path, err := pymtptr.Split(value)
if nil != err {
	fmt.Printf("ERROR: %s\n", err)
	return
}

fmt.Printf("HOST: %q\n", host)
fmt.Printf("PATH: %q\n", path)

Output:

HOST: "example.com"
PATH: ""
Example (WithPath) 
var value string = "$example.com/joeblow"

host, path, err := pymtptr.Split(value)
if nil != err {
	fmt.Printf("ERROR: %s\n", err)
	return
}

fmt.Printf("HOST: %q\n", host)
fmt.Printf("PATH: %q\n", path)

Output:

HOST: "example.com"
PATH: "/joeblow"
Example (WithSubDomain) 
var value string = "$joeblow.example.com"

host, path, err := pymtptr.Split(value)
if nil != err {
	fmt.Printf("ERROR: %s\n", err)
	return
}

fmt.Printf("HOST: %q\n", host)
fmt.Printf("PATH: %q\n", path)

Output:

HOST: "joeblow.example.com"
PATH: ""

Types

type PaymentPointer 

type PaymentPointer struct {
	Host string
	Path string
}

PaymentPointer represents a Payment-Pointer, as defined by: https://paymentpointers.org/ and https://paymentpointers.org/syntax/

func (*PaymentPointer) Parse 

func (receiver *PaymentPointer) Parse(value string) error

Parse parses a Payment-Pointer, and if valid, extracts the host and path from the Payment-Pointer and loads it into the receiver.

Host is NOT punycode encoded, but instead can contain non-ASCII Unicode characters.

Path is NOT urlencoded, but instead can contain non-ASCII Unicode characters.

Example (IdnaHost) 
var value string = "$xn--m28h.com"

var paymentPointer pymtptr.PaymentPointer

err := paymentPointer.Parse(value)
if nil != err {
	fmt.Printf("ERROR: %s\n", err)
	return
}

fmt.Printf("HOST: %q\n", paymentPointer.Host)
fmt.Printf("PATH: %q\n", paymentPointer.Path)

Output:

HOST: "😈.com"
PATH: ""
Example (NonAsciiHost) 
var value string = "$😈.com"

var paymentPointer pymtptr.PaymentPointer

err := paymentPointer.Parse(value)
if nil != err {
	fmt.Printf("ERROR: %s\n", err)
	return
}

fmt.Printf("HOST: %q\n", paymentPointer.Host)
fmt.Printf("PATH: %q\n", paymentPointer.Path)

Output:

HOST: "😈.com"
PATH: ""
Example (NonAsciiPath) 
var value string = "$example.com/۱/۲/۳/۴/۵"

var paymentPointer pymtptr.PaymentPointer

err := paymentPointer.Parse(value)
if nil != err {
	fmt.Printf("ERROR: %s\n", err)
	return
}

fmt.Printf("HOST: %q\n", paymentPointer.Host)
fmt.Printf("PATH: %q\n", paymentPointer.Path)

Output:

HOST: "example.com"
PATH: "/۱/۲/۳/۴/۵"
Example (OnlyHost) 
var value string = "$example.com"

var paymentPointer pymtptr.PaymentPointer

err := paymentPointer.Parse(value)
if nil != err {
	fmt.Printf("ERROR: %s\n", err)
	return
}

fmt.Printf("HOST: %q\n", paymentPointer.Host)
fmt.Printf("PATH: %q\n", paymentPointer.Path)

Output:

HOST: "example.com"
PATH: ""
Example (WithPath) 
var value string = "$example.com/joeblow"

var paymentPointer pymtptr.PaymentPointer

err := paymentPointer.Parse(value)
if nil != err {
	fmt.Printf("ERROR: %s\n", err)
	return
}

fmt.Printf("HOST: %q\n", paymentPointer.Host)
fmt.Printf("PATH: %q\n", paymentPointer.Path)

Output:

HOST: "example.com"
PATH: "/joeblow"
Example (WithSubDomain) 
var value string = "$joeblow.example.com"

var paymentPointer pymtptr.PaymentPointer

err := paymentPointer.Parse(value)
if nil != err {
	fmt.Printf("ERROR: %s\n", err)
	return
}

fmt.Printf("HOST: %q\n", paymentPointer.Host)
fmt.Printf("PATH: %q\n", paymentPointer.Path)

Output:

HOST: "joeblow.example.com"
PATH: ""

func (PaymentPointer) Pretty 

func (receiver PaymentPointer) Pretty() string

Pretty returns the "pretty" version of a payment-pointer.

NOTE that the the "pretty" version of a payment-pointer might NOT be a valid payment-pointer!

What pretty returns is meant to be a more human-legible form meant for displaying to people (and is NOT mean to be consumed by machines).

Some example "pretty" payment-pointer are: 

$example.com

$joeblow.example.com

$example.com/joeblow

$🙂.com/۱/۲/۳/۴/۵

Note that the last example of a "pretty" version of a payment-pointer (i.e., "$🙂.com/۱/۲/۳/۴/۵") is NOT a valid payment-pointer!

To get a valid payment-pointer, instead use PaymentPointer.String.

Example (IdnaHost) 
var paymentPointer = pymtptr.PaymentPointer{
	Host: "xn--m28h.com",
}

pretty := paymentPointer.Pretty()

fmt.Println(pretty)

Output:

$😈.com
Example (NonAsciiHost) 
var paymentPointer = pymtptr.PaymentPointer{
	Host: "😈.com",
}

pretty := paymentPointer.Pretty()

fmt.Println(pretty)

Output:

$😈.com
Example (NonAsciiPath) 
var paymentPointer = pymtptr.PaymentPointer{
	Host: "example.com",
	Path: "/۱/۲/۳/۴/۵",
}

pretty := paymentPointer.Pretty()

fmt.Println(pretty)

Output:

$example.com/۱/۲/۳/۴/۵
Example (OnlyHost) 
var paymentPointer = pymtptr.PaymentPointer{
	Host: "example.com",
}

str := paymentPointer.Pretty()

fmt.Println(str)

Output:

$example.com
Example (WithPath) 
var paymentPointer = pymtptr.PaymentPointer{
	Host: "example.com",
	Path: "/joeblow",
}

pretty := paymentPointer.Pretty()

fmt.Println(pretty)

Output:

$example.com/joeblow
Example (WithSubDomain) 
var paymentPointer = pymtptr.PaymentPointer{
	Host: "joeblow.example.com",
}

pretty := paymentPointer.Pretty()

fmt.Println(pretty)

Output:

$joeblow.example.com

func (PaymentPointer) Resolve 

func (receiver PaymentPointer) Resolve() string

Resolve resolves a PaymentPointer to an HTTP URL.

If the PaymentPointer receiver is NOT a valid the Resolve returns an empty string.

Example (IdnaHost) 
var paymentPointer = pymtptr.PaymentPointer{
	Host: "xn--m28h.com",
}

url := paymentPointer.Resolve()

fmt.Println(url)

Output:

https://xn--m28h.com/.well-known/pay
Example (NonAsciiHost) 
var paymentPointer = pymtptr.PaymentPointer{
	Host: "😈.com",
}

url := paymentPointer.Resolve()

fmt.Println(url)

Output:

https://xn--m28h.com/.well-known/pay
Example (NonAsciiPath) 
var paymentPointer = pymtptr.PaymentPointer{
	Host: "example.com",
	Path: "/۱/۲/۳/۴/۵",
}

url := paymentPointer.Resolve()

fmt.Println(url)

Output:

https://example.com/%DB%B1/%DB%B2/%DB%B3/%DB%B4/%DB%B5
Example (OnlyHost) 
var paymentPointer = pymtptr.PaymentPointer{
	Host: "example.com",
}

url := paymentPointer.Resolve()

fmt.Println(url)

Output:

https://example.com/.well-known/pay
Example (WithPath) 
var paymentPointer = pymtptr.PaymentPointer{
	Host: "example.com",
	Path: "/joeblow",
}

url := paymentPointer.Resolve()

fmt.Println(url)

Output:

https://example.com/joeblow
Example (WithSubDomain) 
var paymentPointer = pymtptr.PaymentPointer{
	Host: "joeblow.example.com",
}

url := paymentPointer.Resolve()

fmt.Println(url)

Output:

https://joeblow.example.com/.well-known/pay

func (PaymentPointer) String 

func (receiver PaymentPointer) String() string

String returns the payment-pointer.

An example payment-pointer looks like these: 

$example.com

$joeblow.example.com

$example.com/joeblow

$xn--938h.com/%DB%B1/%DB%B2/%DB%B3/%DB%B4/%DB%B5

Note that what String returns is in ASCII.

A host with non-ASCII characters is encoded into ASCII using punycode.

A path with non-ASCII character is encoded into ASCII using urlencode.

Example (IdnaHost) 
var paymentPointer = pymtptr.PaymentPointer{
	Host: "xn--m28h.com",
}

str := paymentPointer.String()

fmt.Println(str)

Output:

$xn--m28h.com
Example (NonAsciiHost) 
var paymentPointer = pymtptr.PaymentPointer{
	Host: "😈.com",
}

str := paymentPointer.String()

fmt.Println(str)

Output:

$xn--m28h.com
Example (NonAsciiPath) 
var paymentPointer = pymtptr.PaymentPointer{
	Host: "example.com",
	Path: "/۱/۲/۳/۴/۵",
}

str := paymentPointer.String()

fmt.Println(str)

Output:

$example.com/%DB%B1/%DB%B2/%DB%B3/%DB%B4/%DB%B5
Example (OnlyHost) 
var paymentPointer = pymtptr.PaymentPointer{
	Host: "example.com",
}

str := paymentPointer.String()

fmt.Println(str)

Output:

$example.com
Example (WithPath) 
var paymentPointer = pymtptr.PaymentPointer{
	Host: "example.com",
	Path: "/joeblow",
}

str := paymentPointer.String()

fmt.Println(str)

Output:

$example.com/joeblow
Example (WithSubDomain) 
var paymentPointer = pymtptr.PaymentPointer{
	Host: "joeblow.example.com",
}

str := paymentPointer.String()

fmt.Println(str)

Output:

$joeblow.example.com

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.