# intentojs

<img src="https://docs.trustlesshub.com/assets/img/banner.05ada057.png" width="400">

## install

```sh
npm install intentojs
```

## Connecting with Wallets and Signing Messages

⚡️ For web interfaces, we recommend using [cosmos-kit](https://github.com/cosmology-tech/cosmos-kit). To sign and broadcast messages, you can create signers with a variety of options:

- [cosmos-kit](https://github.com/cosmology-tech/cosmos-kit/tree/main/packages/react#signing-clients) (recommended)
- [keplr](https://docs.keplr.app/api/cosmjs.html)
- [cosmjs](https://gist.github.com/webmaster128/8444d42a7eceeda2544c8a59fbd7e1d9)

### Initializing the Stargate Client

We recommend manually making the `SigningStargateClient` instance yourself by using `getIntentoSigningClientOptions`:

```ts
import {
  getIntentoSigningClientOptions,
  IntentoAccountParser,
} from "@intentojs";

const { registry, aminoTypes } = getIntentoSigningClientOptions();

const client = await SigningStargateClient.connectWithSigner(
  rpc,
  offlineSigner,
  {
    registry,
    aminoTypes,
    accountParser: intentoAccountParser,
  }
);
```

## Usage

We strongly recommend that you check the generated files in `src/codegen/intento` and use it as source of truth for which functions you could use.

The rest of our documentation will cover only the tip of the iceberg &mdash; examples you can take ideas from.

### RPC Client

```ts
import { intento } from "intentojs";

const client = await intento.ClientFactory.createRPCQueryClient({
  rpcEndpoint: RPC_ENDPOINT,
});

const balance = await client.cosmos.bank.v1beta1.allBalances({
  address: "intento1addresshere",
});
```

### Composing & Broadcasting Intento Messages

```ts
import { intento } from "intentojs";

const msgClaimFreeAmount =
  intento.claim.MessageComposer.withTypeUrl.claimFreeAmount({
    user: "into1addresshere",
  });

const fee = {
  amount: [
    {
      amount: "0",
      denom: "uinto",
    },
  ],
  gas: 250_000,
};

const tx = await intentoAccount.client.signAndBroadcast(
  "intento1addresshere",
  [msgClaimFreeAmount],
  fee,
  ""
);

assertIsDeliverTxSuccess(tx);
```

If you're unfamiliar with Stargate, you can read their guide [here](https://gist.github.com/webmaster128/8444d42a7eceeda2544c8a59fbd7e1d9).

#### Composing IBC Messages

```js
import { ibc } from "intentojs";

const { transfer } =
  ibc.applications.transfer.v1.MessageComposer.withTypeUrl.transfer({
    // Redacted (check internal types for the message parameters)
  });
```

## Developing & Publishing

When first cloning the repo:

```bash
git submodule update --init
telescope install
telescope transpile
```

### Codegen

Update the generated ts files:

```bash
yarn codegen
```

Build the module and types:

```bash
yarn build
```

### Publishing

If you haven't logged to npm cli, run:

```bash
npm login
```

Afterwards, update package.json version.

```bash
# Example: <version> = 0.9.0-beta.3
git push origin main
git tag <version>
git push origin <version>
npm publish
```

## Credits

🛠 Built by Cosmology — if you like our tools, please consider delegating to [their validator ⚛️](https://cosmology.tech/validator)

Code built with the help of these related projects:

- [@cosmwasm/ts-codegen](https://github.com/CosmWasm/ts-codegen) for generated CosmWasm contract Typescript classes
- [@cosmology/telescope](https://github.com/cosmology/telescope) a "babel for the Cosmos", Telescope is a TypeScript Transpiler for Cosmos Protobufs.
- [cosmos-kit](https://github.com/cosmology-tech/cosmos-kit) A wallet connector for the Cosmos ⚛️