Account services

Services on this page use the authenticated transport except the auth login endpoints, client.subaccounts.listRoles(), and client.vip.listTiers(), which are public. Methods marked stream return () => void and take onEvent (+ optional onOpen / onClose / onError).

client.auth

Base auth service (all clients):

On PolyesterBrowserClient, auth is an AccountSignerAuthService with the managed login flow on top:

client.auth.profile

client.accounts

client.subaccounts

client.subaccounts.policies

Reusable permission templates for subaccounts.

client.apiKeys

client.apiKeys.policies mirrors the subaccount policies API (list / get / create / update / delete / apply) for API key policy templates.

client.balances

client.claims

Daily campaign rewards belong to the authenticated root account, which can receive the reward itself or have it paid to a subaccount it owns. These endpoints require a session JWT; API keys are not accepted.

const status = await client.claims.getDailyClaimStatus();
if (status.state === "available") {
	// Omit the input, as in claimDailyReward(), to pay the root account.
	const claim = await client.claims.claimDailyReward({ subaccountId });
	console.log(claim.claimId, claim.state, claim.subaccountId, claim.rewards);
}

Request options are the second argument, as in claimDailyReward({}, { signal }).

Both results include state, claimId, rewards, optional resetAt, optional campaign, and optional subaccountId. state is "available", "processing", "claimed", "unavailable", "payout_delayed", or "unspecified". Each reward has assetId, assetCode, and an exact decimal-string amount.

The claim result also includes optional claimedAt and a transfers array of { assetId, transferId } ([] when none). Timestamps are epoch milliseconds when present. A campaign has campaignId, name, description, and claimPolicy ("utc_daily" or "unspecified"). Read status again to follow a "processing" claim rather than treating it as completed.

A "payout_delayed" claim is recorded and is paid automatically once payouts resume. On DailyClaimStatus, optional payoutDelayReason names the cause as a claims error code name, such as "CLAIM_PAYOUT_UNAVAILABLE" (the campaign's payouts are paused). It is undefined when unset or when the code is newer than the SDK; the state alone still means the payout is delayed.

A claim from an account without a verified X or Discord account fails with the non-retryable PreconditionFailedError and detail.code === "SOCIAL_VERIFICATION_REQUIRED". Send the user through social verification, then claim again. Claims errors also include CLAIM_PAYOUT_UNAVAILABLE: the campaign's payouts are paused, and the day's claim is kept and paid once they resume.

Subaccount payout

subaccountId selects where the reward is paid. Omit it to pay the root account. It must name an active subaccount owned by the authenticated root account. Subaccounts shared with the caller through member access, and subaccounts owned by other accounts, are rejected.

The subaccount is only the destination. There is still one claim per root account per UTC day. The destination is fixed when the day's claim is created: a retry with the same, a different, or no subaccountId returns the original claim and its original destination without checking the new input.

Both results report the destination as subaccountId, a subaccount public id string. It is undefined when the reward is paid to the root account, and in status when no claim exists for the current UTC day.

A subaccountId that decodes to zero throws ValidationError before the request is sent. Claims errors carry detail.service === "claims"; see Errors.

client.rewards

Published reward campaign awards for the authenticated root account. Session JWT only; API keys are not accepted. Full shapes: Rewards.

client.checkpoints

Frozen testnet season recaps of the signed-in root account and all of its subaccounts. Session JWT only; API keys are refused with PermissionError. Full shapes: Checkpoints.

client.mfa

See Error handling for the step-up retry pattern.

client.addressBook

client.vip

VIP policy service. listTiers is public. getStatus is authenticated and always reads the root account. Full shapes: VIP.

client.socialVerification

client.guardSigner

Backend guard wallets that co-sign protected account actions.

Related Topics