[ADD] Implement starknet_estimateMessageFee method #80 (#84)

software-mansion · Jul 18, 2023 · 9fd942a · 9fd942a
1 parent a7218ea
commit 9fd942a
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 0 deletions.
diff --git a/Sources/Starknet/Providers/StarknetProvider/JsonRpcMethod.swift b/Sources/Starknet/Providers/StarknetProvider/JsonRpcMethod.swift
@@ -14,4 +14,5 @@ enum JsonRpcMethod: String, Encodable {
     case getTransactionByBlockIdAndIndex = "starknet_getTransactionByBlockIdAndIndex"
     case getTransactionReceipt = "starknet_getTransactionReceipt"
     case simulateTransaction = "starknet_simulateTransaction"
+    case estimateMessageFee = "starknet_estimateMessageFee"
 }
diff --git a/Sources/Starknet/Providers/StarknetProvider/JsonRpcParams.swift b/Sources/Starknet/Providers/StarknetProvider/JsonRpcParams.swift
@@ -56,6 +56,18 @@ struct EstimateFeeParams: Encodable {
     }
 }
 
+struct EstimateMessageFeeParams: Encodable {
+    let message: StarknetCall
+    let senderAddress: Felt
+    let blockId: StarknetBlockId
+
+    enum CodingKeys: String, CodingKey {
+        case message
+        case senderAddress = "sender_address"
+        case blockId = "block_id"
+    }
+}
+
 struct AddDeployAccountTransactionParams: Encodable {
     let deployAccountTransaction: StarknetSequencerDeployAccountTransaction
 

diff --git a/Sources/Starknet/Providers/StarknetProvider/StarknetProvider.swift b/Sources/Starknet/Providers/StarknetProvider/StarknetProvider.swift
@@ -60,6 +60,14 @@ public class StarknetProvider: StarknetProviderProtocol {
         return result
     }
 
+    public func estimateMessageFee(_ message: StarknetCall, senderAddress: Felt, at blockId: StarknetBlockId) async throws -> StarknetFeeEstimate {
+        let params = EstimateMessageFeeParams(message: message, senderAddress: senderAddress, blockId: blockId)
+
+        let result = try await makeRequest(method: .estimateMessageFee, params: params, receive: StarknetFeeEstimate.self)
+
+        return result
+    }
+
     public func estimateFee(for transactions: [any StarknetSequencerTransaction], at blockId: StarknetBlockId) async throws -> [StarknetFeeEstimate] {
         let params = EstimateFeeParams(request: transactions, blockId: blockId)
 

diff --git a/Sources/Starknet/Providers/StarknetProviderProtocol.swift b/Sources/Starknet/Providers/StarknetProviderProtocol.swift
@@ -30,6 +30,15 @@ public protocol StarknetProviderProtocol {
     /// - Returns: Array of fee estimates
     func estimateFee(for transactions: [any StarknetSequencerTransaction], at blockId: StarknetBlockId) async throws -> [StarknetFeeEstimate]
 
+    /// Estimate the L2 fee of a message sent on L1
+    ///
+    /// - Parameters:
+    ///  - message: the message's parameters
+    ///  - senderAddress: the L1 address of the sender
+    ///  - blockId: hash, numer, or tag of a block for which the estimation should be made.
+    /// - Returns: the fee estimation
+    func estimateMessageFee(_ message: StarknetCall, senderAddress: Felt, at blockId: StarknetBlockId) async throws -> StarknetFeeEstimate
+
     /// Invoke a function.
     ///
     /// Invoke a function in deployed contract.
@@ -147,6 +156,16 @@ public extension StarknetProviderProtocol {
         try await estimateFee(for: transaction, at: defaultBlockId)
     }
 
+    /// Estimate the L2 fee of a message sent on L1
+    ///
+    /// - Parameters:
+    ///  - message: the message's parameters
+    ///  - senderAddress: the L1 address of the sender
+    /// - Returns: the fee estimation
+    func estimateMessageFee(_ message: StarknetCall, senderAddress: Felt) async throws -> StarknetFeeEstimate {
+        try await estimateMessageFee(message, senderAddress: senderAddress, at: defaultBlockId)
+    }
+
     /// Get nonce of given starknet contract in the pending block.
     ///
     /// - Parameters