@abstract-money/abstract.js v0.19.20

abstract.js

This repository holds the type declarations and interfaces for our smart contracts in CosmWasm. Autogenerated contracts lie in generated and those that are "fixed" are placed in src/contracts.

Scripts

• pnpm build: Generate the types
• pnpm fix: Temporary fixes for the autogenerated contracts (TODO)
• pnpm format: Run prettier
• pnpm lint: Run linter
• pnpm lint:fix: Attempt linter fixes

Getting Started

1. Install Abstract.js

pnpm install @abstract-money/abstract.js

2. Initialize the AbstractQueryClient for the chain on which you're using Abstract.

import { AbstractQueryClient } from "@abstract-money/abstract.js";

const CHAIN_NAME = "juno";
const getAbstract = async () => {
  const abstractQueryClient = await AbtsractQueryClient.connectToChain(
    CHAIN_NAME
  );
};

Abstract API

1. Install dependencies

pnpm install graphql-request@5

Typescript

To allow for strongly-typing the schemas, we recommend setting up code generation.

See https://www.apollographql.com/docs/ios/code-generation/codegen-configuration/ for alternative options.

The following uses the-guild's graphql codegen as a typescript preset. See https://the-guild.dev/graphql/codegen/plugins/presets/preset-client for client options.

1. Install dependencies

pnpm install -D graphql @graphql-codegen/cli @graphql-codegen/client-preset @graphql-typed-document-node/core

2. Setup codegen.yml. This allows for auto type generation.

schema: "<API_URL>/graphql" # This can be the API URL or the schema document

documents: ["./src/**/*.{tsx,ts}", "!src/__generated__/gql/**/*"]
generates:
  ./src/__generated__/gql/:
    preset: client
    presetConfig:
      gqlTagName: gql
      immutableTypes: true
    config:
      immutableTypes: true
      useTypeImports: true
      scalars:
        # Temporarily map to any, see DAT-16
        JSON: any
        Semver: string
        Bech32Address: string

3. Add codegen command to package.json

{
  "scripts": {
    "codegen": "graphql-codegen --config codegen.yml",
    "codegen:watch": "graphql-codegen --config codegen.yml --watch"
  }
}

NOTE: The first time you generate the types you will not import gql from the generated folder, rather just including the string in the file!

Usage

The following example shows how to query the Abstract API for the value of a given account:

import { AbstractAccountId, abstractApiRequest } from '@abstract-money/abstract.js'

import { gql } from '__generated__/gql'
import { type AccountValueQuery } from '__generated__/gql/graphql'

const accountValueQuery = gql(/* GraphQL */`
  query AccountsByIds($ids: [AccountIdWithChain!]!) {
    accountsByIds(ids: $ids) {
      vault {
        value
        baseAsset
      }
    }
  }
`)

const getAccountValue = async (accountId: AbstractAccountId) => {
  // This type is auto-generated and inferred by graphql-codegen, we are typing it for exemplary purposes
  const result: AccountValueQuery = await abstractApiRequest(
    accountValueQuery,
    // query variables are also strongly-typed!
    { ids: [accountId.toApi()] },
  )

  return result.accountsByIds[0].vault
}

getAccountValue(AbstractAccountId.fromStringId("kujiratestnet-13"))
  .then(({ value, baseAsset }) => console.log(
    `Total account value is ${value} ${baseAsset}`
  )
)

IDEs

We recommend installing the graphql plugins for the ides, where you can also include a link to the Abstract API URL for auto recognition of the schemas.