Class WalletInfoFactory

The base class for building or modifying events

Hierarchy (View Summary)

EventFactory<typeof WALLET_INFO_KIND, WalletInfoTemplate>
- WalletInfoFactory

Index

Constructors

constructor

new WalletInfoFactory(
    executor: (
        resolve: (
            value: WalletInfoTemplate | PromiseLike<WalletInfoTemplate>,
        ) => void,
        reject: (reason?: any) => void,
    ) => void,
): WalletInfoFactory
Creates a new Promise.
Parameters
- executor: (
      resolve: (
          value: WalletInfoTemplate | PromiseLike<WalletInfoTemplate>,
      ) => void,
      reject: (reason?: any) => void,
  ) => void
  A callback used to initialize the promise. This callback is passed two arguments: a resolve callback used to resolve the promise with a value or the result of another promise, and a reject callback used to reject the promise with a provided reason or error.
Returns WalletInfoFactory
Inherited from EventFactory.constructor
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.promise.d.ts:31

Properties

`Protected`_signerRef

_signerRef: SignerRef

Shared mutable reference to the signer, propagated through all chain links

`Readonly`[toStringTag]

"[toStringTag]": string

`Static` `Readonly`[species]

"[species]": PromiseConstructor

Accessors

`Protected`signer

get signer(): EventSigner | undefined
The signer used to sign the event (reads from shared ref)

Returns EventSigner | undefined
Inherited from EventFactory.signer
- Defined in packages/core/dist/factories/event.d.ts:24
set signer(value: EventSigner | undefined): void
Parameters
- value: EventSigner | undefined
Returns void
Inherited from EventFactory.signer
- Defined in packages/core/dist/factories/event.d.ts:25

Methods

alt

alt(alt: string): this
Sets the NIP-31 alt tag for the event
Parameters
- alt: string
Returns this
Inherited from EventFactory.alt
- Defined in packages/core/dist/factories/event.d.ts:45

as

as(signer: EventSigner): this
Sets the event signer to use when building this event
Parameters
- signer: EventSigner
Returns this
Inherited from EventFactory.as
- Defined in packages/core/dist/factories/event.d.ts:29

catch

catch<TResult = never>(
onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null,
): Promise<WalletInfoTemplate | TResult>
Attaches a callback for only the rejection of the Promise.
Type Parameters
- TResult = never
Parameters
- Optionalonrejected: ((reason: any) => TResult | PromiseLike<TResult>) | null
  The callback to execute when the Promise is rejected.
Returns Promise<WalletInfoTemplate | TResult>
A Promise for the completion of the callback.
Inherited from EventFactory.catch
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1564

`Protected`chain

chain(operation: EventOperation<WalletInfoTemplate>): this
Custom .then method that wraps the resulting promise in a new event factory
Parameters
- operation: EventOperation<WalletInfoTemplate>
Returns this
Inherited from EventFactory.chain
- Defined in packages/core/dist/factories/event.d.ts:27

client

client(pubkey: string, relay?: string): WalletInfoFactory
Parameters
- pubkey: string
- Optionalrelay: string
Returns WalletInfoFactory
- Defined in packages/wallet-connect/src/factories/support.ts:35

content

content(content: string): this
Sets the event content
Parameters
- content: string
Returns this
Inherited from EventFactory.content
- Defined in packages/core/dist/factories/event.d.ts:39

contentWarning

contentWarning(warning: string | boolean): this
Sets the NIP-36 content-warning tag for the event
Parameters
- warning: string | boolean
Returns this
Inherited from EventFactory.contentWarning
- Defined in packages/core/dist/factories/event.d.ts:49

created

created(created?: number | Date): this
Set the event created_at timestamp in seconds. if no value is provided, the current unix timestamp will be used
Parameters
- Optionalcreated: number | Date
Returns this
Inherited from EventFactory.created
- Defined in packages/core/dist/factories/event.d.ts:41

encryptedContent

encryptedContent(
    target: string,
    content: string,
    override?: EncryptionMethod,
): this
Sets the encrypted content of the event
Parameters
- target: string
- content: string
- Optionaloverride: EncryptionMethod
Returns this
Inherited from EventFactory.encryptedContent
- Defined in packages/core/dist/factories/event.d.ts:59

encryption

encryption(methods: string[]): WalletInfoFactory
Parameters
- methods: string[]
Returns WalletInfoFactory
- Defined in packages/wallet-connect/src/factories/support.ts:27

expiration

expiration(timestamp: number): this
Sets the NIP-40 expiration timestamp for the event
Parameters
- timestamp: number
Returns this
Inherited from EventFactory.expiration
- Defined in packages/core/dist/factories/event.d.ts:47

finally

finally(onfinally?: (() => void) | null): Promise<WalletInfoTemplate>
Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.
Parameters
- Optionalonfinally: (() => void) | null
  The callback to execute when the Promise is settled (fulfilled or rejected).
Returns Promise<WalletInfoTemplate>
A Promise for the completion of the callback.
Inherited from EventFactory.finally
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2018.promise.d.ts:29

kind

kind<Kind extends number>(
kind: Kind,
): EventFactory<Kind, KnownEventTemplate<Kind>>
Sets the event kind and casts the result to a
Type Parameters
- Kind extends number
Parameters
- kind: Kind
Returns EventFactory<Kind, KnownEventTemplate<Kind>>
Inherited from EventFactory.kind
- Defined in packages/core/dist/factories/event.d.ts:37

methods

methods(methods: string[]): WalletInfoFactory
Parameters
- methods: string[]
Returns WalletInfoFactory
- Defined in packages/wallet-connect/src/factories/support.ts:23

modifyHiddenTags

modifyHiddenTags(...args: TagOperation[]): this
Modifies the events hidden tags array
Parameters
- ...args: TagOperation[]
Returns this
Inherited from EventFactory.modifyHiddenTags
- Defined in packages/core/dist/factories/event.d.ts:57

modifyPublicTags

modifyPublicTags(...args: (TagOperation | undefined)[]): this
Modifies the events public tags array
Parameters
- ...args: (TagOperation | undefined)[]
Returns this
Inherited from EventFactory.modifyPublicTags
- Defined in packages/core/dist/factories/event.d.ts:55

modifyTags

modifyTags(
...args: [tagOperations?: ModifyTagsOptions, signer?: EventSigner],
): this
Modifies the events public and optional hidden tags
Parameters
- ...args: [tagOperations?: ModifyTagsOptions, signer?: EventSigner]
Returns this
Inherited from EventFactory.modifyTags
- Defined in packages/core/dist/factories/event.d.ts:53

notifications

notifications(types: string[]): WalletInfoFactory
Parameters
- types: string[]
Returns WalletInfoFactory
- Defined in packages/wallet-connect/src/factories/support.ts:31

protected

protected(isProtected: boolean): this
Sets the NIP-70 "-" tag for the event
Parameters
- isProtected: boolean
Returns this
Inherited from EventFactory.protected
- Defined in packages/core/dist/factories/event.d.ts:51

sign

sign(signer?: EventSigner): Promise<KnownEvent<13194>>
Signs the event using a signer interface and returns a Promise
Parameters
- Optionalsigner: EventSigner
Returns Promise<KnownEvent<13194>>
Inherited from EventFactory.sign
- Defined in packages/core/dist/factories/event.d.ts:35

stamp

stamp(signer?: EventSigner): EventFactory<13194, KnownUnsignedEvent<13194>>
Stamps the pubkey onto the event template
Parameters
- Optionalsigner: EventSigner
Returns EventFactory<13194, KnownUnsignedEvent<13194>>
Inherited from EventFactory.stamp
- Defined in packages/core/dist/factories/event.d.ts:33

strip

strip(): EventFactory<13194>
Strips the pubkey, sig, and id from the event

Returns EventFactory<13194>
Inherited from EventFactory.strip
- Defined in packages/core/dist/factories/event.d.ts:31

then

then<TResult1 = WalletInfoTemplate, TResult2 = never>(
    onfulfilled?:
        | ((value: WalletInfoTemplate) => TResult1 | PromiseLike<TResult1>)
        | null,
    onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null,
): Promise<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type Parameters
- TResult1 = WalletInfoTemplate
- TResult2 = never
Parameters
- Optionalonfulfilled: ((value: WalletInfoTemplate) => TResult1 | PromiseLike<TResult1>) | null
  The callback to execute when the Promise is resolved.
- Optionalonrejected: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null
  The callback to execute when the Promise is rejected.
Returns Promise<TResult1 | TResult2>
A Promise for the completion of which ever callback is executed.
Inherited from EventFactory.then
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1557

`Static`all

all<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>[]>
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
  An iterable of Promises.
Returns Promise<Awaited<T>[]>
A new Promise.
Inherited from EventFactory.all
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:255
all<T extends [] | readonly unknown[]>(
values: T,
): Promise<{ -readonly [P in string | number | symbol]: Awaited<T[P]> }>
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- values: T
  An array of Promises.
Returns Promise<{ -readonly [P in string | number | symbol]: Awaited<T[P]> }>
A new Promise.
Inherited from EventFactory.all
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.promise.d.ts:39

`Static`allSettled

allSettled<T extends [] | readonly unknown[]>(
    values: T,
): Promise<
    {
        -readonly [P in string
        | number
        | symbol]: PromiseSettledResult<Awaited<T[P]>>
    },
>
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve or reject.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- values: T
  An array of Promises.
Returns Promise<
    {
        -readonly [P in string
        | number
        | symbol]: PromiseSettledResult<Awaited<T[P]>>
    },
>
A new Promise.
Inherited from EventFactory.allSettled
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2020.promise.d.ts:38
allSettled<T>(
values: Iterable<T | PromiseLike<T>>,
): Promise<PromiseSettledResult<Awaited<T>>[]>
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve or reject.
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
  An array of Promises.
Returns Promise<PromiseSettledResult<Awaited<T>>[]>
A new Promise.
Inherited from EventFactory.allSettled
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2020.promise.d.ts:46

`Static`any

any<T extends [] | readonly unknown[]>(values: T): Promise<Awaited<T[number]>>
The any function returns a promise that is fulfilled by the first given promise to be fulfilled, or rejected with an AggregateError containing an array of rejection reasons if all of the given promises are rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- values: T
  An array or iterable of Promises.
Returns Promise<Awaited<T[number]>>
A new Promise.
Inherited from EventFactory.any
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2021.promise.d.ts:40
any<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>>
The any function returns a promise that is fulfilled by the first given promise to be fulfilled, or rejected with an AggregateError containing an array of rejection reasons if all of the given promises are rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm.
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
  An array or iterable of Promises.
Returns Promise<Awaited<T>>
A new Promise.
Inherited from EventFactory.any
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2021.promise.d.ts:47

`Static`create

create<Methods extends TWalletMethod>(
    info: WalletSupport<Methods>,
    client?: string,
    overrideRelay?: string,
): WalletInfoFactory
Type Parameters
- Methods extends TWalletMethod
Parameters
- info: WalletSupport<Methods>
- Optionalclient: string
- OptionaloverrideRelay: string
Returns WalletInfoFactory
- Defined in packages/wallet-connect/src/factories/support.ts:11

`Static`fromEvent

fromEvent<K extends number = number>(
event: KnownEvent<K>,
): EventFactory<K, KnownEventTemplate<K>>
Create a new event factory from a nostr event
Type Parameters
- K extends number = number
Parameters
- event: KnownEvent<K>
Returns EventFactory<K, KnownEventTemplate<K>>
Inherited from EventFactory.fromEvent
- Defined in packages/core/dist/factories/event.d.ts:20

`Static`fromKind

fromKind<K extends number>(kind: K): EventFactory<K>
Create a new event factory from a kind
Type Parameters
- K extends number
Parameters
- kind: K
Returns EventFactory<K>
Inherited from EventFactory.fromKind
- Defined in packages/core/dist/factories/event.d.ts:18

`Static`race

race<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>>
Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
  An iterable of Promises.
Returns Promise<Awaited<T>>
A new Promise.
Inherited from EventFactory.race
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:263
race<T extends [] | readonly unknown[]>(values: T): Promise<Awaited<T[number]>>
Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- values: T
  An array of Promises.
Returns Promise<Awaited<T[number]>>
A new Promise.
Inherited from EventFactory.race
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.promise.d.ts:50

`Static`reject

reject<T = never>(reason?: any): Promise<T>
Creates a new rejected promise for the provided reason.
Type Parameters
- T = never
Parameters
- Optionalreason: any
  The reason the promise was rejected.
Returns Promise<T>
A new rejected Promise.
Inherited from EventFactory.reject
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.promise.d.ts:60

`Static`resolve

resolve(): Promise<void>
Creates a new resolved promise.

Returns Promise<void>
A resolved promise.
Inherited from EventFactory.resolve
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.promise.d.ts:66
resolve<T>(value: T): Promise<Awaited<T>>
Creates a new resolved promise for the provided value.
Type Parameters
- T
Parameters
- value: T
  A promise.
Returns Promise<Awaited<T>>
A promise whose internal state matches the provided promise.
Inherited from EventFactory.resolve
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.promise.d.ts:72
resolve<T>(value: T | PromiseLike<T>): Promise<Awaited<T>>
Creates a new resolved promise for the provided value.
Type Parameters
- T
Parameters
- value: T | PromiseLike<T>
  A promise.
Returns Promise<Awaited<T>>
A promise whose internal state matches the provided promise.
Inherited from EventFactory.resolve
- Defined in node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.promise.d.ts:78

Class WalletInfoFactory

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WalletInfoFactory

Properties

Protected_signerRef

Readonly[toStringTag]

Static Readonly[species]

Accessors

Protectedsigner

Returns EventSigner | undefined

Parameters

Returns void

Methods

alt

Parameters

Returns this

as

Parameters

Returns this

catch

Type Parameters

Parameters

Returns Promise<WalletInfoTemplate | TResult>

Protectedchain

Parameters

Returns this

client

Parameters

Returns WalletInfoFactory

content

Parameters

Returns this

contentWarning

Parameters

Returns this

created

Parameters

Returns this

encryptedContent

Parameters

Returns this

encryption

Parameters

Returns WalletInfoFactory

expiration

Parameters

Returns this

finally

Parameters

Returns Promise<WalletInfoTemplate>

kind

Type Parameters

Parameters

Returns EventFactory<Kind, KnownEventTemplate<Kind>>

meta

Parameters

Returns this

methods

Parameters

Returns WalletInfoFactory

modifyHiddenTags

Parameters

Returns this

modifyPublicTags

Parameters

Returns this

modifyTags

Parameters

Returns this

notifications

Parameters

Returns WalletInfoFactory

`Protected`_signerRef

`Readonly`[toStringTag]

`Static` `Readonly`[species]

`Protected`signer

`Protected`chain

`Static`all

`Static`allSettled

Returns Promise<
{
-readonly [P in string
| number
| symbol]: PromiseSettledResult<Awaited<T[P]>>
},
>

`Static`any

`Static`create

`Static`fromEvent

`Static`fromKind

`Static`race

`Static`reject

`Static`resolve