Skip to content

Commit

Permalink
fixup! docs: document only what works in tests
Browse files Browse the repository at this point in the history
  • Loading branch information
turadg committed Feb 29, 2024
1 parent 2b8cac6 commit a64795e
Showing 1 changed file with 1 addition and 10 deletions.
11 changes: 1 addition & 10 deletions packages/cosmic-proto/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,6 @@ npm install @agoric/cosmic-proto
- [Usage](#usage)
- [RPC Clients](#rpc-clients)
- [Composing Messages](#composing-messages)
- Cosmos, CosmWasm, and IBC
- [CosmWasm](#cosmwasm-messages)
- [IBC](#ibc-messages)
- [Cosmos](#cosmos-messages)
- [Wallets and Signers](#connecting-with-wallets-and-signing-messages)
- [Stargate Client](#initializing-the-stargate-client)
- [Creating Signers](#creating-signers)
Expand Down Expand Up @@ -145,8 +141,6 @@ import { AminoTypes, SigningStargateClient } from "@cosmjs/stargate";
import {
cosmosAminoConverters,
cosmosProtoRegistry,
cosmwasmAminoConverters,
cosmwasmProtoRegistry,
ibcProtoRegistry,
ibcAminoConverters,
agoricAminoConverters,
Expand All @@ -158,14 +152,12 @@ const rpcEndpint = 'https://rpc.cosmos.directory/agoric'; // or another URL

const protoRegistry: ReadonlyArray<[string, GeneratedType]> = [
...cosmosProtoRegistry,
...cosmwasmProtoRegistry,
...ibcProtoRegistry,
...agoricProtoRegistry
];

const aminoConverters = {
...cosmosAminoConverters,
...cosmwasmAminoConverters,
...ibcAminoConverters,
...agoricAminoConverters
};
Expand Down Expand Up @@ -203,7 +195,7 @@ yarn test:live

### Codegen

Contract schemas live in `./contracts`, and protos in `./proto`. Look inside of `scripts/codegen.cjs` and configure the settings for bundling your SDK and contracts into `@agoric/cosmic-proto`:
Protos live in `./proto`. Look inside of `scripts/codegen.cjs` and configure the settings for bundling your SDK into `@agoric/cosmic-proto`:

```
yarn codegen
Expand All @@ -223,7 +215,6 @@ yarn publish
Checkout these related projects:

* [@cosmology/telescope](https://github.com/cosmology-tech/telescope) Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules.
* [@cosmwasm/ts-codegen](https://github.com/CosmWasm/ts-codegen) Convert your CosmWasm smart contracts into dev-friendly TypeScript classes.
* [chain-registry](https://github.com/cosmology-tech/chain-registry) Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application.
* [cosmos-kit](https://github.com/cosmology-tech/cosmos-kit) Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.
* [create-cosmos-app](https://github.com/cosmology-tech/create-cosmos-app) Set up a modern Cosmos app by running one command.
Expand Down

0 comments on commit a64795e

Please sign in to comment.