smartypay-client-subscriptions-react

Index

Interfaces

Type Aliases

Variables

Type Aliases

SmartyPaySubscriptionsBrowserEvent

SmartyPaySubscriptionsBrowserEvent: wallet.WalletApiEvent | "subscription-updating" | "subscription-updated"

SubscriptionsEvent

SubscriptionsEvent: util.Event

SubscriptionsEventListener

SubscriptionsEventListener: ((event: SubscriptionsEvent) => void)

Type declaration

- (event: SubscriptionsEvent): void
- Parameters
  - event: SubscriptionsEvent
  Returns void

Variables

Const TokenMaxAbsoluteAmount

TokenMaxAbsoluteAmount: "0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" = "0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"

Const TokenZeroAmount

TokenZeroAmount: "0x0" = "0x0"

Functions

activateSubscriptionInWallet

activateSubscriptionInWallet(subscriptionGetter: (() => Promise<undefined | Subscription>), props?: ActivateSubscriptionInWalletProps): Promise<void>

- Defined in src/index.tsx:95
Parameters
- subscriptionGetter: (() => Promise<undefined | Subscription>)
  - - (): Promise<undefined | Subscription>
    - Returns Promise<undefined | Subscription>
- Optional props: ActivateSubscriptionInWalletProps
Returns Promise<void>

addSubscriptionsGlobalListener

addSubscriptionsGlobalListener(listener: SubscriptionsEventListener): void

- Defined in src/index.tsx:83
Parameters
- listener: SubscriptionsEventListener
Returns void

addSubscriptionsListener

addSubscriptionsListener(event: SmartyPaySubscriptionsBrowserEvent, listener: SubscriptionsEventListener): void

- Defined in src/index.tsx:79
Parameters
- event: SmartyPaySubscriptionsBrowserEvent
- listener: SubscriptionsEventListener
Returns void

cancelSubscriptionInWallet

cancelSubscriptionInWallet(subscriptionGetter: (() => Promise<undefined | Subscription>)): Promise<void>

- Defined in src/index.tsx:118
Parameters
- subscriptionGetter: (() => Promise<undefined | Subscription>)
  - - (): Promise<undefined | Subscription>
    - Returns Promise<undefined | Subscription>
Returns Promise<void>

changeSubscriptionAllowanceInWallet

changeSubscriptionAllowanceInWallet(subscriptionGetter: (() => Promise<undefined | Subscription>), props?: ChangeSubscriptionAllowanceInWalletProps): Promise<void>

- Defined in src/index.tsx:103
Parameters
- subscriptionGetter: (() => Promise<undefined | Subscription>)
  - - (): Promise<undefined | Subscription>
    - Returns Promise<undefined | Subscription>
- Optional props: ChangeSubscriptionAllowanceInWalletProps
Returns Promise<void>

getAmountWithTokenLabel

getAmountWithTokenLabel(amountWithToken: string): string

- Defined in node_modules/smartypay-client-model/dist/tsc/model/tokens.d.ts:11
Parameters
- amountWithToken: string
Returns string

getTokenByCurrency

getTokenByCurrency(currency: any): Token

- Defined in node_modules/smartypay-client-model/dist/tsc/model/tokens.d.ts:10
Parameters
- currency: any
Returns Token

isEndingSubscription

isEndingSubscription(subscription: undefined | Subscription): boolean

- Defined in node_modules/smartypay-client-subscriptions/dist/tsc/index.d.ts:46
Parameters
- subscription: undefined | Subscription
Returns boolean

isValidBalanceToPay

isValidBalanceToPay(subscription: Subscription): Promise<boolean>

- Defined in src/index.tsx:91
Parameters
- subscription: Subscription
Returns Promise<boolean>

pauseSubscriptionInWallet

pauseSubscriptionInWallet(subscriptionGetter: (() => Promise<undefined | Subscription>)): Promise<void>

- Defined in src/index.tsx:110
Parameters
- subscriptionGetter: (() => Promise<undefined | Subscription>)
  - - (): Promise<undefined | Subscription>
    - Returns Promise<undefined | Subscription>
Returns Promise<void>

removeSubscriptionsListener

removeSubscriptionsListener(listener: SubscriptionsEventListener): void

- Defined in src/index.tsx:87
Parameters
- listener: SubscriptionsEventListener
Returns void

restoreOldWalletConnectionFromAny

restoreOldWalletConnectionFromAny(...providers: Web3ApiProvider[]): Promise<boolean>

- Defined in node_modules/smartypay-client-subscriptions/dist/tsc/index.d.ts:45
Parameters
- Rest ...providers: Web3ApiProvider[]
Returns Promise<boolean>

unPauseSubscriptionInWallet

unPauseSubscriptionInWallet(subscriptionGetter: (() => Promise<undefined | Subscription>)): Promise<void>

- Defined in src/index.tsx:114
Parameters
- subscriptionGetter: (() => Promise<undefined | Subscription>)
  - - (): Promise<undefined | Subscription>
    - Returns Promise<undefined | Subscription>
Returns Promise<void>

useAddCurrencyTokenToWalletCallback

useAddCurrencyTokenToWalletCallback(currency: "UNKNOWN" | "bBUSD" | "bUSDT" | "btMNXe" | "btUSDTv2" | "btBUSD" | "pUSDC" | "pUSDT" | "pmUSDC" | "pmUSDT" | "aUSDC" | "aUSDT" | "asUSDC" | "asUSDT" | "USDT" | "USDC" | "DAI" | "sUSDT" | "sUSDC"): (() => void)

- Defined in src/hooks/callback/useAddCurrencyTokenToWalletCallback.ts:11
Parameters
- currency: "UNKNOWN" | "bBUSD" | "bUSDT" | "btMNXe" | "btUSDTv2" | "btBUSD" | "pUSDC" | "pUSDT" | "pmUSDC" | "pmUSDT" | "aUSDC" | "aUSDT" | "asUSDC" | "asUSDT" | "USDT" | "USDC" | "DAI" | "sUSDT" | "sUSDC"
Returns (() => void)
- - (): void
  - Returns void

useAddTokenToWalletCallback

useAddTokenToWalletCallback(token: Token): (() => void)

- Defined in src/hooks/callback/useAddTokenToWalletCallback.ts:11
Parameters
- token: Token
Returns (() => void)
- - (): void
  - Returns void

useConnectToWalletCallback

useConnectToWalletCallback(provider: Web3ApiProvider): (() => void)

- Defined in src/hooks/callback/useConnectToWalletCallback.ts:11
Parameters
- provider: Web3ApiProvider
Returns (() => void)
- - (): void
  - Returns void

useDisconnectFromWalletCallback

useDisconnectFromWalletCallback(): (() => void)

- Defined in src/hooks/callback/useDisconnectFromWalletCallback.ts:10
Returns (() => void)
- - (): void
  - Returns void

useOldConnectedWallet

useOldConnectedWallet(): string

- Defined in src/hooks/useOldConnectedWallet.ts:10
Returns string

useSmartyApiLastError

useSmartyApiLastError(): any

- Defined in src/hooks/useSmartyApiLastError.ts:10
Returns any

useSmartyApiLocked

useSmartyApiLocked(): boolean

- Defined in src/hooks/useSmartyApiLocked.ts:10
Returns boolean

useSwitchWalletToAssetNetworkCallback

useSwitchWalletToAssetNetworkCallback(token: Token): (() => void)

- Defined in src/hooks/callback/useSwitchWalletToAssetNetworkCallback.ts:11
Parameters
- token: Token
Returns (() => void)
- - (): void
  - Returns void

useSwitchWalletToNetworkCallback

useSwitchWalletToNetworkCallback(network: Network): (() => void)

- Defined in src/hooks/callback/useSwitchWalletToNetworkCallback.ts:11
Parameters
- network: Network
Returns (() => void)
- - (): void
  - Returns void

useUpdatingSubscriptions

useUpdatingSubscriptions(): string[]

- Defined in src/hooks/useUpdatingSubscriptions.ts:10
Returns string[]

useUpdatingSubscriptionsPlans

useUpdatingSubscriptionsPlans(): string[]

- Defined in src/hooks/useUpdatingSubscriptionsPlans.ts:10
Returns string[]

useWalletAddress

useWalletAddress(): undefined | string

- Defined in src/hooks/useWalletAddress.ts:11
Returns undefined | string

useWalletChainId

useWalletChainId(): undefined | number

- Defined in src/hooks/useWalletChainId.ts:11
Returns undefined | number

useWalletConnected

useWalletConnected(): boolean

- Defined in src/hooks/useWalletConnected.ts:10
Returns boolean

useWalletConnecting

useWalletConnecting(): boolean

- Defined in src/hooks/useWalletConnecting.ts:10
Returns boolean

useWalletName

useWalletName(): undefined | string

- Defined in src/hooks/useWalletName.ts:10
Returns undefined | string

Index

Interfaces

Type Aliases

Variables

Functions

Type Aliases

SmartyPaySubscriptionsBrowserEvent

SubscriptionsEvent

SubscriptionsEventListener

Type declaration

Parameters

event: SubscriptionsEvent

Returns void

Variables

Const TokenMaxAbsoluteAmount

Const TokenZeroAmount

Functions

activateSubscriptionInWallet

Parameters

subscriptionGetter: (() => Promise<undefined | Subscription>)

Returns Promise<undefined | Subscription>

Optional props: ActivateSubscriptionInWalletProps

Returns Promise<void>

addSubscriptionsGlobalListener

Parameters

listener: SubscriptionsEventListener

Returns void

addSubscriptionsListener

Parameters

event: SmartyPaySubscriptionsBrowserEvent

listener: SubscriptionsEventListener

Returns void

cancelSubscriptionInWallet

Parameters

subscriptionGetter: (() => Promise<undefined | Subscription>)

Returns Promise<undefined | Subscription>

Returns Promise<void>

changeSubscriptionAllowanceInWallet

Parameters

subscriptionGetter: (() => Promise<undefined | Subscription>)

Returns Promise<undefined | Subscription>

Optional props: ChangeSubscriptionAllowanceInWalletProps

Returns Promise<void>

getAmountWithTokenLabel

Parameters

amountWithToken: string

Returns string

getTokenByCurrency

Parameters

currency: any

Returns Token

isEndingSubscription

Parameters

subscription: undefined | Subscription

Returns boolean

isValidBalanceToPay

Parameters

subscription: Subscription

Returns Promise<boolean>

pauseSubscriptionInWallet

Parameters

subscriptionGetter: (() => Promise<undefined | Subscription>)

Returns Promise<undefined | Subscription>

Returns Promise<void>

removeSubscriptionsListener

Parameters

listener: SubscriptionsEventListener

Returns void

restoreOldWalletConnectionFromAny

Parameters

Rest ...providers: Web3ApiProvider[]

Returns Promise<boolean>

unPauseSubscriptionInWallet

Parameters

subscriptionGetter: (() => Promise<undefined | Subscription>)

Returns Promise<undefined | Subscription>

Returns Promise<void>

useAddCurrencyTokenToWalletCallback

Parameters

currency: "UNKNOWN" | "bBUSD" | "bUSDT" | "btMNXe" | "btUSDTv2" | "btBUSD" | "pUSDC" | "pUSDT" | "pmUSDC" | "pmUSDT" | "aUSDC" | "aUSDT" | "asUSDC" | "asUSDT" | "USDT" | "USDC" | "DAI" | "sUSDT" | "sUSDC"