ArweaveKit Docs
  • ArweaveKit
    • Introduction
  • 🔐Wallets
    • Introduction to Wallets
    • Create Wallet
    • Get Wallet Address
    • Get Wallet Balance
    • Wallet Plugins
  • 💳ARWEAVE WALLET KIT
    • Introduction to Arweave Wallet Kit
    • Setup
    • Connect Button
    • Hooks
    • Customization
  • 🏦Transactions
    • Introduction to Transactions
    • Create Transaction
    • Sign Transaction
    • Post Transaction
    • Get Transaction Status
    • Get Transaction
    • Create and Post Transaction with Othent
    • Transaction Plugins
  • 📄SMART CONTRACTS
    • Introduction to Smart Contracts
    • Create Contract
    • Write Contract
    • Read Contract State
    • View Contract State
    • Write Contract with Othent
    • Read Contract with Othent
    • Smart Contract Plugins
  • ✅AUTH
    • Introduction to Auth
    • Connect
    • Disconnect
    • Get Active Address
    • Get Permissions
    • Get Wallet Names
    • Get All Addresses
    • Get Active Public Key
    • Is Installed
    • Log In with Othent
    • Log Out with Othent
    • Get User Details with Othent
    • Auth Plugins
  • 🔐Encryption
    • Introduction to Encryption
    • Encrypt Data with AES
    • Decrypt Data with AES
    • Encrypt AES Key with RSA
    • Decrypt AES Key with RSA
    • Encryption Plugins
  • 🌐GRAPHQL
    • Introduction to GraphQL
    • Query All Arweave Transactions
    • Query Arweave Data
    • Query Arweave Transactions
    • GraphQL Plugins
  • 🗺️RoadMap
    • Features
  • 📘REFERENCES
    • ArweaveKit in Browser Environments
  • 🛠️SUPPORTING TOOLS
    • Arweave StarterKit
Powered by GitBook
On this page
  • Basic Syntax
  • Input Parameters
  • Returned Data

Was this helpful?

  1. AUTH

Connect

Connecting a web wallet on Arweave

PreviousIntroduction to AuthNextDisconnect

Last updated 2 months ago

Was this helpful?

The connect function connects an application to a web wallet and gives the application appropriate permissions based on the input parameters.

Basic Syntax

The function is called as follows:

import { ArConnect } from 'arweavekit/auth'

const response = await ArConnect.connect({params});

Input Parameters

The following params are available for this function and they must be passed in as an object:

  • permissions: array : The permissions array consists of specific permissions that the application requires to perform actions on behalf of the user. Currently there are 8 permissions available. Read more .

  • appInfo: object (optional) : Additional information about application like name and logo. This is suitable for custom applications trying to make a connection.

  • gateway: object (optional) : The gateway configuration to be used while connecting web wallet to application.

    • host: string : The Hostname or IP address for a Arweave Host.

    • port: number : The port for the gateway.

    • protocol: 'http' | 'https' : The network protocol for the gateway.

Returned Data

The function call returns a void. However, the function can be coupled with conditionals to perform user authentication and display gated information.

✅
here