init

Author: kolirt

.eslintrc.cjs

@@ -0,0 +1,14 @@
+/* eslint-env node */
+require('@rushstack/eslint-patch/modern-module-resolution')
+
+module.exports = {
+  root: true,
+  'extends': [
+    'plugin:vue/vue3-essential',
+    'eslint:recommended',
+    '@vue/eslint-config-typescript'
+  ],
+  parserOptions: {
+    ecmaVersion: 'latest'
+  }
+}

.gitignore

@@ -0,0 +1,28 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+.DS_Store
+#dist
+dist-ssr
+coverage
+*.local
+
+/cypress/videos/
+/cypress/screenshots/
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 kolirt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,8 @@
+dev-docs:
+	yarn dev-docs
+build-docs:
+	yarn build-docs
+preview-docs:
+	yarn preview-docs
+build-lib:
+	yarn build-lib

README.md

@@ -0,0 +1,83 @@
+<h1 align="center">Web3 authentication for Vue3 apps based on WalletConnect v2</h1>
+
+<p align="center">
+    <img src="https://img.shields.io/static/v1?label=Made%20with&message=VueJS&color=limegreen&style=for-the-badge&logo=vue.js" />
+    <img src="https://img.shields.io/badge/Made%20for-Dapps-orange?style=for-the-badge&logo=ethereum" />
+</p>
+
+Simple WalletConnect v2 integration package for Vue3 apps.
+
+**Table of Contents**
+- [Getting started](#getting-started)
+    - [Installation](#installation)
+    - [Setup](#setup)
+- [Usage](#usage)
+    - [Connect wallet button](#connect-wallet-button)
+- [Demo](#demo)
+- [Example](#example)
+- [Faq](#faq)
+- [License](#license)
+
+[//]: # (# Web3 authentication for Vue3 apps)
+# Getting started
+
+## Installation
+
+Use yarn or npm to install the package `@kolirt/vue-web3-auth`.
+
+```bash
+npm install --save @kolirt/vue-web3-auth
+
+yarn add @kolirt/vue-web3-auth
+```
+
+## Setup
+
+Add dependencies to your `main.js`:
+
+```javascript
+import {createApp} from 'vue'
+import {Chains, createWeb3Auth} from '@kolirt/vue-web3-auth'
+
+const app = createApp({...})
+
+app.use(createWeb3Auth({
+  projectId: '', // generate here https://cloud.walletconnect.com/ and turn on 'Supports Sign v2'
+  chains: [
+    Chains.bsc,
+    Chains.mainnet,
+    Chains.polygon
+  ]
+}))
+
+app.mount('#app')
+```
+
+# Usage
+## Connect wallet button
+```vue
+<script setup lang="ts">
+import {account, disconnect, connect} from '@kolirt/vue-web3-auth'
+</script>
+
+<template>
+  <button v-if="account.connected" @click="disconnect()">
+    {{ account.address }}
+  </button>
+  <button v-else @click="connect()">
+    Connect wallet
+  </button>
+</template>
+```
+
+# Demo
+[Demo here](https://kolirt.github.io/vue-web3-auth/).
+
+# Example
+[Example here](https://github.com/kolirt/vue-web3-auth/blob/master/src).
+
+# FAQ
+Check closed [issues](https://github.com/kolirt/vue-web3-auth/issues) to get answers for most asked questions.
+
+# License
+[MIT](https://github.com/kolirt/vue-web3-auth/blob/master/LICENSE).

dist/vue-web3-auth.d.ts

@@ -0,0 +1,59 @@
+import type { Chain } from '@wagmi/core';
+import * as Chains from '@wagmi/core/chains';
+import type { ComputedRef } from 'vue';
+import type { Plugin as Plugin_2 } from 'vue';
+import type { ThemeCtrlState } from '@web3modal/core';
+
+export declare function $off(event: Event_2, callback: (...args: any) => void): void;
+
+export declare function $on(event: Event_2, callback: (...args: any) => void): void;
+
+export declare const account: {
+    connected: boolean;
+    address?: string | undefined;
+    shortAddress?: string | undefined;
+};
+
+export declare function accountDetails(): Promise<void>;
+
+export { Chain }
+
+export declare const chain: ComputedRef<Chain>;
+
+export { Chains }
+
+export declare function connect(chain?: Chain): Promise<void>;
+
+export declare function createWeb3Auth(options: Options): Plugin_2;
+
+export declare function disconnect(): Promise<void>;
+
+declare enum Event_2 {
+    Connected = "connected",
+    Disconnected = "disconnect",
+    ChainSwitched = "chain_switched",
+    UnknownChain = "unknown_chain",
+    ModalStateChanged = "modal_state_changed"
+}
+export { Event_2 as Event }
+
+export declare function getAvailableChains(): Chain[];
+
+export declare type Options = {
+    autoInit?: boolean;
+    projectId: string;
+    chains: Chain[];
+    autoConnect?: boolean;
+    disconnectUnknownChain?: boolean;
+    reconnectToChain?: boolean;
+    logEnabled?: boolean;
+    web3modalOptions?: ThemeCtrlState;
+};
+
+export declare function selectChain(): Promise<void>;
+
+export declare function shortAddressFilter(value?: string): string;
+
+export declare function switchChain(newChain: Chain): Promise<void>;
+
+export { }