Types

All TypeScript types exported by nostr-core.

Import

import type {
  GetInfoResponse,
  GetBalanceResponse,
  GetBudgetResponse,
  PayResponse,
  Transaction,
  // ... etc
} from 'nostr-core'

NWC Types

NWCConnectionOptions

type NWCConnectionOptions = {
  walletPubkey: string
  relayUrl: string
  secret: string
}

EncryptionType

type EncryptionType = 'nip04' | 'nip44'

Nip47Method

type Nip47Method =
  | 'get_info'
  | 'get_balance'
  | 'get_budget'
  | 'make_invoice'
  | 'pay_invoice'
  | 'pay_keysend'
  | 'lookup_invoice'
  | 'list_transactions'
  | 'sign_message'

Nip47NotificationType

type Nip47NotificationType = 'payment_received' | 'payment_sent' | 'hold_invoice_accepted'

Nip47Notification

type Nip47Notification = {
  notification_type: Nip47NotificationType
  notification: Transaction
}

Response Types

GetInfoResponse

type GetInfoResponse = {
  alias: string
  color: string
  pubkey: string
  network: string
  block_height: number
  block_hash: string
  methods: string[]
  notifications?: string[]
}

GetBalanceResponse

type GetBalanceResponse = {
  balance: number // millisatoshis
}

GetBudgetResponse

type GetBudgetResponse = {
  used_budget?: number
  total_budget?: number
  renews_at?: number
  renewal_period?: string
}

PayResponse

type PayResponse = {
  preimage: string
  fees_paid?: number
}

Transaction

type Transaction = {
  type: 'incoming' | 'outgoing'
  state: 'settled' | 'pending' | 'failed' | 'accepted'
  invoice: string
  description: string
  description_hash: string
  preimage: string
  payment_hash: string
  amount: number         // millisatoshis
  fees_paid: number
  settled_at: number     // unix timestamp
  created_at: number     // unix timestamp
  expires_at: number     // unix timestamp
  metadata?: Record<string, unknown>
}

Field	Type	Description
state	string	Transaction state: 'settled', 'pending', 'failed', or 'accepted' (hold invoices)

ListTransactionsResponse

type ListTransactionsResponse = {
  transactions: Transaction[]
}

SignMessageResponse

type SignMessageResponse = {
  message: string
  signature: string
}

Request Types

MakeInvoiceRequest

type MakeInvoiceRequest = {
  amount: number           // millisatoshis
  description?: string
  description_hash?: string
  expiry?: number          // seconds
}

PayInvoiceRequest

type PayInvoiceRequest = {
  invoice: string
  amount?: number // millisatoshis, for zero-amount invoices
}

PayKeysendRequest

type PayKeysendRequest = {
  amount: number   // millisatoshis
  pubkey: string
  preimage?: string
  tlv_records?: Array<{ type: number; value: string }>
}

LookupInvoiceRequest

type LookupInvoiceRequest = {
  payment_hash?: string
  invoice?: string
}

ListTransactionsRequest

type ListTransactionsRequest = {
  from?: number
  until?: number
  limit?: number
  offset?: number
  unpaid?: boolean
  type?: 'incoming' | 'outgoing'
}

SignMessageRequest

type SignMessageRequest = {
  message: string
}

Event Types

See the Event API reference for NostrEvent, EventTemplate, UnsignedEvent, and VerifiedEvent.

Filter Type

See the Filter API reference for the Filter type.

NIP-19 Types

See the NIP-19 API reference for ProfilePointer, EventPointer, AddressPointer, and DecodedResult.