tessl/npm-walletconnect--types

TypeScript type definitions and interfaces for the WalletConnect Protocol v2, enabling type-safe development across the WalletConnect ecosystem

1.18x

Overview

Eval results

Files

WalletConnect Session Manager

Name: tessl/npm-walletconnect--types
Rating: 0.7 (1 reviews)
Author: tessl

A session management utility that helps developers work with WalletConnect engine parameter types for handling session lifecycle operations.

Capabilities

Parameter Creation and Validation

Creates a connection parameters object with required and optional namespaces @test
Creates an approve parameters object with session ID, namespaces, and optional properties @test
Creates a request parameters object with topic, request details, and chain ID @test
Creates a response parameters object with topic and JSON-RPC response @test

Session Information Extraction

Extracts the session topic from request or response parameters @test
Extracts the chain ID from request parameters @test
Extracts required namespaces from connection parameters @test

Implementation

@generates

API

import { EngineTypes, SessionTypes, ProposalTypes, JsonRpcResponse } from '@walletconnect/types';

/**
 * Creates connection parameters for initiating a WalletConnect session
 */
export function createConnectParams(
  requiredNamespaces: ProposalTypes.RequiredNamespaces,
  optionalNamespaces?: ProposalTypes.OptionalNamespaces,
  pairingTopic?: string
): EngineTypes.ConnectParams;

/**
 * Creates approval parameters for accepting a session proposal
 */
export function createApproveParams(
  id: number,
  namespaces: SessionTypes.Namespaces,
  sessionProperties?: ProposalTypes.SessionProperties
): EngineTypes.ApproveParams;

/**
 * Creates request parameters for sending a request through the engine
 */
export function createRequestParams(
  topic: string,
  method: string,
  params: any,
  chainId: string,
  expiry?: number
): EngineTypes.RequestParams;

/**
 * Creates response parameters for responding to a request
 */
export function createRespondParams(
  topic: string,
  response: JsonRpcResponse
): EngineTypes.RespondParams;

/**
 * Extracts the session topic from request parameters
 */
export function extractTopic(params: EngineTypes.RequestParams | EngineTypes.RespondParams): string;

/**
 * Extracts the chain ID from request parameters
 */
export function extractChainId(params: EngineTypes.RequestParams): string;

/**
 * Extracts required namespaces from connection parameters
 */
export function extractRequiredNamespaces(params: EngineTypes.ConnectParams): ProposalTypes.RequiredNamespaces;

Dependencies { .dependencies }

@walletconnect/types { .dependency }

Provides TypeScript type definitions for WalletConnect Protocol v2, including engine types, session types, and JSON-RPC protocol types.

Install with Tessl CLI

npx tessl i tessl/npm-walletconnect--types