AppleSauce
Preparing search index...
applesauce-accounts
IAccount
Interface IAccount<Signer, SignerData, Metadata>
An interface for an account
interface
IAccount
<
Signer
extends
ISigner
=
ISigner
,
SignerData
=
any
,
Metadata
extends
unknown
=
any
,
>
{
disableQueue
?:
boolean
;
getPublicKey
:
()
=>
Promise
<
string
>
;
id
:
string
;
metadata
?:
Metadata
;
name
?:
string
;
nip04
?:
{
decrypt
:
(
pubkey
:
string
,
ciphertext
:
string
)
=>
Promise
<
string
>
;
encrypt
:
(
pubkey
:
string
,
plaintext
:
string
)
=>
Promise
<
string
>
;
}
;
nip44
?:
{
decrypt
:
(
pubkey
:
string
,
ciphertext
:
string
)
=>
Promise
<
string
>
;
encrypt
:
(
pubkey
:
string
,
plaintext
:
string
)
=>
Promise
<
string
>
;
}
;
pubkey
:
string
;
signer
:
Signer
;
signEvent
:
(
template
:
EventTemplate
)
=>
Promise
<
Event
>
;
type
:
string
;
toJSON
()
:
SerializedAccount
<
SignerData
,
Metadata
>
;
}
Type Parameters
Signer
extends
ISigner
=
ISigner
SignerData
=
any
Metadata
extends
unknown
=
any
Hierarchy (
View Summary
)
ISigner
IAccount
Implemented by
BaseAccount
Index
Properties
disable
Queue?
get
Public
Key
id
metadata?
name?
nip04?
nip44?
pubkey
signer
sign
Event
type
Methods
to
JSON
Properties
Optional
disable
Queue
disableQueue
?:
boolean
get
Public
Key
getPublicKey
:
()
=>
Promise
<
string
>
id
id
:
string
Optional
metadata
metadata
?:
Metadata
Optional
name
name
?:
string
Optional
nip04
nip04
?:
{
decrypt
:
(
pubkey
:
string
,
ciphertext
:
string
)
=>
Promise
<
string
>
;
encrypt
:
(
pubkey
:
string
,
plaintext
:
string
)
=>
Promise
<
string
>
;
}
Optional
nip44
nip44
?:
{
decrypt
:
(
pubkey
:
string
,
ciphertext
:
string
)
=>
Promise
<
string
>
;
encrypt
:
(
pubkey
:
string
,
plaintext
:
string
)
=>
Promise
<
string
>
;
}
pubkey
pubkey
:
string
signer
signer
:
Signer
sign
Event
signEvent
:
(
template
:
EventTemplate
)
=>
Promise
<
Event
>
type
type
:
string
Methods
to
JSON
toJSON
()
:
SerializedAccount
<
SignerData
,
Metadata
>
Returns
SerializedAccount
<
SignerData
,
Metadata
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
disable
Queue
get
Public
Key
id
metadata
name
nip04
nip44
pubkey
signer
sign
Event
type
Methods
to
JSON
AppleSauce
Loading...
An interface for an account