keyer: move interfaces to toplevel "nostr" package.

This commit is contained in:
fiatjaf
2024-10-14 16:25:24 -03:00
parent 9057b1a7e1
commit ee5ca07d6d
3 changed files with 52 additions and 17 deletions

20
keyer.go Normal file
View File

@@ -0,0 +1,20 @@
package nostr
import "context"
type Keyer interface {
Signer
Cipher
}
// A Signer provides basic public key signing methods.
type Signer interface {
GetPublicKey(context.Context) (string, error)
SignEvent(context.Context, *Event) error
}
// A Cipher provides NIP-44 encryption and decryption methods.
type Cipher interface {
Encrypt(ctx context.Context, plaintext string, recipientPublicKey string) (base64ciphertext string, err error)
Decrypt(ctx context.Context, base64ciphertext string, senderPublicKey string) (plaintext string, err error)
}

25
keyer/deprecated.go Normal file
View File

@@ -0,0 +1,25 @@
package keyer
import (
"context"
"github.com/nbd-wtf/go-nostr"
)
// Deprecated: use nostr.Keyer instead
type Keyer interface {
Signer
Cipher
}
// Deprecated: use nostr.Signer instead
type Signer interface {
GetPublicKey(context.Context) (string, error)
SignEvent(context.Context, *nostr.Event) error
}
// Deprecated: use nostr.Cipher instead
type Cipher interface {
Encrypt(ctx context.Context, plaintext string, recipientPublicKey string) (base64ciphertext string, err error)
Decrypt(ctx context.Context, base64ciphertext string, senderPublicKey string) (plaintext string, err error)
}

View File

@@ -15,22 +15,12 @@ import (
"github.com/puzpuzpuz/xsync/v3"
)
type Keyer interface {
Signer
Cipher
}
// A Signer provides basic public key signing methods.
type Signer interface {
GetPublicKey(context.Context) (string, error)
SignEvent(context.Context, *nostr.Event) error
}
// A Cipher provides NIP-44 encryption and decryption methods.
type Cipher interface {
Encrypt(ctx context.Context, plaintext string, recipientPublicKey string) (base64ciphertext string, err error)
Decrypt(ctx context.Context, base64ciphertext string, senderPublicKey string) (plaintext string, err error)
}
var (
_ nostr.Keyer = (*BunkerSigner)(nil)
_ nostr.Keyer = (*EncryptedKeySigner)(nil)
_ nostr.Keyer = (*KeySigner)(nil)
_ nostr.Keyer = (*ManualSigner)(nil)
)
type SignerOptions struct {
BunkerClientSecretKey string
@@ -45,7 +35,7 @@ type SignerOptions struct {
Password string
}
func New(ctx context.Context, pool *nostr.SimplePool, input string, opts *SignerOptions) (Keyer, error) {
func New(ctx context.Context, pool *nostr.SimplePool, input string, opts *SignerOptions) (nostr.Keyer, error) {
if opts == nil {
opts = &SignerOptions{}
}