# @shapeshiftoss/proto-tx-builder

> Builds and signs new-style protobuf SIGN_MODE_DIRECT Cosmos SDK transactions

Latest version **0.10.0** (published 2025-05-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @shapeshiftoss/proto-tx-builder
pnpm add @shapeshiftoss/proto-tx-builder
yarn add @shapeshiftoss/proto-tx-builder
bun add @shapeshiftoss/proto-tx-builder
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.10.0 |
| Published | 2025-05-22 |
| First published | 2022-02-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 1.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | ShapeShift DAO |
| Maintainers | giantkin, kmart13, 0xean, 0xgomes, 0xapotheosis |

## Links

- npm: https://www.npmjs.com/package/@shapeshiftoss/proto-tx-builder
- Repository: https://github.com/shapeshift/proto-tx-builder
- Issues: https://github.com/shapeshift/proto-tx-builder/issues
- npm.io page: https://npm.io/package/@shapeshiftoss/proto-tx-builder

## Dependencies (9)

- [bn.js](https://npm.io/package/bn.js.md) ^5.2.1
- [osmojs](https://npm.io/package/osmojs.md) ^0.37.0
- [cosmjs-types](https://npm.io/package/cosmjs-types.md) ^0.5.1
- [@cosmjs/amino](https://npm.io/package/@cosmjs/amino.md) ^0.29.4
- [@cosmjs/crypto](https://npm.io/package/@cosmjs/crypto.md) 0.29.4
- [google-protobuf](https://npm.io/package/google-protobuf.md) ^3.17.0
- [@cosmjs/encoding](https://npm.io/package/@cosmjs/encoding.md) ^0.29.4
- [@cosmjs/stargate](https://npm.io/package/@cosmjs/stargate.md) ^0.29.4
- [@cosmjs/proto-signing](https://npm.io/package/@cosmjs/proto-signing.md) ^0.29.4

## Recent versions

- 0.10.0 (latest) — 2025-05-22
- 0.9.0 — 2025-05-21
- 0.9.0-alpha.4 — 2024-12-18
- 0.9.0-alpha.3 — 2024-12-18
- 0.9.0-alpha.2 — 2024-12-18
- 0.9.0-alpha.1 — 2024-12-17
- 0.9.0-alpha.0 — 2024-12-17
- 0.8.0 — 2023-05-02
- 0.7.0 — 2023-02-22
- 0.6.0 — 2022-11-29
- 0.5.0 — 2022-11-29
- 0.4.0 — 2022-10-18
- 0.3.0 — 2022-09-12
- 0.2.1 — 2022-04-26
- 0.2.0 — 2022-03-31
- … 4 more at https://npm.io/package/@shapeshiftoss/proto-tx-builder/versions

## README

# proto-tx-builder

Constructs and signs protobuf encoded cosmos-sdk

## Getting started

```bash
# Clone submodules
git submodule update --init --recursive
# Install the required dependencies
yarn
```

## Testing

Bug fixes and features should always come with tests, when applicable. Test files should live next to the file they are testing. Before submitting your changes in a pull request, always run the full test suite.

To run the test suite:

```bash
# build all dependent packages
yarn build

# Runs the full test suite
yarn test
```

## TS Proto generation

cosmos-sdk uses [protocol buffers](https://developers.google.com/protocol-buffers) to encode txs and other communication between nodes and clients as well as other nodes. proto-tx-builder leverages the protobuf definitions to generate the TypeScript implementation of the custom protobufs required to interact with a given chain.

-   place .proto files for the cosmos-sdk chain in `./proto` and `./third_party/proto` directories
-   remove existing generated files:
    ```bash
    rm -rf ./proto/generated/*
    ```
-   execute the generation script:
    ```base
    ./gen.sh
    ```
-   commit the generated content along with your changes

## Contributing

Please see the [Contributing Guidelines](CONTRIBUTING.md) document for this repo's specific contributing guidelines.

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