Function: usePeerDID()

usePeerDID(): object

Defined in: hooks/index.ts:222

Hook for accessing Peer DID context and operations.

Peer DIDs are ephemeral, off-ledger DIDs used for direct peer-to-peer communication. They're created quickly and don't require blockchain anchoring. This hook must be used within a PeerDIDProvider.

Returns

Peer DID context containing:

• peerDID: Current Peer DID instance or null if not created yet
• create: Async function to create a new ephemeral Peer DID for communication

create()

create: () => Promise<void>

Function to create a new Peer DID

Returns

Promise<void>

peerDID

peerDID: null | DID

Current Peer DID instance, null if not yet created

Throws

When used outside of PeerDIDProvider

Example

tsxCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
import { usePeerDID } from '@trust0/identus-react/hooks';

function PeerDIDComponent() {
  const { peerDID, create } = usePeerDID();
  
  const handleCreatePeerDID = async () => {
    try {
      await create();
      console.log('Peer DID created for communication');
    } catch (error) {
      console.error('Failed to create Peer DID:', error);
    }
  };
  
  return (
    <div>
      {peerDID ? (
        <div>
          <p>Peer DID: {peerDID.toString()}</p>
          <p>Ready for peer-to-peer communication</p>
        </div>
      ) : (
        <button onClick={handleCreatePeerDID}>
          Create Peer DID
        </button>
      )}
    </div>
  );
}