Skip to content

pur3miish/ReLockeQL

Repository files navigation

relockeql logo

RelockeQL

NPM Package License: MIT

RelockeQL.

RelockeQL is a GraphQL client and server library that allows developers to interact with Relocke-based blockchains using GraphQL. It provides a unified interface to communicate with different chains in the ecosystem, enabling developers to leverage the unique features and capabilities of each blockchain while still benefiting from a consistent development experience.

As a GraphQL client library, RelockeQL simplifies the process of building and executing GraphQL queries and mutations, handling errors, and signing transactions. As a server library, it provides a framework for building GraphQL APIs that can interact with Relocke-based blockchains and other data sources.

With RelockeQL, developers can focus on building the frontend and business logic of their DApps, while relying on the library to handle the complexities of interacting with multiple blockchains in the ecosystem.

Live working example can be found here.

relockeql screenshot

Installation

For Node.js, to install RelockeQL and the peer dependency graphql run:

npm install relockeql graphql

Examples

See the examples folder on how to run RelockeQL as a Node.js endpoint.

Query a Blockchain Account Info

import { RelockeQL } from "relockeql";
import { sign_transaction } from "your-signing-library";

const query = /* GraphQL */ `
  {
    vaulta {
      get_blockchain {
        get_account(account_name: "relockeblock") {
          core_liquid_balance
          ram_quota
          net_weight
          cpu_weight
          ram_usage
        }
      }
    }
  }
`;

const { data } = await RelockeQL({ query });

console.log(data);

Logged output included an account infomation.

Transfer Tokens

import { RelockeQL } from "relockeql";

const query = /* GraphQL */ `
  mutation {
    jungle {
      send_transaction(
        actions: [
          {
            eosio_token: {
              transfer: {
                authorization: { actor: "relockeblock" }
                to: "relockechain"
                from: "relockeblock"
                memo: ""
                quantity: "0.0002 EOS"
              }
            }
          }
        ]
      ) {
        transaction_id
        block_num
      }
    }
  }
`;

const { data } = await RelockeQL({
  query,
  contracts: {
    // List of your smart contracts accounts for each chains.
    jungle: ["eosio.token"]
  },
  signTransaction: async (hash) => {
    const wif_private_key = "PVT_K1_…"; // your private key
    const signature = await sign_transaction({ hash, wif_private_key });
    return [signature]; // signatures must return array
  }
});

console.log(data);

Logged output includes transaction_id and block_num

Requirements

Supported runtime environments:

About

A GraphQL implementation for interacting with ReLocke based blockchains.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors