Skip to content
This repository was archived by the owner on Jul 10, 2024. It is now read-only.

Commit d8a17a6

Browse files
authored
make cdk publicly available (#32)
* update org scope peer dependencies to use npm public pacakages, update readme * add SECURITY.md * update actions to remove npmrc creation * remove examples * lockfile
1 parent bf1e47c commit d8a17a6

File tree

10 files changed

+40
-426
lines changed

10 files changed

+40
-426
lines changed

.github/workflows/lint.yml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,6 @@ jobs:
1414
with:
1515
node-version: 14.17.6
1616

17-
- name: Create NPMRC
18-
run: |
19-
echo "//npm.pkg.github.com/:_authToken=${{ secrets.PACKAGES_TOKEN }}" >> ~/.npmrc
20-
echo "@catalogworks:registry=https://npm.pkg.github.com" >> ~/.npmrc
21-
echo 'registry "https://registry.yarnpkg.com"' >> ~/.yarnrc
22-
2317
- name: code checkout
2418
uses: actions/checkout@v2
2519

.github/workflows/nodejs-tests.yml

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ name: nodejs-tests
33
on: [push, pull_request]
44

55
jobs:
6-
76
test:
87
runs-on: ubuntu-latest
98

@@ -16,13 +15,6 @@ jobs:
1615
uses: actions/setup-node@v1
1716
with:
1817
node-version: 14.17.6
19-
20-
- name: Create NPMRC
21-
run: |
22-
echo "//npm.pkg.github.com/:_authToken=${{ secrets.PACKAGES_TOKEN }}" >> ~/.npmrc
23-
echo "@catalogworks:registry=https://npm.pkg.github.com" >> ~/.npmrc
24-
echo 'registry "https://registry.yarnpkg.com"' >> ~/.yarnrc
25-
2618

2719
- name: Get yarn cache directory path
2820
id: yarn-cache-dir-path
@@ -36,20 +28,18 @@ jobs:
3628
restore-keys: |
3729
${{ runner.os }}-yarn-
3830
39-
4031
- name: Installing dependencies
4132
run: yarn install --frozen-lockfile
4233

4334
- name: start blockchain
4435
run: yarn chain &
4536

46-
# - run:
37+
# - run:
4738
# shell: /bin/sh
4839
# command: |
4940
# wget --retry-connrefused --waitretry=1 --read-timeout=20 --timeout=15 -t 10 http://localhost:8545
5041
# :
5142
# name: wait for chain and override shell
5243

53-
5444
- name: Running tests
55-
run: yarn test
45+
run: yarn test

.npmrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
@catalogworks:registry=https://npm.pkg.github.com
1+
@catalogworks:registry=https://registry.npmjs.org/

README.md

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,14 @@
1111
1212
```
1313

14-
WIP Repo
15-
1614
---
1715

1816
## Info
1917

20-
The Catalog Development Kit (**CDK**) is a small set of tools to easily and safely interact with Catalog contracts and protocols.
18+
The Catalog Development Kit (**CDK**) is a small set of tools to easily and safely interact with Catalog contracts and related Zora market contracts.
2119
The CDK is written in TS and can be used in any JS environment.
2220

23-
This repository is based on the [Zora ZDK](https://github.com/ourzora/zdk).
21+
This repository is based on the [Zora ZDK (original version)](https://github.com/ourzora/zdk).
2422

2523
The CDK has these primary exports plus some types:
2624

@@ -45,20 +43,11 @@ The CDK has these primary exports plus some types:
4543
[Package](https://github.com/catalogworks/cdk/packages/1173720)
4644

4745
```bash
48-
yarn add @catalogworks/cdk@0.3.2
46+
yarn add @catalogworks/cdk
4947
```
5048

5149
---
5250

53-
### Examples
54-
55-
Example usage of the CDK in a NodeJS environment can be found in the [examples](./examples) directory.
56-
57-
- [tree+proofs+root](./examples/scripts/treeproofdb.ts)
58-
- [gnosissafe](./examples/scripts/connectsafe.ts)
59-
60-
---
61-
6251
### Development
6352

6453
```bash
@@ -69,12 +58,6 @@ git clone https://github.com/catalogworks/cdk.git
6958
cd cdk
7059
```
7160

72-
_Note: you may need to do the following before being able to install packages_
73-
74-
- In GitHub, go to settings > developer settings > personal access tokens
75-
- Generate new access token with permission `read:packages`
76-
- Add the following line to bottom of .npmrc `//npm.pkg.github.com/:_authToken=<Your Access Token>`
77-
7861
```bash
7962
yarn
8063
```
@@ -126,6 +109,8 @@ Reports are located in the `./coverage` directory.
126109

127110
View: [LICENSE](./LICENSE)
128111

112+
Zora related code is licensed under [MIT](https://github.com/ourzora/zdk/blob/v1-archive/LICENSE)
113+
129114
---
130115

131116
### Changelog
@@ -134,9 +119,16 @@ View: [LICENSE](./LICENSE)
134119

135120
---
136121

122+
### Contributing
123+
124+
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.
125+
126+
Please create a fork of this repository for your own personal needs.
127+
137128
### Dependencies
138129

139-
- [@catalogworks/catalog-contracts@0.1.4](https://github.com/catalogworks/catalog-contracts/packages/1165811)
130+
- [@catalogworks/catalog-contracts](https://www.npmjs.com/package/@catalogworks/catalog-contracts)
131+
- [@catalogworks/zorav3-with-types](https://www.npmjs.com/package/@catalogworks/zorav3-with-types)
140132
- Ethers
141133
- sjcl
142134
- tiny-invariant

SECURITY.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
- All versions
6+
7+
## Reporting a Vulnerability
8+
9+
External Contributors / Community Auditors:
10+
11+
- Please [open an issue](https://github.com/catalogworks/cdk/issues/new) detailing the vulnerability discovered.
12+
- If this is a **serious** immediate issue, please reach out via Discord, Slack, or [email](mailto:[email protected])

examples/scripts/adminburnsafe.ts

Lines changed: 0 additions & 128 deletions
This file was deleted.

0 commit comments

Comments
 (0)