add deprecate notice to receipts coders

Author: Torres-ssf

packages/transactions/src/coders/receipt.ts

@@ -46,6 +46,11 @@ export type ReceiptCall = {
   is: BN;
 };
 
+/**
+ * @deprecated Receipt Coders are deprecated and will be removed in future versions
+ * because decoding receipts is no longer necessary. No replacement is required as
+ * this functionality is obsolete.
+ */
 export class ReceiptCallCoder extends Coder<ReceiptCall, ReceiptCall> {
   constructor() {
     super('ReceiptCall', 'struct ReceiptCall', 0);
@@ -120,6 +125,11 @@ export type ReceiptReturn = {
   is: BN;
 };
 
+/**
+ * @deprecated Receipt Coders are deprecated and will be removed in future versions
+ * because decoding receipts is no longer necessary. No replacement is required as
+ * this functionality is obsolete.
+ */
 export class ReceiptReturnCoder extends Coder<ReceiptReturn, ReceiptReturn> {
   constructor() {
     super('ReceiptReturn', 'struct ReceiptReturn', 0);
@@ -178,6 +188,11 @@ export type ReceiptReturnData = {
   is: BN;
 };
 
+/**
+ * @deprecated Receipt Coders are deprecated and will be removed in future versions
+ * because decoding receipts is no longer necessary. No replacement is required as
+ * this functionality is obsolete.
+ */
 export class ReceiptReturnDataCoder extends Coder<ReceiptReturnData, ReceiptReturnData> {
   constructor() {
     super('ReceiptReturnData', 'struct ReceiptReturnData', 0);
@@ -242,6 +257,11 @@ export type ReceiptPanic = {
   contractId: string;
 };
 
+/**
+ * @deprecated Receipt Coders are deprecated and will be removed in future versions
+ * because decoding receipts is no longer necessary. No replacement is required as
+ * this functionality is obsolete.
+ */
 export class ReceiptPanicCoder extends Coder<ReceiptPanic, ReceiptPanic> {
   constructor() {
     super('ReceiptPanic', 'struct ReceiptPanic', 0);
@@ -300,6 +320,11 @@ export type ReceiptRevert = {
   is: BN;
 };
 
+/**
+ * @deprecated Receipt Coders are deprecated and will be removed in future versions
+ * because decoding receipts is no longer necessary. No replacement is required as
+ * this functionality is obsolete.
+ */
 export class ReceiptRevertCoder extends Coder<ReceiptRevert, ReceiptRevert> {
   constructor() {
     super('ReceiptRevert', 'struct ReceiptRevert', 0);
@@ -360,6 +385,11 @@ export type ReceiptLog = {
   is: BN;
 };
 
+/**
+ * @deprecated Receipt Coders are deprecated and will be removed in future versions
+ * because decoding receipts is no longer necessary. No replacement is required as
+ * this functionality is obsolete.
+ */
 export class ReceiptLogCoder extends Coder<ReceiptLog, ReceiptLog> {
   constructor() {
     super('ReceiptLog', 'struct ReceiptLog', 0);
@@ -434,6 +464,11 @@ export type ReceiptLogData = {
   is: BN;
 };
 
+/**
+ * @deprecated Receipt Coders are deprecated and will be removed in future versions
+ * because decoding receipts is no longer necessary. No replacement is required as
+ * this functionality is obsolete.
+ */
 export class ReceiptLogDataCoder extends Coder<ReceiptLogData, ReceiptLogData> {
   constructor() {
     super('ReceiptLogData', 'struct ReceiptLogData', 0);
@@ -508,6 +543,11 @@ export type ReceiptTransfer = {
   is: BN;
 };
 
+/**
+ * @deprecated Receipt Coders are deprecated and will be removed in future versions
+ * because decoding receipts is no longer necessary. No replacement is required as
+ * this functionality is obsolete.
+ */
 export class ReceiptTransferCoder extends Coder<ReceiptTransfer, ReceiptTransfer> {
   constructor() {
     super('ReceiptTransfer', 'struct ReceiptTransfer', 0);
@@ -574,6 +614,11 @@ export type ReceiptTransferOut = {
   is: BN;
 };
 
+/**
+ * @deprecated Receipt Coders are deprecated and will be removed in future versions
+ * because decoding receipts is no longer necessary. No replacement is required as
+ * this functionality is obsolete.
+ */
 export class ReceiptTransferOutCoder extends Coder<ReceiptTransferOut, ReceiptTransferOut> {
   constructor() {
     super('ReceiptTransferOut', 'struct ReceiptTransferOut', 0);
@@ -632,6 +677,11 @@ export type ReceiptScriptResult = {
   gasUsed: BN;
 };
 
+/**
+ * @deprecated Receipt Coders are deprecated and will be removed in future versions
+ * because decoding receipts is no longer necessary. No replacement is required as
+ * this functionality is obsolete.
+ */
 export class ReceiptScriptResultCoder extends Coder<ReceiptScriptResult, ReceiptScriptResult> {
   constructor() {
     super('ReceiptScriptResult', 'struct ReceiptScriptResult', 0);
@@ -684,11 +734,20 @@ export type ReceiptMessageOut = {
   data: Uint8Array;
 };
 
+/**
+ * @deprecated Receipt Coders are deprecated and will be removed in future versions
+ * because decoding receipts is no longer necessary. No replacement is required as
+ * this functionality is obsolete.
+ */
 export class ReceiptMessageOutCoder extends Coder<ReceiptMessageOut, ReceiptMessageOut> {
   constructor() {
     super('ReceiptMessageOut', 'struct ReceiptMessageOut', 0);
   }
 
+  /**
+   * @deprecated `ReceiptMessageOutCoder.getMessageId` is deprecated and will be removed in future versions.
+   * Use the static method `InputMessageCoder.getMessageId` instead.
+   */
   static getMessageId(
     value: Pick<ReceiptMessageOut, 'sender' | 'recipient' | 'nonce' | 'amount' | 'data'>
   ): string {
@@ -779,11 +838,20 @@ export const createAssetId = (contractId: string, subId: string): AssetId => ({
   bits: getMintedAssetId(contractId, subId),
 });
 
+/**
+ * @deprecated Receipt Coders are deprecated and will be removed in future versions
+ * because decoding receipts is no longer necessary. No replacement is required as
+ * this functionality is obsolete.
+ */
 export class ReceiptMintCoder extends Coder<ReceiptMint, ReceiptMint> {
   constructor() {
     super('ReceiptMint', 'struct ReceiptMint', 0);
   }
 
+  /**
+   * @deprecated `ReceiptMintCoder.getAssetId` is deprecated and will be removed in future versions.
+   * Use the helper function `getMintedAssetId` instead.
+   */
   static getAssetId(contractId: string, subId: string): string {
     return getMintedAssetId(contractId, subId);
   }
@@ -847,11 +915,20 @@ export type ReceiptBurn = {
   is: BN;
 };
 
+/**
+ * @deprecated Receipt Coders are deprecated and will be removed in future versions
+ * because decoding receipts is no longer necessary. No replacement is required as
+ * this functionality is obsolete.
+ */
 export class ReceiptBurnCoder extends Coder<ReceiptBurn, ReceiptBurn> {
   constructor() {
     super('ReceiptBurn', 'struct ReceiptBurn', 0);
   }
 
+  /**
+   * @deprecated `ReceiptBurnCoder.getAssetId` is deprecated and will be removed in future versions.
+   * Use the helper function `getMintedAssetId` instead.
+   */
   static getAssetId(contractId: string, subId: string): string {
     return getMintedAssetId(contractId, subId);
   }
@@ -914,6 +991,11 @@ export type Receipt =
   | ReceiptMint
   | ReceiptBurn;
 
+/**
+ * @deprecated Receipt Coders are deprecated and will be removed in future versions
+ * because decoding receipts is no longer necessary. No replacement is required as
+ * this functionality is obsolete.
+ */
 export class ReceiptCoder extends Coder<Receipt, Receipt> {
   constructor() {
     super('Receipt', 'struct Receipt', 0);