Class default

Hierarchy

default

Constructors

constructor

new default(sdkConfiguration): default
Parameters
- sdkConfiguration: OpenfortSDKConfiguration
Returns default
- Defined in sdk/src/openfort.ts:35

Properties

`Private` `Readonly` storage

storage: IStorage

Accessors

`Private` backendApiClients

get backendApiClients(): BackendApiClients
Returns BackendApiClients
- Defined in sdk/src/openfort.ts:661

`Private` authManager

get authManager(): default
Returns default
- Defined in sdk/src/openfort.ts:733

Methods

logout

logout(): Promise<void>
Logs the user out by flushing the signer and removing credentials.

Returns Promise<void>
- Defined in sdk/src/openfort.ts:53

getEthereumProvider

getEthereumProvider(options?): Provider
Returns an Ethereum provider using the configured signer.
Parameters
- options: {
      policy?: string;
      providerInfo?: {
          icon: `data:image/${string}`;
          name: string;
          rdns: string;
      };
  } = {}
  
  Configuration options for the Ethereum provider.
  - Optional policy?: string
  - Optional providerInfo?: {
        icon: `data:image/${string}`;
        name: string;
        rdns: string;
    }
    - icon: `data:image/${string}`
    - name: string
    - rdns: string
Returns Provider
A Provider instance.

Throws
If the signer is not an EmbeddedSigner.
- Defined in sdk/src/openfort.ts:70

configureSessionKey

configureSessionKey(): SessionKey
Configures a session key and returns the session key details.

Returns SessionKey
A SessionKey object containing the address and registration status.
- Defined in sdk/src/openfort.ts:106

configureEmbeddedSigner

configureEmbeddedSigner(chainId?, shieldAuthentication?, recoveryPassword?): Promise<void>
Configures an embedded signer.
Parameters
- chainId: null | number = null
  
  The chain ID for the embedded signer.
- shieldAuthentication: null | ShieldAuthentication = null
  
  Shield authentication details.
- recoveryPassword: null | string = null
  
  Recovery password.
Returns Promise<void>
- Defined in sdk/src/openfort.ts:124

signMessage

signMessage(message, options?): Promise<string>
Signs a message.
Parameters
- message: string | Uint8Array<ArrayBufferLike>
  
  Message to sign.
- Optional options: {
  hashMessage?: boolean;
  arrayifyMessage?: boolean;
  }
  
  Additional options for signing.
  - Optional hashMessage?: boolean
  - Optional arrayifyMessage?: boolean
Returns Promise<string>
The signature.

Throws
If no signer is configured.
- Defined in sdk/src/openfort.ts:157

signTypedData

signTypedData(domain, types, value): Promise<string>
Signs typed data.
Parameters
- domain: TypedDataDomain
  
  EIP-712 domain.
- types: Record<string, TypedDataField[]>
  
  Typed data types.
- value: Record<string, any>
  
  Typed data value.
Returns Promise<string>
The signature.

Throws
If no signer is configured.
- Defined in sdk/src/openfort.ts:179

exportPrivateKey

exportPrivateKey(): Promise<string>
Exports the private key.

Returns Promise<string>
The private key.

Throws
If no signer is configured.
- Defined in sdk/src/openfort.ts:225

setEmbeddedRecovery

setEmbeddedRecovery(__namedParameters): Promise<void>
Parameters
- __namedParameters: {
      recoveryMethod: RecoveryMethod;
      recoveryPassword?: string;
      encryptionSession?: string;
  }
  - recoveryMethod: RecoveryMethod
  - Optional recoveryPassword?: string
  - Optional encryptionSession?: string
Returns Promise<void>
- Defined in sdk/src/openfort.ts:235

logInWithEmailPassword

logInWithEmailPassword(__namedParameters): Promise<AuthResponse>
Logs in a user with email and password.
Parameters
- __namedParameters: {
      email: string;
      password: string;
      ecosystemGame?: string;
  }
  - email: string
  - password: string
  - Optional ecosystemGame?: string
Returns Promise<AuthResponse>
An AuthResponse object containing authentication details.
- Defined in sdk/src/openfort.ts:262

signUpGuest

signUpGuest(): Promise<AuthResponse>
Registers a new guest user.

Returns Promise<AuthResponse>
An AuthResponse object containing authentication details.
- Defined in sdk/src/openfort.ts:279

signUpWithEmailPassword

signUpWithEmailPassword(__namedParameters): Promise<AuthResponse>
Signs up a new user with email and password.
Parameters
- __namedParameters: {
      email: string;
      password: string;
      options?: {
          data: {
              name: string;
          };
      };
      ecosystemGame?: string;
  }
  - email: string
  - password: string
  - Optional options?: {
        data: {
            name: string;
        };
    }
    - data: {
      name: string;
      }
      
      name: string
  - Optional ecosystemGame?: string
Returns Promise<AuthResponse>
An AuthResponse object containing authentication details.
- Defined in sdk/src/openfort.ts:298

linkEmailPassword

linkEmailPassword(__namedParameters): Promise<AuthPlayerResponse>
Links an email and password to an existing account using an authentication token.
Parameters
- __namedParameters: {
      email: string;
      password: string;
      authToken: string;
      ecosystemGame?: string;
  }
  - email: string
  - password: string
  - authToken: string
  - Optional ecosystemGame?: string
Returns Promise<AuthPlayerResponse>
An AuthPlayerResponse object.
- Defined in sdk/src/openfort.ts:321

unlinkEmailPassword

unlinkEmailPassword(__namedParameters): Promise<AuthPlayerResponse>
Unlinks an email and password from an existing account using an authentication token.
Parameters
- __namedParameters: {
  email: string;
  authToken: string;
  }
  - email: string
  - authToken: string
Returns Promise<AuthPlayerResponse>
An AuthPlayerResponse object.
- Defined in sdk/src/openfort.ts:336

requestEmailVerification

requestEmailVerification(__namedParameters): Promise<void>
Requests an email verification link.
Parameters
- __namedParameters: {
  email: string;
  redirectUrl: string;
  }
  - email: string
  - redirectUrl: string
Returns Promise<void>
- Defined in sdk/src/openfort.ts:348

resetPassword

resetPassword(__namedParameters): Promise<void>
Resets the user's password.
Parameters
- __namedParameters: {
      email: string;
      password: string;
      state: string;
  }
  - email: string
  - password: string
  - state: string
Returns Promise<void>
- Defined in sdk/src/openfort.ts:361

requestResetPassword

requestResetPassword(__namedParameters): Promise<void>
Requests a password reset link.
Parameters
- __namedParameters: {
  email: string;
  redirectUrl: string;
  }
  - email: string
  - redirectUrl: string
Returns Promise<void>
- Defined in sdk/src/openfort.ts:373

verifyEmail

verifyEmail(__namedParameters): Promise<void>
Verifies the user's email.
Parameters
- __namedParameters: {
  email: string;
  state: string;
  }
  - email: string
  - state: string
Returns Promise<void>
- Defined in sdk/src/openfort.ts:385

initOAuth

initOAuth(__namedParameters): Promise<InitAuthResponse>
Initializes an OAuth authentication process.
Parameters
- __namedParameters: {
      provider: OAuthProvider;
      options?: InitializeOAuthOptions;
      ecosystemGame?: string;
  }
  - provider: OAuthProvider
  - Optional options?: InitializeOAuthOptions
  - Optional ecosystemGame?: string
Returns Promise<InitAuthResponse>
An InitAuthResponse object.
- Defined in sdk/src/openfort.ts:397

initLinkOAuth

initLinkOAuth(__namedParameters): Promise<InitAuthResponse>
Initializes an OAuth linking process.
Parameters
- __namedParameters: {
      provider: OAuthProvider;
      authToken: string;
      options?: InitializeOAuthOptions;
      ecosystemGame?: string;
  }
  - provider: OAuthProvider
  - authToken: string
  - Optional options?: InitializeOAuthOptions
  - Optional ecosystemGame?: string
Returns Promise<InitAuthResponse>
An InitAuthResponse object.
- Defined in sdk/src/openfort.ts:414

linkThirdPartyProvider

linkThirdPartyProvider(__namedParameters): Promise<AuthPlayerResponse>
Links a Third-Party authentication provider to the account.
Parameters
- __namedParameters: {
      provider: ThirdPartyOAuthProvider;
      token: string;
      tokenType: TokenType;
  }
  - provider: ThirdPartyOAuthProvider
  - token: string
  - tokenType: TokenType
Returns Promise<AuthPlayerResponse>
An AuthPlayerResponse object.
- Defined in sdk/src/openfort.ts:437

unlinkOAuth

unlinkOAuth(__namedParameters): Promise<AuthPlayerResponse>
Unlinks an OAuth provider from the account.
Parameters
- __namedParameters: {
  provider: OAuthProvider;
  authToken: string;
  }
  - provider: OAuthProvider
  - authToken: string
Returns Promise<AuthPlayerResponse>
An AuthPlayerResponse object.
- Defined in sdk/src/openfort.ts:457

poolOAuth

poolOAuth(key): Promise<AuthResponse>
Polls for OAuth authentication completion.
Parameters
- key: string
  
  OAuth polling key.
Returns Promise<AuthResponse>
An AuthResponse object.
- Defined in sdk/src/openfort.ts:469

authenticateWithThirdPartyProvider

authenticateWithThirdPartyProvider(__namedParameters): Promise<AuthPlayerResponse>
Authenticates using a third-party OAuth provider.
Parameters
- __namedParameters: {
      provider: ThirdPartyOAuthProvider;
      token: string;
      tokenType: TokenType;
      ecosystemGame?: string;
  }
  - provider: ThirdPartyOAuthProvider
  - token: string
  - tokenType: TokenType
  - Optional ecosystemGame?: string
Returns Promise<AuthPlayerResponse>
An AuthPlayerResponse object.
- Defined in sdk/src/openfort.ts:488

initSIWE

initSIWE(__namedParameters): Promise<SIWEInitResponse>
Initializes Sign-In with Ethereum (SIWE).
Parameters
- __namedParameters: {
  address: string;
  ecosystemGame?: string;
  }
  - address: string
  - Optional ecosystemGame?: string
Returns Promise<SIWEInitResponse>
A SIWEInitResponse object.
- Defined in sdk/src/openfort.ts:523

authenticateWithSIWE

authenticateWithSIWE(__namedParameters): Promise<AuthResponse>
Authenticates using Sign-In with Ethereum (SIWE).
Parameters
- __namedParameters: {
      signature: string;
      message: string;
      walletClientType: string;
      connectorType: string;
  }
  - signature: string
  - message: string
  - walletClientType: string
  - connectorType: string
Returns Promise<AuthResponse>
An AuthResponse object.
- Defined in sdk/src/openfort.ts:538

linkWallet

linkWallet(__namedParameters): Promise<AuthPlayerResponse>
Links a wallet using SIWE.
Parameters
- __namedParameters: {
      signature: string;
      message: string;
      walletClientType: string;
      connectorType: string;
      authToken: string;
  }
  - signature: string
  - message: string
  - walletClientType: string
  - connectorType: string
  - authToken: string
Returns Promise<AuthPlayerResponse>
An AuthPlayerResponse object.
- Defined in sdk/src/openfort.ts:560

unlinkWallet

unlinkWallet(__namedParameters): Promise<AuthPlayerResponse>
Unlinks a wallet.
Parameters
- __namedParameters: {
  address: string;
  authToken: string;
  }
  - address: string
  - authToken: string
Returns Promise<AuthPlayerResponse>
An AuthPlayerResponse object.
- Defined in sdk/src/openfort.ts:575

storeCredentials

storeCredentials(auth): void
Stores authentication credentials.
Parameters
- auth: Auth
  
  Authentication details.
Returns void
- Defined in sdk/src/openfort.ts:586

sendSignatureTransactionIntentRequest

sendSignatureTransactionIntentRequest(transactionIntentId, signableHash?, signature?, optimistic?): Promise<TransactionIntentResponse>
Sends a signature transaction intent request.
Parameters
- transactionIntentId: string
  
  Transaction intent ID.
- signableHash: null | string = null
  
  User operation hash.
- signature: null | string = null
  
  Transaction signature.
- optimistic: boolean = false
  
  Whether the request is optimistic.
Returns Promise<TransactionIntentResponse>
A TransactionIntentResponse object.

Throws
If no signableHash or signature is provided.
- Defined in sdk/src/openfort.ts:604

getAccount

getAccount(): Promise<CurrentAccount>
Returns Promise<CurrentAccount>
- Defined in sdk/src/openfort.ts:647

sendSignatureSessionRequest

sendSignatureSessionRequest(sessionId, signature, optimistic?): Promise<SessionResponse>
Sends a transaction signed with a session request.
Parameters
- sessionId: string
  
  Session ID.
- signature: string
  
  Session signature.
- Optional optimistic: boolean
  
  Whether the request is optimistic.
Returns Promise<SessionResponse>
A SessionResponse object.
- Defined in sdk/src/openfort.ts:682

getEmbeddedState

getEmbeddedState(): EmbeddedState
Gets the embedded state of the current session.

Returns EmbeddedState
The embedded state.
- Defined in sdk/src/openfort.ts:704

getAccessToken

getAccessToken(): null | string
Gets the current access token.

Returns null | string
The access token, or null if not available.
- Defined in sdk/src/openfort.ts:728

getUser

getUser(): Promise<AuthPlayerResponse>
Retrieves the user details.

Returns Promise<AuthPlayerResponse>
An AuthPlayerResponse object.

Throws
If no access token is found.
- Defined in sdk/src/openfort.ts:748

validateAndRefreshToken

validateAndRefreshToken(forceRefresh?): Promise<void>
Validates and refreshes the access token if needed.
Parameters
- Optional forceRefresh: boolean
Returns Promise<void>
- Defined in sdk/src/openfort.ts:760

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

sdkConfiguration: OpenfortSDKConfiguration

Returns default

Properties

Private Readonly storage

Accessors

Private backendApiClients

Returns BackendApiClients

Private authManager

Returns default

Methods

logout

Returns Promise<void>

getEthereumProvider

Parameters

options: { policy?: string; providerInfo?: { icon: `data:image/${string}`; name: string; rdns: string; }; } = {}

Optional policy?: string

Optional providerInfo?: { icon: `data:image/${string}`; name: string; rdns: string; }

icon: `data:image/${string}`

name: string

rdns: string

Returns Provider

Throws

configureSessionKey

Returns SessionKey

configureEmbeddedSigner

Parameters

chainId: null | number = null

shieldAuthentication: null | ShieldAuthentication = null

recoveryPassword: null | string = null

Returns Promise<void>

signMessage

Parameters

message: string | Uint8Array<ArrayBufferLike>

Optional options: { hashMessage?: boolean; arrayifyMessage?: boolean; }

Optional hashMessage?: boolean

Optional arrayifyMessage?: boolean

Returns Promise<string>

Throws

signTypedData

Parameters

domain: TypedDataDomain

types: Record<string, TypedDataField[]>

value: Record<string, any>

Returns Promise<string>

Throws

exportPrivateKey

Returns Promise<string>

Throws

setEmbeddedRecovery

Parameters

__namedParameters: { recoveryMethod: RecoveryMethod; recoveryPassword?: string; encryptionSession?: string; }

recoveryMethod: RecoveryMethod

Optional recoveryPassword?: string

Optional encryptionSession?: string

Returns Promise<void>

logInWithEmailPassword

Parameters

__namedParameters: { email: string; password: string; ecosystemGame?: string; }

email: string

password: string

Optional ecosystemGame?: string

Returns Promise<AuthResponse>

signUpGuest

Returns Promise<AuthResponse>

signUpWithEmailPassword

Parameters

__namedParameters: { email: string; password: string; options?: { data: { name: string; }; }; ecosystemGame?: string; }

email: string

password: string

Optional options?: { data: { name: string; }; }

`Private` `Readonly` storage

`Private` backendApiClients

`Private` authManager

options: {
policy?: string;
providerInfo?: {
icon: `data:image/${string}`;
name: string;
rdns: string;
};
} = {}

`Optional` policy?: string

`Optional` providerInfo?: {
icon: `data:image/${string}`;
name: string;
rdns: string;
}

`Optional` options: {
hashMessage?: boolean;
arrayifyMessage?: boolean;
}

`Optional` hashMessage?: boolean

`Optional` arrayifyMessage?: boolean

__namedParameters: {
recoveryMethod: RecoveryMethod;
recoveryPassword?: string;
encryptionSession?: string;
}

`Optional` recoveryPassword?: string

`Optional` encryptionSession?: string

__namedParameters: {
email: string;
password: string;
ecosystemGame?: string;
}

`Optional` ecosystemGame?: string

__namedParameters: {
email: string;
password: string;
options?: {
data: {
name: string;
};
};
ecosystemGame?: string;
}

`Optional` options?: {
data: {
name: string;
};
}

data: {
name: string;
}

`Optional` ecosystemGame?: string

__namedParameters: {
email: string;
password: string;
authToken: string;
ecosystemGame?: string;
}

`Optional` ecosystemGame?: string

__namedParameters: {
email: string;
authToken: string;
}

__namedParameters: {
email: string;
redirectUrl: string;
}

__namedParameters: {
email: string;
password: string;
state: string;
}

__namedParameters: {
email: string;
redirectUrl: string;
}

__namedParameters: {
email: string;
state: string;
}

__namedParameters: {
provider: OAuthProvider;
options?: InitializeOAuthOptions;
ecosystemGame?: string;
}

`Optional` options?: InitializeOAuthOptions

`Optional` ecosystemGame?: string

__namedParameters: {
provider: OAuthProvider;
authToken: string;
options?: InitializeOAuthOptions;
ecosystemGame?: string;
}

`Optional` options?: InitializeOAuthOptions

`Optional` ecosystemGame?: string

__namedParameters: {
provider: ThirdPartyOAuthProvider;
token: string;
tokenType: TokenType;
}

__namedParameters: {
provider: OAuthProvider;
authToken: string;
}