rotateCircuit()

SIP Protocol API Reference / rotateCircuit

Function: rotateCircuit()

rotateCircuit(controlPort?, password?): Promise<boolean>

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:16987

Request a new Tor circuit (NEWNYM)

Requires Tor control port to be enabled with authentication. Configure in torrc:

ControlPort 9051
HashedControlPassword <your-hashed-password>

Parameters

controlPort?

number

Tor control port (default: 9051)

password?

string

Control port password

Returns

Promise<boolean>

True if circuit rotation succeeded

Example

// Enable in torrc and set password
const success = await rotateCircuit(9051, 'my-tor-password')
if (success) {
  console.log('New Tor circuit established')
}