Class WalletService

Hierarchy

WalletService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WalletService(walletUrl?: string): WalletService

- Defined in src/services/wallet-service.ts:45
Parameters
- Optional walletUrl: string
Returns WalletService

Properties

Private boundMessageListener

boundMessageListener: MessageListener

Private eventListeners

eventListeners: {} = {}

Type declaration

[key: string]: (state: WalletState & { message: WindowMessage }) => void
- - (state: WalletState & { message: WindowMessage }): void
  - Parameters
    - state: WalletState & { message: WindowMessage }
    Returns void

Private messageListener

messageListener: MessageListener

Private setWalletState

setWalletState: undefined | SetWalletState = ...

state

state: WalletState = ...

Private walletUrl

walletUrl: undefined | string

Private walletWindow

walletWindow: null | Window = null

Methods

addEventListener

addEventListener(event: WINDOW_MESSAGES, cb: (state: Required<ConnectedMessageData> & { walletOpen: boolean; walletWindowActive: boolean } & { message: WindowMessage }) => void): void

- Defined in src/services/wallet-service.ts:93
Parameters
- event: WINDOW_MESSAGES
- cb: (state: Required<ConnectedMessageData> & { walletOpen: boolean; walletWindowActive: boolean } & { message: WindowMessage }) => void
  - - (state: Required<ConnectedMessageData> & { walletOpen: boolean; walletWindowActive: boolean } & { message: WindowMessage }): void
    - Parameters
      - state: Required<ConnectedMessageData> & { walletOpen: boolean; walletWindowActive: boolean } & { message: WindowMessage }
      Returns void
Returns void

Private closeWindow

closeWindow(): void

- Defined in src/services/wallet-service.ts:80
Returns void

connect

connect(): void

- Defined in src/services/wallet-service.ts:116
Returns void

disconnect

disconnect(): void

- Defined in src/services/wallet-service.ts:149
Returns void

initialize

initialize(state: ConnectedMessageData): void

- Defined in src/services/wallet-service.ts:135
Initialize the wallet with the parameters returned from connect

remarks

Make sure a WalletService instance has been created via useWalletService or the constructor.

Parameters
- state: ConnectedMessageData
Returns void

Private openWallet

openWallet(url: string, payload?: string | Uint8Array): void

- Defined in src/services/wallet-service.ts:207
Parameters
- url: string
- Optional payload: string | Uint8Array
Returns void

Private pollForOpenWindow

pollForOpenWindow(): void

- Defined in src/services/wallet-service.ts:242
Returns void

removeAllEventListeners

removeAllEventListeners(): void

- Defined in src/services/wallet-service.ts:101
Returns void

removeEventListener

removeEventListener(event: WINDOW_MESSAGES): void

- Defined in src/services/wallet-service.ts:97
Parameters
- event: WINDOW_MESSAGES
Returns void

setStateUpdater

setStateUpdater(setWalletState: SetWalletState): void

- Defined in src/services/wallet-service.ts:112
Parameters
- setWalletState: SetWalletState
Returns void

setWalletUrl

setWalletUrl(url: string): void

- Defined in src/services/wallet-service.ts:89
Parameters
- url: string
Returns void

sign

sign(__namedParameters: Omit<SignQueryParams, keyof MessageParams>): void

- Defined in src/services/wallet-service.ts:194
Send a payload to the wallet to be signed

remarks

Requires wallet to be initialized via connect or initialize After signing, the signed payload can be accessed by subscribing to the WINDOW_MESSAGES.SIGNATURE_COMPLETE event via addEventListener

Parameters
- __namedParameters: Omit<SignQueryParams, keyof MessageParams>
Returns void

transaction

transaction(__namedParameters: TransactionParams): void

- Defined in src/services/wallet-service.ts:170
Initiate a transaction, submitting any message to be signed. Message needs to be a base64 string. Use MessageService.buildMessage to build message. Use MessageService.createAnyMessageBase64 to turn message in a base64 string that is ready to be consumed here.

remarks

Requires wallet to be initialized via connect or initialize After signing, the signed payload can be accessed by subscribing to the WINDOW_MESSAGES.TRANSACTION_COMPLETE event via addEventListener

remarks

Custom Gas Price and Denom can be used when passing gasPrice and denom in the object to transaction (both values are required or the default price and denom will be used)

Parameters
- __namedParameters: TransactionParams
Returns void

updateState

updateState(): void

- Defined in src/services/wallet-service.ts:105
Returns void

Generated using TypeDoc