Class AccountApi

constructor

• new AccountApi(config: ApiConfig): AccountApi

• Parameters

  • config: ApiConfig

  Returns AccountApi

ReadonlycurrentAccount

accountBalance

• accountBalance(): Promise<FullBalances>

• Get the account balance of the current account. This method returns the account balance of the current user, including settled, credit, debit, and unclaimed earnings amounts.

  Returns Promise<FullBalances>

  Example: Get the account balance of the current user

  const balance = await sogni.account.accountBalance();
  console.log(balance);
  Copy

deposit

• deposit(
      password: string,
      amount: string | number,
      provider?: string,
  ): Promise<void>

• Deposit tokens from wallet to account

  Parameters

  • password: string

    account password
  • amount: string | number

    amount to transfer
  • provider: string = 'base'

    blockchain provider, 'base' or 'etherlink' defaults to 'base'

  Returns Promise<void>

  Example: withdraw to current wallet address

  await sogni.account.deposit('your-account-password', 100, 'base');
  Copy

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 = sogni.account.getWallet('username', 'password');
  console.log(wallet.address);
  Copy

login

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

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

  Parameters

  • username: string
  • password: string
  • rememberMe: boolean = false

    Whether to establish a long-lived session. Default is false. Only applicable for cookie-based authentication.

  Returns Promise<LoginData>

  Example: Login with username and password

  await sogni.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 sogni.account.logout();
  console.log('Logged out');
  Copy

me

• me(): Promise<MeData>

• Returns Promise<MeData>

refreshBalance

• refreshBalance(): Promise<Balances>

• 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. Note that will also trigger updated event on the current account.

  Returns Promise<Balances>

  Example: Refresh user account balance

  const balance = await sogni.account.refreshBalance();
  console.log(balance);
  Copy

switchNetwork

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

• Switch between fast and relaxed networks. This will change default network used to process projects. After switching, client will receive list of AI models available for on selected network.

  Parameters

  • network: SupernetType

    Network type to switch to

  Returns Promise<SupernetType>

  Example: Switch to the fast network

  await sogni.account.switchNetwork('fast');
  console.log('Switched to the fast network, now lets wait until we get list of models');
  await sogni.projects.waitForModels();
  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 sogni.account.transactionHistory({
   status: 'completed',
   limit: 10,
   address: sogni.account.currentAccount.walletAddress
  });
  Copy

walletBalance

• walletBalance(
      walletAddress: string,
      provider?: "base" | "etherlink",
  ): Promise<{ ether: string; sogni: string; spark: 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
  • provider: "base" | "etherlink" = 'base'

    blockchain provider, 'base' or 'etherlink' defaults to 'base'

  Returns Promise<{ ether: string; sogni: string; spark: string }>

  Example: Get the balance of the wallet address

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

withdraw

• withdraw(
      password: string,
      amount: string | number,
      provider?: string,
  ): Promise<void>

• Withdraw funds from the current account to wallet.

  Parameters

  • password: string

    account password
  • amount: string | number

    amount of tokens to withdraw from account to wallet
  • provider: string = 'base'

    blockchain provider, 'base' or 'etherlink' defaults to 'base'

  Returns Promise<void>

  Example: withdraw to current wallet address

  await sogni.account.withdraw('your-account-password', 100, 'etherlink');
  Copy