Pool add getDepositQuote, getWithdrawQuote api's

[ghost]

Context

• Currently, the client has to do math to figure out parameters for pool deposit and withdraw. We should provide functions that calculates these values

Changes

• new pool api getDepositQuote(maxTokenAIn, maxTokenBIn, slippage?)
• new pool api getWithdrawQuote(poolTokenIn, slippage?)

Usage Example

const orca = getOrca(connection);
const pool = orca.getPool(OrcaPoolConfig.ORCA_SOL);

const orcaAmount = new Decimal(10);
const quote = await pool.getQuote(pool.getTokenA(), orcaAmount);
const solAmount = quote.getMinOutputAmount();
const poolTokenAmount = await pool.getDepositQuote(orcaAmount, solAmount); // <-- NEW

console.log(`Deposit at most ${orcaAmount} ORCA and ${solAmount} SOL, for at least ${
  poolTokenAmount
} pool tokens`);

const depositPayload = await pool.deposit(owner, orcaAmount, solAmount, poolTokenAmount);
const depositTxId = await depositPayload.execute();

console.log("Confirmation:", depositTxId);

[ghost]

@odcheung - Thanks for the review! Pushed new commits which makes these changes:

• Allow percentage based input for both getDepositQuote and getWithdrawQuote]
• Updated return values of both getDepositQuote and getWithdrawQuote
• Allow constraintToken based for getWithdrawQuote

[odcheung]

Hey @0xscuba,

Thank you for being patient with me so far! Public APIs are often difficult to adjust/recall after it goes out, so I want to make sure we get it right to make the right balance between feature-support & our burden of maintenance responsibility. I promise you that I only have this many opinions on 1 way door type decisions ><

We have a slight miscommunication on the %-usecase in the previous review. I don't think we should explicitly support that inside the SDK because it requires orca-pool to be aware of the user-wallet & it adds input-type complexity that is difficult for the user to use & especially difficult for us to maintain down the road.

[ghost]

Hey @odcheung, haha no worries! I really appreciate all the feedback, and sdk is better for it 🙂

Agree that we should be thoughtful around one-way-door decisions. I think in this case we definitely wanted to get it right because getDepositQuote, getWithdrawQuote will be an integral part of the SDK. Tangentially though, I think it's ok to push an api, then deprecate and add new versions of it without having api breaking changes (e.g. pool.someCoolMethod, later introduce pool.someCoolMethodV2).

Updated the PR with the following changes:

• Remove having different types of inputs
• Update comments, inputs, outputs
• New logic for calculating poolTokenIn_U64 using withdrawTokenAmount & withdrawTokenMint
• Also updated Update Usage section of readme #48 to match the changes

[odcheung]

thank you for addressing the comments! Looks real good to me. Approved
one nit on the description of getPoolTokenMint. (no need to wait for further approve)

[ghost]

@odcheung - thanks for the review! updated the commented, and merging now. I'll also bump the version and publish it