@catalogworks/cdk
v0.3.2
Published
A javascript/typescript SDK for interacting with Catalog related contracts
Downloads
1
Readme
CDK: The Catalog Development Kit
__ __
/\ \/\ \
___ \_\ \ \ \/'\
/'___\ /'_` \ \ , <
/\ \__//\ \L\ \ \ \\`\
\ \____\ \___,_\ \_\ \_\
\/____/\/__,_ /\/_/\/_/
Info
The Catalog Development Kit (CDK) is a small set of tools to easily and safely interact with Catalog contracts and related Zora market contracts. The CDK is written in TS and can be used in any JS environment.
This repository is based on the Zora ZDK (original version).
The CDK has these primary exports plus some types:
- Catalog
- Utils
- Addresses
- Metadata
- AsksV11
- ZoraModuleManager
- OffersV1
- ReserveAuctionETH
- ReserveAuctionFindersETH
- ReserveAuctionListingETH
- ReserveAuctionERC20
- ReserveAuctionFindersERC20
- ReserveAuctionListingERC20
Installation
yarn add @catalogworks/cdk
Development
git clone https://github.com/catalogworks/cdk.git
cd cdk
yarn
To build: (for publishing/local testing and use)
yarn build
Build output is located in the generated ./dist
directory.
Testing
Tests are written in Jest. using ts-jest. Unit tests are located in the tests folder.
To run the tests locally:
in a seperate terminal:
yarn chain
then:
yarn test
Code Coverage
Coverage reports can be generated by running:
yarn coverage
Reports are located in the ./coverage
directory.
License
View: LICENSE
Zora related code is licensed under MIT
Changelog
Contributing
This package is designed specifically for usage at Catalog, and development for this package is handled internally. Creating an issue is welcome for any security related contributions from developers outside of our organization.
Please create a fork of this repository for your own personal needs.
Dependencies
- @catalogworks/catalog-contracts
- @catalogworks/zorav3-with-types
- Ethers
- sjcl
- tiny-invariant
- tiny-warning
- ts-node