2404 sdkv3 transaction request in walletclient

docs/thorest/thor/thorest/model.mmd → docs/thor/thorest/model.mmd

@@ -54,6 +54,7 @@ classDiagram
     }
     class SignedTransactionRequest {
         constructor(SignedTransactionRequestParam param)
+        SignedTransactionRequestJSON toJSON()
     }
     class SignedTransactionRequestParam {
         <<interface>>
@@ -68,9 +69,11 @@ classDiagram
     }
     class SponsoredTransactionRequest {
         constructor(SponsoredTransactionRequestParam: param)
+        SponsoredTransactionRequestJSON toJSON()
     }
     class TransactionRequest {
         constructor(TransactionRequestParam param)
+        TransactionRequestJSON toJSON()
     }
     class TransactionRequestParams {
         <<interface>>

docs/thorest/thor/thorest/signer.mmd → docs/thor/thorest/signer.mmd

@@ -28,12 +28,12 @@ classDiagram
         }
     }
     class RLPCodec {
-        Uint8Array encodeSignedTransactionRequest(SignedTransactionRequest transactionRequest)
-        Uint8Array encodeTransactionRequest(TransactionRequest transactionRequest)
+        TransactionRequest|SignedTransactionRequest|SponsoredTransactionRequest decode(Uint8Array encoded)
+        Uint8Array encode(TransactionRequest|SignedTransactionRequest|SponsoredTransactionRequest transactionRequest)
     }
     class PrivateKeySigner {
         constructor(Uint8Array privateKey)
-        void()
+        disponse()
     }
     class Signer {
         <<interface>>

docs/viem/walletClient.mmd

@@ -0,0 +1,91 @@
+---
+title: "@viem.clients.walletClient"
+---
+classDiagram
+    class CreateEventFilterParams {
+        Address|Address[] address
+        AbiEvent event
+        Hex[] args
+        bigint fromBlock
+        bigint toBlock
+    }
+    class GetFilterChangesParams {
+        <<interface>>
+        Filter filter
+    }
+    class GetFilterLogParams {
+        <<interface>>
+        Filter filter
+    }
+    class PrepareTransactionRequestRequest {
+        <<interface>>
+        Address to
+        Hex|number value
+        Hex data
+        string comment
+        Hex abi
+        Hex blockRef
+        number chainTag
+        Hex dependsOn
+        number expiration
+        Hex|number gas
+        number gasPriceCoef
+        number nonce
+        boolean isIntendedToBeSponsored
+    }
+    class PublicClient {
+        URL|ThorNetwork network
+        constructor(URL|ThorNetwork network, HttpClient transport)
+        Promise~ExecuteCodesResponse~ call(ExecuteCodesRequestJSON request)
+        Promise~BlockFilter~ createBlockFilter()
+        EventFilter createEventFilter(CreateEventFilterParams params)
+        PendingTransactionFilter createPendingTransactionFilter()
+        Promise~bigint~ getBalance(Address address)
+        Promise~ExpandedBlockResponse|RawTx|RegularBlockResponse|null~ getBlock(BlockRevision revision, BlockReponseType type)
+        Promise~number|undefined~ getBlockNumber(BlockRevision revision)
+        Promise~number|undefined~ getBlockTransactionCount(BlockRevision revision)
+        Promise~Hex|undefined~ getBytecode(Address address)
+        Promise~bigint~ getChainId()
+        Promise~ex|undefined~ getCode(Address address)
+        Promise~FeeHistory~ getFeeHistory(number blockCount)
+        Promise~Array~DecodedEventLog|string~~ getFilterChanges(GetFilterChangesParams params)
+        Promise~DecodedEventLog[]~ getFilterLogs(GetFilterLogParams params)
+        Promise~bigint[]~ getGasPrice()
+        Promise~DecodedEventLog[]~ getLogs(EventFilter eventFilter)
+        Promise~number~ getNonce(Address address)
+        Promise~Hex~ getStorageAt(Address address, Hex slot)
+        Promise~GetTxResponse|null~ getTransaction(hash: Hex)
+        Promise~number~ getTransactionCount(Address address)
+        Promise~GetTxReceiptResponse|null~ getTransactionReceipt(Hex hash)
+        Promise~bigint|undefined~ estimateFeePerGas()
+        Promise~EstimatedGas[]~ estimateGas(ExecuteCodesRequestJSON request)
+        Promise~ExecuteCodesResponse~ simulateCalls(ExecuteCodesRequestJSON request)
+        Promise~bigint~ suggestPriorityFeeRequest()
+        void unistallFilter(BeatsSubscription|BlocksSubscription|EventsSubscription|NewTransactionSubscription|TransfersSubscription subscription)
+        BlocksSubscription watchBlocks(Hex pos)
+        BlocksSubscription watchBlockNumber()
+        void watchEvent(WatchEventParams params)
+    }
+    class WatchEventParams {
+        <<interface>>
+        Function~SubscriptionEventResponse[] logs~ onLogs
+        Function~Error error~ onError
+        Address address;
+        Hex event
+        Hex[] args
+        Hex fromBlock
+    }
+    class WalletClient {
+        constructor(URL|ThorNeetwork network, HttpClient transport, Account|null account)
+        Address[] getAddresses()
+        TransactionRequest prepareTransactionRequest(PrepareTransactionRequestRequest request)
+        Promise~Hex~ sendRawTransaction(Hex raw)
+        Promise~Hex~ sendTransaction(PrepareTransactionRequestRequest|SignedTransactionRequest request)
+        Promise~Hex~ signTransaction(PrepareTransactionRequestRequest|SignedTransactionRequest request)
+    }
+    PublicClient <|-- WalletClient
+    CreateEventFilterParams "PublicClient.createEventFilter(...)" -- PublicClient
+    GetFilterChangesParams "PublicClient.getFilterChanges(...)" -- PublicClient
+    GetFilterLogParams "PublicClient.getFilterLogs(...)" -- PublicClient
+    PrepareTransactionRequestRequest "WalletClient.sendTransaction() WalletClient.signTransaction(...)" -- WalletClient
+    WatchEventParams "PublicClient.watchEvent(...)" -- PublicClient

packages/sdk/src/thor/thorest/json/SignedTransactionRequestJSON.ts

@@ -0,0 +1,12 @@
+import { type TransactionRequestJSON } from '@thor/thorest/json/TransactionRequestJSON';
+
+/**
+ * Represents the content of a {@link SignedTransactionRequest} object in JSON format.
+ */
+interface SignedTransactionRequestJSON extends TransactionRequestJSON {
+    origin: string; // hex address
+    originSignature: string; // hex origin signature
+    signature: string; // hex signature
+}
+
+export { type SignedTransactionRequestJSON };

packages/sdk/src/thor/thorest/json/SponsoredTransactionRequestJSON.ts

@@ -0,0 +1,11 @@
+import { type SignedTransactionRequestJSON } from '@thor/thorest/json/SignedTransactionRequestJSON';
+
+/**
+ * Represents the content of a {@link SponsoredTransactionRequest} object in JSON format.
+ */
+interface SponsoredTransactionRequestJSON extends SignedTransactionRequestJSON {
+    gasPayer: string; // hex address
+    gasPayerSignature: string; // hex signature
+}
+
+export { type SponsoredTransactionRequestJSON };

packages/sdk/src/thor/thorest/json/TransactionRequestJSON.ts

@@ -0,0 +1,18 @@
+import { type ClauseJSON } from '@thor/thorest/json/ClauseJSON';
+
+/**
+ * Represents the content of a {@link TransactionRequest} object in JSON format.
+ */
+interface TransactionRequestJSON {
+    blockRef: string;
+    chainTag: number;
+    clauses: ClauseJSON[];
+    dependsOn: string | null;
+    expiration: number;
+    gas: bigint;
+    gasPriceCoef: bigint;
+    nonce: number;
+    isIntendedToBeSponsored: boolean;
+}
+
+export { type TransactionRequestJSON };

packages/sdk/src/thor/thorest/json/index.ts

@@ -3,8 +3,11 @@ export * from './EventJSON';
 export * from './OutputJSON';
 export * from './ReceiptJSON';
 export * from './ReceiptMetaJSON';
+export * from './SignedTransactionRequestJSON';
+export * from './SponsoredTransactionRequestJSON';
 export * from './TransferJSON';
 export * from './TransferJSON';
+export * from './TransactionRequestJSON';
 export * from '../transactions/json';
 export * from '../blocks/json';
 export * from '../debug/json';

packages/sdk/src/thor/thorest/model/SignedTransactionRequest.ts

@@ -2,7 +2,8 @@ import {
     TransactionRequest,
     type TransactionRequestParam
 } from './TransactionRequest';
-import type { Address } from '@common';
+import { type Address, HexUInt } from '@common';
+import { type SignedTransactionRequestJSON } from '@thor/thorest/json';
 
 /**
  * Represents the parameters required for a signed transaction request.
@@ -76,6 +77,20 @@ class SignedTransactionRequest
     public isSigned(): boolean {
         return true;
     }
+
+    /**
+     * Converts the SignedTransactionRequest object into its JSON representation.
+     *
+     * @return {SignedTransactionRequestJSON} The JSON representation of the SignedTransactionRequest object.
+     */
+    public toJSON(): SignedTransactionRequestJSON {
+        return {
+            ...super.toJSON(),
+            origin: this.origin.toString(),
+            originSignature: HexUInt.of(this.originSignature).toString(),
+            signature: HexUInt.of(this.signature).toString()
+        } satisfies SignedTransactionRequestJSON;
+    }
 }
 
 export { type SignedTransactionRequestParam, SignedTransactionRequest };

packages/sdk/src/thor/thorest/model/SponsoredTransactionRequest.ts

@@ -1,8 +1,10 @@
-import { type Address } from '@common';
+import { type Address, HexUInt } from '@common';
+
+import { type SponsoredTransactionRequestJSON } from '@thor/thorest/json';
 import {
     SignedTransactionRequest,
     type SignedTransactionRequestParam
-} from './SignedTransactionRequest';
+} from '@thor/thorest/model';
 
 /**
  * Represents the parameters required for a sponsored transaction request.
@@ -52,6 +54,19 @@ class SponsoredTransactionRequest
         this.gasPayer = params.gasPayer;
         this.gasPayerSignature = new Uint8Array(params.gasPayerSignature);
     }
+
+    /**
+     * Converts the SponsoredTransactionRequest object into its JSON representation.
+     *
+     * @return {SponsoredTransactionRequestJSON} The JSON representation of the SponsoredTransactionRequest object.
+     */
+    toJSON(): SponsoredTransactionRequestJSON {
+        return {
+            ...super.toJSON(),
+            gasPayer: this.gasPayer.toString(),
+            gasPayerSignature: HexUInt.of(this.gasPayerSignature).toString()
+        } satisfies SponsoredTransactionRequestJSON;
+    }
 }
 
 export { SponsoredTransactionRequest, type SponsoredTransactionRequestParam };

packages/sdk/src/thor/thorest/model/TransactionRequest.ts

@@ -1,5 +1,6 @@
 import { type Clause } from '@thor';
 import { type Hex } from '@common';
+import { type TransactionRequestJSON } from '@thor/thorest/json';
 
 /**
  * Represents the parameters required to create a {@link TransactionRequest} instance.
@@ -145,6 +146,25 @@ class TransactionRequest implements TransactionRequestParam {
     public isSigned(): boolean {
         return false;
     }
+
+    /**
+     * Converts the TransactionRequest object into a JSON representation.
+     *
+     * @return {TransactionRequestJSON} The JSON representation of the TransactionRequest object.
+     */
+    public toJSON(): TransactionRequestJSON {
+        return {
+            blockRef: this.blockRef.toString(),
+            chainTag: this.chainTag,
+            clauses: this.clauses.map((clause: Clause) => clause.toJSON()),
+            dependsOn: this.dependsOn?.toString() ?? null,
+            expiration: this.expiration,
+            gas: this.gas,
+            gasPriceCoef: this.gasPriceCoef,
+            nonce: this.nonce,
+            isIntendedToBeSponsored: this.isIntendedToBeSponsored
+        } satisfies TransactionRequestJSON;
+    }
 }
 
 export { TransactionRequest, type TransactionRequestParam };