Class HederaWeb3Wallet

Hierarchy

  • Web3Wallet
    • HederaWeb3Wallet

Implements

Constructors

constructor

Properties

approveSession chains core disconnectSession emitSessionEvent engine events extendSession formatMessage getActiveSessions getPendingAuthRequests getPendingSessionProposals getPendingSessionRequests logger metadata methods name off on once opts pair rejectSession removeListener respondAuthRequest respondSessionRequest sessionEvents updateSession

Methods

buildAndApproveSession executeSessionRequest getHederaWallet hedera_executeTransaction hedera_getNodeAddresses hedera_signAndExecuteQuery hedera_signAndExecuteTransaction hedera_signMessage hedera_signTransaction parseSessionRequest rejectSessionRequest validateParam create init

Constructors

constructor

Properties

approveSession

approveSession: ((params) => Promise<Struct>)

Type declaration

    • (params): Promise<Struct>

    • Parameters

      • params: {
            id: number;
            namespaces: Record<string, BaseNamespace>;
            relayProtocol?: string;
        }
        • id: number
        • namespaces: Record<string, BaseNamespace>
        • Optional relayProtocol?: string

      Returns Promise<Struct>

chains

chains: string[] | HederaChainId[] = ...

core

core: ICore

disconnectSession

disconnectSession: ((params) => Promise<void>)

Type declaration

    • (params): Promise<void>

    • Parameters

      • params: {
            reason: ErrorResponse;
            topic: string;
        }
        • reason: ErrorResponse
        • topic: string

      Returns Promise<void>

emitSessionEvent

emitSessionEvent: ((params) => Promise<void>)

Type declaration

    • (params): Promise<void>

    • Parameters

      • params: {
            chainId: string;
            event: any;
            topic: string;
        }
        • chainId: string
        • event: any
        • topic: string

      Returns Promise<void>

engine

engine: IWeb3WalletEngine

events

events: EventEmitter

extendSession

extendSession: ((params) => Promise<void>)

Type declaration

    • (params): Promise<void>

    • Parameters

      • params: {
            topic: string;
        }
        • topic: string

      Returns Promise<void>

formatMessage

formatMessage: ((payload, iss) => string)

Type declaration

    • (payload, iss): string

    • Parameters

      • payload: CacaoRequestPayload
      • iss: string

      Returns string

getActiveSessions

getActiveSessions: (() => Record<string, Struct>)

Type declaration

    • (): Record<string, Struct>

    • Returns Record<string, Struct>

getPendingAuthRequests

getPendingAuthRequests: (() => Record<number, PendingRequest>)

Type declaration

    • (): Record<number, PendingRequest>

    • Returns Record<number, PendingRequest>

getPendingSessionProposals

getPendingSessionProposals: (() => Record<number, Struct>)

Type declaration

    • (): Record<number, Struct>

    • Returns Record<number, Struct>

getPendingSessionRequests

getPendingSessionRequests: (() => Struct[])

Type declaration

    • (): Struct[]

    • Returns Struct[]

logger

logger: Logger

metadata

metadata: Metadata

methods

methods: string[] = ...

name

name: string

off

off: (<E>(event, listener) => EventEmitter)

Type declaration

    • <E>(event, listener): EventEmitter

    • Type Parameters

      • E extends Event

      Parameters

      • event: E
      • listener: ((args) => void)
          • (args): void

          • Parameters

            • args: EventArguments[E]

            Returns void

      Returns EventEmitter

on

on: (<E>(event, listener) => EventEmitter)

Type declaration

    • <E>(event, listener): EventEmitter

    • Type Parameters

      • E extends Event

      Parameters

      • event: E
      • listener: ((args) => void)
          • (args): void

          • Parameters

            • args: EventArguments[E]

            Returns void

      Returns EventEmitter

once

once: (<E>(event, listener) => EventEmitter)

Type declaration

    • <E>(event, listener): EventEmitter

    • Type Parameters

      • E extends Event

      Parameters

      • event: E
      • listener: ((args) => void)
          • (args): void

          • Parameters

            • args: EventArguments[E]

            Returns void

      Returns EventEmitter

opts

opts: Options

pair

pair: ((params) => Promise<void>)

Type declaration

    • (params): Promise<void>

    • Parameters

      • params: {
            activatePairing?: boolean;
            uri: string;
        }
        • Optional activatePairing?: boolean
        • uri: string

      Returns Promise<void>

rejectSession

rejectSession: ((params) => Promise<void>)

Type declaration

    • (params): Promise<void>

    • Parameters

      • params: {
            id: number;
            reason: ErrorResponse;
        }
        • id: number
        • reason: ErrorResponse

      Returns Promise<void>

removeListener

removeListener: (<E>(event, listener) => EventEmitter)

Type declaration

    • <E>(event, listener): EventEmitter

    • Type Parameters

      • E extends Event

      Parameters

      • event: E
      • listener: ((args) => void)
          • (args): void

          • Parameters

            • args: EventArguments[E]

            Returns void

      Returns EventEmitter

respondAuthRequest

respondAuthRequest: ((params, iss) => Promise<void>)

Type declaration

    • (params, iss): Promise<void>

    • Parameters

      • params: RespondParams
      • iss: string

      Returns Promise<void>

respondSessionRequest

respondSessionRequest: ((params) => Promise<void>)

Type declaration

    • (params): Promise<void>

    • Parameters

      • params: {
            response: JsonRpcResponse;
            topic: string;
        }
        • response: JsonRpcResponse
        • topic: string

      Returns Promise<void>

sessionEvents

sessionEvents: string[] | HederaSessionEvent[] = ...

updateSession

updateSession: ((params) => Promise<void>)

Type declaration

    • (params): Promise<void>

    • Parameters

      • params: {
            namespaces: Namespaces;
            topic: string;
        }
        • namespaces: Namespaces
        • topic: string

      Returns Promise<void>

Methods

buildAndApproveSession

  • buildAndApproveSession(accounts, __namedParameters): Promise<Struct>

  • Parameters

    • accounts: string[]
    • __namedParameters: SessionProposal

    Returns Promise<Struct>

executeSessionRequest

  • executeSessionRequest(event, hederaWallet): Promise<void>

  • Parameters

    • event: SessionRequest
    • hederaWallet: default

    Returns Promise<void>

getHederaWallet

  • getHederaWallet(chainId, accountId, privateKey, _provider?): default

  • Parameters

    Returns default

hedera_executeTransaction

  • hedera_executeTransaction(id, topic, body, signer): Promise<void>

  • Parameters

    • id: number
    • topic: string
    • body: default
    • signer: default

    Returns Promise<void>

hedera_getNodeAddresses

  • hedera_getNodeAddresses(id, topic, _, signer): Promise<void>

  • Parameters

    • id: number
    • topic: string
    • _: any
    • signer: default

    Returns Promise<void>

hedera_signAndExecuteQuery

  • hedera_signAndExecuteQuery(id, topic, body, signer): Promise<void>

  • Parameters

    • id: number
    • topic: string
    • body: default<any>
    • signer: default

    Returns Promise<void>

hedera_signAndExecuteTransaction

  • hedera_signAndExecuteTransaction(id, topic, body, signer): Promise<void>

  • Parameters

    • id: number
    • topic: string
    • body: default
    • signer: default

    Returns Promise<void>

hedera_signMessage

  • hedera_signMessage(id, topic, body, signer): Promise<void>

  • Parameters

    • id: number
    • topic: string
    • body: string
    • signer: default

    Returns Promise<void>

hedera_signTransaction

  • hedera_signTransaction(id, topic, body, signer): Promise<void>

  • Parameters

    • id: number
    • topic: string
    • body: Uint8Array
    • signer: default

    Returns Promise<void>

parseSessionRequest

  • parseSessionRequest(event, shouldThrow?): {
        accountId?: default;
        body?: string | default | Uint8Array | default<any>;
        chainId: HederaChainId;
        id: number;
        method: HederaJsonRpcMethod;
        topic: string;
    }

  • Parameters

    • event: SessionRequest
    • shouldThrow: boolean = true

    Returns {
        accountId?: default;
        body?: string | default | Uint8Array | default<any>;
        chainId: HederaChainId;
        id: number;
        method: HederaJsonRpcMethod;
        topic: string;
    }

    • Optional accountId?: default
    • Optional body?: string | default | Uint8Array | default<any>
    • chainId: HederaChainId
    • id: number
    • method: HederaJsonRpcMethod
    • topic: string

rejectSessionRequest

  • rejectSessionRequest(event, error): Promise<void>

  • Parameters

    • event: SessionRequest
    • error: {
          code: number;
          message: string;
      }
      • code: number
      • message: string

    Returns Promise<void>

validateParam

  • validateParam(name, value, expectedType): void

  • Parameters

    • name: string
    • value: any
    • expectedType: string

    Returns void

Static create

  • create(projectId, metadata, chains?, methods?, sessionEvents?): Promise<HederaWeb3Wallet>

  • Parameters

    Returns Promise<HederaWeb3Wallet>

Static init

  • init(opts): Promise<Web3Wallet>

  • Parameters

    • opts: Options

    Returns Promise<Web3Wallet>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc