docs: document only what works in tests

Author: turadg

packages/cosmic-proto/README.md

@@ -37,11 +37,6 @@ import { agoric } from '@agoric/cosmic-proto';
 const { createRPCQueryClient } = agoric.ClientFactory; 
 const client = await createRPCQueryClient({ rpcEndpoint: RPC_ENDPOINT });
 
-// now you can query the cosmos modules
-const balance = await client.cosmos.bank.v1beta1
-    .allBalances({ address: 'agoric1addresshere' });
-
-// you can also query the agoric modules
 const swingsetParams = await client.agoric.swingset.params()
 ```
 
@@ -57,49 +52,6 @@ const {
 } = agoric.exchange.v1beta1.MessageComposer.withTypeUrl;
 ```
 
-#### IBC Messages
-
-```js
-import { ibc } from '@agoric/cosmic-proto';
-
-const {
-    transfer
-} = ibc.applications.transfer.v1.MessageComposer.withTypeUrl
-```
-
-#### Cosmos Messages
-
-```js
-import { cosmos } from '@agoric/cosmic-proto';
-
-const {
-    fundCommunityPool,
-    setWithdrawAddress,
-    withdrawDelegatorReward,
-    withdrawValidatorCommission
-} = cosmos.distribution.v1beta1.MessageComposer.fromPartial;
-
-const {
-    multiSend,
-    send
-} = cosmos.bank.v1beta1.MessageComposer.fromPartial;
-
-const {
-    beginRedelegate,
-    createValidator,
-    delegate,
-    editValidator,
-    undelegate
-} = cosmos.staking.v1beta1.MessageComposer.fromPartial;
-
-const {
-    deposit,
-    submitProposal,
-    vote,
-    voteWeighted
-} = cosmos.gov.v1beta1.MessageComposer.fromPartial;
-```
-
 ## Connecting with Wallets and Signing Messages
 
 ⚡️ For web interfaces, we recommend using [cosmos-kit](https://github.com/cosmology-tech/cosmos-kit). Continue below to see how to manually construct signers and clients.

packages/cosmic-proto/test/test-readme.js

@@ -0,0 +1,22 @@
+/** @file snippets from the README */
+/* eslint-disable import/no-extraneous-dependencies -- requiring the package itself to check exports map */
+/* eslint-disable import/no-unresolved -- not detecting the "exports" map */
+import test from 'ava';
+
+import { agoric } from '../dist/index.js';
+
+const RPC_ENDPOINT = '';
+
+// Skip because we don't have a real endpoint, still tests the types
+test.skip('RPC Clients', async t => {
+  const { createRPCQueryClient } = agoric.ClientFactory;
+  const client = await createRPCQueryClient({ rpcEndpoint: RPC_ENDPOINT });
+
+  const swingsetParams = await client.agoric.swingset.params();
+  t.truthy(swingsetParams);
+});
+
+test('Composing Messages', t => {
+  const { sendPacket } = agoric.vibc.MessageComposer.withTypeUrl;
+  t.truthy(sendPacket);
+});