Skip to content

Latest commit

 

History

History
480 lines (348 loc) · 15.8 KB

README.md

File metadata and controls

480 lines (348 loc) · 15.8 KB
Raw

nostr-hooks

Nostr-Hooks

React hooks for developing Nostr clients. It's simple yet intelligent.

NPM Downloads

Nostr-Hooks is a stateful wrapper library of React hooks around NDK, designed to simplify the process of interacting with the Nostr protocol in real-time web applications. It provides an easy-to-use interface with low bandwidth consumption and high performance, allowing developers to quickly integrate Nostr into their projects and build responsive, real-time applications.

Supported by

OpenSats

Features

  • Provides high-level hooks to interact with the Nostr protocol, making it easy to integrate Nostr into React applications.
  • Provides a single instance of Nostr pool for the entire application, which is reused by all components.
  • Creates a single connection to each Nostr relay at a time and reuses it for all subscriptions, reducing network overhead.
  • Automatically manages subscriptions from multiple components and delivers only the events that each component needs.
  • Automatically batches multiple subscriptions from different components into a single subscription request, further reducing network overhead.
  • Intelligently merges filters into a unique set of filters, reducing the load on the Nostr relays.
  • Provides a built-in cache mechanism since version 1.1.
  • Minimizes re-renders by updating only the events that have changed, improving application performance.
  • Automatically cleans up subscriptions and garbage events when a component unmounts, preventing memory leaks.
Isn't nostr-tools or NDK enough? Why do we need Nostr-Hooks?

Nostr-Hooks is not a replacement for NDK or nostr-tools. You may still need to install and use them in your application for some advanced low-level functionalities. As you may know NDK is a powerful library (shout-out to pablo) with a lot of out-of-the-box features, like caching, batching, and merging filters. However, it's a stateless library and doesn't understand the React component lifecycle. This means that it's up to the developer to update the component state when new events arrive, and to unsubscribe from the subscription when the component unmounts. This can be a tedious and error-prone process, especially when scaling the application. Nostr-Hooks on the other hand, is a stateful wrapper library that manages the component state and subscriptions automatically, allowing the developer to focus on building and scaling the application. Nostr-Hooks also provides a bunch of well-designed high-level hooks to interact with relays, so you don't need to worry about the low-level details any more.

Usage

Installation

npm install nostr-hooks

Initialize NostrHooks

You need to initialize NostrHooks in your root component. This will execute ndk.connect() under the hood and create a single instance of Nostr pool for the entire application that can be reused by all components.

import { useNostrHooks } from 'nostr-hooks';

const App = () => {
  useNostrHooks();

  return <YourApp />;
};

You can also pass a custom NDK instance to the useNostrHooks hook. This is useful when you want to initiate your app with a custom NDK instance with your own configuration.

import { useNostrHooks } from 'nostr-hooks';

const customNDK = new NDK({
  /* ... */
});

const App = () => {
  useNostrHooks(customNDK);

  return <YourApp />;
};

⚠️ Remember to use memoization techniques like useMemo to prevent re-creating the custom NDK instance on every render and avoid infinite re-render loops.

Subscribe to events

Here are some examples of how to use the useSubscribe hook:

Example 1: Basic usage:

import { useSubscribe } from 'nostr-hooks';

const filters = [{ authors: ['pubkey1'], kinds: [1] }];

const MyComponent = () => {
  const { events } = useSubscribe({ filters });

  if (!events) return <p>Loading...</p>;

  return (
    <ul>
      {events.map((event) => (
        <li key={event.id}>
          <p>{event.pubkey}</p>
          <p>{event.kind}</p>
        </li>
      ))}
    </ul>
  );
};

The useSubscribe hook takes an object with one mandatory and some optional parameters:

  • filters: A mandatory array of filters that the subscription should be created for.
  • enabled: An optional boolean flag indicating whether the subscription is enabled. If set to false, the subscription will not be created automatically.
  • opts: An optional "NDK Subscription Options" object.
  • relays: An optional array of relay urls to use for the subscription. If not provided, the default relays will be used.
  • fetchProfiles: An optional boolean flag indicating whether to fetch profiles for the events in the subscription. If set to true, the profiles will be fetched automatically.

There are lots of options available for creating a subscription. Read more about the NDK subscription options here

The useSubscribe hook returns an object with a few properties:

  • events: An array of events that match the filters.
  • eose: A boolean flag indicating whether the subscription has reached the end of the stream.
  • unSubscribe: A function that can be used to unsubscribe from the subscription.
  • isSubscribed: A boolean flag indicating whether the subscription is active.
  • hasMore: A boolean flag indicating whether there are more events available to fetch.
  • loadMore: A function that can be used to fetch more events.

⚠️ Note that since version 2.8.0, the useSubscribe hook is sensitive to all the input parameters. If any of the input parameters change, the hook will unsubscribe from the previous subscription and subscribe to the new one. This will help you to subscribe to different filters based on the input parameters. You need to make sure that the input parameters are memoized and don't change on every render to avoid infinite re-render loops.

🚫 Don't:

const MyComponent = ({ pubkey }) => {
  const { events } = useSubscribe({ filters: [{ authors: [pubkey], kinds: [1] }] });

  // ...
};

✅ Do:

const MyComponent = ({ pubkey }) => {
  const filters = useMemo(() => [{ authors: [pubkey], kinds: [1] }], [pubkey]);

  const { events } = useSubscribe({ filters });

  // ...
};

Example 2: Using multiple subscriptions in a single component:

import { useSubscribe } from 'nostr-hooks';

// You can define filters outside the component to prevent re-creating them on every render
const articlesFilters = [{ authors: ['pubkey'], kinds: [30023] }];
const notesFilters = [{ authors: ['pubkey'], kinds: [1] }];

const MyComponent = () => {
  const { events: articles } = useSubscribe({ filters: articlesFilters });

  const { events: notes } = useSubscribe({ filters: notesFilters });

  return (
    <>
      <ul>
        {articles.map((article) => (
          <li key={article.id}>
            <p>{article.pubkey}</p>
            <p>{article.content}</p>
          </li>
        ))}
      </ul>

      <ul>
        {notes.map((note) => (
          <li key={note.id}>
            <p>{note.pubkey}</p>
            <p>{note.content}</p>
          </li>
        ))}
      </ul>
    </>
  );
};

The useSubscribe hook can be used multiple times in a single component. Nostr-Hooks batches all subscriptions into a single subscription request, and delivers only the events that each hook needs.

Example 3: Using subscriptions in multiple components:

import { useSubscribe } from 'nostr-hooks';

const App = () => {
  return (
    <>
      <ComponentA />
      <ComponentB />
    </>
  );
};

const ComponentA = () => {
  const filters = useMemo(() => [{ authors: ['pubkey'], kinds: [1] }], []);
  const { events } = useSubscribe({ filters });

  return (
    <ul>
      {events.map((event) => (
        <li key={event.id}>
          <p>{event.pubkey}</p>
          <p>{event.kind}</p>
        </li>
      ))}
    </ul>
  );
};

const ComponentB = () => {
  const filters = useMemo(() => [{ authors: ['pubkey'], kinds: [30023] }], []);
  const { events } = useSubscribe({ filters });

  return (
    <ul>
      {events.map((event) => (
        <li key={event.id}>
          <p>{event.pubkey}</p>
          <p>{event.content}</p>
        </li>
      ))}
    </ul>
  );
};

The useSubscribe hook can be used in multiple components. Nostr-Hooks batches all subscriptions from all components into a single subscription request, and delivers only the events that each component needs.

Example 4: Dependent subscriptions:

import { useSubscribe } from 'nostr-hooks';

const MyComponent = ({ noteId }: Params) => {
  const { events } = useSubscribe(useMemo(() => ({
    filters: [{ ids: [noteId] }],
    enabled: !!noteId,
  }), [noteId]));

  return (
    <>
      <ul>
        {events.map((event) => (
          <li key={event.id}>
            <p>{event.pubkey}</p>
            <p>{event.content}</p>
          </li>
        ))}
      </ul>
    </>
  );
};

The useSubscribe hook can be used in a component that depends on a prop or state. In this example, the subscription waits for the noteId prop to be set before creating the subscription.

Publish new events

The useNewEvent hook is used to create a new NDK event, which can then be published using the internal publish method.

import { useNewEvent } from 'nostr-hooks';

const MyComponent = () => {
  const [content, setContent] = useState('');

  const { createNewEvent } = useNewEvent();

  const handlePublish = () => {
    const event = createNewEvent();
    event.content = content;
    event.kind = 1;

    event.publish();
  };

  return (
    <>
      <input type="text" value={content} onChange={(e) => setContent(e.target.value)} />

      <button onClick={() => handlePublish()}>Publish Note</button>
    </>
  );
};

There is also a usePublish hook that can be used to publish an existing NDK event.

Fetch Profile for a user

The useProfile hook is used to fetch profile for a given user based on their pubkey, npub, nip46 address, or nip05. It returns the fetched profile.

const MyComponent = () => {
  const { profile } = useProfile({ pubkey: '...' });

  return (
    <div>
      <p>{profile?.displayName}</p>
      <p>{profile?.about}</p>
    </div>
  );
};

You can also pass an optional ndk parameter to the useProfile hook to fetch the profile using a custom NDK instance.

Interact with NDK instance

You can leverage useNdk hook to interact with the NDK instance. it returns the NDK instance itself, and a setter function for updating the NDK instance.

import { useNdk } from 'nostr-hooks';

const newNdk = new NDK({
  /* ... */
});

const MyComponent = () => {
  const { ndk, setNdk } = useNdk();

  // You can use the ndk instance to interact with the NDK library
  // Example:
  ndk.getUser({ npub: 'npub1...' }); // Get a user by their npub

  // You can also update the NDK instance using the setNdk function
  // Example:
  setNdk(newNdk); // this will replace the existing NDK instance with the new one
};

Interact with Signer

You can leverage useSigner hook to interact with the signer. it returns the signer itself, and a setter function for updating the signer.

import { useSigner } from 'nostr-hooks';

const newSigner = new NDKNip07Signer();

const MyComponent = () => {
  const { signer, setSigner } = useSigner();

  // You can use the signer instance to interact with the signer
  // Example:
  signer.sign(event); // Sign an event

  // You can also update the signer using the setSigner function
  // Example:
  setSigner(newSigner); // this will keep the existing NDK instance and update its signer
};

You may not need to use the useSigner hook directly, as it's used internally by the useLogin hook.

Login with different signers

You can use the useLogin hook to login with different signers. This hook will automatically update the NDK instance with the new signer. It also uses local storage to persist the login method, so the user doesn't need to login manually every time the page reloads or the app restarts.

The useLogin hook provides 4 methods for logging in with different signers, and 1 method for logging out:

  • loginWithExtension: Login with Nostr Extension (NIP07).
  • loginWithRemoteSigner: Login with Remote Signer (NIP46).
  • loginWithSecretKey: Login with Secret Key.
  • loginFromLocalStorage: Login from previously saved login method in local storage.
  • logout: Logout.
import { useLogin } from 'nostr-hooks';

const MyComponent = () => {
  const {
    loginWithExtension,
    loginWithRemoteSigner,
    loginWithSecretKey,
    loginFromLocalStorage,
    logout,
  } = useLogin();

  return (
    <>
      <button onClick={() => loginWithExtension()}>Login with Extension</button>
      <button onClick={() => loginWithRemoteSigner()}>Login with Remote Signer</button>
      <button onClick={() => loginWithSecretKey()}>Login with Secret Key</button>
      <button onClick={() => loginFromLocalStorage()}>Login from Local Storage</button>
      <button onClick={() => logout()}>Logout</button>
    </>
  );
};

Using a custom NDK instance:

If you are using a custom NDK instance, you can pass it to the useLogin hook along with its setter function to update your custom NDK instance with the new signer instead of the default NDK instance.

import { useLogin } from 'nostr-hooks';

const MyComponent = () => {
  const [customNdk, setCustomNdk] = useState<NDK>(
    new NDK({
      /* ... */
    })
  );

  const { loginWithExtension } = useLogin({ customNdk, setCustomNdk });

  return <button onClick={() => loginWithExtension()}>Login with Extension</button>;
};

Automatically login with previously saved login method:

You can also use useAutoLogin hook to automatically login with previously saved login method in local storage when the component mounts.

import { useAutoLogin } from 'nostr-hooks';

const MyComponent = () => {
  useAutoLogin();
};

Getting the Active User Profile

You can use the useActiveUser hook to get the active user's profile based on the current NDK instance and its signer.

import { useActiveUser } from 'nostr-hooks';

const MyComponent = () => {
  const { activeUser } = useActiveUser();

  if (!activeUser) return <p>Not logged in</p>;

  return (
    <div>
      <p>{activeUser.pubkey}</p>
    </div>
  );
};

If the user is not logged in, the activeUser will be undefined.

Contributing

We welcome contributions from the community! If you'd like to contribute to Nostr-Hooks, please refer to the CONTRIBUTING.md file in the project's GitHub repository.

You can also consider contributing to NDK.

Donations

If you'd like to support the development of Nostr-Hooks, please consider donating to the developer.

You can also consider supporting the NDK.

License

Nostr-Hooks is licensed under the MIT License. For more information, see the LICENSE.md file in the project's GitHub repository.

Contact

If you have any questions or concerns about Nostr-Hooks, please contact the developer at npub18c556t7n8xa3df2q82rwxejfglw5przds7sqvefylzjh8tjne28qld0we7.