https://github.com/peetzweg/abimate

Prebuild ABIs and Typescript types of your favorite smart-contracts for your favorite libraries.
https://github.com/peetzweg/abimate

abi ethereum evm solidity typescript wagmi

Last synced: 26 days ago
JSON representation

Prebuild ABIs and Typescript types of your favorite smart-contracts for your favorite libraries.

• Host: GitHub
• URL: https://github.com/peetzweg/abimate
• Owner: peetzweg
• Created: 2022-06-16T15:42:58.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-19T09:35:56.000Z (almost 2 years ago)
• Last Synced: 2024-10-03T18:14:03.652Z (about 2 months ago)
• Topics: abi, ethereum, evm, solidity, typescript, wagmi
• Language: TypeScript
• Homepage:
• Size: 869 KB
• Stars: 8
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# `@abimate`

ABIs and Typescript types of your favorite smartcontracts.

## Description

I was a quite frustrated to always include a abi and type generation in each of my projects. Even for the most fundamental contracts like ERC721 and ERC20. It's just such bloat to setup even for a quick proof of concept project. Therefore I created this package to provide easy access to ABIs and types to popular smartcontract libraries.

The first contracts to include are from [solmate](https://github.com/Rari-Capital/solmate), which obviously also inspired the projects name.

This repository is setup as a monorepo using [nx](https://nx.dev/) and will probably contain more ABIs and types in the future. Feel free to open a pull request with your favorite smartcontract libraries.

Currently included is:

- [solmate](https://github.com/Rari-Capital/solmate) as [@abimate/solmate](https://www.npmjs.com/package/@abimate/solmate)

- [OpenZeppelin](https://github.com/OpenZeppelin/openzeppelin-contracts) as [@abimate/openzeppelin](https://www.npmjs.com/package/@abimate/openzeppelin)

## Install

`npm install @abimate/solmate`

`npm install @abimate/openzeppelin`

## Usage

Here is an example usage of the ABI and ERC721 contract type.

### Usage with `@wagmi`

```typescript

import { balanceOf } from '@abimate/solmate/ERC20';

import { getContract } from '@wagmi/core';

const ERC20 = [balanceOf];

const token = getContract({

  address: '0x23581767a106ae21c074b2276D25e5C3e136a68b',

  abi: ERC20,

});

const balance = await token.callStatic.balanceOf('0x23581767a106ae21c074b2276D25e5C3e136a68b');

```

### Usage with `ethers`

```typescript

import { Contract } from 'ethers';

import ABI from '@abimate/solmate/ERC20';

import { ERC20 } from '@abimate/solmate/types/ERC20';

const token = new Contract(

  '0x23581767a106ae21c074b2276D25e5C3e136a68b',

  ABI

) as ERC20;

token.functions.balanceOf('0x23581767a106ae21c074b2276D25e5C3e136a68b');

```

## Use with Own Contracts `@abimate/core`

`npm install @abimate/core`

`abimate [output_path] [input_files]`

## Building

Requirements:

+ `nx` - https://nx.dev/

+ `foundry` - https://getfoundry.sh/

Commands to run a build:

`git clone [email protected]:peetzweg/abimate.git`

`cd abimate`

`git submodule update --init --recursive`

`npm install`

`nx build solmate`

## Contribute

Generate new package:

`nx generate @nrwl/js:library --name=PACKAGE_NAME --buildable`

Add contract code via submodule:

`git submodule add  packages/PACKAGE_NAME/lib`

## Acknowledgements

Code in this repository is directly referencing:

- [TypeChain](https://github.com/dethcrypto/TypeChain)

- [solmate](https://github.com/Rari-Capital/solmate)

- [OpenZeppelin](https://github.com/OpenZeppelin/openzeppelin-contracts)

## Licensing

Licensing of the original source code applies. See individual licenses in `/packages/{PACKAGE_NAME}/LICENSE`.