@regen-network/api

🚧 Warning

This API is still under heavy construction, be ready for unexpected breaking changes.

The v1.0.0-alpha4 and v1.0.0-alpha5 release tags include manual overrides of generated code in src in order to resolve a downstream issue within regen-network/groups-ui. For more information, see #84.

Table of Contents

• Install
• Usage
  • LCD Queries
  • RPC Queries
  • Composing Messages
  • Signing Messages
• Development
  • Codegen
  • Updating types
  • Publishing
• Credits

Install

yarn add @regen-network/[email protected]

Usage

LCD Queries

Example query using a cosmos module:

import { cosmos } from "@regen-network/api"
import { PageRequest } from "@regen-network/api/types/codegen/helpers"

const { createLCDClient } = cosmos.ClientFactory

const client = await createLCDClient({
  restEndpoint: "http://localhost:1317",
})

const response = await client.cosmos.bank.v1beta1.allBalances({
  address: "regen1df675r9vnf7pdedn4sf26svdsem3ugavgxmy46",
  pagination: { countTotal: true } as PageRequest,
})

See LCDCosmos.tsx for an example within the api-demo application.

Example query using a regen module:

import { regen } from "@regen-network/api"
import { PageRequest } from "@regen-network/api/types/codegen/helpers"

const { createLCDClient } = regen.ClientFactory

const client = await createLCDClient({
  restEndpoint: "http://localhost:1317",
})

const response = await client.regen.ecocredit.v1.projectByClass({
  classId: "C01",
  pagination: { countTotal: true } as PageRequest,
})

See LCDRegen.tsx for an example within the api-demo application.

RPC Queries

Example query using a cosmos module:

import { cosmos } from "@regen-network/api"
import { PageRequest } from "@regen-network/api/types/codegen/helpers"

import Long from "long"

const { createRPCQueryClient } = cosmos.ClientFactory

const client = await createRPCQueryClient({
  rpcEndpoint: "http://localhost:26657",
})

const response = await client.cosmos.bank.v1beta1.allBalances({
  address: "regen1df675r9vnf7pdedn4sf26svdsem3ugavgxmy46",
  pagination: {
    key: new Uint8Array(0),
    limit: Long.fromNumber(0),
    offset: Long.fromNumber(0),
  } as PageRequest,
})

See RPCCosmos.tsx for an example within the api-demo application.

Example query using a regen module:

import { regen } from "@regen-network/api"
import { PageRequest } from "@regen-network/api/types/codegen/helpers"

import Long from "long"

const { createRPCQueryClient } = regen.ClientFactory

const client = await createRPCQueryClient({
  rpcEndpoint: "http://localhost:26657",
})

const response = await client.regen.ecocredit.v1.projectByClass({
  classId: "C01",
  pagination: {
    key: new Uint8Array(0),
    limit: Long.fromNumber(0),
    offset: Long.fromNumber(0),
  } as PageRequest,
})

See RPCRegen.tsx for an example within the api-demo application.

Composing Messages

Example message using a cosmos module:

import { cosmos, getSigningCosmosClient } from "@regen-network/api"

const { send } = cosmos.bank.v1beta1.MessageComposer.withTypeUrl

const msg = send({
  amount: [
    {
      denom: "uregen",
      amount: "10000",
    },
  ],
  toAddress: "regen156d26rl52y3wl865pr5x9q2vqetuw9kf0642sa",
  fromAddress: "regen1df675r9vnf7pdedn4sf26svdsem3ugavgxmy46",
})

See MsgCosmos.tsx for an example within the api-demo application.

Example message using a regen module:

import { regen, getSigningCosmosClient } from "@regen-network/api"

const { createProject } = regen.ecocredit.v1.MessageComposer.withTypeUrl

const msg = createProject({
  admin: "regen1df675r9vnf7pdedn4sf26svdsem3ugavgxmy46",
  classId: "C01",
  metadata: "regen:13toVgf5UjYBz6J29x28pLQyjKz5FpcW3f4bT5uRKGxGREWGKjEdXYG.rdf",
  jurisdiction: "US-WA",
})

See MsgRegen.tsx for an example within the api-demo application.

Signing Messages

Example using a cosmos client (includes encoding for cosmos modules):

import { getSigningCosmosClient } from "@regen-network/api"

const { keplr } = window

const offlineSigner = keplr.getOfflineSigner("regen-local")

const [account] = await offlineSigner.getAccounts()

const signingClient = await getSigningCosmosClient({
  rpcEndpoint: "http://localhost:26657",
  signer: offlineSigner,
})

const fee = {
  amount: [
    {
      denom: "uregen",
      amount: "5000",
    },
  ],
  gas: "100000",
}

await signingClient.signAndBroadcast(account.address, [msg], fee)

See MsgCosmos.tsx for an example within the api-demo application.

Example using a regen client (includes encoding for regen modules):

import { getSigningRegenClient } from "@regen-network/api"

const { keplr } = window

const offlineSigner = keplr.getOfflineSigner("regen-local")

const [account] = await offlineSigner.getAccounts()

const signingClient = await getSigningRegenClient({
  rpcEndpoint: "http://localhost:26657",
  signer: offlineSigner,
})

const fee = {
  amount: [
    {
      denom: "uregen",
      amount: "5000",
    },
  ],
  gas: "100000",
}

await signingClient.signAndBroadcast(account.address, [msg], fee)

See MsgRegen.tsx for an example within the api-demo application.

Example using cosmjs and support for both cosmos and regen modules:

import { Registry } from "@cosmjs/proto-signing"
import { AminoTypes, SigningStargateClient } from "@cosmjs/stargate"
import {
  cosmosAminoConverters,
  cosmosProtoRegistry,
  regenAminoConverters,
  regenProtoRegistry,
} from "@regen-network/api"

const { keplr } = window

const offlineSigner = keplr.getOfflineSigner("regen-local")

const [account] = await offlineSigner.getAccounts()

const registry = new Registry({ ...cosmosProtoRegistry, ...regenProtoRegistry })

const signingClient = await SigningStargateClient.connectWithSigner(
  "http://localhost:26657",
  offlineSigner,
  {
    registry,
    aminoTypes: new AminoTypes({
      ...cosmosAminoConverters,
      ...regenAminoConverters,
    }),
  },
)

const fee = {
  amount: [
    {
      denom: "uregen",
      amount: "5000",
    },
  ],
  gas: "100000",
}

await signingClient.signAndBroadcast(account.address, [msg], fee)

See MsgMultiple.tsx for an example within the api-demo application.

Development

Install dependencies:

yarn

Generate code from proto:

yarn codegen

Compile and build library:

yarn build

Compile and build src code:

yarn build:ts

Credits

This package is built on osmonauts/telescope with initial guidance from pyramation/tmpl-telescope-module.