OptionalauthThis is the short-lived access token: it expires 20 minutes after the
server issues it, and on its own it cannot be renewed. An instance
constructed with only an authToken therefore stops working at that point,
in one of two ways — API calls reject with a 401 ApiError, while
ceremonies (transaction signing, message signing, account creation) reject
with a ValidationError reading
No refresh token is available. Call authenticate() again.
To get silent auto-refresh instead, pass ConstructorParams.refreshToken alongside it — obtained from Salt.getRefreshToken after Salt.authenticate.
OptionaldomainThe domain this instance authenticates from, used as the SIWE domain
when Salt.authenticate is called. It is carried inside the signed
SIWE message; the backend resolves the tenant from it and verifies it
against the tenant's registered allowed domains. Required to call
Salt.authenticate (browser or not); clients constructed with a
pre-existing authToken don't need it.
Environment to use. This will be optional in the future, but right now it is required. Use 'STAGING'
OptionalmanualPeriod (ms) at which a fallback timer will manually reconnect a
dead socket — recovers from socket.io's "fatal" disconnects (most
notably io server disconnect, fired during relay restarts and
deploys). Recommended for long-running daemons (e.g. 60_000 for
one check per minute). Leave undefined to disable.
OptionalrefreshA refresh token previously obtained from Salt.authenticate (or Salt.getRefreshToken). When provided, the SDK automatically refreshes an expired access token on a 401 and retries the request — no manual re-authentication needed.
OptionalsiweThe SIWE statement shown to the user in their wallet when
Salt.authenticate asks them to sign in — the human-readable line
between the address and the message metadata. Set it to your own product
name so the prompt reads as yours rather than Salt's.
Presentation only: the statement is not a security control and the Salt API does not read it. Authentication is bound to the domain, which is what resolves the tenant and is verified against its registered domains.
Must be a single line — EIP-4361 forbids a newline in the statement, and one is rejected at construction with InvalidParams.
The authentication token for the Salt SDK. See Salt.authenticate for the full authentication flow, or Salt#setAuthToken to set a pre-existing token after calling the constructor.