Class Referrals

constructor

• new Referrals(config?: CallerConfig): Referrals

  Creates a referrals HTTP client.

  Parameters

  • Optionalconfig: CallerConfig

    Optional network, API host, access token, and API path.

  Returns Referrals

Static Readonlyconstants

createReferralLink

• createReferralLink(
      inputs: ApiReferralsCreateReferralLinkBody,
  ): Promise<ApiReferralsCreateReferralLinkResponse>

  Creates a referral link for the authenticated wallet.

  This method sends the referral code in the request body together with the signed authentication fields.

  Parameters

  • inputs: ApiReferralsCreateReferralLinkBody

    Wallet address, signed authentication data, and new code.

  Returns Promise<ApiReferralsCreateReferralLinkResponse>

  The created code, owner address, creation timestamp in milliseconds, and backend status.

  Throws

  AftermathTransportError when the API request or response fails.

createReferralLinkMessageToSign

• createReferralLinkMessageToSign(
      inputs: { refCode: string },
  ): { action: string; date: number; ref_code: string }

  Builds the legacy per-action message for creating a referral link.

  The returned object is local data and does not make a network request. The current API authenticates with the exact string from UserData.createTermsAndConditionsMessage() and receives refCode in the createReferralLink body.

  Parameters

  • inputs: { refCode: string }

    Referral code to include in the legacy message.

  Returns { action: string; date: number; ref_code: string }

  { action: "CREATE_REFERRAL", ref_code: inputs.refCode, date }, where date is the current Unix time in seconds.

  Deprecated

  af-fe no longer accepts this per-action message. Sign UserData.createTermsAndConditionsMessage and pass refCode in the createReferralLink body instead.

getLinkedRefCode

• getLinkedRefCode(
      inputs: ApiReferralsGetLinkedRefCodeBody,
  ): Promise<ApiReferralsGetLinkedRefCodeResponse>

  Fetches the referral code linked to a wallet.

  A JSON null linked code or timestamp is returned to the caller as undefined.

  Parameters

  • inputs: ApiReferralsGetLinkedRefCodeBody

    Wallet address and the bytes and signature of the signed authentication message.

  Returns Promise<ApiReferralsGetLinkedRefCodeResponse>

  The queried address, linked code, and link timestamp when present.

  Throws

  AftermathTransportError when the API request or response fails.

getRefCode

• getRefCode(
      inputs: ApiReferralsGetRefCodeBody,
  ): Promise<ApiReferralsGetRefCodeResponse>

  Fetches the referral code owned by a wallet.

  The API receives the signed authentication fields in inputs. A JSON null referral code is returned to the caller as undefined.

  Parameters

  • inputs: ApiReferralsGetRefCodeBody

    Wallet address and the bytes and signature of the signed authentication message.

  Returns Promise<ApiReferralsGetRefCodeResponse>

  The queried address and its referral code, if one exists.

  Throws

  AftermathTransportError when the API request or response fails.

getReferees

• getReferees(
      inputs: ApiReferralsGetRefereesBody,
  ): Promise<ApiReferralsGetRefereesResponse>

  Fetches the referees linked to a referral code.

  Use limit to bound the returned page and offset to skip that many referees. The response's totalCount is the count before pagination.

  Parameters

  • inputs: ApiReferralsGetRefereesBody

    Referral code and optional page size and offset.

  Returns Promise<ApiReferralsGetRefereesResponse>

  One page of referees and the total count for the code.

  Throws

  AftermathTransportError when the API request or response fails.

isRefCodeTaken

• isRefCodeTaken(
      inputs: ApiReferralsIsRefCodeTakenBody,
  ): Promise<ApiReferralsIsRefCodeTakenResponse>

  Checks whether a referral code is available for use.

  Parameters

  • inputs: ApiReferralsIsRefCodeTakenBody

    Referral code to check.

  Returns Promise<ApiReferralsIsRefCodeTakenResponse>

  The checked code and isAvailable, where true means that the code is available and false means that it is already taken.

  Throws

  AftermathTransportError when the API request or response fails.

setReferrer

• setReferrer(
      inputs: ApiReferralsSetReferrerBody,
  ): Promise<ApiReferralsSetReferrerResponse>

  Links the authenticated wallet to an existing referral code.

  Parameters

  • inputs: ApiReferralsSetReferrerBody

    Wallet address, signed authentication data, and code to link.

  Returns Promise<ApiReferralsSetReferrerResponse>

  The referee address, linked code, creation timestamp in milliseconds, and backend status.

  Throws

  AftermathTransportError when the API request or response fails.

setReferrerMessageToSign

• setReferrerMessageToSign(
      inputs: { refCode: string },
  ): { action: string; date: number; ref_code: string }

  Builds the legacy per-action message for linking a referral code.

  The returned object is local data and does not make a network request. The current API authenticates with the exact string from UserData.createTermsAndConditionsMessage() and receives refCode in the setReferrer body.

  Parameters

  • inputs: { refCode: string }

    Referral code to include in the legacy message.

  Returns { action: string; date: number; ref_code: string }

  { action: "LINK_REFERRAL", ref_code: inputs.refCode, date }, where date is the current Unix time in seconds.

  Deprecated

  af-fe no longer accepts this per-action message. Sign UserData.createTermsAndConditionsMessage and pass refCode in the setReferrer body instead.