Class Identities

constructor

• new Identities(): Identities

• Returns Identities

formats

addGithubIdentity

• addGithubIdentity(demos, payload, referralCode?): Promise<RPCResponseWithValidityData>

• Add a github identity to the GCR.

  Parameters

  • demos: Demos

    A Demos instance to communicate with the RPC.
  • payload: GithubProof

    The payload to add the identity to.
  • OptionalreferralCode: string

  Returns Promise<RPCResponseWithValidityData>

  The response from the RPC call.

addTwitterIdentity

• addTwitterIdentity(demos, payload, referralCode?): Promise<RPCResponseWithValidityData>

• Add a twitter identity to the GCR.

  Parameters

  • demos: Demos

    A Demos instance to communicate with the RPC.
  • payload: `https://x.com/${string}/${string}`

    The payload to add the identity to.
  • OptionalreferralCode: string

  Returns Promise<RPCResponseWithValidityData>

  The response from the RPC call.

bindPqcIdentity

• bindPqcIdentity(demos, algorithms?): Promise<RPCResponseWithValidityData>

• Parameters

  • demos: Demos
  • algorithms: "all" | PQCAlgorithm[] = "all"

  Returns Promise<RPCResponseWithValidityData>

createWeb2ProofPayload

• createWeb2ProofPayload(demos): Promise<string>

• Create a web2 proof payload for use with web2 identity inference.

  Parameters

  • demos: Demos

  Returns Promise<string>

  The web2 proof payload string.

getIdentities

• getIdentities(demos, call?, address?): Promise<RPCResponse>

• Get the identities associated with an address.

  Parameters

  • demos: Demos

    A Demos instance to communicate with the RPC.
  • call: string = "getIdentities"
  • Optionaladdress: string

    The address to get identities for.

  Returns Promise<RPCResponse>

  The identities associated with the address.

getReferralInfo

• getReferralInfo(demos, address?): Promise<RPCResponse>

• Get referral information for an address.

  Parameters

  • demos: Demos

    A Demos instance to communicate with the RPC.
  • Optionaladdress: string

    The address to get referral info for. Defaults to the connected wallet's address.

  Returns Promise<RPCResponse>

  The referral information associated with the address.

getUserPoints

• getUserPoints(demos, address?): Promise<RPCResponseWithValidityData>

• Get the points associated with an identity

  Parameters

  • demos: Demos

    A Demos instance to communicate with the RPC
  • Optionaladdress: string

    The address to get points for. Defaults to the connected wallet's address.

  Returns Promise<RPCResponseWithValidityData>

  The points data for the identity

getWeb2Identities

• getWeb2Identities(demos, address?): Promise<RPCResponse>

• Get the web2 identities associated with an address.

  Parameters

  • demos: Demos

    A Demos instance to communicate with the RPC.
  • Optionaladdress: string

    The address to get identities for.

  Returns Promise<RPCResponse>

  The identities associated with the address.

getXmIdentities

• getXmIdentities(demos, address?): Promise<RPCResponse>

• Get the crosschain identities associated with an address.

  Parameters

  • demos: Demos

    A Demos instance to communicate with the RPC.
  • Optionaladdress: string

    The address to get identities for.

  Returns Promise<RPCResponse>

  The identities associated with the address.

inferWeb2Identity

• inferWeb2Identity(demos, payload): Promise<RPCResponseWithValidityData>

• Infer a web2 identity from a proof payload.

  Parameters

  • demos: Demos

    A Demos instance to communicate with the RPC.
  • payload: Web2CoreTargetIdentityPayload

    The payload to infer the identity from.

  Returns Promise<RPCResponseWithValidityData>

  The validity data of the identity transaction.

inferXmIdentity

• inferXmIdentity(demos, payload, referralCode?): Promise<RPCResponseWithValidityData>

• Infer a crosschain identity from a signature.

  Parameters

  • demos: Demos

    A Demos instance to communicate with the RPC.
  • payload: InferFromSignaturePayload

    The payload to infer the identity from.
  • OptionalreferralCode: string

  Returns Promise<RPCResponseWithValidityData>

  The validity data of the identity transaction.

removePqcIdentity

• removePqcIdentity(demos, algorithms?): Promise<RPCResponseWithValidityData>

• Parameters

  • demos: Demos
  • algorithms: "all" | PQCAlgorithm[] = "all"

  Returns Promise<RPCResponseWithValidityData>

removeWeb2Identity

• removeWeb2Identity(demos, payload): Promise<RPCResponseWithValidityData>

• Remove a web2 identity from the network.

  Parameters

  • demos: Demos

    A Demos instance to communicate with the RPC.
  • payload: {
        context: string;
        username: string;
    }

    The payload to remove the identity.

    • context: string

    • username: string

  Returns Promise<RPCResponseWithValidityData>

  The response from the RPC call.

removeXmIdentity

• removeXmIdentity(demos, payload): Promise<RPCResponseWithValidityData>

• Remove a crosschain identity from the network.

  Parameters

  • demos: Demos

    A Demos instance to communicate with the RPC.
  • payload: XMCoreTargetIdentityPayload

    The payload to remove the identity.

  Returns Promise<RPCResponseWithValidityData>

  The response from the RPC call.

validateReferralCode

• validateReferralCode(demos, referralCode): Promise<RPCResponse>

• Validate a referral code to check if it exists and is valid.

  Parameters

  • demos: Demos

    A Demos instance to communicate with the RPC.
  • referralCode: string

    The referral code to validate.

  Returns Promise<RPCResponse>

  The validation result containing validity status, referrer public key, and message.