Merge pull request #24 from AbstractSDK/adair/readme

Update readmes and add graphql config for type resolution

Author: adairrr

README.md

@@ -2,6 +2,14 @@
 
 This monorepo contains the Typescript-based SDKs for AbstractSDK.
 
+## Development
+
+1. Install the Abstract CLI:
+
+   ```bash
+   npm i -g @abstract-money/cli
+   ```
+
 ## Prerequisites
 
 - Ensure you have Node.js installed.

graphql.config.yml

@@ -0,0 +1,2 @@
+# Allows the IDE to resolve the schema and provide autocomplete
+schema: "https://api.abstract.money/graphql"

packages/cli/README.md

@@ -0,0 +1,11 @@
+# Abstract CLI
+
+The Abstract CLI is a command-line tool for working with AbstractSDK apps and modules.
+
+## Installation 
+
+```bash
+npm i -g @abstract-money/cli
+```
+
+## Usage

packages/react/src/contexts/account-id.ts

@@ -29,6 +29,10 @@ export function AbstractAccountIdProvider({
   })
 }
 
+/**
+ * Hook to retrieve the provided Account id from the {@link AbstractAccountIdProvider} context.
+ * @param accountId the Account id to set if the context is not provided.
+ */
 export function useAccountId({
   accountId,
 }: { accountId?: AbstractAccountId } = {}) {

packages/react/src/contexts/config.ts

@@ -10,6 +10,7 @@ const ConfigContext = React.createContext<Config | undefined>(undefined)
 export type AbstractConfigProps = {
   config?: Config
 }
+
 export function AbstractConfigContext({
   children,
   config = { apiUrl: ABSTRACT_API_URL },
@@ -22,6 +23,9 @@ export function AbstractConfigContext({
   })
 }
 
+/**
+ * Internal hook to retrieve the Abstract configuration from the {@link AbstractConfigContext} context.
+ */
 export function useConfig() {
   const config = React.useContext(ConfigContext)
   if (!config)

packages/react/src/contexts/provider.ts

@@ -17,6 +17,11 @@ const client = new QueryClient({
 })
 
 export type AbstractProviderProps = AbstractConfigProps
+
+/**
+ * Provide abstract configuration for the application.
+ * @param config configuration.
+ */
 export function AbstractProvider({
   children,
   config,

packages/react/src/hooks/use-accounts.ts

@@ -2,6 +2,12 @@ import { AbstractAccountId, AbstractQueryClient } from '@abstract-money/core'
 import { UseQueryOptions, useQuery } from '@tanstack/react-query'
 import React from 'react'
 
+/**
+ * Loads all accounts for a given owner and chain.
+ * @param owner address of the owner. Will automatically translate to other chains' addresses.
+ * @param chain chain to load accounts for.
+ * @param client
+ */
 export function useAccounts(
   {
     owner,

packages/react/src/hooks/use-deposit.ts

@@ -22,12 +22,11 @@ async function deposit({
     memo?: string
   }
 }) {
-  const abstractAccountClient = AbstractAccountClient.fromQueryClient(
-    await AbstractAccountQueryClient.load(abstractClient, accountId),
-    abstractClient,
-  )
+  const accountClient = (
+    await AbstractAccountQueryClient.load(abstractClient, accountId)
+  ).connectAbstractClient(abstractClient)
 
-  return abstractAccountClient.deposit(assets, args.fee, args.memo)
+  return accountClient.deposit(assets, args.fee, args.memo)
 }
 
 type DepositMutation = {
@@ -40,6 +39,10 @@ type DepositMutation = {
   }
 }
 
+/**
+ * Hook to deposit assets to an Account.
+ * @param options deposit options.
+ */
 export function useDeposit(
   options: UseMutationOptions<DeliverTxResponse, unknown, DepositMutation> = {},
 ) {

packages/react/src/hooks/use-execute.ts

@@ -1,5 +1,4 @@
 import {
-  AbstractAccountClient,
   AbstractAccountId,
   AbstractAccountQueryClient,
   AbstractClient,
@@ -20,12 +19,11 @@ async function execute({
   msgs: CosmosMsgForEmpty[]
   funds: Coin[]
 }) {
-  const abstractAccountClient = AbstractAccountClient.fromQueryClient(
-    await AbstractAccountQueryClient.load(abstractClient, accountId),
-    abstractClient,
-  )
+  const accountClient = (
+    await AbstractAccountQueryClient.load(abstractClient, accountId)
+  ).connectAbstractClient(abstractClient)
 
-  return abstractAccountClient.execute(msgs, funds)
+  return accountClient.execute(msgs, funds)
 }
 
 type ExecuteMutation = {
@@ -35,6 +33,10 @@ type ExecuteMutation = {
   abstractClient: AbstractClient
 }
 
+/**
+ * Hook to execute a transaction on an Account.
+ * @param options execute options.
+ */
 export function useExecute(
   options: UseMutationOptions<ExecuteResult, Error, ExecuteMutation> = {},
 ) {

packages/react/src/hooks/use-withdraw.ts

@@ -24,10 +24,9 @@ async function withdraw({
     memo?: string
   }
 }) {
-  const abstractAccountClient = AbstractAccountClient.fromQueryClient(
-    await AbstractAccountQueryClient.load(abstractClient, accountId),
-    abstractClient,
-  )
+  const abstractAccountClient = (
+    await AbstractAccountQueryClient.load(abstractClient, accountId)
+  ).connectAbstractClient(abstractClient)
 
   return abstractAccountClient.withdraw(assets, recipient, args.fee, args.memo)
 }
@@ -43,6 +42,10 @@ type WithdrawMutation = {
   }
 }
 
+/**
+ * Hook to withdraw assets from an Account.
+ * @param options withdraw options.
+ */
 export function useWithdraw(
   options: UseMutationOptions<
     DeliverTxResponse,