@paxoslabs/amplify-sdk 1.0.1 → 1.0.2

package/README.md

@@ -45,7 +45,7 @@ import { AmplifyClient } from '@paxoslabs/amplify-sdk'
 
 const client = new AmplifyClient({ apiKey: process.env.PAXOS_LABS_API_KEY! })
 
-const { vaults } = await client.vaults.list({ filter: 'chainId=1' })
+const { vaults } = await client.amplify.vaults.list({ filter: 'chainId=1' })
 ```
 
 The API key is sent as the `x-api-key` header and authenticates every request.
@@ -74,17 +74,17 @@ Each API area is exposed as a subclient on the `AmplifyClient` instance.
 
 | Accessor | Purpose |
 | :--- | :--- |
-| `client.vaults` | List vaults and assets; fetch APYs, TVLs, compositions, supply caps, and liquidity shortfalls |
-| `client.deposit` | Prepare deposit transactions |
-| `client.smartDeposits` | Create a smart deposit address for a user |
-| `client.withdraw` | Prepare and cancel withdrawals; calculate fees; list requests and volumes |
-| `client.users` | Fetch user positions |
-| `client.permit` | ERC-20 permit / authorization detection |
+| `client.amplify.vaults` | List vaults and assets; fetch APYs, TVLs, compositions, supply caps, and liquidity shortfalls |
+| `client.amplify.deposit` | Prepare deposit transactions |
+| `client.amplify.smartDeposits` | Create a smart deposit address for a user |
+| `client.amplify.withdraw` | Prepare (`prepare`) and cancel (`cancel`) withdrawals; calculate fees (`calculateFee`); list requests (`listRequests`) and volumes (`getVolumes`) |
+| `client.amplify.users` | Fetch user positions |
+| `client.core.authorization` | Detect (`detect`) token authorization requirements (permit, approval, or already approved) |
 
 ### Example: prepare a deposit
 
 ```ts
-const prepared = await client.deposit.prepareDeposit({
+const prepared = await client.amplify.deposit.prepare({
   vaultAddress,
   depositAsset,
   depositAmount,
@@ -99,7 +99,7 @@ const prepared = await client.deposit.prepareDeposit({
 ### Example: create a smart deposit address
 
 ```ts
-const { smartDepositAddress } = await client.smartDeposits.getAddress({
+const { smartDepositAddress } = await client.amplify.smartDeposits.getAddress({
   userDestinationAddress,
   vaultAddress,
   inputToken,
@@ -115,7 +115,7 @@ Requests reject with `AmplifyError` (carrying `statusCode` and `message`); reque
 import { AmplifyError } from '@paxoslabs/amplify-sdk'
 
 try {
-  await client.deposit.prepareDeposit(request)
+  await client.amplify.deposit.prepare(request)
 } catch (err) {
   if (err instanceof AmplifyError) {
     console.error(err.statusCode, err.message)
@@ -126,14 +126,18 @@ try {
 
 ## Types
 
-Generated request and response types are available under the `Amplify` namespace:
+Generated types are available under the `Amplify` namespace:
 
 ```ts
 import { Amplify } from '@paxoslabs/amplify-sdk'
 
-const request: Amplify.PrepareDepositRequest = {
-  /* ... */
-}
+// Response types are at the top level
+type DepositResponse = Amplify.PrepareDepositResponseDto
+type AuthResponse = Amplify.AuthorizationResponseDto
+
+// Request types are nested under resource namespaces
+type DepositRequest = Amplify.amplify.deposit.PrepareDepositRequest
+type AuthRequest = Amplify.core.authorization.DetectAuthorizationRequest
 ```
 
 ## License