Skip to content

Commit

Permalink
fix the readme and undo some temp stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronmgdr committed Dec 6, 2023
1 parent a50a543 commit 3ab415a
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
8 changes: 2 additions & 6 deletions .github/workflows/celo-monorepo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,7 @@ jobs:
run: yarn run postinstall
if: steps.cache_node.outputs.cache-hit == 'true'
- name: Build packages
# Just until contractkit is removed wait to build all packages the need abis to be built first
run: |
yarn build --ignore @celo/contractkit --ignore @celo/explorer --ignore @celo/celocli --ignore @celo/governance --ignore @celo/metadata-crawler --ignore @celo/celotool --ignore @celo/env-tests --ignore @celo/transactions-uri --ignore @celo/wallet-rpc --include-dependencies
yarn --cwd packages/protocol run prepare_contracts_and_abis_publishing
yarn build --ignore docs --include-dependencies
run: yarn build --ignore docs --include-dependencies
- name: Check licenses
if: steps.cache_node.outputs.cache-hit != 'true'
run: |
Expand Down Expand Up @@ -115,7 +111,7 @@ jobs:
- name: Get the artifacts to cache
id: get_artifacts_to_cache
run: |
artifacts_to_cache="$(git ls-files --others --ignored --exclude-standard | grep -v node_modules | grep -v cjs/types/wagmi |grep -v src-generated/types/ethers | grep -v .js.map)"
artifacts_to_cache="$(git ls-files --others --ignored --exclude-standard | grep -v node_modules | grep -v .js.map)"
echo "artifacts_to_cache<<EOF" >> $GITHUB_OUTPUT
echo "$artifacts_to_cache" >> $GITHUB_OUTPUT
echo "EOF" >> $GITHUB_OUTPUT
Expand Down
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,7 @@
"packages": [
"packages/*",
"packages/sdk/*",
"packages/sdk/wallets/*",
"packages/protocol/abis"
"packages/sdk/wallets/*"
],
"nohoist": [
"**/openzeppelin-solidity",
Expand Down
15 changes: 10 additions & 5 deletions packages/protocol/abis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,22 @@ or
yarn add @celo/abis
```

**There is no index so the following do not work**
`import abis from '@celo/abis'` or ` import web3AbiTypes from '@celo/abis/web3'`

### In your javascript or ts

```ts
// json abi
// abi in json
import Accounts from '@celo/abis/Accounts.json'

// web3
import Accounts from '@celo/abis/web3/Accounts'
// abi in js/ts
import { accountsABI } from '@celo/abis/Accounts'

// abi in js/ts for use with contractkit
import { type Accounts, newAccounts, ABI } from '@celo/abis/web3/Accounts'


// wagmi
import Accounts from '@celo/abis/wagmi/Accounts'
```

## License
Expand Down

0 comments on commit 3ab415a

Please sign in to comment.