privy_ruby 0.3.0 → 0.5.0

data/rbi/privy/models/spark_coop_exit_fee_quote.rbi

@@ -0,0 +1,143 @@
+# typed: strong
+
+module Privy
+  module Models
+    class SparkCoopExitFeeQuote < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Privy::SparkCoopExitFeeQuote, Privy::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(String) }
+      attr_accessor :created_at
+
+      sig { returns(String) }
+      attr_accessor :expires_at
+
+      # A currency amount with its original value and unit.
+      sig { returns(Privy::SparkCurrencyAmount) }
+      attr_reader :l1_broadcast_fee_fast
+
+      sig do
+        params(l1_broadcast_fee_fast: Privy::SparkCurrencyAmount::OrHash).void
+      end
+      attr_writer :l1_broadcast_fee_fast
+
+      # A currency amount with its original value and unit.
+      sig { returns(Privy::SparkCurrencyAmount) }
+      attr_reader :l1_broadcast_fee_medium
+
+      sig do
+        params(l1_broadcast_fee_medium: Privy::SparkCurrencyAmount::OrHash).void
+      end
+      attr_writer :l1_broadcast_fee_medium
+
+      # A currency amount with its original value and unit.
+      sig { returns(Privy::SparkCurrencyAmount) }
+      attr_reader :l1_broadcast_fee_slow
+
+      sig do
+        params(l1_broadcast_fee_slow: Privy::SparkCurrencyAmount::OrHash).void
+      end
+      attr_writer :l1_broadcast_fee_slow
+
+      sig { returns(String) }
+      attr_accessor :network
+
+      # A currency amount with its original value and unit.
+      sig { returns(Privy::SparkCurrencyAmount) }
+      attr_reader :total_amount
+
+      sig { params(total_amount: Privy::SparkCurrencyAmount::OrHash).void }
+      attr_writer :total_amount
+
+      sig { returns(String) }
+      attr_accessor :updated_at
+
+      # A currency amount with its original value and unit.
+      sig { returns(Privy::SparkCurrencyAmount) }
+      attr_reader :user_fee_fast
+
+      sig { params(user_fee_fast: Privy::SparkCurrencyAmount::OrHash).void }
+      attr_writer :user_fee_fast
+
+      # A currency amount with its original value and unit.
+      sig { returns(Privy::SparkCurrencyAmount) }
+      attr_reader :user_fee_medium
+
+      sig { params(user_fee_medium: Privy::SparkCurrencyAmount::OrHash).void }
+      attr_writer :user_fee_medium
+
+      # A currency amount with its original value and unit.
+      sig { returns(Privy::SparkCurrencyAmount) }
+      attr_reader :user_fee_slow
+
+      sig { params(user_fee_slow: Privy::SparkCurrencyAmount::OrHash).void }
+      attr_writer :user_fee_slow
+
+      # A fee quote for a cooperative exit from Spark to Bitcoin L1.
+      sig do
+        params(
+          id: String,
+          created_at: String,
+          expires_at: String,
+          l1_broadcast_fee_fast: Privy::SparkCurrencyAmount::OrHash,
+          l1_broadcast_fee_medium: Privy::SparkCurrencyAmount::OrHash,
+          l1_broadcast_fee_slow: Privy::SparkCurrencyAmount::OrHash,
+          network: String,
+          total_amount: Privy::SparkCurrencyAmount::OrHash,
+          updated_at: String,
+          user_fee_fast: Privy::SparkCurrencyAmount::OrHash,
+          user_fee_medium: Privy::SparkCurrencyAmount::OrHash,
+          user_fee_slow: Privy::SparkCurrencyAmount::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        created_at:,
+        expires_at:,
+        # A currency amount with its original value and unit.
+        l1_broadcast_fee_fast:,
+        # A currency amount with its original value and unit.
+        l1_broadcast_fee_medium:,
+        # A currency amount with its original value and unit.
+        l1_broadcast_fee_slow:,
+        network:,
+        # A currency amount with its original value and unit.
+        total_amount:,
+        updated_at:,
+        # A currency amount with its original value and unit.
+        user_fee_fast:,
+        # A currency amount with its original value and unit.
+        user_fee_medium:,
+        # A currency amount with its original value and unit.
+        user_fee_slow:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: String,
+            expires_at: String,
+            l1_broadcast_fee_fast: Privy::SparkCurrencyAmount,
+            l1_broadcast_fee_medium: Privy::SparkCurrencyAmount,
+            l1_broadcast_fee_slow: Privy::SparkCurrencyAmount,
+            network: String,
+            total_amount: Privy::SparkCurrencyAmount,
+            updated_at: String,
+            user_fee_fast: Privy::SparkCurrencyAmount,
+            user_fee_medium: Privy::SparkCurrencyAmount,
+            user_fee_slow: Privy::SparkCurrencyAmount
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/privy/models/spark_coop_exit_request.rbi

@@ -0,0 +1,114 @@
+# typed: strong
+
+module Privy
+  module Models
+    class SparkCoopExitRequest < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Privy::SparkCoopExitRequest, Privy::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(String) }
+      attr_accessor :coop_exit_txid
+
+      sig { returns(String) }
+      attr_accessor :created_at
+
+      sig { returns(String) }
+      attr_accessor :expires_at
+
+      # A currency amount with its original value and unit.
+      sig { returns(Privy::SparkCurrencyAmount) }
+      attr_reader :fee
+
+      sig { params(fee: Privy::SparkCurrencyAmount::OrHash).void }
+      attr_writer :fee
+
+      # A currency amount with its original value and unit.
+      sig { returns(Privy::SparkCurrencyAmount) }
+      attr_reader :l1_broadcast_fee
+
+      sig { params(l1_broadcast_fee: Privy::SparkCurrencyAmount::OrHash).void }
+      attr_writer :l1_broadcast_fee
+
+      sig { returns(String) }
+      attr_accessor :network
+
+      sig { returns(String) }
+      attr_accessor :status
+
+      sig { returns(String) }
+      attr_accessor :updated_at
+
+      # The exit speed for a cooperative withdrawal from Spark to L1.
+      sig { returns(T.nilable(Privy::SparkExitSpeed::TaggedSymbol)) }
+      attr_reader :exit_speed
+
+      sig { params(exit_speed: Privy::SparkExitSpeed::OrSymbol).void }
+      attr_writer :exit_speed
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :fee_quote_id
+
+      sig { params(fee_quote_id: String).void }
+      attr_writer :fee_quote_id
+
+      # A cooperative exit request from Spark to Bitcoin L1.
+      sig do
+        params(
+          id: String,
+          coop_exit_txid: String,
+          created_at: String,
+          expires_at: String,
+          fee: Privy::SparkCurrencyAmount::OrHash,
+          l1_broadcast_fee: Privy::SparkCurrencyAmount::OrHash,
+          network: String,
+          status: String,
+          updated_at: String,
+          exit_speed: Privy::SparkExitSpeed::OrSymbol,
+          fee_quote_id: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        coop_exit_txid:,
+        created_at:,
+        expires_at:,
+        # A currency amount with its original value and unit.
+        fee:,
+        # A currency amount with its original value and unit.
+        l1_broadcast_fee:,
+        network:,
+        status:,
+        updated_at:,
+        # The exit speed for a cooperative withdrawal from Spark to L1.
+        exit_speed: nil,
+        fee_quote_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            coop_exit_txid: String,
+            created_at: String,
+            expires_at: String,
+            fee: Privy::SparkCurrencyAmount,
+            l1_broadcast_fee: Privy::SparkCurrencyAmount,
+            network: String,
+            status: String,
+            updated_at: String,
+            exit_speed: Privy::SparkExitSpeed::TaggedSymbol,
+            fee_quote_id: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/privy/models/spark_currency_amount.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Privy
+  module Models
+    class SparkCurrencyAmount < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Privy::SparkCurrencyAmount, Privy::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :original_unit
+
+      sig { returns(Float) }
+      attr_accessor :original_value
+
+      # A currency amount with its original value and unit.
+      sig do
+        params(original_unit: String, original_value: Float).returns(
+          T.attached_class
+        )
+      end
+      def self.new(original_unit:, original_value:)
+      end
+
+      sig { override.returns({ original_unit: String, original_value: Float }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/privy/models/spark_exit_speed.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module Privy
+  module Models
+    # The exit speed for a cooperative withdrawal from Spark to L1.
+    module SparkExitSpeed
+      extend Privy::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Privy::SparkExitSpeed) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      FAST = T.let(:FAST, Privy::SparkExitSpeed::TaggedSymbol)
+      MEDIUM = T.let(:MEDIUM, Privy::SparkExitSpeed::TaggedSymbol)
+      SLOW = T.let(:SLOW, Privy::SparkExitSpeed::TaggedSymbol)
+
+      sig { override.returns(T::Array[Privy::SparkExitSpeed::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/privy/models/spark_get_withdrawal_fee_quote_rpc_input.rbi

@@ -0,0 +1,94 @@
+# typed: strong
+
+module Privy
+  module Models
+    class SparkGetWithdrawalFeeQuoteRpcInput < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Privy::SparkGetWithdrawalFeeQuoteRpcInput,
+            Privy::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(Privy::SparkGetWithdrawalFeeQuoteRpcInput::Method::OrSymbol)
+      end
+      attr_accessor :method_
+
+      # Parameters for the Spark `getWithdrawalFeeQuote` RPC.
+      sig { returns(Privy::SparkGetWithdrawalFeeQuoteRpcInputParams) }
+      attr_reader :params
+
+      sig do
+        params(
+          params: Privy::SparkGetWithdrawalFeeQuoteRpcInputParams::OrHash
+        ).void
+      end
+      attr_writer :params
+
+      # The Spark network.
+      sig { returns(T.nilable(Privy::SparkNetwork::OrSymbol)) }
+      attr_reader :network
+
+      sig { params(network: Privy::SparkNetwork::OrSymbol).void }
+      attr_writer :network
+
+      # Gets a fee quote for withdrawing from Spark to a Bitcoin L1 address.
+      sig do
+        params(
+          method_: Privy::SparkGetWithdrawalFeeQuoteRpcInput::Method::OrSymbol,
+          params: Privy::SparkGetWithdrawalFeeQuoteRpcInputParams::OrHash,
+          network: Privy::SparkNetwork::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        method_:,
+        # Parameters for the Spark `getWithdrawalFeeQuote` RPC.
+        params:,
+        # The Spark network.
+        network: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            method_:
+              Privy::SparkGetWithdrawalFeeQuoteRpcInput::Method::OrSymbol,
+            params: Privy::SparkGetWithdrawalFeeQuoteRpcInputParams,
+            network: Privy::SparkNetwork::OrSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Method
+        extend Privy::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Privy::SparkGetWithdrawalFeeQuoteRpcInput::Method)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        GET_WITHDRAWAL_FEE_QUOTE =
+          T.let(
+            :getWithdrawalFeeQuote,
+            Privy::SparkGetWithdrawalFeeQuoteRpcInput::Method::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Privy::SparkGetWithdrawalFeeQuoteRpcInput::Method::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/spark_get_withdrawal_fee_quote_rpc_input_params.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module Privy
+  module Models
+    class SparkGetWithdrawalFeeQuoteRpcInputParams < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Privy::SparkGetWithdrawalFeeQuoteRpcInputParams,
+            Privy::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Float) }
+      attr_accessor :amount_sats
+
+      sig { returns(String) }
+      attr_accessor :onchain_address
+
+      # Parameters for the Spark `getWithdrawalFeeQuote` RPC.
+      sig do
+        params(amount_sats: Float, onchain_address: String).returns(
+          T.attached_class
+        )
+      end
+      def self.new(amount_sats:, onchain_address:)
+      end
+
+      sig { override.returns({ amount_sats: Float, onchain_address: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/privy/models/spark_get_withdrawal_fee_quote_rpc_response.rbi

@@ -0,0 +1,82 @@
+# typed: strong
+
+module Privy
+  module Models
+    class SparkGetWithdrawalFeeQuoteRpcResponse < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Privy::SparkGetWithdrawalFeeQuoteRpcResponse,
+            Privy::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(
+          Privy::SparkGetWithdrawalFeeQuoteRpcResponse::Method::TaggedSymbol
+        )
+      end
+      attr_accessor :method_
+
+      # A fee quote for a cooperative exit from Spark to Bitcoin L1.
+      sig { returns(T.nilable(Privy::SparkCoopExitFeeQuote)) }
+      attr_reader :data
+
+      sig { params(data: Privy::SparkCoopExitFeeQuote::OrHash).void }
+      attr_writer :data
+
+      # Response to the Spark `getWithdrawalFeeQuote` RPC.
+      sig do
+        params(
+          method_:
+            Privy::SparkGetWithdrawalFeeQuoteRpcResponse::Method::OrSymbol,
+          data: Privy::SparkCoopExitFeeQuote::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        method_:,
+        # A fee quote for a cooperative exit from Spark to Bitcoin L1.
+        data: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            method_:
+              Privy::SparkGetWithdrawalFeeQuoteRpcResponse::Method::TaggedSymbol,
+            data: Privy::SparkCoopExitFeeQuote
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Method
+        extend Privy::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Privy::SparkGetWithdrawalFeeQuoteRpcResponse::Method)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        GET_WITHDRAWAL_FEE_QUOTE =
+          T.let(
+            :getWithdrawalFeeQuote,
+            Privy::SparkGetWithdrawalFeeQuoteRpcResponse::Method::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Privy::SparkGetWithdrawalFeeQuoteRpcResponse::Method::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/spark_rpc_input.rbi

@@ -17,7 +17,9 @@ module Privy
             Privy::SparkClaimStaticDepositRpcInput,
             Privy::SparkCreateLightningInvoiceRpcInput,
             Privy::SparkPayLightningInvoiceRpcInput,
-            Privy::SparkSignMessageWithIdentityKeyRpcInput
+            Privy::SparkSignMessageWithIdentityKeyRpcInput,
+            Privy::SparkWithdrawRpcInput,
+            Privy::SparkGetWithdrawalFeeQuoteRpcInput
           )
         end
 

data/rbi/privy/models/spark_rpc_response.rbi

@@ -17,7 +17,9 @@ module Privy
             Privy::SparkClaimStaticDepositRpcResponse,
             Privy::SparkCreateLightningInvoiceRpcResponse,
             Privy::SparkPayLightningInvoiceRpcResponse,
-            Privy::SparkSignMessageWithIdentityKeyRpcResponse
+            Privy::SparkSignMessageWithIdentityKeyRpcResponse,
+            Privy::SparkWithdrawRpcResponse,
+            Privy::SparkGetWithdrawalFeeQuoteRpcResponse
           )
         end
 

data/rbi/privy/models/spark_withdraw_rpc_input.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module Privy
+  module Models
+    class SparkWithdrawRpcInput < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Privy::SparkWithdrawRpcInput, Privy::Internal::AnyHash)
+        end
+
+      sig { returns(Privy::SparkWithdrawRpcInput::Method::OrSymbol) }
+      attr_accessor :method_
+
+      # Parameters for the Spark `withdraw` RPC.
+      sig { returns(Privy::SparkWithdrawRpcInputParams) }
+      attr_reader :params
+
+      sig { params(params: Privy::SparkWithdrawRpcInputParams::OrHash).void }
+      attr_writer :params
+
+      # The Spark network.
+      sig { returns(T.nilable(Privy::SparkNetwork::OrSymbol)) }
+      attr_reader :network
+
+      sig { params(network: Privy::SparkNetwork::OrSymbol).void }
+      attr_writer :network
+
+      # Withdraws from Spark to a Bitcoin L1 address (cooperative exit).
+      sig do
+        params(
+          method_: Privy::SparkWithdrawRpcInput::Method::OrSymbol,
+          params: Privy::SparkWithdrawRpcInputParams::OrHash,
+          network: Privy::SparkNetwork::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        method_:,
+        # Parameters for the Spark `withdraw` RPC.
+        params:,
+        # The Spark network.
+        network: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            method_: Privy::SparkWithdrawRpcInput::Method::OrSymbol,
+            params: Privy::SparkWithdrawRpcInputParams,
+            network: Privy::SparkNetwork::OrSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Method
+        extend Privy::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Privy::SparkWithdrawRpcInput::Method) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        WITHDRAW =
+          T.let(:withdraw, Privy::SparkWithdrawRpcInput::Method::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Privy::SparkWithdrawRpcInput::Method::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/spark_withdraw_rpc_input_params.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module Privy
+  module Models
+    class SparkWithdrawRpcInputParams < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Privy::SparkWithdrawRpcInputParams, Privy::Internal::AnyHash)
+        end
+
+      # The exit speed for a cooperative withdrawal from Spark to L1.
+      sig { returns(Privy::SparkExitSpeed::OrSymbol) }
+      attr_accessor :exit_speed
+
+      sig { returns(String) }
+      attr_accessor :onchain_address
+
+      sig { returns(T.nilable(Float)) }
+      attr_reader :amount_sats
+
+      sig { params(amount_sats: Float).void }
+      attr_writer :amount_sats
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :deduct_fee_from_withdrawal_amount
+
+      sig { params(deduct_fee_from_withdrawal_amount: T::Boolean).void }
+      attr_writer :deduct_fee_from_withdrawal_amount
+
+      sig { returns(T.nilable(Float)) }
+      attr_reader :fee_amount_sats
+
+      sig { params(fee_amount_sats: Float).void }
+      attr_writer :fee_amount_sats
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :fee_quote_id
+
+      sig { params(fee_quote_id: String).void }
+      attr_writer :fee_quote_id
+
+      # Parameters for the Spark `withdraw` RPC.
+      sig do
+        params(
+          exit_speed: Privy::SparkExitSpeed::OrSymbol,
+          onchain_address: String,
+          amount_sats: Float,
+          deduct_fee_from_withdrawal_amount: T::Boolean,
+          fee_amount_sats: Float,
+          fee_quote_id: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The exit speed for a cooperative withdrawal from Spark to L1.
+        exit_speed:,
+        onchain_address:,
+        amount_sats: nil,
+        deduct_fee_from_withdrawal_amount: nil,
+        fee_amount_sats: nil,
+        fee_quote_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            exit_speed: Privy::SparkExitSpeed::OrSymbol,
+            onchain_address: String,
+            amount_sats: Float,
+            deduct_fee_from_withdrawal_amount: T::Boolean,
+            fee_amount_sats: Float,
+            fee_quote_id: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end