Using GemWallet in Node.js

info

This page assumes that you have GemWallet installed.

Installing the library

Let's first install the library from npm:

• Install the module using npm: npm install @gemwallet/api

• Install the module using yarn: yarn add @gemwallet/api

Now let's dig into what functionalities are available to you.

Methods

isConnected()

tip

We definitely recommend that you check if the user is connected before using any of the other methods available.

isConnected() -> <Promise<boolean>>

Returns true if the user has GemWallet extension installed, and false otherwise.

Here is an example with a React web application:

import { isConnected } from "@gemwallet/api";

function App() {
  const handleConnect = () => {
    isConnected().then((isConnected) =>
      console.log(`Is the user having GemWallet installed? ${isConnected}`)
    );
  };
  return (
    <div className="App">
      <button onClick={handleConnect}>Click me!</button>
    </div>
  );
}

export default App;

getAddress()

getAddress() -> <Promise<string|null|undefined>>

Returns:

• string returns the classic address of the wallet.
• null user refused to share the address within GemWallet.
• undefined something went wrong.

Here is an example with a React web application:

import { isConnected, getAddress } from "@gemwallet/api";

function App() {
  const handleConnect = () => {
    isConnected().then((isConnected) => {
      if (isConnected) {
        getAddress().then((address) => {
          console.log(`Your address: ${address}`);
        });
      }
    });
  };

  return (
    <div className="App">
      <button onClick={handleConnect}>Click me!</button>
    </div>
  );
}

export default App;

getNetwork()

getNetwork() -> <Promise<'Mainnet'|'Testnet'|'Devnet'|'AMM-Devnet'>>

Returns:

• Mainnet if the user is connected to the main network.
• Testnet if the user is connected to the test network.
• Devnet if the user is connected to the developer network.
• AMM-Devnet if the user is connected to the AMM Devnet.

Here is an example with a React web application:

import { isConnected, getNetwork } from "@gemwallet/api";

function App() {
  const handleConnect = () => {
    isConnected().then((isConnected) => {
      if (isConnected) {
        getNetwork().then((network) => {
          console.log(`Your network: ${network}`);
        });
      }
    });
  };

  return (
    <div className="App">
      <button onClick={handleConnect}>Click me!</button>
    </div>
  );
}

export default App;

getNFT()

getNFT(optionalParameters) -> <Promise<AccountNFToken[]|null|undefined>>

Take as parameter an optional object:

• optionalParameters object

const optionalParameters = {
  // Limit the number of NFTokens to retrieve.
  limit?: number;
  // Value from a previous paginated response.
  // Resume retrieving data where that response left off.
  marker?: unknown;
}

Returns:

• AccountNFToken[] returns an array of owned NFTs.
• null user refused to share owned NFTs within GemWallet.
• undefined something went wrong.

interface AccountNFToken {
  Flags: number;
  Issuer: string;
  NFTokenID: string;
  NFTokenTaxon: number;
  URI?: string;
  nft_serial: number;
}

Here is an example of implementation:

import { isConnected, getNFT } from "@gemwallet/api";

function App() {
  const handleNFTs = () => {
    isConnected().then((isConnected) => {
      if (isConnected) {
        getNFT().then((trHash) => {
          console.log("Your NFTs: ", trHash);
        });
      }
    });
  };

  return (
    <div className="App">
      <button onClick={handleNFTs}>Show my NFTs!</button>
    </div>
  );
}

export default App;

getPublicKey()

getPublicKey() -> <Promise<{ publicKey: string, address: string }|null|undefined>>

Returns:

• { publicKey: string, address: string } returns the public key and the classic address of the wallet.
• null user refused to share the public key within GemWallet.
• undefined something went wrong.

Here is an example with a React web application:

import { isConnected, getPublicKey } from "@gemwallet/api";

function App() {
  const handleConnect = () => {
    isConnected().then((isConnected) => {
      if (isConnected) {
        getPublicKey().then(({ publicKey }) => {
          console.log(`Your public key: ${publicKey}`);
        });
      }
    });
  };

  return (
    <div className="App">
      <button onClick={handleConnect}>Click me!</button>
    </div>
  );
}

export default App;

sendPayment()

sendPayment(payment) -> <Promise<string|null|undefined>>

Take as parameters:

• payment object

const payment = {
  // 	The amount of currency to deliver
  amount: string;
  // The unique address of the account receiving the payment
  destination: string;
  // The token that can be used
  currency?: string;
  // The issuer of the token
  issuer?: string;
}

Returns:

• string returns the hash of the transaction.
• null user refused the payment within GemWallet.
• undefined something went wrong.

Here is an example for an XRP Payment with a React web application:

import { isConnected, sendPayment } from "@gemwallet/api";

function App() {
  const handleConnect = () => {
    isConnected().then((isConnected) => {
      if (isConnected) {
        const payment = {
          amount: "10",
          destination: "rLWQskMM8EoPxaLsmuQxE5rYeP4uX7dhym",
        };
        sendPayment(payment).then((trHash) => {
          console.log("Transaction Hash: ", trHash);
        });
      }
    });
  };

  return (
    <div className="App">
      <button onClick={handleConnect}>Click me!</button>
    </div>
  );
}

export default App;

Here is an example for an ETH Payment with a React web application:

import { isConnected, sendPayment } from "@gemwallet/api";

function App() {
  const handleConnect = () => {
    isConnected().then((isConnected) => {
      if (isConnected) {
        const payment = {
          amount: "10",
          destination: "rLWQskMM8EoPxaLsmuQxE5rYeP4uX7dhym",
          currency: "ETH",
          issuer: "rnm76Qgz4G9G4gZBJVuXVvkbt7gVD7szey",
        };
        sendPayment(payment).then((trHash) => {
          console.log("Transaction Hash: ", trHash);
        });
      }
    });
  };

  return (
    <div className="App">
      <button onClick={handleConnect}>Click me!</button>
    </div>
  );
}

export default App;

signMessage()

signMessage(message) -> <Promise<string|null|undefined>>

Take as parameters:

• message string

Returns:

• string returns the signed message.
• null user refused the payment within GemWallet.
• undefined something went wrong.

Here is an example with a React web application:

import { isConnected, signMessage } from "@gemwallet/api";

function App() {
  const handleConnect = () => {
    isConnected().then((isConnected) => {
      if (isConnected) {
        signMessage("The message I want to get signed").then(
          (signedMessage) => {
            console.log("Signed message: ", signedMessage);
          }
        );
      }
    });
  };

  return (
    <div className="App">
      <button onClick={handleConnect}>Click me!</button>
    </div>
  );
}

export default App;

addTrustline()

addTrustline(transaction) -> <Promise<string|null|undefined>>

Take as parameters:

• transaction object

const transaction = {
  // The token to be used
  currency: string;
  // The address of the account owing the token
  issuer: string;
  // Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network.
  // Some transaction types have different minimum requirements.
  fee?: string;
  // 	The maximum amount of currency that can be exchanged to the trustline
  value: string;
}

Returns:

• string: hash of the transaction
• null: user refused the payment
• undefined: something went wrong

Here is an example with a React web application:

import { isConnected, addTrustline } from "@gemwallet/api";

function App() {
  const handleConnect = () => {
    isConnected().then((isConnected) => {
      if (isConnected) {
        const transaction = {
          currency: "USD",
          issuer: "rwtDvu9QDfCskWuyE2TSEt3s56RbiWUKJN",
          value: "10000000",
        };
        addTrustline(transaction).then((trHash) => {
          console.log("Transaction Hash: ", trHash);
        });
      }
    });
  };

  return (
    <div className="App">
      <button onClick={handleConnect}>Click me!</button>
    </div>
  );
}

export default App;