Developer Portal

Appearance

module : sdk.payment_strategies.prepaid_payment_strategy ​

Link to GitHub

Entities: ​

  1. PrePaidPaymentStrategy

Class PrePaidPaymentStrategy ​

extends: PaymentStrategy

is extended by: -

description ​

The PrePaidPaymentStrategy class is a concrete implementation of the PaymentStrategy interface. The prepaid payment strategy is similar to the paid call strategy, but allows you to pay for several calls at once and then make them.

attributes ​

  • concurrency_manager: The ConcurrencyManager instance.
  • block_offset (int): Block offset.
  • call_allowance (int): The amount of allowed calls.

methods ​

__init__ ​

Initializes a new instance of the class.

args: ​
  • concurrency_manager: The ConcurrencyManager instance.
  • block_offset (int): Block offset.
  • call_allowance (int): The amount of allowed calls. Defaults to 1.
returns: ​
  • None

get_price ​

Returns the price of the service calls using service client.

args: ​
  • service_client (ServiceClient): The service client object.
returns: ​
  • The price of the service call. (int)

get_payment_metadata ​

Creates and returns the payment metadata for a service client with the field snet-payment-type equals to prepaid-call.

args: ​
  • service_client (ServiceClient): The service client object.
  • channel (PaymentChannel): The payment channel to make service call.
returns: ​
  • The payment metadata. (list[tuple[str, Any]])

get_concurrency_token_and_channel ​

Retrieves the concurrency token and channel from the payment strategy.

args: ​
  • service_client (ServiceClient): The service client object.
returns: ​
  • The concurrency token and channel. (tuple[str, PaymentChannel])

select_channel ​

Retrieves the suitable payment channel from the MPE. Opens the channel, extends expiration and adds funds if it is necessary.

args: ​
  • service_client (ServiceClient): The service client object.
returns: ​
  • The payment channel for the service calling. (PaymentChannel)

static _has_sufficient_funds ​

Checks whether the payment channel has the required amount of funds.

args: ​
  • channel (PaymentChannel): The payment channel to check.
  • amount (int): The amount of funds in cogs to check.
returns: ​
  • True if the channel has enough funds, False otherwise. (bool)

static _is_valid ​

Checks if the payment channel expires later than it should.

args: ​
  • channel (PaymentChannel): The payment channel to check.
  • expiry (int): The expiration time in blocks to check.
returns: ​
  • True if the channel has enough expiration, False otherwise. (bool)