Class: Privy::Models::WalletActionEarnDepositCreatedWebhookPayload

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/privy/models/wallet_action_earn_deposit_created_webhook_payload.rb

Defined Under Namespace

Modules: Status, Type

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(action_type:, asset_address:, caip2:, raw_amount:, status:, type:, vault_address:, vault_id:, wallet_action_id:, wallet_id:, amount: nil, asset: nil, decimals: nil) ⇒ Object

Some parameter documentations has been truncated, see Privy::Models::WalletActionEarnDepositCreatedWebhookPayload for more details.

Payload for the wallet_action.earn_deposit.created webhook event.

Parameters:

  • action_type (Symbol, Privy::Models::WalletActionType) —

    Type of wallet action

  • asset_address (String) —

    Underlying asset token address.

  • caip2 (String) —

    CAIP-2 chain identifier.

  • raw_amount (String) —

    Base-unit amount of asset deposited (e.g. “1500000”).

  • status (Symbol, Privy::Models::WalletActionEarnDepositCreatedWebhookPayload::Status) —

    The status of the wallet action.

  • type (Symbol, Privy::Models::WalletActionEarnDepositCreatedWebhookPayload::Type) —

    The type of webhook event.

  • vault_address (String) —

    ERC-4626 vault contract address.

  • vault_id (String) —

    The vault ID.

  • wallet_action_id (String) —

    The ID of the wallet action.

  • wallet_id (String) —

    The ID of the wallet involved in the action.

  • amount (String) (defaults to: nil) —

    Human-readable decimal amount of asset deposited (e.g. “1.5”). Only present when

  • asset (String) (defaults to: nil) —

    Asset identifier (e.g. “usdc”, “eth”). Only present when the token is known in t

  • decimals (Integer) (defaults to: nil) —

    Number of decimals for the underlying asset (e.g. 6 for USDC, 18 for ETH). Only




# File 'lib/privy/models/wallet_action_earn_deposit_created_webhook_payload.rb', line 87

Instance Attribute Details

#action_type ⇒ Symbol, Privy::Models::WalletActionType

Type of wallet action

Returns:



10
 
# File 'lib/privy/models/wallet_action_earn_deposit_created_webhook_payload.rb', line 10

required :action_type, enum: -> { Privy::WalletActionType }

#amount ⇒ String?

Human-readable decimal amount of asset deposited (e.g. “1.5”). Only present when the token is known in the asset registry.

Returns:

  • (String, nil) 


71
 
# File 'lib/privy/models/wallet_action_earn_deposit_created_webhook_payload.rb', line 71

optional :amount, String

#asset ⇒ String?

Asset identifier (e.g. “usdc”, “eth”). Only present when the token is known in the asset registry.

Returns:

  • (String, nil) 


78
 
# File 'lib/privy/models/wallet_action_earn_deposit_created_webhook_payload.rb', line 78

optional :asset, String

#asset_address ⇒ String

Underlying asset token address.

Returns:

  • (String) 


16
 
# File 'lib/privy/models/wallet_action_earn_deposit_created_webhook_payload.rb', line 16

required :asset_address, String

#caip2 ⇒ String

CAIP-2 chain identifier.

Returns:

  • (String) 


22
 
# File 'lib/privy/models/wallet_action_earn_deposit_created_webhook_payload.rb', line 22

required :caip2, String

#decimals ⇒ Integer?

Number of decimals for the underlying asset (e.g. 6 for USDC, 18 for ETH). Only present when the token is known in the asset registry.

Returns:

  • (Integer, nil) 


85
 
# File 'lib/privy/models/wallet_action_earn_deposit_created_webhook_payload.rb', line 85

optional :decimals, Integer

#raw_amount ⇒ String

Base-unit amount of asset deposited (e.g. “1500000”).

Returns:

  • (String) 


28
 
# File 'lib/privy/models/wallet_action_earn_deposit_created_webhook_payload.rb', line 28

required :raw_amount, String

#status ⇒ Symbol, Privy::Models::WalletActionEarnDepositCreatedWebhookPayload::Status

The status of the wallet action.

Returns:



34
 
# File 'lib/privy/models/wallet_action_earn_deposit_created_webhook_payload.rb', line 34

required :status, enum: -> { Privy::WalletActionEarnDepositCreatedWebhookPayload::Status }

#type ⇒ Symbol, Privy::Models::WalletActionEarnDepositCreatedWebhookPayload::Type

The type of webhook event.

Returns:



40
 
# File 'lib/privy/models/wallet_action_earn_deposit_created_webhook_payload.rb', line 40

required :type, enum: -> { Privy::WalletActionEarnDepositCreatedWebhookPayload::Type }

#vault_address ⇒ String

ERC-4626 vault contract address.

Returns:

  • (String) 


46
 
# File 'lib/privy/models/wallet_action_earn_deposit_created_webhook_payload.rb', line 46

required :vault_address, String

#vault_id ⇒ String

The vault ID.

Returns:

  • (String) 


52
 
# File 'lib/privy/models/wallet_action_earn_deposit_created_webhook_payload.rb', line 52

required :vault_id, String

#wallet_action_id ⇒ String

The ID of the wallet action.

Returns:

  • (String) 


58
 
# File 'lib/privy/models/wallet_action_earn_deposit_created_webhook_payload.rb', line 58

required :wallet_action_id, String

#wallet_id ⇒ String

The ID of the wallet involved in the action.

Returns:

  • (String) 


64
 
# File 'lib/privy/models/wallet_action_earn_deposit_created_webhook_payload.rb', line 64

required :wallet_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/privy/models/wallet_action_earn_deposit_created_webhook_payload.rb', line 127