# @eth-optimism/contracts-ts

> TypeScript interface for Contracts Bedrock

Latest version **0.17.2** (published 2024-04-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install @eth-optimism/contracts-ts
pnpm add @eth-optimism/contracts-ts
yarn add @eth-optimism/contracts-ts
bun add @eth-optimism/contracts-ts
```

## Health

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

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

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.17.2 |
| Published | 2024-04-02 |
| First published | 2023-07-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 6.7 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | optibot, kelvinfichter |

## Links

- npm: https://www.npmjs.com/package/@eth-optimism/contracts-ts
- Repository: https://github.com/ethereum-optimism/optimism
- Homepage: https://optimism.io
- Issues: https://github.com/ethereum-optimism/optimism/issues
- npm.io page: https://npm.io/package/@eth-optimism/contracts-ts

## Dependencies (6)

- [viem](https://npm.io/package/viem.md) ^2.8.13
- [react](https://npm.io/package/react.md) ^18.2.0
- [react-dom](https://npm.io/package/react-dom.md) ^18.2.0
- [change-case](https://npm.io/package/change-case.md) 4.1.2
- [@types/change-case](https://npm.io/package/@types/change-case.md) ^2.3.1
- [@testing-library/react](https://npm.io/package/@testing-library/react.md) ^14.2.1

## Recent versions

- 0.17.2 (latest) — 2024-04-02
- 0.0.0-develop-20240401230611 (develop) — 2024-04-01
- 0.0.0-develop-20240401211611 — 2024-04-01
- 0.0.0-develop-20240401201601 — 2024-04-01
- 0.0.0-develop-20240401193634 — 2024-04-01
- 0.0.0-develop-20240401191608 — 2024-04-01
- 0.0.0-develop-20240401184411 — 2024-04-01
- 0.0.0-develop-20240401175937 — 2024-04-01
- 0.0.0-develop-20240401175653 — 2024-04-01
- 0.0.0-develop-20240401175154 — 2024-04-01
- 0.17.0 — 2023-10-20
- 0.0.0-develop-20231019235618 — 2023-10-19
- 0.0.0-develop-20231019232813 — 2023-10-19
- 0.0.0-develop-20231019231912 — 2023-10-19
- 0.0.0-develop-20231019231853 — 2023-10-19
- … 41 more at https://npm.io/package/@eth-optimism/contracts-ts/versions

## README

## Contracts TS

[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/develop/graph/badge.svg?token=0VTG7PG7YR&flag=contracts-bedrock-tests)](https://codecov.io/gh/ethereum-optimism/optimism)

ABI and Address constants + generated code from [@eth-optimism/contracts-bedrock/](../contracts-bedrock/) for use in TypeScript.

Much of this package is generated. See [CODE_GEN.md](./CODE_GEN.md) for instructions on how to generate.

#### @eth-optimism/contracts-ts

The main entrypoint exports constants related to contracts bedrock as const. As const allows it to be [used in TypeScript with stronger typing than importing JSON](https://github.com/microsoft/TypeScript/issues/32063).

- Exports contract abis.
- Exports contract addresses

```typescript
import {
  l2OutputOracleProxyABI,
  l2OutputOracleAddresses,
} from '@eth-optimism/contracts-ts'

console.log(l2OutputOracleAddresses[10], abi)
```

Addresses are also exported as an object for convenience.

```typescript
import { addresses } from '@eth-optimism/contracts-ts'

console.log(addresses.l2OutputOracle[10])
```

#### @eth-optimism/contracts-ts/react

- All [React hooks](https://wagmi.sh/cli/plugins/react) `@eth-optimism/contracts-ts/react`

```typescript
import { useAddressManagerAddress } from '@eth-optimism/contracts-ts/react'

const component = () => {
  const { data, error, loading } = useAddressManagerAddress()
  if (loading) {
    return <div>Loading</div>
  }
  if (err) {
    return <div>Error</div>
  }
  return <div>{data}</div>
}
```

#### @eth-optimism/contracts-ts/actions

- All [wagmi actions](https://wagmi.sh/react/actions) for use in Vanilla JS or non react code

```typescript
import { readSystemConfig } from '@eth-optimism/contracts-ts/actions'
console.log(await readSystemConfig())
```

#### See Also

- [Contracts bedrock specs](../../specs/)
- [Wagmi](https://wagmi.sh)

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