withSecureBuffer()

SIP Protocol API Reference v0.7.0

---

SIP Protocol API Reference / withSecureBuffer

Function: withSecureBuffer()

withSecureBuffer<T>(createSecret, useSecret): Promise<T>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:3486

Execute a function with a secret buffer and ensure cleanup

Provides a safer pattern for using secrets - the buffer is automatically wiped after the function completes (or throws).

Type Parameters

T

T

Parameters

createSecret

() => Uint8Array

Function to create the secret buffer

useSecret

(secret) => T | Promise<T>

Function that uses the secret

Returns

Promise<T>

The result of useSecret

Example

const signature = await withSecureBuffer(
  () => generatePrivateKey(),
  async (privateKey) => {
    return signMessage(message, privateKey)
  }
)
// privateKey is automatically wiped after signing