# @cosmology/protobufs

> osmosis protobufs

Latest version **0.0.8** (published 2022-04-22) · SEE LICENSE IN LICENSE license · 0 weekly downloads

## Install

```sh
npm install @cosmology/protobufs
pnpm add @cosmology/protobufs
yarn add @cosmology/protobufs
bun add @cosmology/protobufs
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.8 |
| Published | 2022-04-22 |
| First published | 2022-04-01 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN LICENSE |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 2.9 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 50 |
| Author | Dan Lynch |
| Maintainers | pyramation |

## Links

- npm: https://www.npmjs.com/package/@cosmology/protobufs
- Repository: https://github.com/cosmology-finance/cosmology.git#master
- Homepage: https://github.com/cosmology-finance/cosmology/tree/master/packages/protobufs#readme
- Issues: https://github.com/cosmology-finance/cosmology/tree/master/packages/protobufs/issues
- npm.io page: https://npm.io/package/@cosmology/protobufs

## Dependencies (6)

- [long](https://npm.io/package/long.md) ^5.2.0
- [@cosmjs/amino](https://npm.io/package/@cosmjs/amino.md) 0.28.4
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.11.2
- [@cosmjs/stargate](https://npm.io/package/@cosmjs/stargate.md) 0.28.4
- [@cosmjs/proto-signing](https://npm.io/package/@cosmjs/proto-signing.md) 0.28.4
- [@cosmjs/tendermint-rpc](https://npm.io/package/@cosmjs/tendermint-rpc.md) ^0.28.4

## Recent versions

- 0.0.8 (latest) — 2022-04-22
- 0.0.7 — 2022-04-05
- 0.0.6 — 2022-04-05
- 0.0.5 — 2022-04-05
- 0.0.4 — 2022-04-01

## README

# protobufs

Typescript Protobuf Messages for Osmosis

# usage

```sh
npm install @cosmology/protobufs
```

## Example

```js
import { MsgJoinPool } from '@cosmology/protobufs';
const msg = MsgJoinPool.fromPartial({
  poolId: '606',
  sender: 'osmo1f4vxvvvvvvvvvv3luuddddddddddcccccccccc',
  shareOutAmount: '101010101',
  tokenInMaxs: [
    coin(
      10248,
      'ibc/27394FB092D2ECCD56123C74F36E4C1F926001CEADA9CA97EA622B25F41E5EB2'
    ),
    coin(
      64837969,
      'ibc/B9E0A1A524E98BB407D3CED8720EFEFD186002F90C1B1B7964811DD0CCC12228'
    )
  ]
});
```

## API

Current exports the following messages:

- `MsgExitPool`
- `MsgExitPoolResponse`
- `MsgExitSwapExternAmountOut`
- `MsgExitSwapExternAmountOutResponse`
- `MsgExitSwapShareAmountIn`
- `MsgExitSwapShareAmountInResponse`
- `MsgJoinPool`
- `MsgJoinPoolResponse`
- `MsgJoinSwapExternAmountIn`
- `MsgJoinSwapExternAmountInResponse`
- `MsgJoinSwapShareAmountOut`
- `MsgJoinSwapShareAmountOutResponse`
- `MsgSwapExactAmountIn`
- `MsgSwapExactAmountInResponse`
- `MsgSwapExactAmountOut`
- `MsgSwapExactAmountOutResponse`
- `SwapAmountInRoute`
- `SwapAmountOutRoute`

# building

```
./bin/run-proto.sh
```

## mac

http://google.github.io/proto-lens/installing-protoc.html

```
brew install protobuf
```

## protobufs

To get the build to work, you have to properly point to the protobuf files, including the ones included by osmosis, cosmos SDK, etc. 

To make this self-contained (for now), I've gone ahead and loaded all the protobufs locally into the `./protobuf` folder. 

### protobufs from other repos

https://github.com/cosmos/cosmos-proto
https://github.com/cosmos/cosmos-sdk/tree/master/proto
https://github.com/googleapis/googleapis/tree/master/google


We got the gogo protobuf here since the [one referenced](https://github.com/gogo/protobuf/issues/737) seems to not exist in google's repo

https://github.com/regen-network/protobuf

### manually installing protobufs

```
go get -u github.com/gogo/protobuf
```

---
_Source: https://npm.io/package/@cosmology/protobufs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
