Class AccountApi

constructor

• new AccountApi(config: ApiConfig): AccountApi

• Parameters

  • config: ApiConfig

  Returns AccountApi

ReadonlycurrentAccount

getWallet

• getWallet(username: string, password: string): Wallet

• Create Ethers.js Wallet instance from username and password. This method is used internally to create a wallet for the user. You can use this method to create a wallet if you need to sign transactions.

  Parameters

  • username: string

    Sogni account username
  • password: string

    Sogni account password

  Returns Wallet

  Example: Create a wallet from username and password

  const wallet = client.account.getWallet('username', 'password');
  console.log(wallet.address);
  Copy

login

• login(username: string, password: string): Promise<LoginData>

• Login with username and password. WebSocket connection is established after successful login.

  Parameters

  • username: string
  • password: string

  Returns Promise<LoginData>

  Example: Login with username and password

  await client.account.login('username', 'password');
  console.log('Logged in');
  Copy

logout

• logout(): Promise<void>

• Logout the user and close the WebSocket connection.

  Returns Promise<void>

  Example: Logout the user

  await client.account.logout();
  console.log('Logged out');
  Copy

refreshBalance

• refreshBalance(): Promise<BalanceData>

• Refresh the balance of the current account.

  Usually, you don't need to call this method manually. Balance is updated automatically through WebSocket events. But you can call this method to force a balance refresh.

  Returns Promise<BalanceData>

  Example: Refresh user account balance

  const balance = await client.account.refreshBalance();
  console.log(balance);
  // { net: '100.000000', settled: '100.000000', credit: '0.000000', debit: '0.000000' }
  Copy

setToken

• setToken(username: string, token: string): void

• Restore session with username and access token.

  You can save access token that you get from the login method and restore the session with this method.

  Parameters

  • username: string
  • token: string

  Returns void

  Example: Store access token to local storage

  const { username, token } = await client.account.login('username', 'password');
  localStorage.setItem('sogni-username', username);
  localStorage.setItem('sogni-token', token);
  Copy

  Example: Restore session from local storage

  const username = localStorage.getItem('sogni-username');
  const token = localStorage.getItem('sogni-token');
  if (username && token) {
   client.account.setToken(username, token);
   console.log('Session restored');
  }
  Copy

switchNetwork

• switchNetwork(network: SupernetType): Promise<void>

• Switch between fast and relaxed networks. Note: This method will close the current WebSocket connection and establish a new one. Do not call this method if you have any active projects.

  Parameters

  • network: SupernetType

  Returns Promise<void>

  Example: Switch to the fast network

  client.apiClient.once('connected', ({ network }) => {
   console.log('Switched to the network:', network);
  });
  await client.account.switchNetwork('fast');
  Copy

transactionHistory

• transactionHistory(
      params: TxHistoryParams,
  ): Promise<{ entries: TxHistoryEntry[]; next: TxHistoryParams }>

• Get the transaction history of the current account.

  Parameters

  • params: TxHistoryParams

    Transaction history query parameters

  Returns Promise<{ entries: TxHistoryEntry[]; next: TxHistoryParams }>

  Transaction history entries and next query parameters

  Example: Get the transaction history

  const { entries, next } = await client.account.transactionHistory({
   status: 'completed',
   limit: 10,
   address: client.account.currentAccount.walletAddress
  });
  Copy

walletBalance

• walletBalance(walletAddress: string): Promise<{ ether: string; token: string }>

• Get the balance of the wallet address.

  This method is used to get the balance of the wallet address. It returns $SOGNI and ETH balance.

  Parameters

  • walletAddress: string

  Returns Promise<{ ether: string; token: string }>

  Example: Get the balance of the wallet address

  const address = client.account.currentAccount.walletAddress;
  const balance = await client.account.walletBalance(address);
  console.log(balance);
  // { token: '100.000000', ether: '0.000000' }
  Copy