@echoxyz/sonar-core

​

SonarClient functions

​

readEntity

• The user has not yet linked the connected wallet to their entity on the Sonar site.
• The user has connected a different wallet on your sale site to the wallet they have linked to their entity on the Sonar site.

​

listAvailableEntities

​

myProfile

​

readEntityInvestmentHistory

const investmentHistory = await client.readEntityInvestmentHistory();

console.log(`Found ${investmentHistory.Investments.length} investments`);

investmentHistory.Investments.forEach((investment) => {
  console.log(`${investment.CompanyName} - ${investment.Round}`);
  console.log(`Invested on: ${new Date(investment.InvestedOn).toLocaleDateString()}`);
});

​

fetchLimits

​

prePurchaseCheck

​

generatePurchasePermit

​

Core types

​

EntityDetails

​

MyProfileResponse

​

EntitySetupState

• The entity has not started the setup process. The user should be linked to the Sonar site to continue.
• Suggested message: “Entity not ready to invest — Please complete the entity setup process.”

• The entity has started the setup process, but it is not yet in review. The user should be linked to the Sonar site to continue.
• Suggested message: “Entity not ready to invest — Please complete the entity setup process.”

• The entity has completed all current steps of the setup process and is ready to submit their data for review. The user should be linked to the Sonar site to continue.
• Suggested message: “Entity not ready to invest — Please complete the entity setup process.”

• The Sonar team is reviewing the entity.
• Suggested message: “Entity not ready to invest — Please wait for the review to finish before you can make investments.”

• There is a problem with the entity setup. The user should be linked to the Sonar site so they can address the issues.
• Suggested message: “Entity not ready to invest — Review your entity status in Sonar.”

• There is a problem with the entity setup, and the user is not able to address the issues.
• Suggested message: “Entity not ready to invest — Review your entity status in Sonar.”

• The setup is in a known technical issue state and we want the user to contact support if this happens.
• Suggested message: “There’s an issue with your account — Please contact Sonar support to resolve it.”

• The entity has completed the setup process.
• Suggested message: depends on the SaleEligibility value.

​

SaleEligibility

• The entity has completed setup and is eligible for the sale.
• Suggested message: “Your entity is ready to participate in the sale.”

• If the entity doesn’t meet sale requirements (e.g. resident of a blocked jurisdiction or accredited).
• Suggested message: “Entity not qualified to invest.”

• We don’t know whether the entity is eligible yet because they have not completed setup.
• Suggested message: depends on the EntitySetupState value.

​

InvestingRegion

• We don’t currently know the entity’s region.

• The entity is located in the United States.

• The entity is located in a region other than the United States.

​

PrePurchaseFailureReason

• We don’t know why the entity is not ready to purchase. This is not expected to happen.
• Suggested message: “An unknown error occurred — Please try again or contact support.”

• The wallet does not meet the configured risk thresholds.
• Suggested message: “The connected wallet is not eligible for this sale. Connect a different wallet.”

• The entity has reached the maximum number of wallets allowed for this sale.
• Suggested message: “Maximum number of wallets reached — This entity can’t use the connected wallet. Use a previous wallet.”

• The entity requires a liveness check.
• This is an expected case and the UI should not show an error; the UI should redirect the user to the LivenessCheckURL to complete a liveness check.

• The sale is not currently in a state where purchases are allowed.
• Suggested message: “The sale is not currently active.”

• The connected wallet is not linked to the entity. This suggests there is a bug on your sale website because the entity ID should be looked up from the currently connected wallet address.

​

PurchasePermitV3

​

PurchasePermitV2

​

APIError