@compass-labs/api-sdk 2.1.1-rc.1 → 2.1.1

package/README.md

@@ -253,7 +253,7 @@ run();
 ### [earn](docs/sdks/earn/README.md)
 
 * [earnPositions](docs/sdks/earn/README.md#earnpositions) - List earn positions
-* [earnPositionsPositionId](docs/sdks/earn/README.md#earnpositionspositionid) - Get individual earn position
+* [earnPositionsPositionId](docs/sdks/earn/README.md#earnpositionspositionid) - Get earn position
 * [earnVaults](docs/sdks/earn/README.md#earnvaults) - List vaults
 * [earnCreateAccount](docs/sdks/earn/README.md#earncreateaccount) - Create earn account
 * [earnTransfer](docs/sdks/earn/README.md#earntransfer) - Transfer tokens to/from account
@@ -400,7 +400,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`earnEarnCreateAccount`](docs/sdks/earn/README.md#earncreateaccount) - Create earn account
 - [`earnEarnManage`](docs/sdks/earn/README.md#earnmanage) - Manage earn position
 - [`earnEarnPositions`](docs/sdks/earn/README.md#earnpositions) - List earn positions
-- [`earnEarnPositionsPositionId`](docs/sdks/earn/README.md#earnpositionspositionid) - Get individual earn position
+- [`earnEarnPositionsPositionId`](docs/sdks/earn/README.md#earnpositionspositionid) - Get earn position
 - [`earnEarnTransfer`](docs/sdks/earn/README.md#earntransfer) - Transfer tokens to/from account
 - [`earnEarnVaults`](docs/sdks/earn/README.md#earnvaults) - List vaults
 - [`erc4626VaultsVaultsDeposit`](docs/sdks/erc4626vaults/README.md#vaultsdeposit) - Deposit to Vault

package/bin/mcp-server.js

@@ -47817,15 +47817,15 @@ var init_earnEarnCreateAccount2 = __esm(() => {
     name: "earn-earn-create-account",
     description: `Create earn account
 
-Create a Compass Earn Account.
+Create an Earn Account.
 
-Before creating Earn positions you must create a Compass Earn Account. This account will be associated with the \`owner\` wallet address.
+Before creating Earn positions, the \`owner\` must create an Earn Account associated with their wallet address.
 
 Only the \`owner\` has the authority to sign transactions for this account. This can be done in one of two ways:
 
-1) The \`owner\` signs an unsigned transaction and submits to the network for execution. The \`owner\` covers the cost of gas in this case.
+1) **No gas-sponsorship:** The \`owner\` signs a transaction and submits it to the network for execution. The \`owner\` covers the cost of gas in this case.
 
-2) The \`owner\` does an off-chain EIP-712 signature and submits this signature to the 'Prepare gas-sponsored transaction' endpoint (\`/gas_sponsorship/prepare\`).
+2) **Gas-sponsorship:** The \`owner\` does an off-chain EIP-712 signature and submits this signature to the 'Prepare gas-sponsored transaction' endpoint (\`/gas_sponsorship/prepare\`). Here, another wallet address is set as \`sender\`. This wallet will sign, submit and cover the gas fees of the transaction.
 
 The creation of an Earn Account itself can be a gas-sponsored transaction by setting the \`sender\` to the wallet which will sign and send the transaction.`,
     args: args22,
@@ -47940,9 +47940,9 @@ If \`DEPOSIT\` is selected for \`action\`, tokens will be deposited to the marke
 
 If \`WITHDRAW\` is selected, tokens will be withdrawn from the market to the \`owner\`'s Earn Account.
 
-A fee can be configured. This fee is deducted from the total \`amount\`. It can be expressed as a \`FIXED\` amount or a \`PERCENTAGE\`.
+A fee can be configured. This fee is deducted from the total \`amount\`. It can be expressed as a \`FIXED\` amount or a \`PERCENTAGE\` of \`amount\`.
 
-The transaction can be gas-sponsored by an arbitrary wallet address. Where the owner of said wallet will sign, submit and pay the required gas for the transaction. If \`gas_sponsorship\` is set to \`true\`, EIP-712 typed data will be returned that must be signed by the \`owner\` and submitted to the 'Prepare gas-sponsored transaction' endpoint (\`/gas_sponsorship/prepare\`) where the \`sender\` of the transaction can be set.`,
+The transaction can be gas-sponsored by an arbitrary wallet address which will sign, submit and pay the required gas for the transaction. If \`gas_sponsorship\` is set to \`true\`, EIP-712 typed data will be returned that must be signed by the \`owner\` and submitted to the 'Prepare gas-sponsored transaction' endpoint (\`/gas_sponsorship/prepare\`) where the \`sender\` of the transaction can be set.`,
     args: args23,
     tool: async (client, args24, ctx) => {
       const [result, apiCall] = await earnEarnManage(client, args24.request, { fetchOptions: { signal: ctx.signal } }).$inspect();
@@ -48165,7 +48165,7 @@ var init_earnEarnPositionsPositionId2 = __esm(() => {
   };
   tool$earnEarnPositionsPositionId = {
     name: "earn-earn-positions-position-id",
-    description: `Get individual earn position
+    description: `Get earn position
 
 This endpoint fetches a single Compass Earn position by its encoded ID.`,
     args: args25,
@@ -48270,14 +48270,14 @@ var init_earnEarnTransfer2 = __esm(() => {
     name: "earn-earn-transfer",
     description: `Transfer tokens to/from account
 
-Transfer tokens to and from a Compass Earn Account.
+Transfer tokens to and from an Earn Account.
 
 If \`DEPOSIT\`'\` is selected, tokens will be transferred from the \`owner\`'s wallet into their Earn Account.
 
 If \`WITHDRAW\` is selected, tokens will be transferred from the \`owner\`'s Earn Account into their wallet.
 
-If a gas-sponsored \`DEPOSIT\` transfer is desired for a given token, a one-time Permit2 allowance must be set before proceeding. This is common practice for many other applications and, for many users, this one-time allowance will already have been set for the token they would like to transfer.
-Once the one-time allowance is set for a given token, EIP-712 typed data will be returned and can be signed off-chain by the user. This signature can then be submitted to the 'Prepare gas-sponsored transaction' endpoint (\`/gas_sponsorship/prepare\`).`,
+If a gas-sponsored \`DEPOSIT\` transfer is desired for a given token, a one-time Permit2 allowance must be set before proceeding. This is common practice for many other applications and, for many \`owner\`s, this one-time allowance will already have been set for the token they would like to transfer.
+Once the one-time allowance is set for a given token and \`gas_sponsorship\` is set to 'true', EIP-712 typed data will be returned and can be signed off-chain by the user. This signature can then be submitted to the 'Prepare gas-sponsored transaction' endpoint (\`/gas_sponsorship/prepare\`) where a \`sender\` can be set for the transaction.`,
     args: args26,
     tool: async (client, args27, ctx) => {
       const [result, apiCall] = await earnEarnTransfer(client, args27.request, { fetchOptions: { signal: ctx.signal } }).$inspect();
@@ -56562,5 +56562,5 @@ export {
   app
 };
 
-//# debugId=B32A35E8492910EB64756E2164756E21
+//# debugId=82051501CC880E9464756E2164756E21
 //# sourceMappingURL=mcp-server.js.map