Class WalletConnection

This class is not intended for use outside the browser. Without window (i.e. in server contexts), it will instantiate but will throw a clear error when used.

See

https://docs.near.org/tools/near-api-js/quick-reference#wallet

Example

// create new WalletConnection instance
const wallet = new WalletConnection(near, 'my-app');

// If not signed in redirect to the NEAR wallet to sign in
// keys will be stored in the BrowserLocalStorageKeyStore
if(!wallet.isSignedIn()) return wallet.requestSignIn()

Constructors

constructor

Methods

account getAccountId isSignedIn isSignedInAsync requestSignIn requestSignInUrl requestSignTransactions requestSignTransactionsUrl signOut

Constructors

constructor

Methods

account

getAccountId

  • getAccountId(): string

    Returns authorized Account ID.

    Returns string

    Example

    const wallet = new WalletConnection(near, 'my-app');
    wallet.getAccountId();

isSignedIn

  • isSignedIn(): boolean

    Returns true, if this WalletConnection is authorized with the wallet.

    Returns boolean

    Example

    const wallet = new WalletConnection(near, 'my-app');
    wallet.isSignedIn();

isSignedInAsync

  • isSignedInAsync(): Promise<boolean>

    Returns promise of completing signing in after redirecting from wallet

    Returns Promise<boolean>

    Example

    // on login callback page
    const wallet = new WalletConnection(near, 'my-app');
    wallet.isSignedIn(); // false
    await wallet.isSignedInAsync(); // true

requestSignIn

  • requestSignIn(options: SignInOptions): Promise<void>

    Redirects current page to the wallet authentication page.

    Parameters

    • options: SignInOptions

      An optional options object

      • contractId

        The NEAR account where the contract is deployed

      • successUrl

        URL to redirect upon success. Default: current url

      • failureUrl

        URL to redirect upon failure. Default: current url

    Returns Promise<void>

    Example

    const wallet = new WalletConnection(near, 'my-app');
    // redirects to the NEAR Wallet
    wallet.requestSignIn({ contractId: 'account-with-deploy-contract.near' });

requestSignInUrl

  • requestSignInUrl(options: SignInOptions): Promise<string>

    Constructs string URL to the wallet authentication page.

    Parameters

    • options: SignInOptions

      An optional options object

      • contractId

        The NEAR account where the contract is deployed

      • successUrl

        URL to redirect upon success. Default: current url

      • failureUrl

        URL to redirect upon failure. Default: current url

    Returns Promise<string>

    Example

    const wallet = new WalletConnection(near, 'my-app');
    // return string URL to the NEAR Wallet
    const url = await wallet.requestSignInUrl({ contractId: 'account-with-deploy-contract.near' });

requestSignTransactions

  • requestSignTransactions(options: RequestSignTransactionsOptions): void

    Requests the user to quickly sign for a transaction or batch of transactions by redirecting to the wallet.

    Parameters

    • options: RequestSignTransactionsOptions

      A required options object

      • transactions

        List of transactions to sign

      • callbackUrl

        URL to redirect upon success. Default: current url

      • meta

        Meta information the wallet will send back to the application. meta will be attached to the callbackUrl as a url search param

    Returns void

requestSignTransactionsUrl

  • requestSignTransactionsUrl(options: RequestSignTransactionsOptions): string

    Constructs string URL to the wallet to sign a transaction or batch of transactions.

    Parameters

    • options: RequestSignTransactionsOptions

      A required options object

      • transactions

        List of transactions to sign

      • callbackUrl

        URL to redirect upon success. Default: current url

      • meta

        Meta information the wallet will send back to the application. meta will be attached to the callbackUrl as a url search param

    Returns string

signOut

Settings

Member Visibility

On This Page

Constructors
Methods