antelopeql 1.0.0 → 1.1.0

package/antelopeql.mjs

@@ -10,6 +10,7 @@ import {
 
 import blockchain_query_field from "./blockchain_query_field.mjs";
 import build_graphql_fields_from_abis from "./build_graphql_fields_from_abis.mjs";
+import get_abis from "./get_abis.mjs";
 import actions from "./graphql_input_types/actions.mjs";
 import push_serialized_transaction from "./push_serialized_transaction.mjs";
 import push_transaction from "./push_transaction.mjs";
@@ -63,6 +64,7 @@ export default async function AntelopeQL({
   fetch,
   contracts = [],
   private_keys = [],
+  ABIs = [],
   rpc_url,
   headers,
   signal
@@ -76,35 +78,15 @@ export default async function AntelopeQL({
     if (headers) fetchOptions.headers = headers;
     if (signal) fetchOptions.signal = signal;
 
-    const uri = `${rpc_url}/v1/chain/get_abi`;
-
-    const abi_req = contracts.map((account_name) =>
-      fetch(uri, {
-        method: "POST",
-        ...fetchOptions,
-        body: JSON.stringify({
-          account_name,
-          json: true
-        })
-      }).then((/** @type {{ json: () => any; }} */ req) => req.json())
-    );
-
-    const ABIs = await Promise.all(abi_req);
-    for (let i = 0; i < contracts.length; i++) {
-      if (ABIs[i].error)
-        throw new GraphQLError(ABIs[i].message, { extensions: ABIs[i] });
-      if (!ABIs[i].abi)
-        throw new GraphQLError(
-          `No smart contract found for “${contracts[i]}”.`
-        );
-    }
-
     const { mutation_fields, query_fields, ast_list } =
-      build_graphql_fields_from_abis(ABIs);
+      build_graphql_fields_from_abis([
+        ...ABIs,
+        ...(await get_abis(contracts, { fetch, rpc_url, fetchOptions }))
+      ]);
 
     const queries = new GraphQLObjectType({
       name: "Query",
-      description: "Query table data from EOSIO blockchain.",
+      description: "Query table data from Antelope blockchains.",
       fields: { blockchain: blockchain_query_field, ...query_fields }
     });
 

package/blockchain/deserialize_action_data.mjs

@@ -8,11 +8,11 @@ const deserialize_action_data = {
   type: GraphQLString,
   args: {
     code: {
-      description: "Account name that holds the EOSIO smart contract.",
+      description: "Account name that holds the Antelope smart contract.",
       type: new GraphQLNonNull(name_type)
     },
     action: {
-      description: "Action name on the EOSIO smart contract.",
+      description: "Action name on the Antelope smart contract.",
       type: new GraphQLNonNull(name_type)
     },
     binargs: {

package/blockchain/get_account.mjs

@@ -81,7 +81,7 @@ const linked_actions_type = new GraphQLObjectType({
 
 const permission_type = new GraphQLObjectType({
   name: "permission_type",
-  description: "EOS account permissions",
+  description: "Antelope account permissions",
   fields: {
     perm_name: { type: name_type },
     parent: { type: name_type },
@@ -94,6 +94,7 @@ const permission_type = new GraphQLObjectType({
 
 const account_type = new GraphQLObjectType({
   name: "account_type",
+  description: `Retreive details about a specific account on the blockchain.`,
   fields: () => ({
     account_name: {
       type: name_type
@@ -111,7 +112,7 @@ const account_type = new GraphQLObjectType({
     cpu_limit: { type: bandwidth_type },
     ram_usage: { type: GraphQLString },
     permissions: {
-      description: "List of the EOS `account_name` permissions",
+      description: "List of the Antelope `account_name` permissions",
       type: new GraphQLList(permission_type)
     },
     total_resources: {
@@ -200,7 +201,6 @@ const account_type = new GraphQLObjectType({
 });
 
 const get_account = {
-  description: `Retreive details about a specific account on the blockchain.`,
   type: account_type,
   args: {
     account_name: {

package/blockchain/get_accounts_by_authorizers.mjs

@@ -36,6 +36,8 @@ const authorized_accounts_type = new GraphQLObjectType({
 
 const accounts_by_authorizers_type = new GraphQLObjectType({
   name: "accounts_by_authorizers",
+  description:
+    "Fetch permissions authorities that are, in part or whole, satisfiable.",
   fields: () => ({
     accounts: {
       type: new GraphQLList(authorized_accounts_type)
@@ -44,8 +46,6 @@ const accounts_by_authorizers_type = new GraphQLObjectType({
 });
 
 const accounts_by_authorizers = {
-  description:
-    "Fetch permissions authorities that are, in part or whole, satisfiable.",
   type: accounts_by_authorizers_type,
   args: {
     accounts: {

package/blockchain/get_block.mjs

@@ -43,7 +43,7 @@ const producer_type = new GraphQLObjectType({
     },
     block_signing_key: {
       type: GraphQLString,
-      description: `Base58 encoded EOSIO public key.`
+      description: `Base58 encoded Antelope public key.`
     }
   })
 });
@@ -138,7 +138,7 @@ const transactions_type = new GraphQLObjectType({
 
 const block_type = new GraphQLObjectType({
   name: "block_type",
-  description: "",
+  description: "Return info relating to a specific block.",
   fields: () => ({
     timestamp: {
       description: "Date/time string in the format `YYYY-MM-DDTHH:MM:SS.sss`",
@@ -179,7 +179,7 @@ const block_type = new GraphQLObjectType({
     },
     producer_signature: {
       type: GraphQLString,
-      description: `Base58 encoded EOSIO cryptographic signature.`
+      description: `Base58 encoded Antelope cryptographic signature.`
     },
     transactions: {
       type: new GraphQLList(transactions_type),
@@ -205,7 +205,6 @@ const block_type = new GraphQLObjectType({
 });
 
 const get_block = {
-  description: "Return info relating to a specific block.",
   type: block_type,
   args: {
     block_num_or_id: {

package/blockchain/get_info.mjs

@@ -2,7 +2,7 @@ import { GraphQLError, GraphQLObjectType, GraphQLString } from "graphql";
 
 const info_type = new GraphQLObjectType({
   name: "info_type",
-  description: "Returns various details about the EOS blockchain",
+  description: "Returns various details about the Antelope blockchain",
   fields: () => ({
     server_version: {
       type: GraphQLString,

package/blockchain/get_producers.mjs

@@ -56,9 +56,9 @@ const producers = new GraphQLObjectType({
 });
 
 const get_producers = {
-  description: "Return info about block producers.",
+  description: "Return info about Antelope block producers.",
   type: new GraphQLObjectType({
-    name: "blockchain_producers",
+    name: "antelope_producers",
     fields: {
       total_producer_vote_weight: {
         type: GraphQLString

package/blockchain_query_field.mjs

@@ -13,9 +13,9 @@ import get_ram_price from "./blockchain/get_ram_price.mjs";
 import get_table from "./blockchain/get_table_by_scope.mjs";
 
 const blockchain_query_field = {
-  description: `Retrieve infomation about the blockchain, cryptocurrency and accounts.`,
   type: new GraphQLObjectType({
-    name: "blockchain",
+    name: "blockchain_type",
+    description: `Retrieve infomation about the blockchain, cryptocurrency and accounts.`,
     fields: {
       get_account,
       get_abi,

package/eosio_abi_to_graphql_ast.mjs

@@ -182,13 +182,18 @@ export function get_graphql_fields_from_AST(AST, ABI, account_name = "") {
   let mutation_fields = {};
   const mutationTypes = {};
   for (const action of actions) {
-    let { name: action_name, type: action_type } = action;
+    let {
+      name: action_name,
+      type: action_type,
+      ricardian_contract = ""
+    } = action;
     action_name = action_name.replace(/\./gmu, "_");
     const action_fields = AST[action_type];
 
     const buildQGL = (fields, acc = {}) => {
       for (const field of fields) {
         const { name, type, $info } = field;
+
         if ($info.object) {
           if (!GQL_MTYPES[type])
             GQL_MTYPES[type] = new GraphQLInputObjectType({
@@ -202,18 +207,24 @@ export function get_graphql_fields_from_AST(AST, ABI, account_name = "") {
       return acc;
     };
 
-    if (!mutationTypes[action_type])
+    if (!mutationTypes[action_type]) {
       mutationTypes[action_type] = {
         type: new GraphQLInputObjectType({
           name: gql_account_name + action_type,
+          description: ricardian_contract
+            .replace(/(https?|http|ftp):\/\/[^\s$.?#].[^\s]*$/gmu, "")
+            .replace(/icon:/gmu, "")
+            .replace(/(\s)?nowrap(\s)?/gmu, ""),
           fields: {
             ...buildQGL(action_fields),
             authorization: {
+              description: "Authorization to sign the transaction",
               type: new GraphQLList(new GraphQLNonNull(authorization_type))
             }
           }
         })
       };
+    }
 
     mutation_fields[action_name] = mutationTypes[action_type];
   }

package/get_abis.mjs

@@ -0,0 +1,41 @@
+import { GraphQLError } from "graphql";
+
+export default async function get_abis(
+  contracts = [],
+  { fetch, rpc_url, fetchOptions = {} }
+) {
+  if (!contracts.length) [];
+
+  const uri = `${rpc_url}/v1/chain/get_abi`;
+
+  const abi_req = contracts.map((account_name) =>
+    fetch(uri, {
+      method: "POST",
+      ...fetchOptions,
+      body: JSON.stringify({ account_name, json: true })
+    }).then((req) => req.json())
+  );
+
+  const ABIs = await Promise.all(abi_req);
+
+  let errors = [];
+  ABIs.forEach(({ error, abi, account_name }, i) => {
+    if (error) {
+      try {
+        if (error.details[0]?.message.startsWith("unknown key ("))
+          errors.push({ message: `No account found for “${contracts[i]}”` });
+      } catch (err) {
+        throw new GraphQLError(ABIs[i].message, { extensions: ABIs[i] });
+      }
+    }
+    if (!abi)
+      errors.push({ message: `No contract found for “${account_name}”` });
+  });
+
+  if (errors.length)
+    throw new GraphQLError("Invalid Antelope smart contracts provided.", {
+      extensions: errors
+    });
+
+  return ABIs;
+}

package/graphql_input_types/configuration.mjs

@@ -11,7 +11,7 @@ const configuration_default_value = {
 };
 
 /**
- * Handles various elements relating to the `EOSIO` transaction.
+ * Handles various elements relating to the `Antelope` transaction.
  * @typedef {Object} configuration_type
  * @param {Number} blocksBehind Number of blocks behind the current block (TaPoS protection).
  * @param {Number} expireSeconds Seconds past before transaction is no longer valid (TaPoS protection)

package/graphql_object_types/transaction_receipt.mjs

@@ -48,7 +48,7 @@ const transaction_status = new GraphQLEnumType({
 });
 
 /**
- * Bandwidth reciept for EOSIO transaction.
+ * Bandwidth reciept for Antelope transaction.
  * @typedef {Object} Bandwidth_cost
  * @prop {Number} net_usage_words Consumption of network bandwidth (bytes).
  * @prop {Number} cpu_usage_us Consumption of CPU bandwidth (µs).
@@ -119,7 +119,7 @@ const transaction_receipt_type = new GraphQLObjectType({
   fields: () => ({
     transaction_id: {
       type: GraphQLID,
-      description: "`eosio` blockchain transaction id “reciept”"
+      description: "`Antelope` blockchain transaction id “reciept”"
     },
     block_num: {
       type: GraphQLInt,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "antelopeql",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A GraphQL implementation for interacting with Antelope based blockchains.",
   "repository": "github:pur3miish/antelopeql",
   "bugs": "https://github.com/pur3miish/antelopeql/issues",
@@ -37,7 +37,8 @@
     "query_resolver.mjs",
     "serialize_transaction.mjs",
     "antelopeql.mjs",
-    "types.mjs"
+    "types.mjs",
+    "get_abis.mjs"
   ],
   "sideEffects": false,
   "exports": {
@@ -56,7 +57,8 @@
     "./query_resolver.mjs": "./query_resolver.mjs",
     "./serialize_transaction.mjs": "./serialize_transaction.mjs",
     "./antelopeql.mjs": "./antelopeql.mjs",
-    "./types.mjs": "./types.mjs"
+    "./types.mjs": "./types.mjs",
+    "./get_abis.mjs": "./get_abis.mjs"
   },
   "browserslist": [
     "> 0.5%, not OperaMini all, not IE > 0, not dead"

package/readme.md

@@ -1,12 +1,18 @@
-![antelopeql logo](https://raw.githubusercontent.com/pur3miish/antelope/main/static/antelopeql.svg)
+![antelopeql logo](https://raw.githubusercontent.com/pur3miish/antelopeql/main/static/antelopeql.svg)
 
 # AntelopeQL
 
 [![NPM Package](https://img.shields.io/npm/v/antelopeql.svg)](https://www.npmjs.org/package/antelopeql) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/pur3miish/antelopeql/blob/main/LICENSE)
 
-AntelopeQL is a [GraphQL](https://graphql.org/) implementation for interacting with [Antelope](https://antelope.io/) blockchains. Query and mutate your smart contracts with a GraphQL tool that provides comprehensive documentation about the entire blockchain.
+AntelopeQL (_Antelope Query Language_)
 
-**For a live example of AntelopeQL GUI see: [antelope.relocke.io](https://antelope.relocke.io).**
+AntelopeQL is a GraphQL client and server library that allows developers to interact with the Antelope blockchain using GraphQL. It provides a unified interface to communicate with different blockchains within the Antelope 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, AntelopeQL 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 the Antelope blockchain and other data sources.
+
+With AntelopeQL, 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 Antelope ecosystem.
+
+**For a live example of AntelopeQL GUI see: [antelopeql.relocke.io](https://antelopeql.relocke.io).**
 
 ![antelopeql screenshot](https://raw.githubusercontent.com/pur3miish/antelopeql/main/static/antelopeql-screen.png)