docs: deprecate transferAllocation + docs corrections

Author: ashuvssut

.changeset/many-islands-fly.md

@@ -0,0 +1,6 @@
+---
+'@zerochain/sdk': patch
+---
+
+- Add missing code documentation / corrections
+- transferAllocation is marked as deprecated

docs/docs/api/allocation.mdx

@@ -438,17 +438,17 @@ const transactionHash = await updateForbidAllocation({
 ```
 
 ### `getUpdateAllocTicket`
-Signs an "Update Allocation ticket," which is needed to allow someone else to run an update transaction for your allocation on your terms.
-{/* Get details of params and update code docs too // DOTODO: https://0chain.slack.com/archives/D06680GNC49/p1739215304759299 */}
+Generates and signs an "Update Allocation ticket", which authorizes the "add blobber" or "replace blobber" operation from other wallets.
+
 #### Parameters
 | Name | Type | Description | Default value |
 |---|---|---|---|
 | `domain` | `NetworkDomain` | Network domain for the allocation | |
 | `wallet` | `ActiveWallet` | Active Wallet details | |
 | `allocationId` | `string` | Allocation ID to update | |
-| `userId` | `string` | Wallet ID of the user updating the allocation. | |
-| `operationType` | `string` | Type of operation | |
-| `roundExpiry` | `number` | Expiry round for the ticket | |
+| `userId` | `string` | UserID is the wallet ID which will be allowed to update your allocation | |
+| `operationType` | `replace_blobber` \| `add_blobber` | Type of operation | |
+| `roundExpiry` | `number` | Round expiry is the round after which the auth ticket will no longer be valid. | |
 
 #### Return Type
 ```typescript
@@ -469,9 +469,9 @@ const authTicket = await getUpdateAllocTicket({
 })
 ```
 
-### `transferAllocation`
+{/* ### `transferAllocation`
 Transfers the ownership of an allocation to a new owner.
-{/* verify and update code docs too // DOTODO: https://0chain.slack.com/archives/D06680GNC49/p1739216420958469 */}
+
 #### Parameters
 | Name | Type | Description | Default value |
 |---|---|---|---|
@@ -492,7 +492,7 @@ await transferAllocation({
   newOwnerId: walledIdOfNewOwner,
   newOwnerPublicKey: walletPublicKeyOfNewOwner
 })
-```
+``` */}
 
 ### `checkAllocStatus`
 Checks the health status of the allocation.

docs/docs/api/introduction.mdx

@@ -61,14 +61,14 @@ The allocation storage methods allow you to create, update, and manage allocatio
 | [`updateAllocationWithRepair`](/docs/api/allocation#updateallocationwithrepair) | Updates your allocation settings and repairs the allocation if any blobber was replaced or added |
 | [`getUpdateAllocationMinLock`](/docs/api/allocation#getupdateallocationminlock) | Retrieves the minimum lock value for the allocation after update. |
 | [`updateForbidAllocation`](/docs/api/allocation#updateforbidallocation) | UpdateForbidAllocation updates the permissions of an allocation, given the permission parameters in a forbid-first manner. |
-| [`getUpdateAllocTicket`](/docs/api/allocation#getupdateallocticket) | This method is used to sign an "Update Allocation ticket". This ticket is needed to allow someone else to run update transaction for your allocation on your terms. |
-| [`transferAllocation`](/docs/api/allocation#transferallocation) | Transfer the ownership of an allocation to a new owner |
+| [`getUpdateAllocTicket`](/docs/api/allocation#getupdateallocticket) | Generates and signs an "Update Allocation ticket", which authorizes the "add blobber" or "replace blobber" operation from other wallets. |
 | [`checkAllocStatus`](/docs/api/allocation#checkallocstatus) | Check the health status of the allocation.|
 | [`skipStatusCheck`](/docs/api/allocation#skipstatuscheck) | Skips the `checkAlloctionStatus` health status check of the allocation. |
 | [`repairAllocation`](/docs/api/allocation#repairallocation) | Start a repair process for an allocation. |
 | [`repairSize`](/docs/api/allocation#repairsize) | Retrieves the repair size for a specific path in an allocation. |
 | [`createWorkers`](/docs/api/allocation#createworkers) | Manually create local workers that sync with the allocation. |
 | [`terminateWorkers`](/docs/api/allocation#terminateworkers) | Remove local workers that sync with the allocation. This is useful when switching between allocations. |
+{/* | [`transferAllocation`](/docs/api/allocation#transferallocation) | Transfer the ownership of an allocation to a new owner | */}
 {/* createFreeAllocation // DOTODO */}
 
 ### Blobber Methods

package/src/sdk/allocation.ts

@@ -206,7 +206,10 @@ export const reloadAllocation = async ({
   return await goWasm.sdk.reloadAllocation(allocationId)
 }
 
-/** transferAllocation transfers the ownership of an allocation to a new owner */
+/**
+ * transferAllocation transfers the ownership of an allocation to a new owner
+ * @deprecated
+ */
 export const transferAllocation = async ({
   wallet,
   domain,
@@ -562,7 +565,7 @@ export const createFreeAllocation = async ({
 }
 
 /**
- * This method is used to sign an "Update Allocation ticket". This ticket is needed to allow someone else to run update transaction for your allocation on your terms.
+ * Generates and signs an "Update Allocation ticket", which authorizes the "add blobber" or "replace blobber" operation from other wallets. This ticket must be signed by the allocation owner.
  */
 export const getUpdateAllocTicket = async ({
   domain,
@@ -575,9 +578,11 @@ export const getUpdateAllocTicket = async ({
   domain: NetworkDomain
   wallet: ActiveWallet
   allocationId: string
-  // get from zcnContracts
+  // TODO: get from zcnContracts? Check for other zcnContracts teamWallet mentions too. Are they valid?
+  /** UserID is the wallet ID which will be allowed to update your allocation */
   userId: string // TODO: Should we directly add teamWallet here
-  operationType: string // TODO
+  operationType: 'replace_blobber' | 'add_blobber'
+  /** Round expiry is the round after which the auth ticket will no longer be valid. */
   roundExpiry: number
 }): Promise<string> => {
   const goWasm = await getWasm({ domain, wallet })